SpellingOptions

SpellingOptions

is an option for notebooks that specifies settings for spellchecking.

Details

  • The typical usage is SpellingOptions->{opt1->val1,opt2->val2,}.
  • The following suboptions can be specified:
  • "AlwaysSkip"{"SingleCharacterWords", "Numbers", "WordsWithNumbers", "WordsInAllCaps","WordsWithUnderscores","WordsWithInternalCapitals","WordsInURL"}criteria for skipping words during a spellcheck
    "AlwaysStop"{"UncapitalizedStartOfSentence", "RepeatedWords"}criteria for stopping a spellcheck
    "WordSplitting"{"Hyphen"}whether compound words of a given type should be split before being tested by the spellchecker
    "AutoSpellCheckDelay"0.4time in seconds when a spellcheck begins after typing stops
    "AutoSpellCheckPopupDelay"0.4time in seconds when a mouse hover over a highlighted misspelled word will produce a popup with corrections
    "MaxSuggestions"3maximum number of suggestions to list in right-click and hover menus
    "MisspelledWordStyle""MisspelledWord"style to apply to misspelled words
  • "AlwaysSkip" is given as a list of conditions to be tested. If a word being tested satisfies any of the conditions, the spellchecker skips that word. This option allows you to customize a spellcheck to ignore certain types of words.
  • The settings for "AlwaysStop" override those for "AlwaysSkip" if the same condition is specified for both options.
  • Possible settings for "AlwaysSkip" are "UncapitalizedStartOfSentence", "RepeatedWords", "SingleCharacterWords", "Numbers", "WordsWithNumbers", "WordsInAllCaps", "RomanNumerals", "AlternateSpellings", "CaseDifferences", "EncliticForms", "HyphenatedWords", "WordsWithUnderscores", "WordsWithInternalCapitals", and "WordsInURL".
  • "AlwaysStop" is given as a list of conditions to be tested. If a word being tested satisfies any of the conditions, the spellcheck stops at that word. This option allows you to generalize a spellcheck to search for errors other than ordinary spelling errors.
  • Possible settings for "AlwaysStop" are the same as for "AlwaysSkip".
  • When the spellchecker encounters a compound word of a type specified in "WordSplitting", it splits the word and tests each of its component words separately.
  • Possible settings for "WordSplitting" are "All", "Hyphen", "Underscore", and "InternalCapitals".
  • With the setting "WordSplitting"->"All", the spellchecker will attempt to split up compound words even if they are not internally capitalized or hyphenated or have no underscore. For example, "shortstop" could be tested as "short" and "stop".

Examples

Basic Examples  (1)

By default, words with hyphens are split and spellchecked, but words with underscores are ignored:

Split and spellcheck words with underscores:

Wolfram Research (1999), SpellingOptions, Wolfram Language function, https://reference.wolfram.com/language/ref/SpellingOptions.html.

Text

Wolfram Research (1999), SpellingOptions, Wolfram Language function, https://reference.wolfram.com/language/ref/SpellingOptions.html.

CMS

Wolfram Language. 1999. "SpellingOptions." Wolfram Language & System Documentation Center. Wolfram Research. https://reference.wolfram.com/language/ref/SpellingOptions.html.

APA

Wolfram Language. (1999). SpellingOptions. Wolfram Language & System Documentation Center. Retrieved from https://reference.wolfram.com/language/ref/SpellingOptions.html

BibTeX

@misc{reference.wolfram_2021_spellingoptions, author="Wolfram Research", title="{SpellingOptions}", year="1999", howpublished="\url{https://reference.wolfram.com/language/ref/SpellingOptions.html}", note=[Accessed: 19-January-2022 ]}

BibLaTeX

@online{reference.wolfram_2021_spellingoptions, organization={Wolfram Research}, title={SpellingOptions}, year={1999}, url={https://reference.wolfram.com/language/ref/SpellingOptions.html}, note=[Accessed: 19-January-2022 ]}