Using Spell Checker

You can use the Spell Checker feature to detect possible spelling errors of words within a topic or a map.

There are two separate spell checker variations available to you, based on your platform and your usage.

  1. Oxygen XML Author built-in automatic, as-you-type spell checker on selected topics and maps in CCMS Web, available if enabled from the Oxygen toolbar (See Enable the Oxygen automatic spell checker)
  2. New built-in spell checker for use map-wide or on individual topics, based on open-source Language Tool plug-in

Both Oxygen versions uses the Hunspell engine for its functions. The new Spell Checker feature uses the Language Tool engine for its functions.

The new Spell Checker feature provides you with the choice of identifying any issues with spelling and then ignoring any suggestions for an alternative for a single instance or all instances of that particular spelling. The spell checker works across all variations of a supported language type, such as British and U.S. English, and then identifies any issues found in the Spell Checker Results report or in a topic's Spell Checker side panel.

Note: There is a visual distinction between the two variations.
  • The Oxygen spell checker marks any misspelled words with a wavy red underline.
  • The new built-in spell checker highlights any misspelled words while listing them in the Spell Checker side panel and also provides the context around them.
Note: The Spell Checker feature is only available to you in the Authoring cycle and requires you to have access rights to it. Contact your system administrator if you are having issues accessing it.

Current support exists for the following source languages used during the Authoring cycle:

  • English

  • French

  • German

  • Japanese

There are two points of access to the Spell Checker feature:

  1. For maps, use the Spell Checker menu item on the More Options menu from an object open in Structure orContent view. See Check the spelling for an entire map.
  2. For topics, use the Spell Checker side panel. See Check the spelling in a topic.
Note: In the 7.2 version, there is no support for using the spell checker for text in SVG images. However, the spell checker does use the existing configuration files so that you can continue to use the elements you already specified as exempt. Discuss with your system administrator to implement a list of custom words.
Figure: For maps, sample Spell Checker Results page with callouts

Item

Name

Function

1

Results tabs

Provides access to three categories of spelling errors:

  • To Correct: The list of possible spelling errors still ready for review and an action to correct or accept that spelling

  • Skipped: The list of flagged words that you chose to pass over, ignoring the error

  • Processed: The list of words you chose to add to a list of words the spell checker should treat as correct spellings

2

Objects with Errors wheel

Registers total number of objects that contain possible errors, such as maps, topics, or images

3

Misspelled word interactive, dynamic grid

Lists misspelled errors and related actions

4

Error Types wheel

Registers total number of spelling mistake types, such as unknown word, hint, or other

5

Actions column

Access to all currently allowed actions for the topic

  • : Add the word to a permanent ignore list within a custom spelling dictionary

  • : Correct the spelling error

  • has three variations:

    1. Skip: Do not list as an error for this single occurrence
    2. Skip in object: Do not list as an error for all occurrences in the current object
    3. Skip in all objects: Do not list as an error in all objects within the map
Figure: For topics, sample Spell Checker side panel with callouts

Item

Name

Function

1

Breadcrumb path

Provides topic title and any related context

2

Oxygen Web Author toolbar

Supports common authoring and editing features and functions

3

Misspelled word inMain Editing area

Allows edits to misspelled word from suggestions in side panel

4

Action buttons

Access to all currently allowed actions for the topic

5

Side Panel

Access to different useful panels, according to the context

Tip:

You can click on any of the panels to access or hide the related content.

  • Details icon Details panel: Provides additional information for the topic such as status, assignees, and last check in date

  • Taxonomy Terms icon Taxonomy Terms panel: Provides the taxonomy terms currently applied to the topic

  • Spell Checker iconSpell Checker panel: Provides spelling suggestions for all spelling errors in the topic or all topics within the map and allows you to filter the results by error code or by type

  • Review icon Review panel: Displays all the comments and annotations in the topic

  • Attributes icon Attributes panel: Displays related attributes and values for elements in topic

  • Validation icon Validation panel: Displays status of document validity and any errors related to items such as keyword and cross references

6

Refresh icon

Refresh icon: Refreshes the spell checker side panel with the latest updates from the topic content

7

Spell checker action icons

  • : Add to custom skip list for all instances of the term

  • : Skips over this single instance of the selected term or all instances of the term in a topic

8

Filters

Filter all identified terms by error code or error type.