Customizing Annotations in the Content Completion Assistant
Edit online

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 your framework.

    Example: path/to/.../custom_framework/styleguide

  2. In Oxygen XML Editor/Author, 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. Go to Options > Preferences > Document Type Association and edit the document type configuration for your framework. Now you need to indicate where your mapping file is located 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 a mapping file if found 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_DATA_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. Create an archive that only contains your custom framework folder and upload the changes to your framework to Web Author.

Result: If you open a document for your framework, the Content Completion Assistant should now display the additional annotations for each element.