Intelligent XML Editing

Context-Sensitive Content Completion Assistant

oXygen offers the list of elements, attributes, and attribute values through a Content Completion Assistant. Unlike other editors that offer all the available entries (all the element names defined by the document XML Schema, for example), oXygen shows only those entries valid in the editing context. Therefore, the XML document is kept valid most of the time and the user does not have to know about the relationship between elements.

In the following image you can see that the list of possible elements for the tgroup element contains colspec, tbody, and thead, which is exactly what the DocBook DTD has defined.

Content completion

Support for Showing Recent Content Items

The proposals that have previously been used are promoted at the top of the content completion list, thus allowing for efficient re-use. For example, when editing an XSLT stylesheet, you are using a small fraction from all the set of XSLT and HTML elements. By sorting the recently used ones to appear higher on the list, it is easier to find them the next time you want to use them.

In the following image you can see that the four XSLT elements that were previously used, appear above other elements of the XHTML grammar.

Recent Content Items

Support for Learning Words

This feature is disabled by default, but when enabled all the words in the document will be indexed as they are written. When you enter a word's prefix and press CTRL+SPACE, words starting with that prefix are presented through the content completion window.

Learning Words

Content Completion Assistant for Documents Without a Schema

If there is a schema associated with the edited document, then oXygen will analyze it and initialize the Content Completion Assistant. If the document has no associated schema then the Content Completion Assistant is initialized by examining the edited document and learning its structure. Alternatively, you can use the options page to set the default XML Schema or DTD to be used.

Note that the learned structure can be saved to a DTD file and can be used as a skeleton for further development.

Configurable Content Completion Assistant Behaviour

There are many settings that customize the operating mode of the Content Completion Assistant. For example, you can enable or disable the generation of the required content or modify the way the cursor is positioned after an insertion.

XML Content Completion

Content Completion Assistant for IDREFS

05:57
Content Completion Assistance for IDRREFS

oXygen will present the ID values collected in the last validate action on the content completion proposals where an IDREF or IDREFS type is specified. This not only works with documents that have an associated DTD but also with documents that have an XML Schema or Relax NG schema associated.

In the following image you can see the content completion list containing all the IDs displayed when creating a link. The attribute linkend is defined as an IDREF (a reference to an ID value).

IDREFs Content Completion

When an attribute value is of the type anyURI (in both XML Schema and Relax NG schema) oXygen will present proposals of the form #ID for each defined ID value in the document.

Search/Refactoring Support for ID/IDREFS

oXygen offers support for search and refactoring operations for ID/IDREFS in XML documents that have an associated DTD, XML Schema, or Relax NG Schema. These operations are available in the Text mode and also in the Author mode.

In Text mode, the easiest way to access the search/refactoring action is by using the Quick Assist support. It is available when you position the caret inside an ID or an IDREF and click the yellow light bulb from the line-number stripe.

Enumeration Content Completion

Highlight ID Occurrences in Text Mode

To see the occurrences of an ID in an XML document while in the Text mode, place the cursor inside the ID declaration or reference. The occurrences are marked in the vertical side bar at the right of the editor. Click a marker on the side bar to navigate to the occurrence that it corresponds to. The occurrences are also highlighted in the editing area.

Enumeration Content Completion

Support for Enumerations

The Content Completion Assistant offers proposals for attributes and element values, whose type is an enumeration of tokens. This is available for documents that use XML Schema or Relax NG schema.

In the following image the attribute list of root has been defined as a list of decimal values (1.44, 2.88, 3.0, and 5.0) and the Content Completion Assistant offers proposals accordingly.

Enumeration Content Completion

Automatic Generation of Required Content

To speed up the content creation, oXygen automatically inserts the required attributes or content of an element. In the following image you can see how an entire subtree is generated just by selecting an element. This allows you to create valid content with minimum effort.

Generate the required element attributes and content

Code Templates

03:36
Code Templates

Document fragments can be defined and re-used while editing. The template list can be obtained with the Content Completion Assistant by using the keyboard shortcut CTRL+SPACE. oXygen includes a large number of ready-to-use templates for XSLT and XML Schema.

For example, in the following image you can see how Copy-Template has been defined. After insertion, the caret will be positioned after the xsl:template closing tag line.

XSLT Code Templates

Note that the templates can be shared using the export/import actions.

XML Markup Contrast Adjuster

The contrast control button allows you to change the transparency levels for XML markup or text. Therefore, you can change the focus of attention from markup to text, and vice versa. The transparent markup option, combined with locking the tags, can be used for safe and easy editing.

Contrast control

Resource Hierarchy/Dependencies View

The relationship between XML resources that are referred using the XInclude and external entity mechanisms can be visualized and understood with the help of the Resource Hierarchy/Dependencies View.

XML Resource Hierarchy

Update References of Moved or Renamed Resources

When an XML resource is renamed or moved in the Project view, oXygen gives you the option to update the resource's references. The same option is available when you move or rename a resource from the Resource Hierarchy/Dependencies view.

Update References of the Moved or Renamed Resource(s)

Matching Tag Highlight and Navigation

When placing the cursor inside a tag name, both the start-tag and the end-tag are underlined in order to provide immediate focus on the current element. You can move the cursor to the matching tag using an action Go to Matching Tag from the contextual menu.

Matching tag

Automatic Editing of the Matching End-tag

It is easy to rename elements in oXygen. When the start-tag of an XML element is edited, the matching end-tag is automatically changed, thus keeping the XML document "well-formed" and saving you a few keystrokes. This behavior is controlled from the preferences page.

Lock/Unlock XML Tags

This is very useful when you edit forms, such as XML documents or XML templates. This allows you to protect the markup from accidental changes and to only modify the text sections.

Folding

03:15
Folding

XML documents have a tree-like structure. Folding allows you to collapse elements, leaving only the ones you need to edit in the focus. A unique feature of oXygen is the fact that the folds are persistent (the next time you open the document the folds are restored to the last state so you can continue to work from where you left off). For non-XML files, the folding strategy is to collapse blocks of text that have the same indent.

In the following image you can see that only one of the chapter sections is expanded and the rest are collapsed. The folds show the number of lines that were collapsed on the right side.

XML Folding

To speed up the fold operation you can use the contextual menu to collapse or expand all the child folds of an element.

Optional Content Generation

02:49
Optional Content Generation

When creating a new XML document the editor generates the content of the root element, based on the required elements as it was specified in the associated schema or DTD. There are two options available to make the content generation process also take into account optional content and choice models, thus allowing you to obtain more content for the new document.

In the following image, the "site" element was chosen as the root of the new document. The checkboxes above the text show the settings from the New Document dialog. You can see that activating the optional content generation options implies more generated content.

Generation of XML optional content
Video Tutorials
Upcoming Events
oXygen Users Meetup Prague 2015
oXygen Users Meetup Prague 2015
February 13, 2015
Prague, Czech Republic
" oXygen XML Editor is the premier text editor for XML geeks, and an indispensable tool for O'Reilly's Production group. My team uses oXygen XML Editor for everything from simple XML editing to Schema validation and XSLT transformations. The digital production staff especially loves oXygen's built-in EPUB support, which eliminates a great deal of the grunt work that is usually entailed in editing EPUB files. The more we use oXygen, the more realize what a powerful tool it can be in digital and XML-based workflows."
Adam Witwer
Director of Content and Publishing Operations
O'Reilly Media