|
699
|
1 *spell.txt* For Vim version 7.0aa. Last change: 2006 Mar 01
|
|
221
|
2
|
|
|
3
|
|
|
4 VIM REFERENCE MANUAL by Bram Moolenaar
|
|
|
5
|
|
|
6
|
|
|
7 Spell checking *spell*
|
|
|
8
|
|
|
9 1. Quick start |spell-quickstart|
|
|
378
|
10 2. Remarks on spell checking |spell-remarks|
|
|
|
11 3. Generating a spell file |spell-mkspell|
|
|
|
12 4. Spell file format |spell-file-format|
|
|
221
|
13
|
|
|
14 {Vi does not have any of these commands}
|
|
|
15
|
|
|
16 Spell checking is not available when the |+syntax| feature has been disabled
|
|
|
17 at compile time.
|
|
|
18
|
|
|
19 ==============================================================================
|
|
|
20 1. Quick start *spell-quickstart*
|
|
|
21
|
|
|
22 This command switches on spell checking: >
|
|
|
23
|
|
|
24 :setlocal spell spelllang=en_us
|
|
|
25
|
|
237
|
26 This switches on the 'spell' option and specifies to check for US English.
|
|
221
|
27
|
|
|
28 The words that are not recognized are highlighted with one of these:
|
|
333
|
29 SpellBad word not recognized |hl-SpellBad|
|
|
388
|
30 SpellCap word not capitalised |hl-SpellCap|
|
|
333
|
31 SpellRare rare word |hl-SpellRare|
|
|
|
32 SpellLocal wrong spelling for selected region |hl-SpellLocal|
|
|
221
|
33
|
|
237
|
34 Vim only checks words for spelling, there is no grammar check.
|
|
|
35
|
|
435
|
36 If the 'mousemodel' option is set to "popup" and the cursor is on a badly
|
|
|
37 spelled word or it is "popup_setpos" and the mouse pointer is on a badly
|
|
564
|
38 spelled word, then the popup menu will contain a submenu to replace the bad
|
|
435
|
39 word. Note: this slows down the appearance of the popup menu.
|
|
|
40
|
|
237
|
41 To search for the next misspelled word:
|
|
|
42
|
|
|
43 *]s* *E756*
|
|
|
44 ]s Move to next misspelled word after the cursor.
|
|
253
|
45 A count before the command can be used to repeat.
|
|
500
|
46 'wrapscan' applies.
|
|
237
|
47
|
|
|
48 *[s*
|
|
253
|
49 [s Like "]s" but search backwards, find the misspelled
|
|
348
|
50 word before the cursor. Doesn't recognize words
|
|
|
51 split over two lines, thus may stop at words that are
|
|
386
|
52 not highlighted as bad. Does not stop at word with
|
|
|
53 missing capital at the start of a line.
|
|
253
|
54
|
|
|
55 *]S*
|
|
|
56 ]S Like "]s" but only stop at bad words, not at rare
|
|
|
57 words or words for another region.
|
|
|
58
|
|
|
59 *[S*
|
|
|
60 [S Like "]S" but search backwards.
|
|
237
|
61
|
|
221
|
62
|
|
523
|
63 To add words to your own word list:
|
|
314
|
64
|
|
|
65 *zg*
|
|
386
|
66 zg Add word under the cursor as a good word to the first
|
|
501
|
67 name in 'spellfile'. A count may precede the command
|
|
|
68 to indicate the entry in 'spellfile' to be used. A
|
|
|
69 count of two uses the second entry.
|
|
|
70
|
|
|
71 In Visual mode the selected characters are added as a
|
|
|
72 word (including white space!).
|
|
|
73 When the cursor is on text that is marked as badly
|
|
|
74 spelled then the marked text is used.
|
|
|
75 Otherwise the word under the cursor, separated by
|
|
|
76 non-word characters, is used.
|
|
|
77
|
|
|
78 If the word is explicitly marked as bad word in
|
|
|
79 another spell file the result is unpredictable.
|
|
314
|
80
|
|
383
|
81 *zG*
|
|
386
|
82 zG Like "zg" but add the word to the internal word list
|
|
|
83 |internal-wordlist|.
|
|
383
|
84
|
|
314
|
85 *zw*
|
|
386
|
86 zw Like "zg" but mark the word as a wrong (bad) word.
|
|
314
|
87
|
|
383
|
88 *zW*
|
|
386
|
89 zW Like "zw" but add the word to the internal word list
|
|
|
90 |internal-wordlist|.
|
|
383
|
91
|
|
333
|
92 *:spe* *:spellgood*
|
|
386
|
93 :[count]spe[llgood] {word}
|
|
391
|
94 Add {word} as a good word to 'spellfile', like with
|
|
386
|
95 "zg". Without count the first name is used, with a
|
|
|
96 count of two the second entry, etc.
|
|
314
|
97
|
|
391
|
98 :spe[llgood]! {word} Add {word} as a good word to the internal word list,
|
|
386
|
99 like with "zG".
|
|
383
|
100
|
|
333
|
101 *:spellw* *:spellwrong*
|
|
386
|
102 :[count]spellw[rong] {word}
|
|
391
|
103 Add {word} as a wrong (bad) word to 'spellfile', as
|
|
386
|
104 with "zw". Without count the first name is used, with
|
|
|
105 a count of two the second entry, etc.
|
|
314
|
106
|
|
391
|
107 :spellw[rong]! {word} Add {word} as a wrong (bad) word to the internal word
|
|
383
|
108 list.
|
|
|
109
|
|
359
|
110 After adding a word to 'spellfile' with the above commands its associated
|
|
378
|
111 ".spl" file will automatically be updated and reloaded. If you change
|
|
|
112 'spellfile' manually you need to use the |:mkspell| command. This sequence of
|
|
|
113 commands mostly works well: >
|
|
386
|
114 :edit <file in 'spellfile'>
|
|
359
|
115 < (make changes to the spell file) >
|
|
|
116 :mkspell! %
|
|
|
117
|
|
|
118 More details about the 'spellfile' format below |spell-wordlist-format|.
|
|
314
|
119
|
|
386
|
120 *internal-wordlist*
|
|
383
|
121 The internal word list is used for all buffers where 'spell' is set. It is
|
|
|
122 not stored, it is lost when you exit Vim. It is also cleared when 'encoding'
|
|
|
123 is set.
|
|
|
124
|
|
314
|
125
|
|
323
|
126 Finding suggestions for bad words:
|
|
587
|
127 *z=*
|
|
|
128 z= For the word under/after the cursor suggest correctly
|
|
378
|
129 spelled words. This also works to find alternatives
|
|
|
130 for a word that is not highlighted as a bad word,
|
|
|
131 e.g., when the word after it is bad.
|
|
642
|
132 In Visual mode the highlighted text is taken as the
|
|
|
133 word to be replaced.
|
|
|
134 The results are sorted on similarity to the word being
|
|
|
135 replaced.
|
|
488
|
136 This may take a long time. Hit CTRL-C when you get
|
|
323
|
137 bored.
|
|
488
|
138
|
|
|
139 If the command is used without a count the
|
|
|
140 alternatives are listed and you can enter the number
|
|
|
141 of your choice or press <Enter> if you don't want to
|
|
|
142 replace. You can also use the mouse to click on your
|
|
|
143 choice (only works if the mouse can be used in Normal
|
|
|
144 mode and when there are no line wraps). Click on the
|
|
|
145 first line (the header) to cancel.
|
|
|
146
|
|
|
147 If a count is used that suggestion is used, without
|
|
587
|
148 prompting. For example, "1z=" always takes the first
|
|
488
|
149 suggestion.
|
|
|
150
|
|
|
151 If 'verbose' is non-zero a score will be displayed
|
|
|
152 with the suggestions to indicate the likeliness to the
|
|
|
153 badly spelled word (the higher the score the more
|
|
|
154 different).
|
|
344
|
155 When a word was replaced the redo command "." will
|
|
|
156 repeat the word replacement. This works like "ciw",
|
|
493
|
157 the good word and <Esc>. This does NOT work for Thai
|
|
|
158 and other languages without spaces between words.
|
|
344
|
159
|
|
374
|
160 *:spellr* *:spellrepall* *E752* *E753*
|
|
587
|
161 :spellr[epall] Repeat the replacement done by |z=| for all matches
|
|
374
|
162 with the replaced word in the current window.
|
|
|
163
|
|
477
|
164 In Insert mode, when the cursor is after a badly spelled word, you can use
|
|
|
165 CTRL-X s to find suggestions. This works like Insert mode completion. Use
|
|
|
166 CTRL-N to use the next suggestion, CTRL-P to go back. |i_CTRL-X_s|
|
|
|
167
|
|
344
|
168 The 'spellsuggest' option influences how the list of suggestions is generated
|
|
|
169 and sorted. See |'spellsuggest'|.
|
|
323
|
170
|
|
386
|
171 The 'spellcapcheck' option is used to check the first word of a sentence
|
|
|
172 starts with a capital. This doesn't work for the first word in the file.
|
|
|
173 When there is a line break right after a sentence the highlighting of the next
|
|
480
|
174 line may be postponed. Use |CTRL-L| when needed. Also see |set-spc-auto| for
|
|
|
175 how it can be set automatically when 'spelllang' is set.
|
|
386
|
176
|
|
625
|
177 Vim counts the number of times a good word is encountered. This is used to
|
|
|
178 sort the suggestions: words that have been seen before get a small bonus,
|
|
|
179 words that have been seen often get a bigger bonus. The COMMON item in the
|
|
|
180 affix file can be used to define common words, so that this mechanism also
|
|
|
181 works in a new or short file |spell-COMMON|.
|
|
|
182
|
|
378
|
183 ==============================================================================
|
|
|
184 2. Remarks on spell checking *spell-remarks*
|
|
323
|
185
|
|
227
|
186 PERFORMANCE
|
|
|
187
|
|
378
|
188 Vim does on-the-fly spell checking. To make this work fast the word list is
|
|
|
189 loaded in memory. Thus this uses a lot of memory (1 Mbyte or more). There
|
|
|
190 might also be a noticeable delay when the word list is loaded, which happens
|
|
|
191 when 'spell' is set and when 'spelllang' is set while 'spell' was already set.
|
|
|
192 To minimize the delay each word list is only loaded once, it is not deleted
|
|
|
193 when 'spelllang' is made empty or 'spell' is reset. When 'encoding' is set
|
|
|
194 all the word lists are reloaded, thus you may notice a delay then too.
|
|
227
|
195
|
|
|
196
|
|
221
|
197 REGIONS
|
|
|
198
|
|
|
199 A word may be spelled differently in various regions. For example, English
|
|
|
200 comes in (at least) these variants:
|
|
|
201
|
|
|
202 en all regions
|
|
247
|
203 en_au Australia
|
|
|
204 en_ca Canada
|
|
221
|
205 en_gb Great Britain
|
|
247
|
206 en_nz New Zealand
|
|
|
207 en_us USA
|
|
221
|
208
|
|
|
209 Words that are not used in one region but are used in another region are
|
|
333
|
210 highlighted with SpellLocal |hl-SpellLocal|.
|
|
221
|
211
|
|
237
|
212 Always use lowercase letters for the language and region names.
|
|
221
|
213
|
|
320
|
214 When adding a word with |zg| or another command it's always added for all
|
|
|
215 regions. You can change that by manually editing the 'spellfile'. See
|
|
389
|
216 |spell-wordlist-format|. Note that the regions as specified in the files in
|
|
564
|
217 'spellfile' are only used when all entries in 'spelllang' specify the same
|
|
389
|
218 region (not counting files specified by their .spl name).
|
|
320
|
219
|
|
482
|
220 *spell-german*
|
|
481
|
221 Specific exception: For German these special regions are used:
|
|
|
222 de all German words accepted
|
|
|
223 de_de old and new spelling
|
|
|
224 de_19 old spelling
|
|
|
225 de_20 new spelling
|
|
|
226 de_at Austria
|
|
|
227 de_ch Switzerland
|
|
|
228
|
|
504
|
229 *spell-russian*
|
|
|
230 Specific exception: For Russian these special regions are used:
|
|
|
231 ru all Russian words accepted
|
|
|
232 ru_ru "IE" letter spelling
|
|
|
233 ru_yo "YO" letter spelling
|
|
|
234
|
|
482
|
235 *spell-yiddish*
|
|
|
236 Yiddish requires using "utf-8" encoding, because of the special characters
|
|
|
237 used. If you are using latin1 Vim will use transliterated (romanized) Yiddish
|
|
|
238 instead. If you want to use transliterated Yiddish with utf-8 use "yi-tr".
|
|
|
239 In a table:
|
|
|
240 'encoding' 'spelllang'
|
|
|
241 utf-8 yi Yiddish
|
|
|
242 latin1 yi transliterated Yiddish
|
|
|
243 utf-8 yi-tr transliterated Yiddish
|
|
|
244
|
|
221
|
245
|
|
353
|
246 SPELL FILES *spell-load*
|
|
221
|
247
|
|
|
248 Vim searches for spell files in the "spell" subdirectory of the directories in
|
|
320
|
249 'runtimepath'. The name is: LL.EEE.spl, where:
|
|
237
|
250 LL the language name
|
|
|
251 EEE the value of 'encoding'
|
|
221
|
252
|
|
353
|
253 The value for "LL" comes from 'spelllang', but excludes the region name.
|
|
|
254 Examples:
|
|
|
255 'spelllang' LL ~
|
|
|
256 en_us en
|
|
|
257 en-rare en-rare
|
|
|
258 medical_ca medical
|
|
|
259
|
|
320
|
260 Only the first file is loaded, the one that is first in 'runtimepath'. If
|
|
|
261 this succeeds then additionally files with the name LL.EEE.add.spl are loaded.
|
|
|
262 All the ones that are found are used.
|
|
|
263
|
|
651
|
264 If no spell file is found the |SpellFileMissing| autocommand event is
|
|
|
265 triggered. This may trigger the |spellfile.vim| plugin to offer you
|
|
|
266 downloading the spell file.
|
|
|
267
|
|
386
|
268 Additionally, the files related to the names in 'spellfile' are loaded. These
|
|
|
269 are the files that |zg| and |zw| add good and wrong words to.
|
|
353
|
270
|
|
242
|
271 Exceptions:
|
|
|
272 - Vim uses "latin1" when 'encoding' is "iso-8859-15". The euro sign doesn't
|
|
|
273 matter for spelling.
|
|
|
274 - When no spell file for 'encoding' is found "ascii" is tried. This only
|
|
|
275 works for languages where nearly all words are ASCII, such as English. It
|
|
|
276 helps when 'encoding' is not "latin1", such as iso-8859-2, and English text
|
|
320
|
277 is being edited. For the ".add" files the same name as the found main
|
|
|
278 spell file is used.
|
|
|
279
|
|
|
280 For example, with these values:
|
|
|
281 'runtimepath' is "~/.vim,/usr/share/vim70,~/.vim/after"
|
|
|
282 'encoding' is "iso-8859-2"
|
|
|
283 'spelllang' is "pl"
|
|
|
284
|
|
|
285 Vim will look for:
|
|
|
286 1. ~/.vim/spell/pl.iso-8859-2.spl
|
|
|
287 2. /usr/share/vim70/spell/pl.iso-8859-2.spl
|
|
|
288 3. ~/.vim/spell/pl.iso-8859-2.add.spl
|
|
|
289 4. /usr/share/vim70/spell/pl.iso-8859-2.add.spl
|
|
|
290 5. ~/.vim/after/spell/pl.iso-8859-2.add.spl
|
|
|
291
|
|
|
292 This assumes 1. is not found and 2. is found.
|
|
|
293
|
|
|
294 If 'encoding' is "latin1" Vim will look for:
|
|
|
295 1. ~/.vim/spell/pl.latin1.spl
|
|
|
296 2. /usr/share/vim70/spell/pl.latin1.spl
|
|
|
297 3. ~/.vim/after/spell/pl.latin1.spl
|
|
|
298 4. ~/.vim/spell/pl.ascii.spl
|
|
|
299 5. /usr/share/vim70/spell/pl.ascii.spl
|
|
|
300 6. ~/.vim/after/spell/pl.ascii.spl
|
|
|
301
|
|
|
302 This assumes none of them are found (Polish doesn't make sense when leaving
|
|
|
303 out the non-ASCII characters).
|
|
221
|
304
|
|
227
|
305 Spelling for EBCDIC is currently not supported.
|
|
|
306
|
|
237
|
307 A spell file might not be available in the current 'encoding'. See
|
|
|
308 |spell-mkspell| about how to create a spell file. Converting a spell file
|
|
242
|
309 with "iconv" will NOT work!
|
|
221
|
310
|
|
626
|
311 *spell-sug-file* *E781*
|
|
625
|
312 If there is a file with exactly the same name as the ".spl" file but ending in
|
|
|
313 ".sug", that file will be used for giving better suggestions. It isn't loaded
|
|
|
314 before suggestions are made to reduce memory use.
|
|
|
315
|
|
626
|
316 *E758* *E759* *E778* *E779* *E780* *E782*
|
|
237
|
317 When loading a spell file Vim checks that it is properly formatted. If you
|
|
242
|
318 get an error the file may be truncated, modified or intended for another Vim
|
|
|
319 version.
|
|
237
|
320
|
|
227
|
321
|
|
|
322 WORDS
|
|
|
323
|
|
|
324 Vim uses a fixed method to recognize a word. This is independent of
|
|
|
325 'iskeyword', so that it also works in help files and for languages that
|
|
|
326 include characters like '-' in 'iskeyword'. The word characters do depend on
|
|
|
327 'encoding'.
|
|
|
328
|
|
323
|
329 The table with word characters is stored in the main .spl file. Therefore it
|
|
|
330 matters what the current locale is when generating it! A .add.spl file does
|
|
359
|
331 not contain a word table though.
|
|
323
|
332
|
|
320
|
333 A word that starts with a digit is always ignored. That includes hex numbers
|
|
|
334 in the form 0xff and 0XFF.
|
|
227
|
335
|
|
|
336
|
|
348
|
337 WORD COMBINATIONS
|
|
|
338
|
|
|
339 It is possible to spell-check words that include a space. This is used to
|
|
|
340 recognize words that are invalid when used by themselves, e.g. for "et al.".
|
|
|
341 It can also be used to recognize "the the" and highlight it.
|
|
|
342
|
|
|
343 The number of spaces is irrelevant. In most cases a line break may also
|
|
|
344 appear. However, this makes it difficult to find out where to start checking
|
|
|
345 for spelling mistakes. When you make a change to one line and only that line
|
|
|
346 is redrawn Vim won't look in the previous line, thus when "et" is at the end
|
|
|
347 of the previous line "al." will be flagged as an error. And when you type
|
|
|
348 "the<CR>the" the highlighting doesn't appear until the first line is redrawn.
|
|
|
349 Use |CTRL-L| to redraw right away. "[s" will also stop at a word combination
|
|
|
350 with a line break.
|
|
|
351
|
|
|
352 When encountering a line break Vim skips characters such as '*', '>' and '"',
|
|
|
353 so that comments in C, shell and Vim code can be spell checked.
|
|
|
354
|
|
|
355
|
|
253
|
356 SYNTAX HIGHLIGHTING *spell-syntax*
|
|
227
|
357
|
|
|
358 Files that use syntax highlighting can specify where spell checking should be
|
|
|
359 done:
|
|
|
360
|
|
320
|
361 1. everywhere default
|
|
|
362 2. in specific items use "contains=@Spell"
|
|
|
363 3. everywhere but specific items use "contains=@NoSpell"
|
|
227
|
364
|
|
320
|
365 For the second method adding the @NoSpell cluster will disable spell checking
|
|
|
366 again. This can be used, for example, to add @Spell to the comments of a
|
|
|
367 program, and add @NoSpell for items that shouldn't be checked.
|
|
227
|
368
|
|
348
|
369
|
|
|
370 VIM SCRIPTS
|
|
|
371
|
|
|
372 If you want to write a Vim script that does something with spelling, you may
|
|
|
373 find these functions useful:
|
|
|
374
|
|
|
375 spellbadword() find badly spelled word at the cursor
|
|
|
376 spellsuggest() get list of spelling suggestions
|
|
378
|
377 soundfold() get the sound-a-like version of a word
|
|
348
|
378
|
|
480
|
379
|
|
|
380 SETTING 'spellcapcheck' AUTOMATICALLY *set-spc-auto*
|
|
|
381
|
|
|
382 After the 'spelllang' option has been set successfully, Vim will source the
|
|
|
383 files "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
|
|
|
384 up to the first comma, dot or underscore. This can be used to set options
|
|
|
385 specifically for the language, especially 'spellcapcheck'.
|
|
|
386
|
|
|
387 The distribution includes a few of these files. Use this command to see what
|
|
|
388 they do: >
|
|
|
389 :next $VIMRUNTIME/spell/*.vim
|
|
|
390
|
|
|
391 Note that the default scripts don't set 'spellcapcheck' if it was changed from
|
|
|
392 the default value. This assumes the user prefers another value then.
|
|
|
393
|
|
481
|
394
|
|
|
395 DOUBLE SCORING *spell-double-scoring*
|
|
|
396
|
|
|
397 The 'spellsuggest' option can be used to select "double" scoring. This
|
|
|
398 mechanism is based on the principle that there are two kinds of spelling
|
|
|
399 mistakes:
|
|
|
400
|
|
|
401 1. You know how to spell the word, but mistype something. This results in a
|
|
|
402 small editing distance (character swapped/omitted/inserted) and possibly a
|
|
|
403 word that sounds completely different.
|
|
|
404
|
|
|
405 2. You don't know how to spell the word and type something that sounds right.
|
|
|
406 The edit distance can be big but the word is similar after sound-folding.
|
|
|
407
|
|
|
408 Since scores for these two mistakes will be very different we use a list
|
|
|
409 for each and mix them.
|
|
|
410
|
|
|
411 The sound-folding is slow and people that know the language won't make the
|
|
|
412 second kind of mistakes. Therefore 'spellsuggest' can be set to select the
|
|
|
413 preferred method for scoring the suggestions.
|
|
|
414
|
|
221
|
415 ==============================================================================
|
|
378
|
416 3. Generating a spell file *spell-mkspell*
|
|
237
|
417
|
|
|
418 Vim uses a binary file format for spelling. This greatly speeds up loading
|
|
|
419 the word list and keeps it small.
|
|
371
|
420 *.aff* *.dic* *Myspell*
|
|
237
|
421 You can create a Vim spell file from the .aff and .dic files that Myspell
|
|
|
422 uses. Myspell is used by OpenOffice.org and Mozilla. You should be able to
|
|
|
423 find them here:
|
|
|
424 http://lingucomponent.openoffice.org/spell_dic.html
|
|
348
|
425 You can also use a plain word list. The results are the same, the choice
|
|
378
|
426 depends on what word lists you can find.
|
|
221
|
427
|
|
388
|
428 If you install Aap (from www.a-a-p.org) you can use the recipes in the
|
|
|
429 runtime/spell/??/ directories. Aap will take care of downloading the files,
|
|
|
430 apply patches needed for Vim and build the .spl file.
|
|
|
431
|
|
341
|
432 Make sure your current locale is set properly, otherwise Vim doesn't know what
|
|
|
433 characters are upper/lower case letters. If the locale isn't available (e.g.,
|
|
|
434 when using an MS-Windows codepage on Unix) add tables to the .aff file
|
|
353
|
435 |spell-affix-chars|. If the .aff file doesn't define a table then the word
|
|
|
436 table of the currently active spelling is used. If spelling is not active
|
|
|
437 then Vim will try to guess.
|
|
341
|
438
|
|
353
|
439 *:mksp* *:mkspell*
|
|
|
440 :mksp[ell][!] [-ascii] {outname} {inname} ...
|
|
564
|
441 Generate a Vim spell file from word lists. Example: >
|
|
378
|
442 :mkspell /tmp/nl nl_NL.words
|
|
353
|
443 < *E751*
|
|
314
|
444 When {outname} ends in ".spl" it is used as the output
|
|
|
445 file name. Otherwise it should be a language name,
|
|
353
|
446 such as "en", without the region name. The file
|
|
|
447 written will be "{outname}.{encoding}.spl", where
|
|
|
448 {encoding} is the value of the 'encoding' option.
|
|
301
|
449
|
|
378
|
450 When the output file already exists [!] must be used
|
|
333
|
451 to overwrite it.
|
|
|
452
|
|
242
|
453 When the [-ascii] argument is present, words with
|
|
|
454 non-ascii characters are skipped. The resulting file
|
|
314
|
455 ends in "ascii.spl".
|
|
301
|
456
|
|
|
457 The input can be the Myspell format files {inname}.aff
|
|
|
458 and {inname}.dic. If {inname}.aff does not exist then
|
|
|
459 {inname} is used as the file name of a plain word
|
|
|
460 list.
|
|
|
461
|
|
237
|
462 Multiple {inname} arguments can be given to combine
|
|
|
463 regions into one Vim spell file. Example: >
|
|
|
464 :mkspell ~/.vim/spell/en /tmp/en_US /tmp/en_CA /tmp/en_AU
|
|
|
465 < This combines the English word lists for US, CA and AU
|
|
|
466 into one en.spl file.
|
|
|
467 Up to eight regions can be combined. *E754* *755*
|
|
323
|
468 The REP and SAL items of the first .aff file where
|
|
493
|
469 they appear are used. |spell-REP| |spell-SAL|
|
|
237
|
470
|
|
348
|
471 This command uses a lot of memory, required to find
|
|
484
|
472 the optimal word tree (Polish, Italian and Hungarian
|
|
|
473 require several hundred Mbyte). The final result will
|
|
|
474 be much smaller, because compression is used. To
|
|
|
475 avoid running out of memory compression will be done
|
|
|
476 now and then. This can be tuned with the 'mkspellmem'
|
|
|
477 option.
|
|
348
|
478
|
|
378
|
479 After the spell file was written and it was being used
|
|
|
480 in a buffer it will be reloaded automatically.
|
|
308
|
481
|
|
371
|
482 :mksp[ell] [-ascii] {name}.{enc}.add
|
|
|
483 Like ":mkspell" above, using {name}.{enc}.add as the
|
|
378
|
484 input file and producing an output file in the same
|
|
|
485 directory that has ".spl" appended.
|
|
371
|
486
|
|
|
487 :mksp[ell] [-ascii] {name}
|
|
|
488 Like ":mkspell" above, using {name} as the input file
|
|
378
|
489 and producing an output file in the same directory
|
|
|
490 that has ".{enc}.spl" appended.
|
|
314
|
491
|
|
481
|
492 Vim will report the number of duplicate words. This might be a mistake in the
|
|
|
493 list of words. But sometimes it is used to have different prefixes and
|
|
|
494 suffixes for the same basic word to avoid them combining (e.g. Czech uses
|
|
484
|
495 this). If you want Vim to report all duplicate words set the 'verbose'
|
|
|
496 option.
|
|
481
|
497
|
|
314
|
498 Since you might want to change a Myspell word list for use with Vim the
|
|
|
499 following procedure is recommended:
|
|
237
|
500
|
|
|
501 1. Obtain the xx_YY.aff and xx_YY.dic files from Myspell.
|
|
|
502 2. Make a copy of these files to xx_YY.orig.aff and xx_YY.orig.dic.
|
|
|
503 3. Change the xx_YY.aff and xx_YY.dic files to remove bad words, add missing
|
|
258
|
504 words, define word characters with FOL/LOW/UPP, etc. The distributed
|
|
|
505 "src/spell/*.diff" files can be used.
|
|
378
|
506 4. Start Vim with the right locale and use |:mkspell| to generate the Vim
|
|
|
507 spell file.
|
|
|
508 5. Try out the spell file with ":set spell spelllang=xx" if you wrote it in
|
|
388
|
509 a spell directory in 'runtimepath', or ":set spelllang=xx.enc.spl" if you
|
|
378
|
510 wrote it somewhere else.
|
|
221
|
511
|
|
237
|
512 When the Myspell files are updated you can merge the differences:
|
|
258
|
513 1. Obtain the new Myspell files as xx_YY.new.aff and xx_UU.new.dic.
|
|
|
514 2. Use Vimdiff to see what changed: >
|
|
237
|
515 vimdiff xx_YY.orig.dic xx_YY.new.dic
|
|
258
|
516 3. Take over the changes you like in xx_YY.dic.
|
|
237
|
517 You may also need to change xx_YY.aff.
|
|
258
|
518 4. Rename xx_YY.new.dic to xx_YY.orig.dic and xx_YY.new.aff to xx_YY.new.aff.
|
|
237
|
519
|
|
353
|
520
|
|
484
|
521 SPELL FILE VERSIONS *E770* *E771* *E772*
|
|
|
522
|
|
|
523 Spell checking is a relatively new feature in Vim, thus it's possible that the
|
|
|
524 .spl file format will be changed to support more languages. Vim will check
|
|
|
525 the validity of the spell file and report anything wrong.
|
|
|
526
|
|
|
527 E771: Old spell file, needs to be updated ~
|
|
|
528 This spell file is older than your Vim. You need to update the .spl file.
|
|
|
529
|
|
|
530 E772: Spell file is for newer version of Vim ~
|
|
|
531 This means the spell file was made for a later version of Vim. You need to
|
|
|
532 update Vim.
|
|
|
533
|
|
|
534 E770: Unsupported section in spell file ~
|
|
|
535 This means the spell file was made for a later version of Vim and contains a
|
|
|
536 section that is required for the spell file to work. In this case it's
|
|
|
537 probably a good idea to upgrade your Vim.
|
|
|
538
|
|
|
539
|
|
353
|
540 SPELL FILE DUMP
|
|
|
541
|
|
|
542 If for some reason you want to check what words are supported by the currently
|
|
|
543 used spelling files, use this command:
|
|
|
544
|
|
|
545 *:spelldump* *:spelld*
|
|
|
546 :spelld[ump] Open a new window and fill it with all currently valid
|
|
500
|
547 words. Compound words are not included.
|
|
378
|
548 Note: For some languages the result may be enormous,
|
|
|
549 causing Vim to run out of memory.
|
|
353
|
550
|
|
625
|
551 :spelld[ump]! Like ":spelldump" and include the word count. This is
|
|
|
552 the number of times the word was found while
|
|
|
553 updating the screen. Words that are in COMMON items
|
|
|
554 get a starting count of 10.
|
|
|
555
|
|
353
|
556 The format of the word list is used |spell-wordlist-format|. You should be
|
|
|
557 able to read it with ":mkspell" to generate one .spl file that includes all
|
|
|
558 the words.
|
|
|
559
|
|
383
|
560 When all entries to 'spelllang' use the same regions or no regions at all then
|
|
|
561 the region information is included in the dumped words. Otherwise only words
|
|
|
562 for the current region are included and no "/regions" line is generated.
|
|
353
|
563
|
|
378
|
564 Comment lines with the name of the .spl file are used as a header above the
|
|
|
565 words that were generated from that .spl file.
|
|
353
|
566
|
|
651
|
567
|
|
|
568 SPELL FILE MISSING *spell-SpellFileMissing* *spellfile.vim*
|
|
|
569
|
|
|
570 If the spell file for the language you are using is not available, you will
|
|
|
571 get an error message. But if the "spellfile.vim" plugin is active it will
|
|
|
572 offer you to download the spell file. Just follow the instructions, it will
|
|
|
573 ask you where to write the file.
|
|
|
574
|
|
|
575 The plugin has a default place where to look for spell files, on the Vim ftp
|
|
|
576 server. If you want to use another location or another protocol, set the
|
|
|
577 g:spellfile_URL variable to the directory that holds the spell files. The
|
|
|
578 |netrw| plugin is used for getting the file, look there for the speficic
|
|
|
579 syntax of the URL. Example: >
|
|
|
580 let g:spellfile_URL = 'http://ftp.vim.org/vim/runtime/spell'
|
|
|
581 You may need to escape special characters.
|
|
|
582
|
|
|
583 The plugin will only ask about downloading a language once. If you want to
|
|
|
584 try again anyway restart Vim, or set g:spellfile_URL to another value (e.g.,
|
|
|
585 prepend a space).
|
|
|
586
|
|
|
587 To avoid using the "spellfile.vim" plugin do this in your vimrc file: >
|
|
|
588
|
|
|
589 let loaded_spellfile_plugin = 1
|
|
|
590
|
|
|
591 Instead of using the plugin you can define a |SpellFileMissing| autocommand to
|
|
|
592 handle the missing file yourself. You can use it like this: >
|
|
|
593
|
|
|
594 :au SpellFileMissing * call Download_spell_file(expand('<amatch>'))
|
|
|
595
|
|
|
596 Thus the <amatch> item contains the name of the language. Another important
|
|
|
597 value is 'encoding', since every encoding has its own spell file. With two
|
|
|
598 exceptions:
|
|
|
599 - For ISO-8859-15 (latin9) the name "latin1" is used (the encodings only
|
|
|
600 differ in characters not used in dictionary words).
|
|
|
601 - The name "ascii" may also be used for some languages where the words use
|
|
|
602 only ASCII letters for most of the words.
|
|
|
603
|
|
|
604 The default "spellfile.vim" plugin uses this autocommand, if you define your
|
|
|
605 autocommand afterwars you may want to use ":au! SpellFileMissing" to overrule
|
|
|
606 it. If you define your autocommand before the plugin is loaded it will notice
|
|
|
607 this and not do anything.
|
|
|
608
|
|
237
|
609 ==============================================================================
|
|
378
|
610 4. Spell file format *spell-file-format*
|
|
237
|
611
|
|
|
612 This is the format of the files that are used by the person who creates and
|
|
|
613 maintains a word list.
|
|
221
|
614
|
|
237
|
615 Note that we avoid the word "dictionary" here. That is because the goal of
|
|
|
616 spell checking differs from writing a dictionary (as in the book). For
|
|
564
|
617 spelling we need a list of words that are OK, thus should not be highlighted.
|
|
|
618 Person and company names will not appear in a dictionary, but do appear in a
|
|
|
619 word list. And some old words are rarely used while they are common
|
|
|
620 misspellings. These do appear in a dictionary but not in a word list.
|
|
237
|
621
|
|
388
|
622 There are two formats: A straight list of words and a list using affix
|
|
378
|
623 compression. The files with affix compression are used by Myspell (Mozilla
|
|
|
624 and OpenOffice.org). This requires two files, one with .aff and one with .dic
|
|
|
625 extension.
|
|
301
|
626
|
|
|
627
|
|
378
|
628 FORMAT OF STRAIGHT WORD LIST *spell-wordlist-format*
|
|
301
|
629
|
|
314
|
630 The words must appear one per line. That is all that is required.
|
|
378
|
631
|
|
314
|
632 Additionally the following items are recognized:
|
|
378
|
633
|
|
301
|
634 - Empty and blank lines are ignored.
|
|
378
|
635
|
|
625
|
636 # comment ~
|
|
301
|
637 - Lines starting with a # are ignored (comment lines).
|
|
378
|
638
|
|
625
|
639 /encoding=utf-8 ~
|
|
308
|
640 - A line starting with "/encoding=", before any word, specifies the encoding
|
|
|
641 of the file. After the second '=' comes an encoding name. This tells Vim
|
|
378
|
642 to setup conversion from the specified encoding to 'encoding'. Thus you can
|
|
|
643 use one word list for several target encodings.
|
|
|
644
|
|
625
|
645 /regions=usca ~
|
|
320
|
646 - A line starting with "/regions=" specifies the region names that are
|
|
|
647 supported. Each region name must be two ASCII letters. The first one is
|
|
|
648 region 1. Thus "/regions=usca" has region 1 "us" and region 2 "ca".
|
|
378
|
649 In an addition word list the region names should be equal to the main word
|
|
|
650 list!
|
|
|
651
|
|
314
|
652 - Other lines starting with '/' are reserved for future use. The ones that
|
|
625
|
653 are not recognized are ignored. You do get a warning message, so that you
|
|
|
654 know something won't work.
|
|
301
|
655
|
|
383
|
656 - A "/" may follow the word with the following items:
|
|
|
657 = Case must match exactly.
|
|
|
658 ? Rare word.
|
|
|
659 ! Bad (wrong) word.
|
|
|
660 digit A region in which the word is valid. If no regions are
|
|
|
661 specified the word is valid in all regions.
|
|
|
662
|
|
320
|
663 Example:
|
|
|
664
|
|
|
665 # This is an example word list comment
|
|
|
666 /encoding=latin1 encoding of the file
|
|
|
667 /regions=uscagb regions "us", "ca" and "gb"
|
|
|
668 example word for all regions
|
|
383
|
669 blah/12 word for regions "us" and "ca"
|
|
|
670 vim/! bad word
|
|
|
671 Campbell/?3 rare word in region 3 "gb"
|
|
|
672 's mornings/= keep-case word
|
|
320
|
673
|
|
389
|
674 Note that when "/=" is used the same word with all upper-case letters is not
|
|
|
675 accepted. This is different from a word with mixed case that is automatically
|
|
|
676 marked as keep-case, those words may appear in all upper-case letters.
|
|
|
677
|
|
301
|
678
|
|
625
|
679 FORMAT WITH .AFF and .DIC FILES
|
|
301
|
680
|
|
625
|
681 There are two files: the basic word list and an affix file. The affix file
|
|
|
682 specifies settings for the language and can contain affixes. The affixes are
|
|
237
|
683 used to modify the basic words to get the full word list. This significantly
|
|
|
684 reduces the number of words, especially for a language like Polish. This is
|
|
|
685 called affix compression.
|
|
221
|
686
|
|
625
|
687 The basic word list and the affix file are combined with the ":mkspell"
|
|
|
688 command and results in a binary spell file. All the preprocessing has been
|
|
|
689 done, thus this file loads fast. The binary spell file format is described in
|
|
|
690 the source code (src/spell.c). But only developers need to know about it.
|
|
221
|
691
|
|
237
|
692 The preprocessing also allows us to take the Myspell language files and modify
|
|
|
693 them before the Vim word list is made. The tools for this can be found in the
|
|
|
694 "src/spell" directory.
|
|
|
695
|
|
493
|
696 The format for the affix and word list files is based on what Myspell uses
|
|
|
697 (the spell checker of Mozilla and OpenOffice.org). A description can be found
|
|
|
698 here:
|
|
|
699 http://lingucomponent.openoffice.org/affix.readme ~
|
|
|
700 Note that affixes are case sensitive, this isn't obvious from the description.
|
|
|
701
|
|
|
702 Vim supports quite a few extras. They are described below |spell-affix-vim|.
|
|
|
703 Attempts have been made to keep this compatible with other spell checkers, so
|
|
625
|
704 that the same files can often be used. One other project that offers more
|
|
|
705 than Myspell is Hunspell ( http://hunspell.sf.net ).
|
|
493
|
706
|
|
237
|
707
|
|
320
|
708 WORD LIST FORMAT *spell-dic-format*
|
|
237
|
709
|
|
625
|
710 A short example, with line numbers:
|
|
221
|
711
|
|
625
|
712 1 1234 ~
|
|
|
713 2 aan ~
|
|
|
714 3 Als ~
|
|
|
715 4 Etten-Leur ~
|
|
|
716 5 et al. ~
|
|
|
717 6 's-Gravenhage ~
|
|
|
718 7 's-Gravenhaags ~
|
|
|
719 8 # word that differs between regions ~
|
|
|
720 9 kado/1 ~
|
|
|
721 10 cadeau/2 ~
|
|
|
722 11 TCP,IP ~
|
|
|
723 12 /the S affix may add a 's' ~
|
|
|
724 13 bedel/S ~
|
|
237
|
725
|
|
314
|
726 The first line contains the number of words. Vim ignores it, but you do get
|
|
|
727 an error message if it's not there. *E760*
|
|
221
|
728
|
|
625
|
729 What follows is one word per line. White space at the end of the line is
|
|
|
730 ignored, all other white space matters. The encoding is specified in the
|
|
|
731 affix file |spell-SET|.
|
|
|
732
|
|
|
733 Comment lines start with '#' or '/'. See the example lines 8 and 12. Note
|
|
|
734 that putting a comment after a word is NOT allowed:
|
|
|
735
|
|
|
736 someword # comment that causes an error! ~
|
|
|
737
|
|
|
738 After the word there is an optional slash and flags. Most of these flags are
|
|
|
739 letters that indicate the affixes that can be used with this word. These are
|
|
|
740 specified with SFX and PFX lines in the .aff file, see |spell-SFX| and
|
|
|
741 |spell-PFX|. Vim allows using other flag types with the FLAG item in the
|
|
|
742 affix file |spell-FLAG|.
|
|
237
|
743
|
|
|
744 When the word only has lower-case letters it will also match with the word
|
|
|
745 starting with an upper-case letter.
|
|
|
746
|
|
|
747 When the word includes an upper-case letter, this means the upper-case letter
|
|
|
748 is required at this position. The same word with a lower-case letter at this
|
|
|
749 position will not match. When some of the other letters are upper-case it will
|
|
|
750 not match either.
|
|
|
751
|
|
625
|
752 The word with all upper-case characters will always be OK,
|
|
221
|
753
|
|
237
|
754 word list matches does not match ~
|
|
|
755 als als Als ALS ALs AlS aLs aLS
|
|
|
756 Als Als ALS als ALs AlS aLs aLS
|
|
|
757 ALS ALS als Als ALs AlS aLs aLS
|
|
|
758 AlS AlS ALS als Als ALs aLs aLS
|
|
221
|
759
|
|
624
|
760 The KEEPCASE affix ID can be used to specifically match a word with identical
|
|
|
761 case only, see below |spell-KEEPCASE|.
|
|
308
|
762
|
|
625
|
763 Note: in line 5 to 7 non-word characters are used. You can include any
|
|
|
764 character in a word. When checking the text a word still only matches when it
|
|
|
765 appears with a non-word character before and after it. For Myspell a word
|
|
|
766 starting with a non-word character probably won't work.
|
|
237
|
767
|
|
493
|
768 In line 12 the word "TCP/IP" is defined. Since the slash has a special
|
|
|
769 meaning the comma is used instead. This is defined with the SLASH item in the
|
|
625
|
770 affix file, see |spell-SLASH|. Note that without this SLASH item the word
|
|
|
771 will be "TCP,IP".
|
|
|
772
|
|
|
773
|
|
|
774 AFFIX FILE FORMAT *spell-aff-format* *spell-affix-vim*
|
|
493
|
775
|
|
625
|
776 *spell-affix-comment*
|
|
|
777 Comment lines in the .aff file start with a '#':
|
|
|
778
|
|
|
779 # comment line ~
|
|
|
780
|
|
|
781 With some items it's also possible to put a comment after it, but this isn't
|
|
|
782 supported in general.
|
|
|
783
|
|
|
784
|
|
|
785 ENCODING *spell-SET*
|
|
237
|
786
|
|
625
|
787 The affix file can be in any encoding that is supported by "iconv". However,
|
|
|
788 in some cases the current locale should also be set properly at the time
|
|
|
789 |:mkspell| is invoked. Adding FOL/LOW/UPP lines removes this requirement
|
|
|
790 |spell-FOL|.
|
|
389
|
791
|
|
625
|
792 The encoding should be specified before anything where the encoding matters.
|
|
|
793 The encoding applies both to the affix file and the dictionary file. It is
|
|
|
794 done with a SET line:
|
|
221
|
795
|
|
625
|
796 SET utf-8 ~
|
|
|
797
|
|
|
798 The encoding can be different from the value of the 'encoding' option at the
|
|
|
799 time ":mkspell" is used. Vim will then convert everything to 'encoding' and
|
|
|
800 generate a spell file for 'encoding'. If some of the used characters to not
|
|
|
801 fit in 'encoding' you will get an error message.
|
|
237
|
802 *spell-affix-mbyte*
|
|
625
|
803 When using a multi-byte encoding it's possible to use more different affix
|
|
|
804 flags. But Myspell doesn't support that, thus you may not want to use it
|
|
|
805 anyway. For compatibility use an 8-bit encoding.
|
|
221
|
806
|
|
341
|
807
|
|
|
808 CHARACTER TABLES
|
|
258
|
809 *spell-affix-chars*
|
|
314
|
810 When using an 8-bit encoding the affix file should define what characters are
|
|
625
|
811 word characters. This is because the system where ":mkspell" is used may not
|
|
|
812 support a locale with this encoding and isalpha() won't work. For example
|
|
|
813 when using "cp1250" on Unix.
|
|
493
|
814 *E761* *E762* *spell-FOL*
|
|
|
815 *spell-LOW* *spell-UPP*
|
|
258
|
816 Three lines in the affix file are needed. Simplistic example:
|
|
|
817
|
|
341
|
818 FOL áëñ ~
|
|
|
819 LOW áëñ ~
|
|
|
820 UPP ÁËÑ ~
|
|
258
|
821
|
|
|
822 All three lines must have exactly the same number of characters.
|
|
|
823
|
|
|
824 The "FOL" line specifies the case-folded characters. These are used to
|
|
|
825 compare words while ignoring case. For most encodings this is identical to
|
|
|
826 the lower case line.
|
|
|
827
|
|
|
828 The "LOW" line specifies the characters in lower-case. Mostly it's equal to
|
|
|
829 the "FOL" line.
|
|
|
830
|
|
|
831 The "UPP" line specifies the characters with upper-case. That is, a character
|
|
|
832 is upper-case where it's different from the character at the same position in
|
|
|
833 "FOL".
|
|
|
834
|
|
493
|
835 An exception is made for the German sharp s ß. The upper-case version is
|
|
|
836 "SS". In the FOL/LOW/UPP lines it should be included, so that it's recognized
|
|
|
837 as a word character, but use the ß character in all three.
|
|
|
838
|
|
258
|
839 ASCII characters should be omitted, Vim always handles these in the same way.
|
|
|
840 When the encoding is UTF-8 no word characters need to be specified.
|
|
|
841
|
|
|
842 *E763*
|
|
353
|
843 Vim allows you to use spell checking for several languages in the same file.
|
|
|
844 You can list them in the 'spelllang' option. As a consequence all spell files
|
|
|
845 for the same encoding must use the same word characters, otherwise they can't
|
|
|
846 be combined without errors. If you get a warning that the word tables differ
|
|
|
847 you may need to generate the .spl file again with |:mkspell|. Check the FOL,
|
|
|
848 LOW and UPP lines in the used .aff file.
|
|
|
849
|
|
|
850 The XX.ascii.spl spell file generated with the "-ascii" argument will not
|
|
|
851 contain the table with characters, so that it can be combine with spell files
|
|
|
852 for any encoding. The .add.spl files also do not contain the table.
|
|
258
|
853
|
|
341
|
854
|
|
371
|
855 MID-WORD CHARACTERS
|
|
|
856 *spell-midword*
|
|
|
857 Some characters are only to be considered word characters if they are used in
|
|
|
858 between two ordinary word characters. An example is the single quote: It is
|
|
|
859 often used to put text in quotes, thus it can't be recognized as a word
|
|
|
860 character, but when it appears in between word characters it must be part of
|
|
|
861 the word. This is needed to detect a spelling error such as they'are. That
|
|
|
862 should be they're, but since "they" and "are" are words themselves that would
|
|
|
863 go unnoticed.
|
|
|
864
|
|
625
|
865 These characters are defined with MIDWORD in the .aff file. Example:
|
|
371
|
866
|
|
|
867 MIDWORD '- ~
|
|
|
868
|
|
|
869
|
|
497
|
870 FLAG TYPES *spell-FLAG*
|
|
|
871
|
|
|
872 Flags are used to specify the affixes that can be used with a word and for
|
|
|
873 other properties of the word. Normally single-character flags are used. This
|
|
|
874 limits the number of possible flags, especially for 8-bit encodings. The FLAG
|
|
|
875 item can be used if more affixes are to be used. Possible values:
|
|
|
876
|
|
|
877 FLAG long use two-character flags
|
|
|
878 FLAG num use numbers, from 1 up to 65000
|
|
499
|
879 FLAG caplong use one-character flags without A-Z and two-character
|
|
497
|
880 flags that start with A-Z
|
|
|
881
|
|
|
882 With "FLAG num" the numbers in a list of affixes need to be separated with a
|
|
|
883 comma: "234,2143,1435". This method is inefficient, but useful if the file is
|
|
|
884 generated with a program.
|
|
|
885
|
|
499
|
886 When using "caplong" the two-character flags all start with a capital: "Aa",
|
|
|
887 "B1", "BB", etc. This is useful to use one-character flags for the most
|
|
|
888 common items and two-character flags for uncommon items.
|
|
497
|
889
|
|
|
890 Note: When using utf-8 only characters up to 65000 may be used for flags.
|
|
|
891
|
|
|
892
|
|
341
|
893 AFFIXES
|
|
493
|
894 *spell-PFX* *spell-SFX*
|
|
341
|
895 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell
|
|
371
|
896 documentation or the Aspell manual:
|
|
|
897 http://aspell.net/man-html/Affix-Compression.html).
|
|
|
898
|
|
625
|
899 Summary:
|
|
|
900 SFX L Y 2 ~
|
|
|
901 SFX L 0 re [^x] ~
|
|
|
902 SFX L 0 ro x ~
|
|
|
903
|
|
|
904 The first line is a header and has four fields:
|
|
|
905 SFX {flag} {combine} {count}
|
|
|
906
|
|
|
907 {flag} The name used for the suffix. Mostly it's a single letter,
|
|
|
908 but other characters can be used, see |spell-FLAG|.
|
|
|
909
|
|
|
910 {combine} Can be 'Y' or 'N'. When 'Y' then the word plus suffix can
|
|
|
911 also have a prefix. When 'N' then a prefix is not allowed.
|
|
|
912
|
|
|
913 {count} The number of lines following. If this is wrong you will get
|
|
|
914 an error message.
|
|
|
915
|
|
|
916 For PFX the fields are exactly the same.
|
|
|
917
|
|
|
918 The basic format for the following lines is:
|
|
|
919 SFX {flag} {strip} {add} {condition}
|
|
|
920
|
|
|
921 {flag} Must be the same as the {flag} used in the first line.
|
|
|
922
|
|
|
923 {strip} Characters removed from the basic word. There is no check if
|
|
|
924 the characters are actually there, only the length is used (in
|
|
|
925 bytes). This better match the {condition}, otherwise strange
|
|
|
926 things may happen. If the {strip} length is equal to or
|
|
|
927 longer than the basic word the suffix won't be used.
|
|
|
928 When {strip} is 0 (zero) then nothing is stripped.
|
|
|
929
|
|
|
930 {add} Characters added to the basic word, after removing {strip}.
|
|
|
931
|
|
|
932 {condition} A simplistic pattern. Only when this matches with a basic
|
|
|
933 word will the suffix be used for that word. This is normally
|
|
|
934 for using one suffix letter with different {add} and {strip}
|
|
|
935 fields for words with different endings.
|
|
|
936 When {condition} is a . (dot) there is no condition.
|
|
|
937 The pattern may contain:
|
|
|
938 - Literal characters.
|
|
|
939 - A set of characters in []. [abc] matches a, b and c.
|
|
|
940 A dash is allowed for a range [a-c], but this is
|
|
|
941 Vim-specific.
|
|
|
942 - A set of characters that starts with a ^, meaning the
|
|
|
943 complement of the specified characters. [^abc] matches any
|
|
|
944 character but a, b and c.
|
|
|
945
|
|
|
946 For PFX the fields are the same, but the {strip}, {add} and {condition} apply
|
|
|
947 to the start of the word.
|
|
|
948
|
|
|
949 Note: Myspell ignores any extra text after the relevant info. Vim requires
|
|
|
950 this text to start with a "#" so that mistakes don't go unnoticed. Example:
|
|
371
|
951
|
|
|
952 SFX F 0 in [^i]n # Spion > Spionin ~
|
|
|
953 SFX F 0 nen in # Bauerin > Bauerinnen ~
|
|
341
|
954
|
|
499
|
955 Apparently Myspell allows an affix name to appear more than once. Since this
|
|
|
956 might also be a mistake, Vim checks for an extra "S". The affix files for
|
|
|
957 Myspell that use this feature apparently have this flag. Example:
|
|
|
958
|
|
|
959 SFX a Y 1 S ~
|
|
|
960 SFX a 0 an . ~
|
|
|
961
|
|
|
962 SFX a Y 2 S ~
|
|
|
963 SFX a 0 en . ~
|
|
|
964 SFX a 0 on . ~
|
|
|
965
|
|
625
|
966
|
|
|
967 AFFIX FLAGS *spell-affix-flags*
|
|
|
968
|
|
|
969 This is a feature that comes from Hunspell: The affix may specify flags. This
|
|
|
970 works similar to flags specified on a basic word. The flags apply to the
|
|
|
971 basic word plus the affix. Example:
|
|
|
972
|
|
|
973 SFX S Y 1 ~
|
|
|
974 SFX S 0 s . ~
|
|
|
975
|
|
|
976 SFX A Y 1 ~
|
|
|
977 SFX A 0 able/S . ~
|
|
|
978
|
|
|
979 When the dictionary file contains "drink/AS" then these words are possible:
|
|
|
980
|
|
|
981 drink
|
|
|
982 drinks uses S suffix
|
|
|
983 drinkable uses A suffix
|
|
|
984 drinkables uses A suffix and then S suffix
|
|
|
985
|
|
|
986 Generally the flags of the suffix are added to the flags of the basic word,
|
|
|
987 both are used for the word plus suffix. But the flags of the basic word are
|
|
|
988 only used once for affixes, except that both one prefix and one suffix can be
|
|
|
989 used when both support combining.
|
|
|
990
|
|
|
991 Specifically, the affix flags can be used for:
|
|
|
992 - Affixes on affixes, as in the example above.
|
|
|
993 - Making the word with the affix rare, by using the |spell-RARE| flag.
|
|
|
994 - Exclude the word with the affix from compounding, by using the
|
|
|
995 |spell-COMPOUNDFORBIDFLAG| flag.
|
|
|
996
|
|
|
997 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
|
|
|
998 OLD STUFF
|
|
484
|
999 *spell-affix-rare*
|
|
371
|
1000 An extra item for Vim is the "rare" flag. It must come after the other
|
|
|
1001 fields, before a comment. When used then all words that use the affix will be
|
|
625
|
1002 marked as rare words. Examples:
|
|
371
|
1003
|
|
|
1004 PFX F 0 nene . rare ~
|
|
|
1005 SFX F 0 oin n rare # hardly ever used ~
|
|
|
1006
|
|
625
|
1007 However, if the word also appears as a good word in another way (e.g., in
|
|
|
1008 another region) it won't be marked as rare.
|
|
336
|
1009
|
|
484
|
1010 *spell-affix-nocomp*
|
|
|
1011 Another extra item for Vim is the "nocomp" flag. It must come after the other
|
|
488
|
1012 fields, before a comment. It can be either before or after "rare". When
|
|
|
1013 present then all words that use the affix will not be part of a compound word.
|
|
484
|
1014 Example:
|
|
|
1015 affix file:
|
|
|
1016 COMPOUNDFLAG c ~
|
|
|
1017 SFX a Y 2 ~
|
|
|
1018 SFX a 0 s . ~
|
|
|
1019 SFX a 0 ize . nocomp ~
|
|
|
1020 dictionary:
|
|
|
1021 word/c ~
|
|
|
1022 util/ac ~
|
|
|
1023
|
|
|
1024 This allows for "wordutil" and "wordutils" but not "wordutilize".
|
|
625
|
1025 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
|
|
484
|
1026
|
|
493
|
1027 *spell-PFXPOSTPONE*
|
|
341
|
1028 When an affix file has very many prefixes that apply to many words it's not
|
|
|
1029 possible to build the whole word list in memory. This applies to Hebrew (a
|
|
|
1030 list with all words is over a Gbyte). In that case applying prefixes must be
|
|
|
1031 postponed. This makes spell checking slower. It is indicated by this keyword
|
|
|
1032 in the .aff file:
|
|
|
1033
|
|
|
1034 PFXPOSTPONE ~
|
|
|
1035
|
|
|
1036 Only prefixes without a chop string can be postponed, prefixes with a chop
|
|
456
|
1037 string will still be included in the word list. An exception if the chop
|
|
|
1038 string is one character and equal to the last character of the added string,
|
|
|
1039 but in lower case. Thus when the chop string is used to allow the following
|
|
|
1040 word to start with an upper case letter.
|
|
341
|
1041
|
|
481
|
1042
|
|
493
|
1043 WORDS WITH A SLASH *spell-SLASH*
|
|
481
|
1044
|
|
|
1045 The slash is used in the .dic file to separate the basic word from the affix
|
|
640
|
1046 letters and other flags. Unfortunately, this means you cannot use a slash in
|
|
|
1047 a word. Thus "TCP/IP" is not a word but "TCP with the flags "IP". To include
|
|
|
1048 a slash in the word put a backslash before it: "TCP\/IP". In the rare case
|
|
|
1049 you want to use a backslash inside a word you need to use two backslashes.
|
|
|
1050 Any other use of the backslash is reserved for future expansion.
|
|
481
|
1051
|
|
|
1052
|
|
624
|
1053 KEEP-CASE WORDS *spell-KEEPCASE*
|
|
481
|
1054
|
|
624
|
1055 In the affix file a KEEPCASE line can be used to define the affix name used
|
|
|
1056 for keep-case words. Example:
|
|
308
|
1057
|
|
624
|
1058 KEEPCASE = ~
|
|
308
|
1059
|
|
625
|
1060 This flag is not supported by Myspell. It has the meaning that case matters.
|
|
|
1061 This can be used if the word does not have the first letter in upper case at
|
|
|
1062 the start of a sentence. Example:
|
|
|
1063
|
|
|
1064 word list matches does not match ~
|
|
|
1065 's morgens/= 's morgens 'S morgens 's Morgens 'S MORGENS
|
|
|
1066 's Morgens 's Morgens 'S MORGENS 'S morgens 's morgens
|
|
|
1067
|
|
|
1068 The flag can also be used to avoid that the word matches when it is in all
|
|
|
1069 upper-case letters.
|
|
308
|
1070
|
|
341
|
1071
|
|
624
|
1072 RARE WORDS *spell-RARE*
|
|
481
|
1073
|
|
624
|
1074 In the affix file a RARE line can be used to define the affix name used for
|
|
308
|
1075 rare words. Example:
|
|
|
1076
|
|
624
|
1077 RARE ? ~
|
|
308
|
1078
|
|
|
1079 Rare words are highlighted differently from bad words. This is to be used for
|
|
|
1080 words that are correct for the language, but are hardly ever used and could be
|
|
348
|
1081 a typing mistake anyway. When the same word is found as good it won't be
|
|
|
1082 highlighted as rare.
|
|
|
1083
|
|
|
1084
|
|
493
|
1085 BAD WORDS *spell-BAD*
|
|
481
|
1086
|
|
348
|
1087 In the affix file a BAD line can be used to define the affix name used for
|
|
|
1088 bad words. Example:
|
|
|
1089
|
|
|
1090 BAD ! ~
|
|
|
1091
|
|
|
1092 This can be used to exclude words that would otherwise be good. For example
|
|
371
|
1093 "the the" in the .dic file:
|
|
|
1094
|
|
|
1095 the the/! ~
|
|
|
1096
|
|
|
1097 Once a word has been marked as bad it won't be undone by encountering the same
|
|
|
1098 word as good.
|
|
308
|
1099
|
|
625
|
1100 The flag also applies to the word with affixes, thus this can be used to mark
|
|
|
1101 a whole bunch of related words as bad.
|
|
|
1102
|
|
493
|
1103 *spell-NEEDAFFIX*
|
|
484
|
1104 The NEEDAFFIX flag is used to require that a word is used with an affix. The
|
|
625
|
1105 word itself is not a good word (unless there is an empty affix). Example:
|
|
484
|
1106
|
|
|
1107 NEEDAFFIX + ~
|
|
|
1108
|
|
308
|
1109
|
|
493
|
1110 COMPOUND WORDS *spell-compound*
|
|
481
|
1111
|
|
484
|
1112 A compound word is a longer word made by concatenating words that appear in
|
|
|
1113 the .dic file. To specify which words may be concatenated a character is
|
|
|
1114 used. This character is put in the list of affixes after the word. We will
|
|
|
1115 call this character a flag here. Obviously these flags must be different from
|
|
|
1116 any affix IDs used.
|
|
481
|
1117
|
|
|
1118 *spell-COMPOUNDFLAG*
|
|
625
|
1119 The Myspell compatible method uses one flag, specified with COMPOUNDFLAG. All
|
|
|
1120 words with this flag combine in any order. This means there is no control
|
|
484
|
1121 over which word comes first. Example:
|
|
481
|
1122 COMPOUNDFLAG c ~
|
|
|
1123
|
|
|
1124 *spell-COMPOUNDFLAGS*
|
|
484
|
1125 A more advanced method to specify how compound words can be formed uses
|
|
|
1126 multiple items with multiple flags. This is not compatible with Myspell 3.0.
|
|
|
1127 Let's start with an example:
|
|
|
1128 COMPOUNDFLAGS c+ ~
|
|
|
1129 COMPOUNDFLAGS se ~
|
|
481
|
1130
|
|
484
|
1131 The first line defines that words with the "c" flag can be concatenated in any
|
|
|
1132 order. The second line defines compound words that are made of one word with
|
|
|
1133 the "s" flag and one word with the "e" flag. With this dictionary:
|
|
|
1134 bork/c ~
|
|
|
1135 onion/s ~
|
|
|
1136 soup/e ~
|
|
481
|
1137
|
|
484
|
1138 You can make these words:
|
|
|
1139 bork
|
|
|
1140 borkbork
|
|
|
1141 borkborkbork
|
|
|
1142 (etc.)
|
|
481
|
1143 onion
|
|
|
1144 soup
|
|
|
1145 onionsoup
|
|
|
1146
|
|
484
|
1147 The COMPOUNDFLAGS item may appear multiple times. The argument is made out of
|
|
|
1148 one or more groups, where each group can be:
|
|
|
1149 one flag e.g., c
|
|
|
1150 alternate flags inside [] e.g., [abc]
|
|
|
1151 Optionally this may be followed by:
|
|
|
1152 * the group appears zero or more times, e.g., sm*e
|
|
|
1153 + the group appears one or more times, e.g., c+
|
|
481
|
1154
|
|
484
|
1155 This is similar to the regexp pattern syntax (but not the same!). A few
|
|
|
1156 examples with the sequence of word flags they require:
|
|
|
1157 COMPOUNDFLAGS x+ x xx xxx etc.
|
|
|
1158 COMPOUNDFLAGS yz yz
|
|
|
1159 COMPOUNDFLAGS x+z xz xxz xxxz etc.
|
|
|
1160 COMPOUNDFLAGS yx+ yx yxx yxxx etc.
|
|
481
|
1161
|
|
484
|
1162 COMPOUNDFLAGS [abc]z az bz cz
|
|
|
1163 COMPOUNDFLAGS [abc]+z az aaz abaz bz baz bcbz cz caz cbaz etc.
|
|
|
1164 COMPOUNDFLAGS a[xyz]+ ax axx axyz ay ayx ayzz az azy azxy etc.
|
|
|
1165 COMPOUNDFLAGS sm*e se sme smme smmme etc.
|
|
|
1166 COMPOUNDFLAGS s[xyz]*e se sxe sxye sxyxe sye syze sze szye szyxe etc.
|
|
481
|
1167
|
|
491
|
1168 A specific example: Allow a compound to be made of two words and a dash:
|
|
|
1169 In the .aff file:
|
|
|
1170 COMPOUNDFLAGS sde ~
|
|
|
1171 NEEDAFFIX x ~
|
|
|
1172 COMPOUNDMAX 3 ~
|
|
|
1173 COMPOUNDMIN 1 ~
|
|
|
1174 In the .dic file:
|
|
|
1175 start/s ~
|
|
|
1176 end/e ~
|
|
|
1177 -/xd ~
|
|
|
1178
|
|
|
1179 This allows for the word "start-end", but not "startend".
|
|
|
1180
|
|
625
|
1181 *spell-NEEDCOMPOUND*
|
|
|
1182 The NEEDCOMPOUND flag is used to require that a word is used as part of a
|
|
|
1183 compound word. The word itself is not a good word. Example:
|
|
|
1184
|
|
|
1185 NEEDCOMPOUND & ~
|
|
|
1186
|
|
481
|
1187 *spell-COMPOUNDMIN*
|
|
500
|
1188 The minimal character length of a word used for compounding is specified with
|
|
481
|
1189 COMPOUNDMIN. Example:
|
|
|
1190 COMPOUNDMIN 5 ~
|
|
|
1191
|
|
500
|
1192 When omitted there is no minimal length. Obviously you could just leave out
|
|
|
1193 the compound flag from short words instead, this feature is present for
|
|
|
1194 compatibility with Myspell.
|
|
481
|
1195
|
|
484
|
1196 *spell-COMPOUNDMAX*
|
|
|
1197 The maximum number of words that can be concatenated into a compound word is
|
|
|
1198 specified with COMPOUNDMAX. Example:
|
|
|
1199 COMPOUNDMAX 3 ~
|
|
|
1200
|
|
|
1201 When omitted there is no maximum. It applies to all compound words.
|
|
|
1202
|
|
|
1203 To set a limit for words with specific flags make sure the items in
|
|
|
1204 COMPOUNDFLAGS where they appear don't allow too many words.
|
|
|
1205
|
|
|
1206 *spell-COMPOUNDSYLMAX*
|
|
|
1207 The maximum number of syllables that a compound word may contain is specified
|
|
|
1208 with COMPOUNDSYLMAX. Example:
|
|
|
1209 COMPOUNDSYLMAX 6 ~
|
|
481
|
1210
|
|
484
|
1211 This has no effect if there is no SYLLABLE item. Without COMPOUNDSYLMAX there
|
|
|
1212 is no limit on the number of syllables.
|
|
|
1213
|
|
491
|
1214 If both COMPOUNDMAX and COMPOUNDSYLMAX are defined, a compound word is
|
|
|
1215 accepted if it fits one of the criteria, thus is either made from up to
|
|
|
1216 COMPOUNDMAX words or contains up to COMPOUNDSYLMAX syllables.
|
|
|
1217
|
|
625
|
1218 *spell-COMPOUNDFORBIDFLAG*
|
|
|
1219 The COMPOUNDFORBIDFLAG specifies a flag that can be used on an affix. It
|
|
|
1220 means that the word plus affix cannot be used in a compound word.
|
|
|
1221 NOT IMPLEMENTED YET.
|
|
|
1222
|
|
|
1223 *spell-COMPOUNDPERMITFLAG*
|
|
|
1224 The COMPOUNDPERMITFLAG specifies a flag that can be used on an affix. It
|
|
|
1225 means that the word plus affix can also be used in a compound word in a way
|
|
|
1226 where the affix ends up halfway the word.
|
|
|
1227 NOT IMPLEMENTED YET.
|
|
|
1228
|
|
484
|
1229 *spell-SYLLABLE*
|
|
|
1230 The SYLLABLE item defines characters or character sequences that are used to
|
|
|
1231 count the number of syllables in a word. Example:
|
|
|
1232 SYLLABLE aáeéiíoóöõuúüûy/aa/au/ea/ee/ei/ie/oa/oe/oo/ou/uu/ui ~
|
|
|
1233
|
|
|
1234 Before the first slash is the set of characters that are counted for one
|
|
|
1235 syllable, also when repeated and mixed, until the next character that is not
|
|
|
1236 in this set. After the slash come sequences of characters that are counted
|
|
|
1237 for one syllable. These are preferred over using characters from the set.
|
|
|
1238 With the example "ideeen" has three syllables, counted by "i", "ee" and "e".
|
|
|
1239
|
|
|
1240 Only case-folded letters need to be included.
|
|
|
1241
|
|
|
1242 Above another way to restrict compounding was mentioned above: adding "nocomp"
|
|
|
1243 after an affix causes all words that are made with that affix not be be used
|
|
|
1244 for compounding. |spell-affix-nocomp|
|
|
481
|
1245
|
|
493
|
1246
|
|
|
1247 UNLIMITED COMPOUNDING *spell-NOBREAK*
|
|
|
1248
|
|
|
1249 For some languages, such as Thai, there is no space in between words. This
|
|
|
1250 looks like all words are compounded. To specify this use the NOBREAK item in
|
|
|
1251 the affix file, without arguments:
|
|
|
1252 NOBREAK ~
|
|
|
1253
|
|
|
1254 Vim will try to figure out where one word ends and a next starts. When there
|
|
|
1255 are spelling mistakes this may not be quite right.
|
|
|
1256
|
|
481
|
1257
|
|
625
|
1258 *spell-COMMON*
|
|
|
1259 Common words can be specified with the COMMON item. This will give better
|
|
|
1260 suggestions when editing a short file. Example:
|
|
|
1261
|
|
|
1262 COMMON the of to and a in is it you that he was for on are ~
|
|
|
1263
|
|
|
1264 The words must be separated by white space, up to 25 per line.
|
|
|
1265 When multiple regions are specified in a ":mkspell" command the common words
|
|
|
1266 for all regions are combined and used for all regions.
|
|
|
1267
|
|
|
1268 *spell-NOSPLITSUGS*
|
|
699
|
1269 This item indicates that splitting a word to make suggestions is not a good
|
|
|
1270 idea. Split-word suggestions will appear only when there are few similar
|
|
|
1271 words.
|
|
625
|
1272
|
|
|
1273 NOSPLITSUGS ~
|
|
|
1274
|
|
|
1275 *spell-NOSUGGEST*
|
|
|
1276 The flag specified with NOSUGGEST can be used for words that will not be
|
|
|
1277 suggested. Can be used for obscene words.
|
|
|
1278
|
|
|
1279 NOSUGGEST % ~
|
|
|
1280
|
|
|
1281
|
|
493
|
1282 REPLACEMENTS *spell-REP*
|
|
323
|
1283
|
|
|
1284 In the affix file REP items can be used to define common mistakes. This is
|
|
|
1285 used to make spelling suggestions. The items define the "from" text and the
|
|
|
1286 "to" replacement. Example:
|
|
|
1287
|
|
|
1288 REP 4 ~
|
|
|
1289 REP f ph ~
|
|
|
1290 REP ph f ~
|
|
|
1291 REP k ch ~
|
|
|
1292 REP ch k ~
|
|
|
1293
|
|
497
|
1294 The first line specifies the number of REP lines following. Vim ignores the
|
|
625
|
1295 number, but it must be there (for compatibility with Myspell).
|
|
497
|
1296
|
|
378
|
1297 Don't include simple one-character replacements or swaps. Vim will try these
|
|
|
1298 anyway. You can include whole words if you want to, but you might want to use
|
|
|
1299 the "file:" item in 'spellsuggest' instead.
|
|
323
|
1300
|
|
532
|
1301 You can include a space by using an underscore:
|
|
|
1302
|
|
|
1303 REP the_the the ~
|
|
|
1304
|
|
323
|
1305
|
|
626
|
1306 SIMILAR CHARACTERS *spell-MAP* *E783*
|
|
323
|
1307
|
|
378
|
1308 In the affix file MAP items can be used to define letters that are very much
|
|
323
|
1309 alike. This is mostly used for a letter with different accents. This is used
|
|
|
1310 to prefer suggestions with these letters substituted. Example:
|
|
|
1311
|
|
|
1312 MAP 2 ~
|
|
|
1313 MAP eéëêè ~
|
|
|
1314 MAP uüùúû ~
|
|
|
1315
|
|
497
|
1316 The first line specifies the number of MAP lines following. Vim ignores the
|
|
|
1317 number, but the line must be there.
|
|
323
|
1318
|
|
378
|
1319 Each letter must appear in only one of the MAP items. It's a bit more
|
|
|
1320 efficient if the first letter is ASCII or at least one without accents.
|
|
336
|
1321
|
|
323
|
1322
|
|
625
|
1323 .SUG FILE *spell-NOSUGFILE*
|
|
|
1324
|
|
|
1325 When soundfolding is specified in the affix file then ":mkspell" will normally
|
|
644
|
1326 produce a .sug file next to the .spl file. This file is used to find
|
|
|
1327 suggestions by their sound-a-like form quickly. At the cost of a lot of
|
|
|
1328 memory (the amount depends on the number of words, |:mkspell| will display an
|
|
|
1329 estimate when it's done).
|
|
625
|
1330
|
|
|
1331 To avoid producing a .sug file use this item in the affix file:
|
|
|
1332
|
|
|
1333 NOSUGFILE ~
|
|
|
1334
|
|
644
|
1335 Users can simply omit the .sug file if they don't want to use it.
|
|
|
1336
|
|
625
|
1337
|
|
493
|
1338 SOUND-A-LIKE *spell-SAL*
|
|
323
|
1339
|
|
|
1340 In the affix file SAL items can be used to define the sounds-a-like mechanism
|
|
|
1341 to be used. The main items define the "from" text and the "to" replacement.
|
|
378
|
1342 Simplistic example:
|
|
323
|
1343
|
|
|
1344 SAL CIA X ~
|
|
|
1345 SAL CH X ~
|
|
|
1346 SAL C K ~
|
|
|
1347 SAL K K ~
|
|
|
1348
|
|
388
|
1349 There are a few rules and this can become quite complicated. An explanation
|
|
378
|
1350 how it works can be found in the Aspell manual:
|
|
375
|
1351 http://aspell.net/man-html/Phonetic-Code.html.
|
|
323
|
1352
|
|
|
1353 There are a few special items:
|
|
|
1354
|
|
|
1355 SAL followup true ~
|
|
|
1356 SAL collapse_result true ~
|
|
|
1357 SAL remove_accents true ~
|
|
|
1358
|
|
|
1359 "1" has the same meaning as "true". Any other value means "false".
|
|
|
1360
|
|
375
|
1361
|
|
493
|
1362 SIMPLE SOUNDFOLDING *spell-SOFOFROM* *spell-SOFOTO*
|
|
375
|
1363
|
|
|
1364 The SAL mechanism is complex and slow. A simpler mechanism is mapping all
|
|
|
1365 characters to another character, mapping similar sounding characters to the
|
|
|
1366 same character. At the same time this does case folding. You can not have
|
|
378
|
1367 both SAL items and simple soundfolding.
|
|
375
|
1368
|
|
388
|
1369 There are two items required: one to specify the characters that are mapped
|
|
375
|
1370 and one that specifies the characters they are mapped to. They must have
|
|
|
1371 exactly the same number of characters. Example:
|
|
|
1372
|
|
|
1373 SOFOFROM abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ ~
|
|
|
1374 SOFOTO ebctefghejklnnepkrstevvkesebctefghejklnnepkrstevvkes ~
|
|
|
1375
|
|
|
1376 In the example all vowels are mapped to the same character 'e'. Another
|
|
378
|
1377 method would be to leave out all vowels. Some characters that sound nearly
|
|
|
1378 the same and are often mixed up, such as 'm' and 'n', are mapped to the same
|
|
|
1379 character. Don't do this too much, all words will start looking alike.
|
|
375
|
1380
|
|
|
1381 Characters that do not appear in SOFOFROM will be left out, except that all
|
|
|
1382 white space is replaced by one space. Sequences of the same character in
|
|
|
1383 SOFOFROM are replaced by one.
|
|
|
1384
|
|
|
1385 You can use the |soundfold()| function to try out the results. Or set the
|
|
587
|
1386 'verbose' option to see the score in the output of the |z=| command.
|
|
375
|
1387
|
|
|
1388
|
|
625
|
1389 UNSUPPORTED ITEMS *spell-affix-not-supported*
|
|
|
1390
|
|
|
1391 These items appear in the affix file of other spell checkers. In Vim they are
|
|
|
1392 ignored, not supported or defined in another way.
|
|
|
1393
|
|
|
1394 ACCENT (Hunspell) *spell-ACCENT*
|
|
|
1395 Use MAP instead. |spell-MAP|
|
|
|
1396
|
|
|
1397 CHECKCOMPOUNDCASE (Hunspell) *spell-CHECKCOMPOUNDCASE*
|
|
|
1398 Disallow uppercase letters at compound word boundaries.
|
|
|
1399 Not supported.
|
|
|
1400
|
|
|
1401 CHECKCOMPOUNDDUP (Hunspell) *spell-CHECKCOMPOUNDDUP*
|
|
|
1402 Disallow using the same word twice in a compound. Not
|
|
|
1403 supported.
|
|
|
1404
|
|
|
1405 CHECKCOMPOUNDREP (Hunspell) *spell-CHECKCOMPOUNDREP*
|
|
|
1406 Something about using REP items and compound words. Not
|
|
|
1407 supported.
|
|
|
1408
|
|
|
1409 CHECKCOMPOUNDTRIPLE (Hunspell) *spell-CHECKCOMPOUNDTRIPLE*
|
|
|
1410 Forbid three identical characters when compounding. Not
|
|
|
1411 supported.
|
|
|
1412
|
|
|
1413 CHECKCOMPOUNDPATTERN (Hunspell) *spell-CHECKCOMPOUNDPATTERN*
|
|
|
1414 Forbid compounding when patterns match. Not supported.
|
|
|
1415
|
|
|
1416 CIRCUMFIX (Hunspell) *spell-CIRCUMFIX*
|
|
|
1417 This means a prefix and suffix must be added at the same time.
|
|
|
1418 Instead only specify the suffix, and give the that suffix two
|
|
|
1419 flags: The required prefix and the NEEDAFFIX flag.
|
|
|
1420 |spell-NEEDAFFIX|
|
|
|
1421
|
|
|
1422 COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES*
|
|
|
1423 Enables using two prefixes. Not supported.
|
|
|
1424
|
|
|
1425 COMPOUNDBEGIN (Hunspell) *spell-COMPOUNDBEGIN*
|
|
|
1426 Use COMPOUNDFLAGS instead. |spell-COMPOUNDFLAGS|
|
|
|
1427
|
|
|
1428 COMPOUNDEND (Hunspell) *spell-COMPOUNDEND*
|
|
|
1429 Use COMPOUNDFLAGS instead. |spell-COMPOUNDFLAGS|
|
|
|
1430
|
|
|
1431 COMPOUNDMIDDLE (Hunspell) *spell-COMPOUNDMIDDLE*
|
|
|
1432 Use COMPOUNDFLAGS instead. |spell-COMPOUNDFLAGS|
|
|
|
1433
|
|
|
1434 COMPOUNDROOT (Hunspell) *spell-COMPOUNDROOT*
|
|
|
1435 Flag for words in the dictionary that are already a compound.
|
|
|
1436 Vim doesn't use it.
|
|
|
1437
|
|
|
1438 COMPOUNDSYLLABLE (Hunspell) *spell-COMPOUNDSYLLABLE*
|
|
|
1439 Use SYLLABLE and COMPOUNDSYLMAX instead. |spell-SYLLABLE|
|
|
|
1440 |spell-COMPOUNDSYLMAX|
|
|
|
1441
|
|
|
1442 COMPOUNDWORDMAX (Hunspell) *spell-COMPOUNDWORDMAX*
|
|
|
1443 Use COMPOUNDMAX instead. |spell-COMPOUNDMAX|
|
|
|
1444
|
|
|
1445 FORBIDDENWORD (Hunspell) *spell-FORBIDDENWORD*
|
|
|
1446 Use BAD instead. |spell-BAD|
|
|
|
1447
|
|
|
1448 HOME (Hunspell) *spell-HOME*
|
|
|
1449 Specifies the website for the language. Not supported.
|
|
|
1450
|
|
|
1451 LANG (Hunspell) *spell-LANG*
|
|
|
1452 This specifies language-specific behavior. This actually
|
|
|
1453 moves part of the language knowledge into the program,
|
|
|
1454 therefore Vim does not support it. Each language property
|
|
|
1455 must be specified separately.
|
|
|
1456
|
|
|
1457 LEMMA_PRESENT (Hunspell) *spell-LEMMA_PRESENT*
|
|
|
1458 Only needed for mprphological analysis.
|
|
|
1459
|
|
|
1460 MAXNGRAMSUGS (Hunspell) *spell-MAXNGRAMSUGS*
|
|
|
1461 Not supported.
|
|
|
1462
|
|
|
1463 NAME (Hunspell) *spell-NAME*
|
|
|
1464 Specifies the name of the language. Not supported.
|
|
|
1465
|
|
|
1466 ONLYINCOMPOUND (Hunspell) *spell-ONLYINCOMPOUND*
|
|
|
1467 Use NEEDCOMPOUND instead. |spell-NEEDCOMPOUND|
|
|
|
1468
|
|
|
1469 PSEUDOROOT (Hunspell) *spell-PSEUDOROOT*
|
|
|
1470 Use NEEDAFFIX instead. |spell-NEEDAFFIX|
|
|
|
1471
|
|
|
1472 SUGSWITHDOTS (Hunspell) *spell-SUGSWITHDOTS*
|
|
|
1473 Adds dots to suggestions. Vim doesn't need this.
|
|
|
1474
|
|
|
1475 SYLLABLENUM (Hunspell) *spell-SYLLABLENUM*
|
|
|
1476 Not supported.
|
|
|
1477
|
|
|
1478 TRY (Myspell, Hunspell, others) *spell-TRY*
|
|
|
1479 Vim does not use the TRY item, it is ignored. For making
|
|
|
1480 suggestions the actual characters in the words are used.
|
|
|
1481
|
|
|
1482 VERSION (Hunspell) *spell-VERSION*
|
|
|
1483 Specifies the version for the language. Not supported.
|
|
|
1484
|
|
|
1485 WORDCHARS (Hunspell) *spell-WORDCHARS*
|
|
|
1486 Used to recognize words. Vim doesn't need it, because there
|
|
|
1487 is no need to separate words before checking them (using a
|
|
|
1488 trie instead of a hashtable).
|
|
|
1489
|
|
221
|
1490 vim:tw=78:sw=4:ts=8:ft=help:norl:
|
