Preferences

Once oXygen is installed you may want to use the following preferences to customize oXygen for your requirements and network environment.

Global

Change Interface Language

oXygen supports a number of languages for localization of the GUI. Select Options->Preferences->Global->Language to display a sub-menu with choices.

Changing Look and Feel

This option enables the selection of look and feels that change the graphic style used by the oXygen GUI.

Automatic Version Checking

When enabled, checks the availability of new oXygen versions at http://www.oxygenxml.com.

File Types

oXygen has support for a wide variety of file types. Users can add new file types and associate them with the editor which fits better.

Extension

The new file types.

Editor

The type of editor which the extensions will be associated with.

Proxy Configuration

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 Options->Preferences->Proxy Configuration.

Figure 2.1. The Proxy Configuration Dialog

The Proxy Configuration Dialog

Complete the dialog as follows:

Use proxy server

When checked enables oXygen to use the specified Proxy Server. When unchecked, Proxy Server is disabled.

Web Proxy (HTTP)

The IP address or Fully Qualified Domain Name (FQDN) of the Proxy Server.

Port

The TCP Port Number, normally set to 80 or 8080.

User

The Name of the user if required. Can be empty.

Password

The Password for authentication. Can be empty.

No proxy for

Specify domains for which no proxy should be used.

SOCKS

When checked enables SOCKS using the specified host and port for the server. When unchecked, SOCKS is disabled.

Host

The SOCKS host you wish to connect to.

Port

The SOCKS port you wish to connect to.

Editor

Figure 2.2. The Editor option

The Editor option
Font

This option enables the selection of the font family and size used to display text.

Same font for the GUI

When checked the GUI font will be changed as the editing font.

Line Wrap

This option will automatically wrap lines in edited documents.

Show EOL/EOF marks

Marks the EOL/EOF using small icons, for a better visualisation of the document.

Show line numbers

This option enables the line numbers column located in the left part of the editing space. When unchecked, line numbers option is disabled.

Indent size

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.

Line width - pretty print

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.

Indent with tabs

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.

Smart indent

Smart Indent attempts to indent mark-up in accordance to the tag/text and its position/ context within the body of a document. This option either enables or disables the use of smart indenting.

Make backup copy when save

When checked, on saving the edited document a backup copy is made.

Enable automatic save

Automatic save is a useful and time saving feature that ensures your work is being saved in the background. You can specify the time intervals between automatic saves. When checked enables Automatic Save to use the value specified. When unchecked, Automatic Save is disabled.

Automatic save intervals

Select the period in minutes for Auto Save intervals.

Print

Figure 2.3. The Printing Scale option

The Printing Scale option

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.

Printing Scale

Displays a slide allowing the user to adjust the printing scale between 40% and 100%.

External FO processors

Besides the built-in formatting objects processor (Apache FOP) the user can use other external processors. oXygen has implemented an easy way to add XEP as External FO processor if the user have the XEP installed.

The users can configure the external processors for use with oXygen in the following dialog.

Name

The name that will be displayed in the list of available FOP processors on the FOP tab of the Transforming Configuration dialog.

Description

The description of the FO processor displayed in the Preferences->FO Processors option.

Shortcut key

The keyboard shortcut that runs the FO processor on the document currently edited.

Working directory

The directory in which the intermediate and final results of the processing will be stored.

Command line

The command line that will start the FO processor, specific to each processor.

External Tools

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.

Name

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.

Description

The description of the tool displayed in the Preferences->External Tools option.

Shortcut key

The keyboard shortcut that launches the external tool.

Working directory

The directory the external tool will use to store intermediate and final results.

Command line

The command line that will start the external tool.

Plugins

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.

XML Catalog

An XML catalog is a set of mappings between remote DTD and/or XML Schema files and local copies of these files. When Internet access is not available or is slow one or more XML catalogs can be added to the list in the dialog below and the local copies of the DTD and/or XML Schema files will be used during validation. When you add or delete an XML catalog to the list of XML catalogs in the Options -> Preferences -> XML Catalog pane you should restart the application so that the changes take effect.

The Prefer option is used to specify whether 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.

The verbosity level specifies the types of output messages displayed to standard output and can have one of the values: debug, warn, info, error and fatal.

XML Parser Features

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.

Code Insight

The Code-Insight feature enables in line syntax lookup and Auto Completion of mark-up elements and attributes to streamline mark-up and reduce errors while editing.

Features

Use Code-insight

This option enables Code-insight feature. When unchecked, all Code-insight features are disabled.

Close the inserted element

When inserting elements from the Code-Insight assistant, both start and end tags are inserted.

Add required elements

When checked, oXygen will insert automatically the required elements from the DTD or XML Schema.

End tag autocompletion

Having manually typed the start tag of an element, oXygen will automatically insert the after tag when </ is typed.

Insert the required attributes

When inserting an element from the Code-Insight assistant, the cursor is automatically positioned before the > bracket of the start tag. Entering a space displays the attributes supported by the inserted element.

XML

DTD

Used to specify the full path location of the DTD file that will be used to initialize the Code-Insight assistant when a document does not define a DTD or XML Schema.

XML Schema

Used to specify the full path location of the XML Schema file that will be used to initialize the Code-Insight assistant when a document does not define a DTD or XML Schema.

XSL

None

The Code-Insight will offer only the XSL information.

XHTML transitional

Includes XHTML Transitional elements as substitute for xsl:element.

Formating objects

Includes Formating Objects elements as substitute for xsl:element.

Other

Includes elements from a DTD file or a XML Schema file specified from a URL as substitute for xsl:element.

Colors

oXygen support Syntax Highlight for Java, PHP, C, C++, SQL, Perl, Shell and Batch. 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.

Swatches

Displays a color pallet containing a variety of colors from across the color spectrum and shades thereof. Select a color.

HSB

Hue, Saturation and Brightness (HSB) enables you to specify a color by describing it using hue, saturation and brightness.

RGB

Red, Green and Blue (RGB) enables you to specify a color using triplets of red, green and blue numbers.

Preview

Displays the color properties of the current token and results of customization.

Modifications are saved when the OK button is clicked. Cancel discards changes. Reset button change the color to the default value.

Memory Management

When starting oXygen it is possible to specify the amount of memory that will be available to the application by adjusting parameter variables contained in the startup script.

While there are minor changes in syntax to cater for differences in operating systems, the general structure of the command is as follows: [execute] [memory variables] [application path] [call main class] [pass script arguments to main class].

For memory management we are only interested in the [memory variables] portion of the command. The installation default for the memory value is set to 256 MB, as shown in the following example, where -Xmx256m establishes the maximum memory to be used to 256 MB. Adjust this value as required.

Example 2.1. Example Startup Script (Windows)

java -Xmx256m -cp ".: ./lib/oxygen.jar: classes" ro.sync.exml.oxygen $1 $2 $3 $4

Modifying the value from 256 to 100 sets the memory available from 256 to 100.