Authoring tips and tricks

When you work in the Oxygen-based editor, make sure you understand the basics to easily create and edit structured DITA and DocBook documents in an XML data format.

When you open a document for editing, the file is locked so that other users can't make changes while you're working.

  • When you save and submit your changes, the file is unlocked and ready for other users to edit.
  • You can also choose to open a read-only copy of a document to keep it unlocked if you don't need to make changes.

Opening components

The editor gives you a rich set of tools to develop your content, including ways to manage files, format text, track changes, and re-use content through links and key references.

  • After you start working in the editor you can customize display options such as changing the font size and type, and enabling a screen reader for accessibility.

Customize the editor

If you need to work with the XML elements in your document, you have a rich set of tools. You don't have to choose one way to edit a component. You can start out in Author mode, where you only see text and images, and switch to XML mode where you only see code.

  • Author mode: By default, the editor opens in a graphic user interface where you can see the text and images that are used in the component. You can insert images and format text using buttons on a toolbar and Inspire inserts the XML code around it.
  • Edit XML source mode: This view lets you directly edit XML code and text within elements. You can hide attribute IDs to make authoring easier by showing more text and less code. When attribute IDs are hidden, element tags and link references are still displayed. You can select the Hide IDs button to show attribute IDs again.

To quickly switch between views:

  • In the XML or Authoring mode, use the keyboard shortcut keys Alt+fn+F5
  • In XML editing mode, click the Switch to Author mode button

Author XML content

Use the AI Assistant in the Oxygen Editor. An administrator can create an index so that authors and Inspire users can add data to it and build up the content for an AI-powered search.

Manage the premium AI feature

To access the AI premium feature, you must purchase it separately. Please contact your Vasont customer representative.