Chapter 3. Getting Started

Table of Contents

Main Window
Main Menu
Main Toolbar
Project Panel
Editor Panel
Message Panel
Tree View Window
Main Menu
Main Toolbar
Tree Editing Toolbar
Editor Panel
Message Panel
Information Panel
Entities Panel
All Elements Panel

This section provides an overview of the oXygen Graphic User Interface (GUI). It provides you with an explanation for each of the interface components and a short description of its purpose or usage. The oXygen interface is splitted in two separate windows, but linked:

Main Window

The oXygen interface uses standard interface conventions and components to provide a familiar and intuitive editing environment across all operating systems.

The main window is central to the work process. In addition to the title bar, which shows the oXygen program icon, name, license information, the main window is comprised of the following main components:

Figure 3.1. The Main Interface

The Main Interface

When two or more main window panels are displayed, oXygen provides divider bars that allow arrangement of screen real-estate. By selecting a divider bar it can be dragged to a new position, so increasing the space occupied for one panel, while decreasing it for the other. Using this method you can optimize the desktop to your workspace requirements.

As majority of the work process centers around the Editor panel, other panels can be hidden from view using the expand and collapse controls located on the divider bars.

Main Menu

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

File Menu

Note

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

Table 3.1.  File Menu Options

  • 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 one or more files.

  • File-> Import HTML (Ctrl+M) : Import HTML files to XML. It results an XHTML file which contains the DOCTYPE declaration and the parsed html content of the imported file.

  • File->Revert: Loads the last saved file content. All unsaved modifications are lost.

  • File->New from Templates: Displays the Templates dialog used to discover, select and open a new document based on an exiting template document. Template documents act as starting points that have predefined properties such as file type, prolog, root element, containers and even existing content.

  • File->Add to Templates: Displays the Add Templates dialog used to define the name by which the template will be recognized in the “New from templates” option.

  • 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 All: Saves all open documents. If any document does not have a file, displays the “Save As” dialog.

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

  • File->New Project: Create a new project in the Project pane.

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

  • File->Save Project (Ctrl+F3 (Cmd+G on Mac)) : Saves the current project. If the project does not have a file, displays the “Save Project As” dialog.

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

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

  • File->Print Results: Displays the Page Setup dialog used to define the page size and orientation properties for printing the result-list of the current message tab.

  • File->Close (Ctrl+W) : Closes only the selected tab. All other tab instances remain.

  • File->Close All: Closes all open documents. If a document is modified or has no file, a prompt to save, not to save, or cancel the save operation is displayed.

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

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

  • File->Exit (Ctrl+Q) : Terminates the oXygen XML Editor. Session information such as the current Project, open Documents and Option settings is made persistent. When the oXygen editor is re-opened, the persistence information returns to the last saved state.

Edit Menu

Table 3.2.  Edit Menu Options

  • 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.

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

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

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

  • Edit->Select All (Ctrl+A) : Selects the entire body of the current document, including whitespace preceding the first and following the last character.

  • Edit->Check Spelling (F4) : Checks the spelling in your document.

Find Menu

Table 3.3.  Find Menu Options

  • Find->Find/Replace... (Ctrl+F) : Displays the Find/Replace dialog, used to define “search for” or “search for and replace” operations on the current document.

  • Find->Search/Replace in Files... (Ctrl+F) : Displays the Search/Replace in Files dialog, used to define “search for” or “search for and replace” operations across a number of files.

  • Find->Go to Line (Ctrl+G (Cmd+L on Mac)) : Displays the Go to Line dialog used to move the cursor directly to the line number specified.

  • Find->Search again (F3) : Performs another search using the last search configuration.

Tree View Menu

Table 3.4.  Tree View Menu Options

  • Show Tree View: This option opens the Tree View window.

Options Menu

Table 3.5.  Options Menu Options

  • Preferences: Includes all configuration options necessary to customize oXygen for your requirements and network environment.

  • Check for New Versions: Forces the version checking function to query the oxygen Web Site for new versions.

  • Integrate into Explorer Shell : Available for Windows Operating Systems only, enables MIME association of file types with the oXygen XML Editor.

  • Reset Options: Reverts all custom user settings within oXygen to the installation defaults.

Plugins Menu

Table 3.6.  Plugins Menu Options

Contains the list of the general type plugins detected in the Plugins sub-directory of the installation folder. If there are no general plugins configured the menu will not be displayed.

External Tools Menu

Table 3.7.  External Tools Menu Options

Contains the Preferences for the External Tools and the list of the external tools configured in the Preferences->External Tools option.

Window Menu

Table 3.8.  Window Menu Options

  • Window-> Next (Ctrl+K): Traverses the Editor focus across the list of open documents from left to right.

  • Window-> Previous (Ctrl+J): Traverses Editor focus across the list of open documents from right to left.

  • Open Files List: Displays a list of documents currently open in the Editor panel.

XML Menu

Table 3.9.  XML Menu Options

  • XML->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 or XML Schema rules.

  • XML->Check XML Form (Ctrl+Shift+W): Executes the XML Form check operation on the current document using a non-validating parser. Returns an error result-list in the Message panel.

  • XML->Relax NG Validation: Displays the RELAX NG Validation dialog, used to select the Relax NG schema and to execute the Validation operation on the current document using the selected Relax NG Schema. Returns an error result-list in the Message panel. Mark-up of current document is checked to conform with the specified RNG Schema rules.

  • XML->Apply Transformation (Ctrl+Shift+T): Executes the transformation process using the configuration properties defined in the Configure Transformation dialog.

  • XML->Configure Transformation (Ctrl+Shift+C): Displays the Configure Transformation dialog, used to define properties for conversion of documents to multiple output targets. Also enables saving of “Scenario's”. Each scenario, can store a unique configuration ready to be used in the future.

  • XML->Format and Indent (Ctrl+Shift+P): Also referred to as “Pretty Print”, “Format and Indent” performs layout functions to make mark-up easier to read on screen and in print output.

  • XML->Learn Structure (Ctrl+Shift+L): Reads the mark-up structure of the current document so that it can be saved as a template using the Save Structure option.

  • XML->Save Structure (Ctrl+Shift+S): Displays the Save Structure dialog, used to name and create DTD documents learnt by the “Learn Structure” function.

  • Lock/Unlock XML Tags: When in “Lock” mode tags cannot be edited. Unlock to enable tag editing.

Help Menu

Table 3.10.  Help Menu Options

  • Help->Help (F1): Opens the oXygen XML Editor Online Help System.

  • About: Displays the About dialog, which provides information about the oXygen version number and license status.

  • Buy Now: Displays the oXygen e-Store Web page using the default Web Browser. The oXygen e-Store provides information about licensing costs and provides facilities for secure online transactions.

  • Tip of the day: Randomly selects an oXygen productivity tip and displays it in the Tip of the Day dialog.

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.2. The Main Toolbar Buttons

The Main Toolbar Buttons

Table 3.11. 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 one or more files.

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

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.

Save All: Saves all open documents. If any document does not have a file, displays the “Save As” dialog.

New from Templates: Displays the Templates dialog used to discover, select and open a new document based on an exiting template document. Template documents act as starting points that have predefined properties such as file type, prolog, root element, containers and even exiting content.

Add to Templates: Displays the Add Templates dialog used to define the name by which the template will be recognized in the “New from templates” option.

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.

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

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

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

Edit->Check Spelling (F4): Checks the spelling of the current document.

Find->Find/Replace (Ctrl+F): Displays the Find/Replace dialog, used define “search for” or “search for and replace” operations on the current document.

Search Replace in Files: Displays the Search/Replace in Files dialog, used to define “search for” or “search for and replace” operations across a number of files.

Tree Editor->Show Tree View (Ctrl+T): Displays the Tree View window.

 

External Tools: Displays the available External Tools.

Project Panel

The Project panel, located on the left-hand side of the Main window, enables the definition of projects and logical management of the documents it contains.

Table 3.12. Description of Project Panel

The Project Panel is comprised of:

Project Toolbar

The Project toolbar, located on the top of the Project panel, provides easy access to oXygen project functions. Each icon is a button that acts as a short-cut to a related function. Hold your 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.3. The Project Toolbar

The Project Toolbar

Table 3.13. Description of Project Toolbar Buttons

New Project: Create a new project in the Project pane.

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

File->Save Project (Ctrl+F3): Saves the current project. If the project does not have a file, displays the “Save Project As” dialog.

Show/Hide Path Option: Toggles the file path ON and OFF for all files displayed in the Project View.

New Folder: Displays the New Folder dialog, used to specify the name of a folder about to be created under the existing and selected Project or Folder in the Project View.

Delete Folder: Removes the selected folder its contents from the Project View.

Add File : Includes the current document into the selected folder in the Project View.

Project View

The Project view provides a method for logical management and visualization of files associated with a project. Once a project is open, saved files can be added to, or removed from, the project. Either while open in the Editor Panel or directly from a local or remote file system.

Table 3.14. Description of Project View

To help organize files, virtual folders can be created. Virtual folders only exist within the project file, providing a logical method for visual organization. In addition to internal creation of Virtual Folders, you can also import system folders and their contents from local or remote file systems. The result is a tree-view that promotes navigation and easy file management within the project, regardless of the files physical location.

All folders, whether created internally or imported, have no physical connection with a local or remote file system. i.e. If you add, delete or rename a Project folder those operations are only performed in the oXygen project file. The same principle is applicable to files, with the exception that the representation of a file in the Project View does maintain a backward link to the physical file. i.e. Actions such as “Remove”, only removes the file from the current project file, it does not delete the file from the file system. Double-clicking a file is equivalent to File-> Open (Ctrl+O) .

The full path to file is hidden by default. Click the Show/Hide Path button to toggle the file path on or off.

The default target when adding files to a project is the project root. Selecting a folder changes the target to the selected folder. Files may have multiple instances, within the folder system but cannot appear twice within the same folder.

Right-clicking any object in the tree-view displays the Project menu with functions that can be performed on, or from the selected object. Options available from the Project menu are specific to the object type selected in the tree-view.

Table 3.15. Description of Project Menu

From the Project Object

From the Folder Object

From the File Object

  • New Folder: Displays the New Folder dialog, used to specify the name of a folder about to be created under the existing and selected Project or Folder in the Project View.

  • Rename Folder: Enables modification to the selected project folder name.

  • Delete Folder: Removes the selected folder its contents from the Project View.

  • Add Files : Displays the Add File dialog, used to discover and select files to include in the Project View.

  • Add File : Includes the current document into the selected folder in the Project View.

  • Import Folder: Displays the Import Folder dialog, used to add folders and their contents to the Project View.

  • Open all Files: Opens all files associated with the current project. If a file appears twice, only the first instance is opened.

  • Open: Opens the selected file.

  • Remove File: Removes the selected file from the Project View.

Editor Panel

The Editor panel is were you spend most your time, reading, editing, applying markup and checking the validity and form of your documents.

The Editor panel is comprised of:

Figure 3.4. The Editor Panel

The Editor Panel

Editor Document Tabs

The oXygen editor uses the tabbed page mode to display open documents. The document tab is located above the Editor Toolbar and shows the file type, file name and its edit status.

Figure 3.5. The Editor Document Tabs

The Editor Document Tabs

Modified files are denoted with an “*”, saving the document removes this status until the next edit operation.

Each open document has an associated tab displaying this information. To distinguish which document is currently under edit, the active document is highlighted and brought to the foreground. Inactive document tabs are shadowed in the background. Selecting a tab changes the document focus to display its contents for editing. Hovering the pointer over a tab displays the files full path in a tool tip.

Right-click on any tab to display the Document Tab menu.

Document Tab Menu

  • Close: Closes only the selected tab. All other tab instances remain.

  • Close All: Closes all open documents. If a document is modified or has no file, a prompt to save, not to save, or cancel the save operation is displayed.

Document File Types

The file type is denoted by an icon preceding the filename. While this information can be obtained from the file extension, visual identification of style types is improved using a color legend that correlates to the Project View icons:

RED

XML Documents

DARK PURPLE

DTD Documents

LIGHT PURPLE

XSD Documents

GREEN

XSL Documents

WHITE

TXT Documents

Editor Toolbar

The Editor toolbar, located below the Document Tabs, provides easy access to oXygen editing functions. Each icon is a button that acts as a shortcut to a related function. Hold your 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.6. The Editor Toolbar Buttons

The Editor Toolbar Buttons

Table 3.16. Description of Editor Toolbar Buttons

XML->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 or XML Schema rules.

XML->Check XML Form (Ctrl+Shift+W): Executes the XML Form check operation on the current document using a non-validating parser. Returns an error result-list in the Message panel.

XML->Relax NG Validation: Displays the RELAX NG Validation dialog, used to select the Relax NG schema and to execute the Validation operation on the current document using the selected Relax NG Schema. Returns an error result-list in the Message panel. Mark-up of current document is checked to conform with the specified RNG Schema rules.

XML->Apply Transformation (Ctrl+Shift+T): Executes the transformation process using the configuration properties defined in the Configure Transformation dialog.

XML->Configure Transformation (Ctrl+Shift+C): Displays the Configure Transformation dialog, used to define properties for conversion of documents to multiple output targets. Also enables saving of “Scenario's”. Each scenario, can store a unique configuration ready to be used in the future.

XML->Format and Indent (Ctrl+Shift+P): Also referred to as “Pretty Print”, “Format and Indent” performs layout functions to make mark-up easier to read on screen and in print output.

XML->Learn Structure (Ctrl+Shift+L): Reads the mark-up structure of the current document so that it can be saved as a template using the Save Structure option.

XML->Save Structure (Ctrl+Shift+S): Displays the Save Structure dialog, used to name and create DTD documents learnt by the “Learn Structure” function.

Lock/Unlock XML Tags: When in “Lock” mode tags cannot be edited. Unlock to enable tag editing.

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

Editing Space

The oXygen editor provides a useful set of features that promote easy editing of structure mark-up documents. Features such as automatic syntax highlighting and checking, intelligent Code-Insight, end tag auto completion help improve productivity and reduce errors. Text attributes such as font, formatting, coupled with customizable coloring options for syntax highlighting provide a flexible and powerful structured mark-up editor.

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

Table 3.17. Description of Editor Space Menu

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

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

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

  • Edit->Select All (Ctrl+A): Selects the entire body of the current document, including whitespace preceding the first and following the last character.

  • Edit->Spelling... (F4): Checks the spelling of the current document.

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

  • 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-> Close (Ctrl+W): Closes only the selected tab. All other tab instances remain.

  • Add to Templates: Displays the Add Templates dialog used to define the name by which the template will be recognized in the “New from templates” option.

  • Edit->Open file at cursor: Opens in a new panel the file with the name under the current position of the caret in the current document.

  • Edit->Insert file at cursor: Inserts in a file under the current position of the caret in the current document.

  • Surround in: Displays a sub-menu with mark-up elements arranged in alphabetical order. Selected Text in the editor is marked with start and end tags of the selected element.

  • Surround in <tag>: Selected Text in the editor is marked with start and end tags of the last 'Surround in' action.

  • Plug-ins: Displays a sub-menu with the list of the selection type plugins that can be launched in the context of the document currently edited.

  • Escape Selection: Replaces the <, >, &,", ' symbols with &lt;, &gt;, &amp;, &quot;, &apos;.

Editor Status Bar

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

Figure 3.7. 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, Check XML Form, Apply Transformation, XPath expression evaluation and Format and Indent (Pretty Print) operations and the result (success or not) and number of errors found in the last operation.

The Cursor Coordinates Pane

Displays the current position of the cursor in terms of Line Number: Space Number.

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 Main Window, displays messages returned from the following operations:

Figure 3.8. 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.18. Message Panel Tab Menu

  • Close the Results Tab: Closes the selected Results Tab.

  • Close the Other Tabs: Closes the other tabs except the selected 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 Editors cursor to, and highlights the object in question. If the target document is closed, it will be opened in the Editor panel.

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.19. 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 body of the current document, including whitespace preceding the first and following the last character.

  • 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 and Check XML Parser Errors

The “Validate XML ” and “Check XML Form” functions use the same tab instance named “errors” to display their results. As both functions use the same tab instance, “Validate XML ” and “Check XML Form” result-lists overwrite one another. Each time one of these functions 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.

Transformation Output Messages

During transformation processes, XML, XHTML or FOP, the message panel is used to display, parser errors, warning messages and output of XML or XHTML. Each is displayed in a separate tab. Tab instances for XML/XHTML are created on a per document basis, error and warning tabs are simply repopulated.

Find/Replace Results

The “Find/Replace” function opens a new tab instance for each document on which the function is run. Each tab instance is named “Find all results - <filename.ext>”. Each time that the function is run the result-list in the documents associated tab instance is populated with new results.

Search Replace in files Messages

The “Search/Replace in Files” function uses a single tab instance named “Search_in_files” to display results. It does not share the tabs with any other function, repopulating the same tab instance each time the function is executed.