Configure the elements skipped during spell check

You can configure the spell checker feature so that specific elements are skipped.

This can be very useful with elements such as <codeblock> and <codeph>, which often contain code and commands that you do not want to spell check.

By default, the DITA CMS is configured to skip the <codeblock> and <codeph> elements, but you can configure it as appropriate for your deployment. For example, you could configure the spell checker so that <filepath> elements are skipped.

The elements to skip during spell check are defined in the dictionaryExclusions.xml configuration file.

To configure the elements skipped during spell check:

  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 dictionaryExclusions.xml file in the repository's /system/conf collection.
  6. Check out dictionaryExclusions.xml and open it with a text editor.
    The default file looks as follows:
    <?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>

    Elements to skip are specified using class attributes. See the DITA OASIS specification or your DTD specialization to determine the class attributes for the elements you want to exclude.

  7. For each element to skip, add an <exclude> element before the closing </dictionaryExclusions> element.
    For example, to skip the <filepath> element, add the following:
    <exclude _class="sw-d/filepath"/>
  8. Save, close, and check in the dictionaryExclusions.xml file.
  9. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their DITA CMS. Users can also apply the changes without restarting their DITA CMS by clicking DITA CMS > Synchronize Configuration.