Table of Contents
Once <oXygen/> is installed you can use the following preferences to customize <oXygen/> for your requirements and network environment.
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.
This option will automatically wrap lines in edited documents. When this option is checked line folding will be disabled.
This option enables highlight for the tag matching the one on which the caret is situated.
If checked, it enables folding when a new editor is opened.
If "Enable folding when opening a new editor" is checked, you can specify the minimum number of lines for folding. If you modify this value, you'll notice the changes when you open/reopen the editor.
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 corresponding 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.
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 selected the <oXygen/> plugin will perform a well-formed check every time the user saves a document.
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.
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 (folder Application Data\com.oxygenxml
on Windows / .com.oxygenxml
on Linux 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.
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.
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.
If the Use tag insight option is not checked and if this option is checked, <oXygen/> will close the last opened tag when </ is typed.
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.
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, a XML Schema file or a RNG 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 local 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 fix-up.
[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 fix-up.
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.
1.0 - Allows XSLT 1.0 expressions for Schematron assertion tests.
2.0 - Allows XSLT 2.0 expressions for Schematron assertion tests.
2.0 - Allows XSLT 2.0 expressions for Schematron assertion tests.
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.
Saxon8 Options
Version warnings: If checked a warning will be output when running an XSLT 2.0 processor against an XSLT 1.0 stylesheet. The XSLT specification requires this to be done by default.
Allow calls on extension functions: If checked external functions called is allowed. Not checking this is recommended in an environment where untrusted stylesheets may be executed. Also disables user-defined extension elements, together with the writing of multiple output files, all of which carry similar security risks.
DTD based validation of the source file: If checked XML source documents are validated against their DTD.
Schema based validation of the source: This determines whether source documents should be parsed with schema-validation enabled.
Lax schema based validation of the source: This determines whether source documents should be parsed with schema-validation enabled.
Validation errors in the result tree treated as warnings: If checked, all validation errors are treated as warnings, otherwise they are treated as fatal.
Line numbering: If checked line numbers are maintained for the source document.
Policy for handling recoverable errors in the stylesheet: Allows the user to choose how dynamic errors will be handled. Either one of the following options can be selected: recover silently, recover with warnings or signal the error and do not attempt recovery.
Saxon6 Options
Line numbering: If checked line numbers are maintained for the source document.
Allow calls on extension functions: If checked external functions called is allowed. Not checking this is recommended in an environment where untrusted stylesheets may be executed. Also disables user-defined extension elements, together with the writing of multiple output files, all of which carry similar security risks.
Policy for handling recoverable errors in the stylesheet: Allows the user to choose how dynamic errors will be handled. Either one of the following options can be selected: recover silently, recover with warnings or signal the error and do not attempt recovery.
When you need to enrich the functionality of the XSLT with calls to a procedural language, the extensions support can be used. This options panel allows you to load the extensions (Java classes, jars, zips).
The position of the extensions in the list decides the order in which the extensions are loaded by the class loader. You can use the 2 arrow buttons to alter the extensions order.
Any change in the extension list requires restarting the application
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.
If checked, the debugger presents the output of xsl: result-document instruction into the debugger output view.
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.
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.
When checked, unescapes the entities found in the XPath expression. For example the expression
//varlistentry[starts-with(@os,'s')]
is equivalent with
//varlistentry[starts-with(@os,'s')]
.
When checked, results of different XPath expressions executed on the same file are written in separate result set tabs.
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 separately.
The New button creates an editable prefix-namespace mapping.
The Remove button deletes the selected mapping.
Allows you to select the XSLT Processor to validate the XQuery
If checked external functions called is allowed. Not checking this is recommended in an environment where untrusted stylesheets may be executed. Also disables user-defined extension elements, together with the writing of multiple output files, all of which carry similar security risks.
If checked performs stripping of all whitespace-only text nodes.
This determines whether source documents should be parsed with schema-validation enabled.
This determines whether source documents should be parsed with schema-validation enabled.
If checked, all validation errors are treated as warnings, otherwise they are treated as fatal.
If checked, <oXygen/> takes the results of a query and creates an XML document containing copies of all items in the sequence, suitably wrapped.
Allows the user to choose how dynamic errors will be handled. Either one of the following options can be selected: recover silently, recover with warnings or signal the error and do not attempt recovery.
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.
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 certificate is valid.
Allows you to import all transformation scenarios from a scenarios properties file. Their names will appear in the "Configure Transformation Scenario" dialog followed by "(import)". This way there are no scenarios' names conflicts.
Allows you to export all transformation scenarios available in the "Configure Transformation Scenario" dialog.
<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.