spell_cmd¶

View page source

Spell Command¶

Syntax¶

{xrst_spell word_1 … word_n }
{xrst_spell_off}
{xrst_spell_on}

The lines containing the { ( } ) character must have nothing but white space before ( after ) it.

spell_off¶

By default xrst does spell checking. You can turn spell checking off using this command.

spell_on¶

If spell checking has been turned off, you can turn it back on using this command.

spell¶

You can specify special words to include as correct spelling for this page using this command.

Words¶

Each word, that is checked for spelling, is a sequence of letters. Upper case letters start a new word (even when preceded by a letter).

Special Words¶

In the syntax above, the special word list is

word_1 … word_n

These words are considered correct spelling even though they are not in the dictionary. In the syntax above the special words are all in one line. They could be on different lines which helps when displaying the difference between versions of the corresponding file. Latex commands should not be in the special word list because words that have a backslash directly before them are not include in spell checking.

project_dictionary¶

The list of words in the project_dictionary are considered correct spellings for all pages. If multiple people are working on a project using different spell checkers, the words that are correct in one spell checker and not another should be included in the project_dictionary.

page_name¶

For each of the following commands in a page, the words in page_name are considered correct spelling for that page:

      {xrst_begin        page_name group_name }
      {xrst_begin_parent page_name group_name }
      :ref: ` …  page_name-name … `
      :ref: ` …  page_name-title … `

Note that group_name can be empty which corresponds to the default group; see begin_cmd .

Capital Letters¶

The case of the first letter does not matter when checking spelling; e.g., if abcd is word_1 then Abcd will be considered a valid word. Each capital letter starts a new word; e.g., CamelCase is considered to be the two words ‘camel’ and ‘case’. Single letter words are always correct and not included in the special word list; e.g., the word list entry CppAD is the same as Cpp.

Double Words¶

It is considered an error to have only white space between two occurrences of the same word. You can make an exception for this by entering the same word twice (next to each other) in the special word list.

Double words errors occur in the output the user sees. for example, the input:

`python package index <https://pypi.org/>`_ index.

results in the double word ‘index index’ in the output the user sees; i.e., the following output: python package index index.

Example¶

spell_example