<< Click here to display Table of Contents >> Navigation: Install, Configure and Administer GN4 > Configuring GN4 > Configuring Spell-Checker > Spell-Checker Configuration:

Example of spell data in GlobalConfig

Build 1501 on 14/Nov/2017 This topic last edited on: 5/Aug/2014, at 15:34

Contents

<!--

SpellChecker Configuration

The CSApi element must feature one SpellConfig node (containing parameters independant of the language and library used)

plus one Spell node for each language installed - actually one Spell node is required for each couple (Library x Language).

CSapi/SpellConfig:

@Alpha:

Alphabetical characters, i.e. the list of all the characters that can be found in a word to spell check.

If this entry is not present the system automatically uses all the alphabetical characters in the

standard Western Windows character set, both unaccented ASCII letters and all the accented variations.

Note that both lowercase and uppercase letters must be put in this list. Note also that characters

that are not in the @Spaces nor in the Alpha lists are considered punctuation, and checked as such.

@Space:

Characters to be considered spaces, i.e. to be ignored by spell checking.

The space character and end line are always automatically considered spaces,

if other characters need to be ignored they should be added to this list.

Characters that are not in the @Spaces nor in the @Alpha lists are considered

punctuation, and checked as such.

Note: used only for Ted4, not in editing/creation forms.

@FromChars:

List of characters that should be converted before checking a word.

The default value for @FromChars is the typographical apostrophe (ANSI 146), with the ASCII

apostrophe of code 39 as the replacement in @ToChars

Note: used only for Ted4, not in editing/creation forms.

@ToChars:

List of characters to convert to before checking a word.

The length of the strings @FromChars and @ToChars must be the same. Characters found in the

first string are replaced with the corresponding ones in the second.

The default value for @FromChars is the typographical apostrophe (ANSI 146), with the ASCII

apostrophe of code 39 as the replacement in @ToChars.

Note: used only for Ted4, not in editing/creation forms.

CSapi/SpellConfig/SpellConfigKey:

Each SpellConfigKey element describes the validation rules for a specific punctuation symbol.

CSApi/SpellChecker/Spell:

@Library:

The name of the spellchecker library (for example 'GN3Sentry.dll', 'GN4Hunspell.dll').

Note that the spellchecker library (and all the others libraries it needs to work) must be into the 'bin' folder of the site

(when being used with GNPortal) and/or in the same directories that the executable client applications.

@Language:

Name of the corresponding dictionary. It can be:

- a two characters code of a pre-defined list, corresponding to the dictionary files

Possible values are:

"xx": any, "am": English (U.S.), "br": English (U.K.), "ca": Catalan,

"cz": Czech, "da": Danish, "du": Dutch, "fi": Finnish,

"fr": French, "ge": German, "hu": Hungarian, "it": Italian,

"nb": Norvegian (Bokmal), "nn": Norvegian (Nynorsk), "pl": Polish, "pb": Portuguese (Brazil),

"po": Portuguese (Iberian), "ru": Russian, "sp": Spanish, "sw": Swedish

For example (GN3Sentry): 'br du', where exist the 'sscebr.tlx', 'sscebr2.clx', 'sscedu.tlx' and 'sscedu2.clx' Wintertree files.

- the name of the .dic (dictionary) and .aff (affix) files into the binary folder

For example (GN4Hunspell): 'en_US fr', where exist the 'en_US.dic', 'en_US.aff', 'fr.dic' and 'fr.aff' MySpell files.

CSApi/SpellChecker/Spell/ShellOptKey:

For each SpellChecker/Spell element, it is possible to specify more options, using a ShellOptKey sub-element for each of them.

The name of the option to enable is indicated by the attribute SpellChecker/Spell/SpellOptKey/@Name. Possible values are:

- IgnoreCappedWord

ignore capitalized words (e.g., Canada).

Useful for checking text containing many proper names that may not be in the dictionary

[Sentry]

- IgnoreMixedCase

ignore words with mixed case (e.g., SuperBase)

Useful for checking text containing variable names, computer terms, etc. [Sentry]

- IgnoreMixedDigits

ignore words with numbers (e.g., Win98) [Sentry, Polderland]

- IgnoreAllCapsWord

ignore all-caps words (e.g., ASAP) [Sentry, Polderland]

- ReportUncapped

report words whose first character is not capitalized [Sentry]

- ReportMixedCase

report words containing an unusual combination of upper- and lower-case letters [Sentry]

- ReportMixedDigits

report words containing a combination of letters and digits or other symbols [Sentry]

- ReportSpelling

report the same occurrence of a word appearing twice in a row, such as the. [Sentry, Polderland]

- ReportDoubledWord

case sensitive (when the option is disabled, canada, Canada, and CANADA are considered identical) [Sentry]

- CaseSensitive

hyphens ("-") should, if necessary, be treated as word separators, and each sub-word spell checked individually [Sentry]

- SplitHyphenatedWords

apostrophes should, if necessary, be treated as word separators, and each sub-word spell checked individually [Sentry]

- SplitContractedWords

words should, if necessary, be treated as a series of concatenated sub-words, and each sub-word spell checked individually [Sentry]

- SplitWords

suggest split words (e.g., 'is the' would be suggested as a replacement for 'isthe') [Sentry, Polderland]

- SuggestSplitWords

[Sentry]

- SuggestPhonetic

suggestions for misspelled words should include words which are typographically similar to the misspelled word [Sentry]

- SuggestTypographical

possessives of the form xxx's and xxxs' should be removed from words before checking their spelling [Sentry]

- StripPossessives

[Sentry]

- IgnoreNonAlphaWord

ignore domain names (e.g, xyz.com) [Sentry]

- IgnoreDomainNames

[Sentry]

- AllowAccentedCaps

[Sentry]

- CheckSingleWord

ignore HTML markups appearing in the text such as <HEAD>, </B>, &lt;, etc. [Sentry]

- IgnoreHtmlMarkups

ignore words that look like roman numerals [Polderland]

- IgnoreRomanNumerals

ignore words consisting of only a single letter [Polderland]

- IgnoreSingleLetters

also use user dictionaries for possible suggestions [Polderland]

- SuggestFromUserDict

score the likeliness of suggestions (1-255) with 255 is best [Polderland]

- ScoreSuggestions

don't capitalize suggs [Polderland]

- DontCapSuggs

no compose for verify [Polderland]

- NoComposeVerify

no composed suggs [Polderland]

- NoComposeSugg

-->

<CSApi>

</Spell>

</Spell>

</SpellConfig>

</CSApi>