Text in the following areas is included in this operation:
- Module, section, and topic names
- Text and Object names in the Frame toolpane
- Implicit text for string inputs
- Decision frame headings and path names
- Jump-in point text
- Text in Author Notes, Instructor Notes, and Expected Test Results panes in the Topic Editor
- Text in web pages
- Glossary terms and definitions
- Document output fields in the Properties toolpane
- Custom properties
Note: The names of the following document types are not included in this operation: web pages, packages, glossaries, role lists, and publishing styles.
You can start this tool from the Library or the Outline Editor only. From the Library, you must have at least one document selected or the tool is disabled. If nothing is selected in the Outline Editor, the entire outline is searched; this is equivalent to selecting the root of the outline.
If the document(s) selected for spell checking are linked to other documents, you are prompted with the choice of checking the selection only or the selection and related documents. Clicking the View related documents link displays a list of the related documents. For this process, related documents are defined as all searchable documents that are directly or indirectly linked as children of the selection. For example, if you select a section that has topics and each of the topics has a web page linked as its concept, choosing to search related documents searches the section, the topics, and the web pages linked to the topics. Templates and package contents are not included in this operation.
By default, the Spell Check tool ignores words that are in all uppercase letters and attempts to split compound words into two words. However, you can change these settings either before initiating a spelling check or while checking your content from Spelling page of the Options dialog box.
When a misspelled word is found, the Developer identifies the Library path of the document in which the word appears, as well as the context of the word within the document. You then have the option of ignoring that particular instance or all instances of the word, changing the word in that particular location or in all locations where it appears, or adding the word to the custom dictionary.
Warning! You cannot undo any changes made during a spelling check.
When you add a word to your dictionary during a spelling check, the word is added to the custom dictionary specified in the Spelling category in the Options dialog box. While performing a spelling check, you can also switch custom dictionaries or create a new one.
The Developer provides a dictionary for each of the following supported languages:
- English (United Kingdom)
- English (United States)
- French (Canada)
- Portuguese (Brazil)
During a spelling check, the Developer uses the dictionary that matches the Language property of the document it is currently checking. If the content selected for a spelling check includes documents with different assigned languages, the spelling checker switches dictionaries as needed. If no dictionary of the same language exists, the spelling checker skips the document and adds a message to the activity log.
- For changes to be made to a document using this tool, the document must be checked out. If you plan to use this tool offline, you should check out all affected documents before going offline.
When you execute this process, the Developer searches through all of the documents in the selection, regardless of their check in/out state. If a change is necessary and the document is not checked out and if you are working online, the Developer automatically checks the document out to you and makes the change. If the document cannot be checked out, for example, if it is open in another editor or checked out to another user or you are working offline, it is skipped. At the end of the process, a summary message appears with a link to an activity log. Clicking the View activity log link in the message displays a list of the documents that were checked out to you during the process and those that could not be checked out. After you save any changes, you should check in the documents to make them available to other authors and add the changes to the Developer's version control system.
To spell check a document:
- From the Library or Outline Editor, select one or more documents or folders containing the documents whose content you want to spell check.
You can select multiple documents using the standard Windows selection keys (CTRL+click and SHIFT+click).
- On the Tools menu, choose Spelling.
You can also press the F7 key.
The Related Documents dialog box appears when you perform an action on any document that has links to other documents. You can choose to process only the document(s) you selected or to process your selection and all of the related documents.
Click the View related documents link to display a list of the related documents if you are not sure whether you want to include related documents.
After you have made your selection, click OK.
- If a misspelling is found, it is displayed in the Location section, along with information describing the location of the text within the document and the location of the document within the Library. Click Ignore, Ignore All, Change, Change All, or Add, as appropriate.
If you are working in the Outline Editor, the first time you change a word, a Replace Confirmation message appears indicating that you cannot undo replacements made during a spelling check. Click Yes to continue or No to cancel the spell check.
- If necessary, click Options to change the spelling options or the custom dictionary.
To change the custom dictionary, select the dictionary from the Custom dictionary list in the Options dialog box and click OK. You can also click User Dictionaries in the Options dialog box to create a new custom dictionary. After you change the custom dictionary, clicking Add in the Check Spelling dialog box adds the word to the newly selected dictionary.
- Click OK when the spelling check is complete.
If you changed one or more misspelled words, you can also click the View activity log link to see a list of documents in which changes were made and the number of changes in each document.