Configure spell checking to skip an element

You can configure the CCMS Desktop and CCMS Web spell checker so that it skips specific elements.

About this task

The spell checker stores the list of elements to skip in the dictionaryExclusions.xml configuration file.

Elements such as <codeblock> and <codeph>, which often contain code and commands, do not require a spell checker. By default, IXIA CCMS is configured to skip the <codeblock> and <codeph> elements, but you can configure it as appropriate for your deployment.

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

Procedure

  1. Open TEXTML Administration and connect to the server.
  2. Open the Content Store.
  3. Navigate and check out the dictionaryExclusions.xml file in the repository's /system/conf collection.
  4. Open the file with a text editor.
    Note: Specify the elements to skip using class attributes. See the DITA OASIS specification or your DTD specialization to determine the class attributes for the elements you want to exclude.
    <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE dictionaryExclusions PUBLIC "-//ixiasoft.com//cms//config//dictionaryExclusion" "dictionaryExclusion.dtd">

<!-- Offers the possibility of excluding elements from the IXIASOFT spell checker -->
<dictionaryExclusions>
   <!-- The elements matching the following classes will be excluded from spellchecking -->
   <!-- Please consult the DITA OASIS specification or your DTD specialization to determine class attributes -->
   <exclude _class="pr-d/codeblock"/>
   <exclude _class="pr-d/codeph"/>
</dictionaryExclusions>
  5. For each element to skip, add an <exclude> element before the closing </dictionaryExclusions> element.
    For example, skip the <filepath> element by adding this exclusion.
    <exclude _class="sw-d/filepath"/>
  6. Save, close, and check in the dictionaryExclusions.xml 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.