Configure spellchecker to skip an element

You can configure the spellchecker so that it skips specific elements.

The spellchecker 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 spellchecker. By default, IXIASOFT CCMS is configured to skip the <codeblock> and <codeph> elements, but you can configure it as appropriate for your deployment. For example, configure the spellchecker so that it only skips <codeph> elements, but does not skip <codeblock> elements.

Important: Make configuration changes in a test environment and confirm they work before copying them to a production environment. For dedicated SaaS deployments, test the changes and then ask IXIASOFT Customer Support to copy the changes to your production environment.

To configure spellchecker to skip an element:

  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 > Perspective > Open Perspective > Other
    2. Click TEXTML Administration.
    3. Click Open.
  2. In the TEXTML Administration view, double-click the server.
  3. If your server is not displayed in the view, add it by doing the following:
    1. To find the server name, click Window > Preferences and select IXIASOFT CCMS.
      In the TEXTML Server Connection section, the server name is the Hostname.
    2. Copy the Hostname and close the Preferences window.
    3. In the TEXTML Administration view, right-click and select Add Server.
    4. In the Server field, enter the server name.
      The Port field should fill automatically. If you need the port number, you can find it in the same place as the server name in the Preferences window.
    5. Click OK.
  4. When the Connect as dialog opens, type your username and password and click OK.
  5. Double-click the name of your Content Store to open a connection to it.
  6. Locate the dictionaryExclusions.xml file in the repository's /system/conf collection.
  7. 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.

  8. 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"/>
  9. Save, close, and check in the dictionaryExclusions.xml file.
  10. Inform users of the changes.
    The changes will be applied automatically once users close and then reopen their IXIASOFT CCMS Desktop. Users can also apply the changes without restarting their CCMS Desktop by clicking IXIASOFT CCMS > Synchronize Configuration.
Spellchecker now skips the elements you designated.