<oXygen/> XML Editor User Guide

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.24. 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, therefore increasing the space occupied by one panel while decreasing it for the other.

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]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-> Open URL (Ctrl+U) : Displays the Open URL dialog used to discover, select and open one or more files using FTP/WebDAV.

  • File-> Import HTML (Ctrl+M) : Import HTML files to XHTML 1.0 Transitional or Strict. It results an XHTML file which contains a DOCTYPE declaration referring to the XHTML DTD definition on the Web and the parsed content of the imported file as XHTML Transitional or Strict depending on what radio button the user chose when performing the import operation.

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

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

  • File->New from Templates : Displays the Templates dialog used to discover, select and open a new document based on an existing 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 existing 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 saves an existing file with a new name, using FTP/WebDAV.

  • 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-> Properties : Display file properties like the schema file used for Tag-Insight, the file encoding and the indent properties.

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

  • File->Close All: Closes all opened 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 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. Complex operations like "Replace All", "Indent selection", etc are now treated as a single undo event.

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

  • Edit->Bookmarks : Placing bookmarks and quickly accessing bookmarked positions in edited documents.

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. The replace operation can bind Perl 5-like regexp group variables ($1, $2, etc.) from the find match.

  • 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. The replace operation can bind Perl 5-like regexp group variables ($1, $2, etc.) from the search match.

  • Find->Go to Line (Ctrl+L (Cmd+L on Mac)) : Displays the Go to dialog used to move the cursor directly to a precise position in the current document specified by line and column or by offset relative to beginning of document.

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

Perspective Menu

Table 3.4. Perspective Menu Options

  • Tree Editor... (Ctrl+T) : This option opens the Tree View window.

  • Debugger : This option opens the Debugger perspective.

  • Editor : This option opens the Editor perspective.

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 : Uses the version checker to query the <oXygen/> Web Site for new versions.

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

  • Import transformation scenario : Load a properties file with scenarios.

  • Export tansformation scenario : Store all the scenarios in a separate file , a properties file.

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.

Tools Menu

Table 3.7. Tools Menu Options

  • Trang Converter... (Ctrl+Alt+T) : Converts the current document to a supported grammar language using the integrated Trang converter.

  • Schema documentation... (Ctrl+Alt+S) : A tool used to generate HTML documentation for an XML Schema document.

  • SVG Viewer : Contains a viewer for Scalable Vector Graphics file types.

  • WSDL SOAP Analyser : Contains a SOAP analyser and sender for Web Services Description Language file types.

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

Debugger Menu

Table 3.8. Debugger Menu Options

  • Debugger : This option opens the Debugger perspective.

  • Debugger actions : The descriptions of the debugger actions can be found in Control Toolbar section.

Document Menu

Table 3.9. Document Menu Options

  • Document+File->Insert file...: Inserts in a file under the current position of the caret in the current document.

  • Document+File->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.

  • Document+File->Open in system application : Open edited file with default application associated on current machine.

  • Document+Find->Find all: Find all occurences of current selection in current document.

  • Document+Folding->Toggle fold: Toggle document folding.

  • Document+Folding->Collapse child folds (Ctrl+NumPad+-): Fold the sections indented with one level inside the current element.

  • Document+Folding->Expand child folds (Ctrl+NumPad++): Unfold the sections indented with one level inside the current element.

  • Document+Folding->Expand all (Ctrl+NumPad+*): Unfold all the sections inside the current element.

  • Document+XML Document->Validate document (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. For validation against Relax NG schemas the XML document must include a processing instructions of the form: <?oxygen RNGSchema="URL-of-schema" type="xml (or compact)">

  • Document+XML Document->Check document 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.

  • Document+XML Document->External Validation : Displays the External Validation dialog, used to select the external schemas(XML, Relax NG, NRL,Schematron schema and to execute the Validation operation on the current document using the selected schemas. Returns an error result-list in the Message panel. Mark-up of current document is checked to conform with the specified schemas rules.

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

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

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

  • Document+XML Document->Open external schema : Open the schema used for validating the current document in a new editor.

  • Document+XML Document->Associate schema... : Open a dialog for selecting a schema used to validate the document. The schema if one of the types: XML Schema, DTD, Relax NG, NRL, Schematron.

  • Document+XML Document->Convert to...: Open a dialog to convert the current document to different schema formats using the Trang converter.

  • Document+XML Document->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.

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

  • Document+XML Document->Lock/Unlock XML Tags : When in "Lock" mode tags cannot be edited. Unlock to enable tag editing.

  • Document+XML Document->Indent selection: Performs layout functions to the current selection to make mark-up easier to read on screen and in print output.

  • Document+XML Document->Uncomment selection : Removes <!-- --> comment brackets from currently selected comment.

  • Document+XML Document->Comment selection: Places <!-- --> comment brackets around current selection or cursor position.

  • Document+XML Document->Go to the matching tag (Ctrl+Shift+G): Moves the cursor to the end tag that matches the start tag, or vice versa.

  • Document+XML Refactoring->Surround in <tag> (Ctrl+/): Selected Text in the editor is marked with start and end tags of the last 'Surround in' action.

  • Document+XML Refactoring->Surround in tag... (Ctrl+E): Selected Text in the editor is marked with the specified start and end tags.

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

  • Document+XML Refactoring->Rename element: The element from the caret position and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog.

  • Document+XML Refactoring->Split element (Ctrl+Alt+D): Split the element from the caret position in two identical elements. The caret must be inside the element

  • Document+XML Refactoring->Join elements (Ctrl+Alt+J): Joins the left and the right elements relative to the current caret position. The elements must have the same name, attributes and attributes values.

  • Document+XML Refactoring->Delete elements tags (Ctrl+Alt+X): Delete the tags of the element that includes the current selection in the document.

  • Document+XML Refactoring->Import entities list : Select a list of files and Import them as external entities.

Window Menu

Table 3.10. Window Menu Options

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

  • Window-> Previous: 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.

Help Menu

Table 3.11. Help Menu Options

  • Help->Help (F1): Opens the <oXygen/> XML Editor Help Window.

  • Help->Browse <oXygen/> web site :Displays the <oXygen/> home page using the default Web Browser. The <oXygen/> e-Store provides information about licensing costs and provides facilities for secure online transactions.

  • Help->Register :Allows the user to enter the license text from the registration mail.

  • Help->Tip of the day: Randomly selects an <oXygen/> productivity tip and displays it in the Tip of the Day dialog.

  • Help->About : Displays the About dialog, which provides information about the <oXygen/> version number and license status.

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 shortcut to a related function. Hold the pointer/cursor over an icon to display a context label that will give you a hint about its functionality. Click an icon to use its function.

Figure 3.25. The Main Toolbar Buttons

The Main Toolbar Buttons

Table 3.12. 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-> 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 To URL : Displays the Save URL dialog, used to name and save an open document to a file; or save an existing file with a new name, using FTP/WebDAV.

File->New from Templates :Displays the Templates dialog used to discover, select and open a new document based on an existing 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.

Edit->Undo (Ctrl+Z): Reverses, a maximum of 100, editing actions to return to the preceding state. Complex operations like "Replace All", "Indent selection", etc are now treated as a single undo event.

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

Edit->Bookmarks (F7) -> Quick creation: Places a bookmark at current caret position.

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 : Displays the Search/Replace in Files dialog, used to define "search for" or "search for and replace" operations across a number of files.

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

Perspective->Debugger : Opens the debugger perspective.

Perspective->Editor : Opens the editor perspective.

Transparency Contrast Adjuster->Transparency : Adjusts the contrast of markup in Editor perspective.

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.

The files from the entire project or from a project folder can be validated with a single button click against a schema of type Schematron, XML Schema, Relax NG, NRL, or a combination of the later with Schematron. This together with the logical folder support of the project allows you to group your files and validate them very easily.

If a project folder contains many documents a certain document can be quickly located in the project tree if the user selects with the mouse the folder containing the desired document (or some arbitrary document in this folder) and types the first characters of the document name. The desired document will be automatically selected as soon as the typed characters uniquely identify its name in the folder. Once selected the document can be opened by pressing the ENTER key or by double-clicking on it or it can be deleted by pressing the DELETE key or by choosing "Remove File" from the context menu.

Table 3.13. 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 shortcut to a related function. Hold the pointer over an icon to display a context label that will give you a hint about its functionality. Click an icon to use its function.

Figure 3.26. The Project Toolbar

The Project Toolbar

Table 3.14. Description of Project Toolbar Buttons

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): Saves the current project. If the project does not have a file, displays the "Save Project As" dialog.

Validate all: Validate all project files.

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.

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 opened, saved files can be added to or removed from the project. Either operations can be performed while the file is opened in the Editor Panel directly from a local or remote file system.

Table 3.15. 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 allows 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.

The project menu contains a list of actions that is dependent on the selected item. The description of all available actions follows.

Table 3.16. Description of Project Menu

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

  • Open: Opens the selected file.

  • Open in system application : Opens the selected file with application associated on the system.

  • Copy location: Copy the location of the selected file as a URL.

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

  • Search/Replace in Files : Searches for a string in the project selected files or in the entire project.

  • Open with->SVG Viewer: Open selected document with SVG Viewer.

  • Open with->Schema documentation : Open selected document in the Schema documentation dialog.

  • Open with->Trang converter: Open selected document in the Trang converter dialog.

  • Open with->WSDL SOAP Analyser : Open selected document in the WSDL SOAP Analyser dialog.

  • Validate Selection: Validates the selected file or all the files from the selected folder.

  • Validate selection with... : Validates the selected file or all the files from the selected folder with the specified schemas.

Model View Panel

The Model View panel, located on the left-hand side of the main window, eases the editing effort by presenting the structure of the currently edited tag and additional tag documentation.

The Model View, combined with the powerful Outliner is an useful tool in providing the user with spacial and insight information on the edited document.

Table 3.17. Description of Model View Panel

The Model View Panel is comprised of:

The Element Structure View.

The Element Structure View shows the structure of the current edited or selected tag in a Tree format.

Table 3.18. Description of the Element Structure View

The information includes the name, model and attributes the currently edited tag may have. The allowed attributes are shown along with any restrictions they might possess.

The Annotation View.

The Annotation View shows the annotations that are present in the used schema for the currently edited or selected tag.

Table 3.19. Description of the Annotation View

This information can be very useful to persons learning XML because it has small available definitions for each used tag.

Editor Panel

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

The Editor panel is comprised of:

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.27. 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 file's 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 other files: Closes the other files except the selected tab.

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

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

  • Add all to project: Includes all open documents into the selected folder in the Project View.

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

LIGHT BLUE

DTD Documents

DARK PURPLE

XSD Documents

PURPLE

Relax NG Schema - XML

YELLOW

Relax NG Schema - Compact

YELLOW

NRL Schema

GREEN

XSL Documents

MAROON

WSDL Documents

RED

XQuery Documents

CYAN

Schematron schema 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.28. The Editor Toolbar Buttons

The Editor Toolbar Buttons

Table 3.20. Description of Editor Toolbar Buttons

Document+XML Document->Validate document (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.

Document+XML Document->Check document 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.

Document+XML Document->External Validation: Displays the External Validation dialog, used to select a schema of one of the types XML Schema, Relax NG, NRL and Schematron to execute the validation operation on the current document. The Relax NG schema file can be either in XML syntax or in compact syntax. In case of errors the validation returns an error result-list in the Message panel.

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

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

Document+XML Document->Debug scenario : You can start the debugging and the input file, the processor and parameter settings from the XSLT transformation scenario that is associated to the current edited file are updated into the debugger control panel.

Document+XML Document->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 printed output.

Document+XML Document->Open external schema: Open the schema used for validating the current document.

Document+XML Document->Associate Schema ...: Associates a schema with the current document.

Document+XML Document->Convert to ...: Converts the current document to a supported grammar language using the integrated Trang converter.

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

Document+XML Document->Save Structure (Ctrl+Shift+S): Save the learned document structure to an external dtd file.

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. <oXygen/> can execute expressions according to XPath version 1.0 or 2.0.

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

When moving the mouse pointer over an element or an attribute it is displayed a tooltip containing the documentation defined in the XML Schema or DTD.

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

Table 3.21. 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 copy of the current selection in the clipboard.

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

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

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

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

  • Document->Find All (Ctrl+Shift+F): Finds all occurencies of selected word in current file.

  • Document->Go to the matching tag (Ctrl+Shift+G): Moves the cursor to the end tag that matches the start tag, or vice versa.

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

  • Document->Surround in <tag> (Ctrl+/): Selected Text in the editor is marked with start and end tags of the last 'Surround in' action.

  • Document->Surround in tag... (Ctrl+E): Selected Text in the editor is marked with the specified start and end tags.

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

  • Document->Comment selection: Places <!-- --> comment brackets around current selection or cursor position.

  • Document->Uncomment selection : Removes <!-- --> comment brackets from currently selected comment.

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

  • Document->Indent selection: Performs layout functions to the current selection to make mark-up easier to read on screen and in printed output.

  • Document->Rename element: The element from the caret position and the elements that have the same name as the current element can be renamed according with the options from the Rename dialog.

  • Document->Split element (Ctrl+Alt+D): Split the element from the caret position in two identical elements. The caret must be inside the element

  • Document->Join elements (Ctrl+Alt+J): Joins the left and the right elements relative to the current caret position. The elements must have the same name, attributes and attributes values.

Editor Status Bar

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

Figure 3.29. 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: Column 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.30. 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. To sort the column values, just click on the table column header. The first click will sort the table ascending, the second click will sort descending and the next click will return to unsorted state.

Table 3.22. 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 pressing right-click.

Table 3.23. The Message Panel Menu

  • Edit->Copy (Ctrl+C): Places a 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 selected message tab.

  • Close Results Tab: Closes the selected Results Tab.

  • Close the other Tabs : Closes all the other opened Results Tabs.

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

Validate and Check XML Parser Errors

The "Validate document " and "Check document 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 each 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.

Outliner Panel

The Outliner panel, located in the bottom left part of the main Window has the following available functions:

Figure 3.31. The Outliner Panel

The Outliner Panel

XML Document Overview

The Outliner displays a general tag overview of the current edited XML Document. It also shows the correct hierarchical dependencies between the tag elements, making it easier for the user to be aware of the document's structure and the way tags are nested.

Modification Follow-up

When editing, the Outliner dynamically follows the modifications introduced by the user, showing in the middle of the panel the node which is currently being modified. This gives the user better insight on to where in the document he/she is positioned and how the structure of the document is affected by his/hers modifications.

Document Structure Change

Entire XML elements can be moved or copied in the edited document using only the mouse in the Outliner panel as this panel supports drag-and-drop operations. If you drag an XML element in the Outliner panel and drop it on another one in the same panel then the dragged element will be moved after the drop target element. If you hold the mouse pointer over the drop target for a short time before the drop then the drop element will be expanded first and the dragged element will be moved inside the drop one after its opening tag. If you hold down the CTRL key it will be performed a copy operation instead a move one.

Document Tag Selection

The Outliner can also be used to search for a specific tag's location and contents in the edited document. Intuitively, by selecting with the left mouse button the desired tag in the Outliner Panel, the document is scrolled to the position of the selected tag. Moreover, the tag's contents are selected in the document, making it easy to notice the part of the document contained by that specific tag and furthermore to easily copy and paste the tag's contents in other parts of the document or in other documents.