Documentation Center

Customizing Quality Check in Draft Space

Quality Check comes with en and en-US spelling check by default, but there is a command that allows to customize Quality Check with new dictionaries and rules for spelling check.

Implementing new spelling check configuration

In order to customize spelling check for Collective Spaces, specific files need to be provided to a directory that holds configuration for Fonto Content Quality configuration: /App/Utilities/FontoContentQuality/configuration/spelling. Within spellingdirectory all dictionaries must be placed inside folders named with respective language code - e.g. en or language-culture code - e.g. en-US. Table below shows accepted file types.

FileDescriptionNote
*.dicHunspell dictionary fileRequired; only one allowed
*affHunspell affix fileRequired; only one allowed
spelling.txtA list of individual words which are considered to be spelled correctly. These words also appear as suggestions for similar, but incorrectly spelled, words.Optional
ignore.txtA list of individual words which are always considered valid. No suggestions are generated for words on this list.Optional
prohibit.txtA list of individual words which are always considered invalid. No suggestions are generated for words on this list.Optional
replacements.txtThis specifies a list of individual words for which specific replacements are given.Optional
To implement new configuration from files in /App/Utilities/FontoContentQuality/configuration/spelling run the following command:
Set-ISHFontoContentQuality

Note: You can use the Copy- ISHFile cmdlet to copy the custom spelling related files to the \App\Utilities\FontoContentQuality\Configuration\spelling folder.

Excluding DITA elements from spelling check

Tridion Docs excludes following DITA elements from spelling check:
  • self::apiname
  • self::area
  • self::classname
  • self::cmdname
  • self::codeblock
  • self::codeph
  • self::data
  • self::draft-comment
  • self::equation-number
  • self::filepath
  • self::feign
  • self::functionname
  • self::glossProperty
  • self::index-st-as
  • self::paramName
  • self::parmname
  • self::required-cleanup
  • self::unknown
  • self::var
  • self::varname

To add more DITA elements to that list, edit excludeFromSpellCheck.txt file inside \App\Utilities\FontoContentQuality\Configuration directory, and follow the instructions from the file to add DITA elements you want to exclude. Save changes afterwards.

To implement changes made in excludeFromSpellCheck.txt file, run the following command:

Set-ISHFontoContentQuality