Edit online

Oxygen XML Editor gathers documentation from the associated schemas (DTD, XML Schema, RelaxNG) and presents it for each element or attribute. For example, if you open the Content Completion Assistant for a recognized XML vocabulary, documentation is displayed for each element provided by the associated schema. Similar information is displayed when you hover over tag names presented in the Elements view. If you hover over attributes in the Attributes view you also see information about each attribute, gathered from the same schema.

If you have a framework configuration set up for your XML vocabulary, there is a special XML configuration file that can be added to provide additional documentation information or links to additional information for certain elements and attributes.

To provide this additional information in the Content Completion Assistant, follow these steps:
  1. Create a new folder in the configuration directory for the document type.

    Example: OXYGEN_INSTALL_DIR/frameworks/dita/styleguide

  2. Use the New document wizard to create a file using the Content Completion Styleguide document template (in the Framework Templates > Oxygen Extensions section).
  3. Save the file in the folder created in step 1, using the fixed name: contentCompletionElementsMap.xml.
  4. Open the Preferences dialog box (Options > Preferences), go to Document Type Association, and edit the document type configuration for your XML vocabulary. Now you need to indicate where Oxygen XML Editor will locate your mapping file by doing one of the following:
    • In the Classpath tab add a link to the newly created folder.
    • In the Catalogs tab add a new catalog file. The selected file needs to contain the following:
      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE catalog PUBLIC "-//OASIS//DTD XML Catalogs V1.1//EN" 
          "http://www.oasis-open.org/committees/entity/release/1.1/catalog.dtd">
      <catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
          <uri name="http://www.oxygenxml.com/{processed_dt_name}/styleguide/
      contentCompletionElementsMap.xml" uri="contentCompletionElementsMap.xml"/>
      </catalog>

      where {processed_dt_name} is the name of the document type in lower case and with spaces replaced by underscores.

      Note: If Oxygen XML Editor finds a mapping file in both locations, the one in the Catalogs tab takes precedence.
  5. Make the appropriate changes to your custom mapping file.

    Example: You can look at how the DITA mapping file is configured: OXYGEN_INSTALL_DIR/frameworks/dita/styleguide/contentCompletionElementsMap.xml

    The associated XML Schema contains additional details about how each element and attribute is used in the mapping file.

  6. Re-open the application and open an XML document.

In the Content Completion Assistant, you should see the additional annotations for each element.

Translating Annotations

Annotations in the Content Completion Assistant can be displayed in various languages. Based on the language set for the interface, Oxygen XML Editor looks for several filename formats to determine the information to load for the content completion annotations. These files that begin with the name contentCompletionElementsMap, are located in the styleguide folder for each built-in framework (for example, OXYGEN_INSTALL_DIR/frameworks/dita/styleguide).

For example, for English, the files are loaded in the following order (from specific to more general):
  • contentCompletionElementsMap_en_US.xml or contentCompletionElementMap_en_UK.xml, and so on
  • contentCompletionElementsMap_en.xml
  • contentCompletionElementsMap.xml
If you want the annotations to be displayed in another language, you need to create similar files for the particular language. For example, to show annotations in German, create a file with one of the following names (and store it in the styleguide folder for your framework):
  • contentCompletionElementsMap_de_DE.xml
  • contentCompletionElementsMap_de.xml