Configure which processing instructions to remove

The RemoveProcInsTriggers.xml file in the system configuration enables you to configure the list of processing instructions to remove when a topic moves to a specified status.

When you add editing comments to a topic, these comments are added as processing instructions (PI). A comment added to a paragraph appears similar to this example:

<p>This new feature is not yet documented.<?oxy_comment_start author="whitel" timestamp="20140730T123424-0500" comment="Please check the specification for more information on this feature."?><?oxy_comment_end?></p>

As you can see, the opening and closing tags for PIs always include question marks, which makes them easy to identify as such. You can add PIs in other ways as well, and there may be certain system actions that also insert PIs. PIs are not part of the content of a topic, so they can appear anywhere without affecting the topic's structure.

The CMS includes a configurable trigger, com.ixiasoft.cms.triggers.RemoveProcIns, that can automatically delete all PIs when a topic moves to Authoring:done (or whatever your final state may be). The specific PIs that are deleted depend on a list in your system configuration, RemoveProcInsTriggers.xml.

To configure which processing instructions to remove:

  1. Open the TEXTML Administration perspective by clicking the TEXTML Administration shortcut on the tool bar. If the shortcut is not displayed, follow these steps:
    1. Select Window > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click OK.
  2. In the TEXTML Administration view, double-click the server. If your server is not displayed in the view, you must add it to the view.
  3. When the Connect as dialog opens, type your username and password and click OK.
  4. Double-click the name of your docbase to open a connection to the Content Store.
  5. Locate the RemoveProcInsTriggers.xml file in the repository's /system/conf collection.
  6. Open RemoveProcInsTriggers.xml with a text editor.
  7. Add a new <procins> element that includes the name of the PI you want to delete.

    For example, the name of the processing instruction in the previous example is oxy-comment-start. This PI is already in the list of PIs to be deleted.

    Note: Although the name of the trigger in the RemoveProcInsTriggers.xml file is "XMetalChangeTracking", the list actually includes PIs inserted by both oXygen and XMetaL. You can disregard the trigger name and add triggers of any sort to this list.
  8. Delete any <procins> elements that correspond to PIs you do not want to delete.
  9. Save, close, and check in the RemoveProcInsTriggers.xml file.
  10. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their . Users can also apply the changes without restarting their IXIASOFT CCMS Desktop by clicking DITA CMS > Synchronize Configuration.