<oXygen/> User Guide

Tree View Window

The Tree View window is comprised of the following main components:

Figure 3.31. The Main Interface

The Main Interface

Main Menu

The main menu, located below the program title bar, provides menu driven access to all the features and functions available within Oxygen Tree View.

File Menu

[Note]Note

Macintosh users should use the command key instead of the control key for all keyboard shortcuts.

Table 3.23. File Menu Options

  • File-> New (Ctrl+N) : Creates a new empty document and displays it in the Tree View Editor.

  • File-> Open (Ctrl+O) : Displays the Open dialog used to discover, select and open a file to be edited.

  • File-> Open URL (Ctrl+U) : Displays the Open URL dialog used to discover, select and open one or more files using FTP/WebDAV.

  • File-> Save (Ctrl+S) : Saves the current document. If the document does not have a file, displays the "Save As" dialog.

  • File->Save As: Displays the Save As dialog, used to name and save an open document to a file; or save an exiting file with a new name.

  • File->Save To URL: Displays the Save to URL dialog, used to name and save an open document to a file; or save an exiting file with a new name, using FTP/WebDAV.

  • File->Reopen: Displays a list of recently opened document files. Select a file to open.

  • File-> Close (Ctrl+W) : Closes the Tree View Editor.

Edit Menu

Table 3.24. Edit Menu Options

  • Edit->Copy (Ctrl+C) : Places a duplicate copy of the current selection in the clipboard.

  • Edit->Cut (Ctrl+X) : Removes the current selected node from the document and places it in the clipboard.

  • Edit->Paste (Ctrl+V) : Places the current clipboard content into the document at the cursor position.

  • Edit->Delete (Delete) : Delete the selected node from the document.

  • Edit->Start Editing (F5) : Starts editing the selected node from the document.

  • Edit->End Editing (F6) : Ends editing the selected node.

  • Edit->Undo (Ctrl+Z) : Reverses, a maximum of 100, editing actions to return to the preceding state.

  • Edit->Redo (Ctrl+Shift+Z) : Recreates, a maximum of 100 editing actions that were undone by the "Undo" function.

Insert Menu

Table 3.25. Insert Menu Options

  • Insert-> Insert (F9) : Insert a new node of the same type like the selected one as its sibling.

  • Insert Element: Insert an Element after the selected node as its last child.

  • Insert Attribute: Insert an Attribute after the selected node as its last attribute.

  • Insert Comment: Insert a Comment after the selected node as its last child.

  • Insert CDATA: Insert a CDATA after the selected node as its last child.

  • Insert Processing Instruction: Insert a Processing Instruction after the selected node as its last child.

  • Insert Text: Insert a Text after the selected node as its last child.

  • Insert Entity Reference: Insert a Entity after the selected node as its last child.

Move Menu

Table 3.26. Move Menu Options

  • Move->Move Up (Ctrl+Up) : Move up the selected node with one position.

  • Move->Move Down (Ctrl+Down) : Move down the selected node with one position.

Main Toolbar

The Main toolbar, located below the Main menu, provides easy access to common and frequently used functions. Each icon is a button that acts as a short-cut to a related function. Hold the pointer cursor over an icon to display a context label that will give you a hint as to its function. Click an icon to use its' function.

Figure 3.32. The Main Toolbar Buttons

The Main Toolbar Buttons

Table 3.27. Description of Main Toolbar Buttons

File-> New (Ctrl+N): Displays the New dialog from which to select the document file type.

File-> Open (Ctrl+O): Displays the Open dialog used to discover, select and open a file.

File-> Open URL (Ctrl+U): Displays the Open URL dialog used to discover, select and open one or more files using FTP/WebDAV.

File-> Save (Ctrl+S): Saves the current document. If the document does not have a file, displays the "Save As" dialog.

Save To URL: Displays the Save URL dialog, used to name and save an open document to a file; or save an exiting file with a new name, using FTP/WebDAV.

Edit->Copy (Ctrl+C): Places a duplicate copy of the current selection in the clipboard.

Edit->Cut (Ctrl+X): Removes the current selection from the document and places it in the clipboard.

Edit->Paste (Ctrl+V): Places the current clipboard content into the document at the current position.

Edit->Delete (Delete): Delete the selected node from the document.

Edit->Undo (Ctrl+Z): Reverses, a maximum of 100, editing actions to return to the preceding state.

Edit->Redo (Ctrl+Shift+Z): Recreates, a maximum of 100, editing actions that were undone by the "Undo" function.

XPath: Executes an XPath expression, used to select specified elements within the current document.

Tree Editing Toolbar

The tree editing toolbar, located on the left side of the tree editor window, provides easy access to frequently used functions. Each icon is a button that acts as a shortcut to the corresponding function. Hold your mouse pointer over an icon to display a tooltip text that will give you a hint to its function. Click an icon to use its function.

Table 3.28. Description of Tree Editing Toolbar Buttons

Validate XML (Ctrl+Shift+V): Executes the Validation operation on the current document using a validating parser. Returns an error result-list in the Message panel. Mark-up of current document is checked to conform with the specified DTD, XML Schema or Relax NG schema rules.

Insert->Insert - Element: Insert an element after the selected node as its last child.

Insert->Insert - Attribute: Insert an attribute after the selected node as its last child.

Insert->Insert - Comment: Insert a Comment after the selected node as its last child.

Insert->Insert - CDATA: Insert a CDATA after the selected node as its last child.

Insert->Insert - Processing Instruction: Insert a processing instruction after the selected node as its last child.

Insert->Insert - Text: Insert a text after the selected node as its last child.

Insert->Insert - Entity Reference: Insert an entity reference after the selected node as its last child.

Start Editing: Starts editing the selected node from the document.

Stop Editing: Ends editing the selected node.

Toggle AT: This option shows/hides the attributes.

Toggle WS: This option shows/hides the whitespaces.

Move->Move Up (Ctrl+Up): This option moves up the selected node with one position.

Move->Move Down (Ctrl+Down): This option moves down the selected node with one position.

Expand All (Ctrl+P): This option expands the selected element by one level.

Collapse All (Ctrl+L): This option collapses the selected element by one level.

Insert->Insert (Insert): Insert a new node of the same type like the selected one as its sibling.

Editor Panel

The Editor panel is comprised of:

Figure 3.33. The Editor Panel

The Editor Panel

The Navigation Panel

For a quick navigation in the document you can use the navigation panel which displays each level of the document on a different column. You can easily navigate on the same level of the tree by pressing on the down arrow of a column and choosing the desired token.

The navigation panel is located above the editing space.

Figure 3.34. The Navigation Panel

The Navigation Panel

Editing Space

The Tree View Editor provides a useful set of features that promote easy editing of structure mark-up documents. Each token have associated an icon for a easy visual identification of the tokens.

Right-click anywhere in the editor to display a menu with options related to editing and mark-up operations.

Table 3.29. Description of Editor Space Menu

  • Edit->Copy (Ctrl+C) : Places a duplicate copy of the current selection in the clipboard.

  • Edit->Cut (Ctrl+X) : Removes the current selected node from the document and places it in the clipboard.

  • Edit->Paste (Ctrl+V) : Places the current clipboard content into the document at the cursor position.

  • Edit->Delete (Delete) : Delete the selected node from the document.

  • Edit->Undo (Ctrl+Z) : Reverses, a maximum of 100, editing actions to return to the preceding state.

  • Edit->Redo (Ctrl+Shift+Z) : Recreates, a maximum of 100, editing actions that were undone by the "Undo" function.

  • Expand All (Ctrl+P): This option expands the selected element by one level.

  • Collapse All (Ctrl+L): This option collapses the selected element by one level.

  • Validate XML (Ctrl+Shift+V): Executes the Validation operation on the current document using a validating parser. Returns an error result-list in the Message panel. Mark-up of current document is checked to conform with the specified DTD, XML Schema or Relax NG schema rules.

Editor Status Bar

The Editor status bar, located below the Editing space, provides information about the current document:

Figure 3.35. The Editor Status Bar

The Editor Status Bar
The Document Path Pane

Displays the full path of the current document.

The Message Pane

Displays the status of Validate XML and XPath expression evaluation operations and the result (success or not) and number of errors found in the last operation.

The Edit Status Pane

Indicates whether or not the document has been modified since the last save.

Message Panel

The Message panel, located across the bottom half of the Tree View Window, displays messages returned from the following operations:

Figure 3.36. The Message Panel

The Message Panel

To distinguish between result types, each functions result-list is displayed in a separate tab within the panel.

To change focus between the result-lists, just select the tab required. To close a tab, or all tabs, right-click the tab to display a menu and select an option.

Table 3.30. Message Panel Tab Menu

  • Close Results Tab: Closes the selected Results Tab.

  • Close all Tabs: Closes all open tabs within the panel.

In all instances, each record within a result-list is linked to the document location where the indicated error or character string will be found. Selecting a result list record moves the Editor selection to the object in question.

In addition to this time saving feature, the Message panel menu enables several operations to be performed on single or multiple selected records. The Message panel menu is displayed by selecting a record, then right-clicking.

Table 3.31. The Message Panel Menu

  • Edit->Copy (Ctrl+C): Places a duplicate copy of the current selection in the clipboard.

  • Edit->Select All (Ctrl+A): Selects the entire content of the message panel.

  • File->Print (Ctrl+P): Displays the Page Setup dialog used to define the page size and orientation properties for printing.

  • File->Save Results (Ctrl+R): Displays the Save Results dialog, used to save the result-list of the, currently in focus, message tab.

  • Close Results Tab: Closes the selected Results Tab.

  • Close all Tabs: Closes all open tabs within the panel.

Validate XML

The "Validate XML " function use the tab instance named "errors" to display results. Each time this function is executed the result-list is populated with new results.

XPath Messages

When working with XPath expressions, Oxygen outputs errors and node results to the message panel.

Information Panel

Oxygen XML Editor provides a handy information panel that shows the detailed information about the attribute or element that you are working on.

Table 3.32. Elements Information

  • Elements: Indicates the name of the element.

  • Model: Indicates the list of elements which the selected element may contains, as it is specified in the DTD, XML Schema or Relax NG schema.

  • Facets: Indicates all the facets applied to the element.

  • Attributes: Indicates the list of attributes which the selected element may contain, as it is specified in the DTD, XML Schema or Relax NG schema.

Table 3.33. Attributes Information

  • Attributes: Indicates the name of the attribute.

  • Model: Indicates the type of the selected attribute, as it is specified in the DTD or XML Schema.

  • Facets: Indicates all the facets applied to the element.

  • Value: Indicates the list of possible values which the selected attribute may contain, as it is specified in the DTD or XML Schema.

  • Default: Indicates the default value of the attribute.

  • Required: Indicates if the selected attribute is required.

Entities Panel

The Entities Panel presents a list of defined entities that you can insert within your document.

Table 3.34. Entities Panel

  • After: Allows you to insert the selected entity into your document after the current node as next sibling.

  • First: Allows you to insert the selected entity into your document as first child of the current element.

  • Last: Allows you to insert the selected entity into your document as the last child of the current element.

All Elements Panel

The All Elements Panel presents a list of all defined elements that you can insert within your document.

Table 3.35. All Elements Panel

  • After: Allows you to insert the selected element into your document after the current element as next sibling.

  • First: Allows you to insert the selected element into your document as first child of the current element.

  • Last: Allows you to insert the selected element into your document as the last child of the current element.