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