Specify the elements that require an id attribute

Elements that will be the target of conrefs, conkeyrefs, or internal cross-references require an @id attribute. You can specify to which elements the CCMS should automatically add @id upon check in.

About this task

By default the CCMS automatically adds @id to the following elements: section, fig, table, note, step, and all elements within referable-content topics.

The xpathforids.xml file works with the Add Ids trigger in CCMS Desktop (configured in triggers.xml) and the AddElementIdTrigger trigger in CCMS Web (configured in triggerswebplatform.xml).

Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment.

Procedure

  1. In the TEXTML Administration perspective, connect to your server.
  2. Locate the xpathforids.xml file in the repository's /system/conf collection.
  3. Check out the file and open it for editing.
  4. To add another element to the list, copy one of the existing elements and change the class.

    For example, to add <li> (list item) to the list, change the class to 

    <xpath value="//*[contains(@class, ' topic/li ')]"/>
    Tip: You can find the class of a DITA element in the DITA specification, available at https://docs.oasis-open.org/dita/dita/v1.3/dita-v1.3-part3-all-inclusive.html.
  5. To remove an element from the list, simply delete it.

    Doing so does not remove any @id attributes that are already present in the content.

  6. Save, close, and check in the file.
  7. Inform users of the changes.
    The changes are automatically applied once users close and then reopen their IXIA CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIA CCMS > Synchronize Configuration.