<oXygen/> XML Editor User Guide |
Once <oXygen/> is installed you can use the following preferences to customize <oXygen/> for your requirements and network environment.
When enabled, checks the availability of new <oXygen/> versions at http://www.oxygenxml.com.
<oXygen/> supports a number of languages for localization of the GUI. Select
-> -> + droplist to display the language choices.Use this option to change graphic style (look and feel) of the GUI.
This option defines the default encoding to be used when opening non XML documents.
This option defines how to handle the BOM (Byte Order Mark) on document save.
The available options are:
Don't Write - Don't write the BOM bytes, the loaded BOM bytes are ignored;
Write - Write the BOM bytes accordingly with chosen encoding;
Keep - If the loaded document has BOM then write them accordingly with chosen encoding. This is the default option.
This option defines line separator to be used.System Default choice sets the line separator from the platform.
The path to a web browser executable. The browser is used to open XSLT or PDF transformation results, to open the <oXygen/> homepage or to point to specific paragraphs in the W3C recommendation of XML Schema on the W3C website in case of validation errors.
When enabled, <oXygen/> will open the last edited files from project at start-up.
If checked, it notifies the user thru a beep that an action has ended. It will notify the user only at the end of validate, wellformed and transform actions.
Use these options to configure the visual aspect, formatting parameters, and behaviour of the content assistant.
Use this option to select the font family and size used to display text in the editor.
Use this option to set the background color of the editor.
Use this option to set the background color of the editor.
Use this option to set the text color of selected text.
Use this option to set the background color of selected text.
Use this option to set the highlight color for the line on which the caret is situated.
When checked the editor will use the font from the GUI.
This option indicates whether text strings should be drawn with antialiased rendering.
This option will automatically wrap lines in edited documents.
Marks the EOL/EOF using small icons, for a better visualisation of the document.
This option enables the line numbers column located in the left part of the editing space. When unchecked, line numbers option is disabled.
This options enables the display of the document folding bar.
This option enables highlight for the tag matching the one on which the caret is situated.
Enables highlight for the current line.
The editor tries to detect the indent settings of the opened XML document. In this way you can correctly format (pretty-print) files that were created with different settings, without changing your options. More than that you can activate the advanced option for detecting the maximum line width to be used for formatting and hard wrap. These features were designed to minimize the differences created by the pretty print operation when working with a versioning system, like CVS for example.
When checked enables 'Indent with tabs' to sets the indent to a tab unit. When unchecked, 'Indent with tabs' is disabled and the indent will measure as many spaces as defined by the 'Indent size' option.
Sets the number of spaces or the tab size that will equal a single indent. The Indent can be spaces or a tab, select the preference using the Indent With Tabs option. If set to 4 one tab will equal 4 white spaces or 1 tab with size of 4 characters depending on which option was set in the Indent With Tabs option.
Indent paste text coresponding to the indent settings set by the user. This is useful for keeping the indent style of text copied from other document.
This feature saves time when writing a reach text XML document. You can set a limit for the length of the lines in your document. When this limit is exceeded the editor will insert a new line before the word that breaks the limit, and indent the next line. This will minimize the need of reformatting the document.
If checked, it inserts a new indented line between start and end tag.
When checked, the Format and indent the document on open operation will format and indent the document before open
When checked the Format and Indent operation will output empty elements with a separate closing tag, ex. <a atr1="v1"></a>. When not checked the same operation will represent an empty element in a more compact form: <a atr1="v1"/>
When checked the Format and Indent operation will add a space before the closing slash of a closing tag.
When checked the Format and Indent operation will sort the attributes of an element alphabetically. When not checked the same operation will leave them in the same order as before applying the operation.
If checked, the "Format and Indent" (Pretty-Print) function will break the line before the attribute's name.
If checked, the "Format and Indent" (Pretty-Print) function will break long attributes.
If checked, it detects the line width automatically when the document is opened.
If checked, automatic tags indentation while editing will take place for all elements including the ones that are excluded from Pretty Print (default behaviour). When unchecked, indentation while editing will not take place in elements that have the 'xml:space' attribute set on 'preserve' or are in the list of Preserve Space Elements.
Defines the point at which the "Format and Indent" (Pretty-Print) function will perform line wrapping. So if set to 100 Pretty-Print will wrap lines at the 100th space inclusive of white spaces, tags and elements.
This list contains the names of the elements for which the contained white spaces like blanks, tabs and newlines are preserved by the Format and Indent operation exactly as before applying the operation.
This list contains the names of the elements for which contiguous white spaces like blanks, tabs and newlines are merged by the Format and Indent operation into one blank.
If checked, a backup copy is made when saving the edited document.
Automatic save is a useful feature that ensures your work is being saved in the background. You can specify the time intervals between automatic saves. If checked it enables Automatic Save. When unchecked, Automatic Save is disabled.
Selects the period in minutes for Auto Save intervals.
Save all opened files before validating or transforming an XML document. In this way the dependencies are resolved, for example when modifying both the XML document and its XML Schema.
If checked, a checking for errors is done when saving the edited document.
Code templates are small document fragments that can be reused
in other editing sessions. We have defined a large set of ready-to use
templates for XSL and XML Schema stored in a file named
code_templates.xml
located in the <oXygen/>
Preferences folder (subfolder com.oxygenxml
of the user home directory). So you can even share
the templates from this file with your colleagues using the import function.
To obtain the template list you have use the Tag-Insight on request shortcut
key (usually CTRL-SPACE).
Define a new code template.
Edit the selected code template.
Delete the selected code template.
Import a file with code templates.
Export a file with code templates.
If checked, the undo action has no effect after you've saved your document. You can only undo the modifications made after you've saved it.
If checked, the undo buffer is cleared. The undo action can now only undo the Format and Indent action
The Tag-Insight feature enables inline syntax lookup and Auto Completion of mark-up elements and attributes to streamline mark-up and reduce errors while editing.
These settings define the operating mode of the content assistant.
This option enables Tag-Insight feature. When unchecked, all Tag-Insight features are disabled.
When it is checked the search in the content completion window when you type a character is case sensitive ('a' and 'A' are different characters).
When inserting elements from the Tag-Insight assistant, both start and end tags are inserted.
When checked, <oXygen/> will insert automatically the required elements from the DTD or XML Schema.
When checked, <oXygen/> will insert automatically the optional elements from the DTD or XML Schema.
When checked, <oXygen/> will insert automatically the first Choice particle from the DTD or XML Schema.
When checked, <oXygen/> will insert automatically the required attributes from the DTD or XML Schema for an element inserted with the help of the Tag-Insight assistant.
When checked, <oXygen/> will insert automatically any FIXED attributes from the DTD or XML Schema for an element inserted with the help of the Tag-Insight assistant.
When checked, <oXygen/> will display a list with all the internal and external entities declared in the current document when the user types the start character of an entity reference (i.e. &).
When checked, <oXygen/>, will set the cursor automatically between tags. Even if the auto-inserted elements have attributes that are not required, the position of cursor can be forced between tags.
When checked, <oXygen/>, will display the annotations that are present in the used schema for the current element, attribute or attribute value.
If checked, it shows the annotations of that element as tooltip.
When checked, <oXygen/> will use all DTD comments as annotation.
When checked, <oXygen/> will display a list with all attributes values learned from the current document.
When checked, <oXygen/> will automatically learn the document structure when the document is opened.
When no schema is specified in the edited document, <oXygen/> will try to use one of the default association rules set. It will try to use the association rules in the order presented in the Tag Insight / Default pane.
Specifies the namespace of the root element from the association rules set (any by default).
Specifies the local name of the root element (any by default).
Specifies the name of the file (any by default).
Specifies the type of schema to be used in the association rules for the document.
Specifies the location from where to load the
schema to be used in the current association rule. The macro
${frameworks} can be used and it will be expanded to the path of
the subdirectory frameworks
of the
<oXygen/> installation directory.
Opens a new dialog allowing you to specify a new association rule.
Opens a new dialog allowing you to edit an existing association rule.
Deletes one of the existing association rule.
Moves the selected association rule one level up (the order is important because the first schema mapping in the list that can be associated with the document will be associated.
Moves the selected association rule one level down.
These settings define what elements are suggested by the content assistant in addition to the XSL ones.
The Tag-Insight will offer only the XSL information.
Includes XHTML Transitional elements as substitutes for xsl:element.
Includes Formating Objects elements as substitutes for xsl:element.
Includes elements from a DTD file or a XML Schema file specified from a URL as substitutes for xsl:element.
If operation is slow for very large schemas disabling the schema diagram view will improve the speed of navigation through the edited schema.
If this option is disabled the schema diagram for XML Schemas will not be generated and displayed.
If this option is disabled the schema diagram for Relax NG schemas will not be generated and displayed.
When using catalogs it is sometimes useful to see what catalog files are parsed, if they are valid or not, and what identifiers are resolved by the catalogs. The Verbosity option is used to control the output of such messages. By default it is not selected.
If the Use default catalog option is checked the first XML catalog which <oXygen/> will use to resolve system IDs at document validation and URI references at document transformation will be a default built-in catalog which maps such references to the built-in local copies of the DocBook and TEI frameworks and the schemas for XHTML, SVG and JSP documents.
The Prefer option is used to specify if <oXygen/> will try to resolve first the PUBLIC or SYSTEM reference using the specified XML catalogs. If a PUBLIC reference is not mapped in any of the catalogs then a SYSTEM reference is looked up.
When you add/delete an XML catalog to/from the list you must restart the application so that the changes take effect.
Limit the number of errors reported at validation or well-formed check. Use this option when the total number of errors is big and the time of displaying is too large.
http://apache.org/xml/features/validation/schema - This option sets the 'schema' feature to true.
http://apache.org/xml/features/validation/schema-full-checking - This option sets the 'schema-full-checking' feature to true.
http://apache.org/xml/features/validation/honour-all-schema-location - This option sets the 'honour-all-schema-location' feature to true. This means all the schemas that are imported for a specific namespace are used to compose the validation model. If this is false, only the first schema import is taken into account.
This option forces validation against a referred XML Schema even if the document includes a DTD declaration.
Enable XInclude processing - if checked the XInclude support in <oXygen/> is turned on.
[Xerces XML Parser documentation:] According to the specification for XInclude, processors must add an xml:base attribute to elements included from locations with a different base URI. Without these attributes, the resulting infoset information would be incorrect.
Unfortunately, these attributes make XInclude processing not transparent to Schema validation.
One solution to this is to modify your schema to allow xml:base attributes to appear on elements that might be included from different base URIs.
If the addition of xml:base and/or xml:lang is undesired by your application, you can disable base URI fixup.
[Xerces XML Parser documentation:]The processor will preserve language information on a top-level included element by adding an xml:lang attribute if its include parent has a different [language] property.
If the addition of xml:lang is undesired by your application, you can disable the Language fixup.
Checks the ID/IDREF matches when the Relax NG document is validated.
Checks the Relax NG to be feasibly valid when this document is validated.
If you want to use an XSLT transformer different than the ones that ship with <oXygen/> namely Apache Xalan and Saxon all you have to do is to specify the name of the transformer's factory class which <oXygen/> will set as the value of the Java property "javax.xml.transform.TransformerFactory". To perform an XSLT transformation with Saxon 7 for instance you have to place the Saxon 7 jar file in the <oXygen/> libraries directory (the lib subdirectory of the installation directory), set "net.sf.saxon.TransformerFactoryImpl" as the property value and select JAXP as the XSLT processor in the transformation scenario associated to the transformed XML document.
Allows the user to enter the name of the transformer factory Java class.
Allows the user to set the XSLT Engine used for validation of XSL 1.0 documents.
Allows the user to set the XSLT Engine used for validation of XSL 2.0 documents.
This section explains the settings available for Debugger mode. To display settings select Debugger Options (see Figure 13.15, “Debugger Settings”).
-> -> +The following settings are available:
Enable or disable rendering of output to the XHTML Output document View during the transformation process. For performance issues, it is advisable to disable XHTML output for large jobs. Also, the XHTML area is only able to render XHTML documents. In order to view the output result of other formats, such as HTML, save the Text output area to a file and use the required external browser for viewing.
Set this option to receive notifications when an infinite loop occurs during transformation.
How many templates (<xsl:templates>
) instructions can appear on the current
stack. This setting is used by the infinite loop detection.
This section explains the settings available for XSLT Profiler mode. To display settings select Profiler Options (see Figure 13.15, “Debugger Settings”).
-> -> +The following settings are available:
Show the total time that was spent in the node.
Show the inherent time that was spent in the node.
Show how many times the node was called in this particular call sequence.
The time scale options determine the unit of time measurement, which may be milliseconds (ms) or microseconds (µs).
The threshold below which hot spots are ignored is entered in milliseconds (ms).
The threshold below which invocations are ignored is entered in microseconds (µs).
The percentage base determines against what time span percentages are calculated.
Absolute: Percentage values show the contribution to the total time.
Relative: Percentage values show the contribution to the calling node.
Besides the built-in formatting objects processor (Apache FOP) the user can use other external processors. <oXygen/> has implemented an easy way to add RenderX XEP as external FO processor if the user has the XEP installed.
When checked all FOP output will be displayed in a results pane at the bottom of the editor window including warning messages about FO instructions not supported by FOP.
If your FOP transformations fail with an "Out of Memory" error select from this combo box a larger value for the amount of memory reserved for FOP transformations.
You should specify here the path to a FOP configuration file, necessary for example to render to PDF using a special true type font a document containing Unicode content.
The users can configure the external processors for use with <oXygen/> in the following dialog.
The name that will be displayed in the list of available FOP processors on the FOP tab of the Transforming Configuration dialog.
The description of the FO processor displayed in the Preferences->FO Processors option.
The directory in which the intermediate and final results of the processing will be stored. Here you can use one of the following macros:
The path to user home directory.
The path of current file directory.
The project directory.
The command line that will start the FO processor, specific to each processor. Here you can use one of the following macros:
The FOP transformation method (pdf, ps, txt).
The input FO file.
The output file.
If checked <oXygen/> will evaluate XPath expresion over XSLT documents, otherwise the XPath expresion is applied on the XML document selected in the eventual transformation scenario associated with the XSLT document.
Associates prefixes to namespaces. These mappings are useful when applying an XPath in XPath console and you don't have to define these mappings for each document separatelly.
The New button creates an editable prefix-namespace mapping.
The Delete button deletes the selected mapping.
Allows you to select the XSLT Procesor to validate the XQuery
Here it is configured how empty values and null values are handled when they are encountered in an import operation.
If this option is enabled an empty value from a database column will be imported as an empty element.
If this option is enabled a null value from a database column will be imported as an empty element.
Here you can configure the JDBC Drivers for the Import from Database action.
Opens the JDBC Drivers dialog, allowing you to configure a new driver that will appear in in the list from "Select database table" dialog.
Provide the name for the JDBC Driver
Provide the URL for the JDBC Driver
Provide the Driver Class for the JDBC Driver
Adds the JDBC driver class library.
Removes driver class library from the list.
Detects JDBC driver candidates.
Stops the detection of the JDBC driver candidates.
Opens the JDBC Drivers dialog, allowing you to edit the selected driver. See above the specifications for the JDBC Drivers dialog.
Deletes the selected JDBC Driver.
<oXygen/> offers both directory and file comparison, six different diff algorithms to choose from for file comparison and multiple levels of comparison.
The complete diff solution includes two XML diff algorithms (XML Fast and XML Accurate), one Syntax Aware algorithm that gives very good results on all file types known by <oXygen/> and three all-purpose algorithms: line based, word based and characted based. Any algorithm can be used to perform differences on request, but <oXygen/> offers also an automatic selection of the algorithm, selecting the most appropriate one based on the files' content and size.
Select from the list the algorithm that will be used as default when you open the Compare files dialog
Auto makes an automatic selection of the diff algorithm, based on the files' content and size.
Characters computes the differences at character level.
Words computes the differences at word level..
Lines computes the differences at line level.
Syntax aware : for the file types known by <oXygen/>, this algorithm computes the differences taking into consideration the syntax of the documents.
XML Fast is designed for XML documents. It works better than XML Accurate on large files, but it is less precise.
XML Accurate is designed for XML documents. It works best on smaller XML files and it is most precise.
![]() | Note |
---|---|
XML Fast and XML Accurate work for XML documents. If you'll try to use them for other types of files, you'll be prompted with the message "content not allowed in prolog" |
This option, if checked, allows the diff algorithm to ignore the whitespaces.
This set of options allows you to specify the types of differences that will be ignored in the XML Fast and XML Accurate algorithms:
Processing instructions
Comments
CDATA
DOCTYPE
Text
in namespaces / prefixes
in the attributes order
If checked, it considers adjacent differences as one and they are presented in this way in the side-by-side editors. If unchecked, every difference is represented separately.
If checked, end tags of modified elements are presented as differences.
If checked, empty elements in both expansion states are considered matched.
This option allows you to specify the maximum number of differences between your documents that you might be interested to see. If the number of differences is larger than the one specified here, you'll be notified by the message "Too many differences".
For the directories comparison you can specify the criterion for the component files comparison and a default file filter.
Content
Timestamp (last modified date/time)
specifies the default type of files that will be compared in Diff Directories
<oXygen/> provides the ability to add plugins that extend the functionality of the application. The plugins are shipped as separate packages; check for new plugins on <oXygen/> site: http://www.oxygenxml.com.
One plugin consists of a separate sub-folder in the Plugins folder in the <oXygen/> installation folder. This sub-folder must contain a valid plugin.xml in accordance with the plugin.dtd file from the Plugins folder.
<oXygen/> automatically detects and loads plugins correctly installed in the Plugins folder and displays them in the Plugin option from the Preferences dialog.
A short description of the plugin can be obtained with a click on the plugin name.
The user can run within <oXygen/> other tools as if from the command line of the operating system shell. The configuration of such a tool is done in the following dialog.
The name of the menu entry corresponding to this tool that will be displayed in the External Tools menu and in the external tools combo box on the toolbar.
The description of the tool displayed in the Preferences->External Tools option.
The keyboard shortcut that launches the external tool.
The directory the external tool will use to store intermediate and final results. Here you can use one of the following macros:
The path to user home directory.
The path of current file directory.
The project directory.
The command line that will start the external tool. Here you can use one of the following macros:
The path to the current Debugger source selection.
The path to the current Debugger stylesheet selection.
The path to user home directory.
The current file name without extension.
The path of the currently edited file.
The path of current file directory.
Transformation result file.
The project directory.
The user can configure in one place all the keyboard shortcuts of the menu items available in <oXygen/>. The current shortcuts assigned to menu items are displayed in the following table.
A short description of the menu item operation.
The shortcuts are classified in categories for easier management. For example the "Cut" operation for the source view is distinguished from the tree view one by assigning it to a separate category.
The keyboard shortcut that launches the operation. Double-clicking on a table row or pressing the "Edit" button allows the user to register a new shortcut for the operation displayed on that row.
<oXygen/> offers support for a wide variety of file types, but users are free to add new file types specified by extension and associate them with the editor type which fits better.
The new file types.
The type of editor which the extensions will be associated with. Some editors provide easy access to frequent operations via toolbars (e.g. XML editor, XSL editor, DTD editor) while other provide just a syntax highlight scheme (e.g. Java editor, SQL editor, Shell editor, etc.)
Some networks use Proxy servers to provide Internet Services to LAN Clients. Clients behind the Proxy may therefore, only connect to the Internet via the Proxy Service. The Proxy Configuration dialog enables this configuration. If you are not sure whether your computer is required to use a Proxy server to connect to the Internet or the values required by the Proxy Configuration dialog, please consult your Network Administrator.
Open the Proxy Configuration dialog by selecting
-> -> .Complete the dialog as follows:
When checked enables <oXygen/> to use the specified Proxy Server. When unchecked, Proxy Server is disabled.
The IP address or Fully Qualified Domain Name (FQDN) of the Proxy Server.
The TCP Port Number, normally set to 80 or 8080.
The Name of the user if required. Can be empty.
The Password for authentication. Can be empty.
Specify domains for which no proxy should be used.
When checked enables SOCKS using the specified host and port for the server. When unchecked, SOCKS is disabled.
The SOCKS host you wish to connect to.
The SOCKS port you wish to connect to.
In <oXygen/> there are provided two types of Keystores: Java KeyStore (JKS) and Public-Key Cryptography Standards version 12 (PKCS-12). A keystore file is protected by a password.
Represents the type of keystore to be used.
Represents the location of the file to be imported.
The password which is used to protect the privacy of the stored keys.
The alias to be used to store the key entry (the certificate and /or the private key) inside the keystore.
It is only necessary in case of JKS keystore. It represents the certificate's private key password.
Verifies the entries from the fields; assures that the cerificate is valid.
This option sets the maximum number of lines of the output console where the external tools place their output.
It is sometimes useful to print out the contents of a document on paper. <oXygen/> allows you to adjust the scale of the print output to make it easier to read on a page.
Displays a slide allowing the user to adjust the printing scale between 40% and 100%.
Check if the document should be formatted and indented (pretty-print) on save.
<oXygen/> supports Syntax Highlight for XML, DTD, Relax NG (XML and Compact Syntax), Java, JavaScript, XQuery, C++, C, PHP,CSS, Perl, Properties, SQL, Shell and Batch documents. While <oXygen/> provides a default color configuration for highlighting the tokens, you may choose to customize, as required, using the Colors dialog.
Open the Colors dialog by selecting Options->Preferences->Colors and choose one of the supported Document Types. Each document type contains a set of Tokens. When the Document Type is selected the associated tokens are listed. Selecting a token displays the current color properties and enables you to modify them.
Use Swatch, HSB or RGB models from the Color Dialog to define the color properties.
Modifications are saved when the OK button is clicked. Cancel discards changes. Reset button changes the color to the default value.
Displays a color pallete containing a variety of colors from across the color spectrum and shades thereof. Select a color.
Hue, Saturation and Brightness (HSB) enables you to specify a color by describing it using hue, saturation and brightness.
Red, Green and Blue (RGB) enables you to specify a color using triplets of red, green and blue numbers.
Displays the color properties of the current token and results of customization.