Mercurial > vim
annotate runtime/doc/spell.txt @ 2287:573da4dac306 vim73
Make the dos installer work with more compilers.
author | Bram Moolenaar <bram@vim.org> |
---|---|
date | Wed, 07 Jul 2010 15:14:03 +0200 |
parents | 7c8c7c95a865 |
children | 733f0dc510c3 12b829477c60 |
rev | line source |
---|---|
2154
7c8c7c95a865
First step in the Vim 7.3 branch. Changed version numbers.
Bram Moolenaar <bram@zimbu.org>
parents:
2152
diff
changeset
|
1 *spell.txt* For Vim version 7.3a. Last change: 2010 Apr 11 |
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 ============================================================================== |
1622 | 24 1. Quick start *spell-quickstart* *E756* |
221 | 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 | |
1622 | 49 *]s* |
237 | 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 |
2152 | 471 uses. Myspell is used by OpenOffice.org and Mozilla. The OpenOffice .oxt |
472 files are zip files which contain the .aff and .dic files. You should be able | |
473 to find them here: | |
474 http://extensions.services.openoffice.org/dictionary | |
475 The older, OpenOffice 2 files may be used if this doesn't work: | |
1125 | 476 http://wiki.services.openoffice.org/wiki/Dictionaries |
348 | 477 You can also use a plain word list. The results are the same, the choice |
378 | 478 depends on what word lists you can find. |
221 | 479 |
388 | 480 If you install Aap (from www.a-a-p.org) you can use the recipes in the |
481 runtime/spell/??/ directories. Aap will take care of downloading the files, | |
482 apply patches needed for Vim and build the .spl file. | |
483 | |
341 | 484 Make sure your current locale is set properly, otherwise Vim doesn't know what |
485 characters are upper/lower case letters. If the locale isn't available (e.g., | |
486 when using an MS-Windows codepage on Unix) add tables to the .aff file | |
353 | 487 |spell-affix-chars|. If the .aff file doesn't define a table then the word |
488 table of the currently active spelling is used. If spelling is not active | |
489 then Vim will try to guess. | |
341 | 490 |
353 | 491 *:mksp* *:mkspell* |
492 :mksp[ell][!] [-ascii] {outname} {inname} ... | |
564 | 493 Generate a Vim spell file from word lists. Example: > |
378 | 494 :mkspell /tmp/nl nl_NL.words |
353 | 495 < *E751* |
314 | 496 When {outname} ends in ".spl" it is used as the output |
497 file name. Otherwise it should be a language name, | |
353 | 498 such as "en", without the region name. The file |
499 written will be "{outname}.{encoding}.spl", where | |
500 {encoding} is the value of the 'encoding' option. | |
301 | 501 |
378 | 502 When the output file already exists [!] must be used |
333 | 503 to overwrite it. |
504 | |
242 | 505 When the [-ascii] argument is present, words with |
506 non-ascii characters are skipped. The resulting file | |
314 | 507 ends in "ascii.spl". |
301 | 508 |
509 The input can be the Myspell format files {inname}.aff | |
510 and {inname}.dic. If {inname}.aff does not exist then | |
511 {inname} is used as the file name of a plain word | |
512 list. | |
513 | |
237 | 514 Multiple {inname} arguments can be given to combine |
515 regions into one Vim spell file. Example: > | |
516 :mkspell ~/.vim/spell/en /tmp/en_US /tmp/en_CA /tmp/en_AU | |
517 < This combines the English word lists for US, CA and AU | |
518 into one en.spl file. | |
819 | 519 Up to eight regions can be combined. *E754* *E755* |
323 | 520 The REP and SAL items of the first .aff file where |
493 | 521 they appear are used. |spell-REP| |spell-SAL| |
237 | 522 |
348 | 523 This command uses a lot of memory, required to find |
484 | 524 the optimal word tree (Polish, Italian and Hungarian |
525 require several hundred Mbyte). The final result will | |
526 be much smaller, because compression is used. To | |
527 avoid running out of memory compression will be done | |
528 now and then. This can be tuned with the 'mkspellmem' | |
529 option. | |
348 | 530 |
378 | 531 After the spell file was written and it was being used |
532 in a buffer it will be reloaded automatically. | |
308 | 533 |
371 | 534 :mksp[ell] [-ascii] {name}.{enc}.add |
535 Like ":mkspell" above, using {name}.{enc}.add as the | |
378 | 536 input file and producing an output file in the same |
537 directory that has ".spl" appended. | |
371 | 538 |
539 :mksp[ell] [-ascii] {name} | |
540 Like ":mkspell" above, using {name} as the input file | |
378 | 541 and producing an output file in the same directory |
542 that has ".{enc}.spl" appended. | |
314 | 543 |
481 | 544 Vim will report the number of duplicate words. This might be a mistake in the |
545 list of words. But sometimes it is used to have different prefixes and | |
546 suffixes for the same basic word to avoid them combining (e.g. Czech uses | |
484 | 547 this). If you want Vim to report all duplicate words set the 'verbose' |
548 option. | |
481 | 549 |
314 | 550 Since you might want to change a Myspell word list for use with Vim the |
551 following procedure is recommended: | |
237 | 552 |
553 1. Obtain the xx_YY.aff and xx_YY.dic files from Myspell. | |
554 2. Make a copy of these files to xx_YY.orig.aff and xx_YY.orig.dic. | |
555 3. Change the xx_YY.aff and xx_YY.dic files to remove bad words, add missing | |
258 | 556 words, define word characters with FOL/LOW/UPP, etc. The distributed |
1125 | 557 "*.diff" files can be used. |
378 | 558 4. Start Vim with the right locale and use |:mkspell| to generate the Vim |
559 spell file. | |
560 5. Try out the spell file with ":set spell spelllang=xx" if you wrote it in | |
388 | 561 a spell directory in 'runtimepath', or ":set spelllang=xx.enc.spl" if you |
378 | 562 wrote it somewhere else. |
221 | 563 |
237 | 564 When the Myspell files are updated you can merge the differences: |
258 | 565 1. Obtain the new Myspell files as xx_YY.new.aff and xx_UU.new.dic. |
566 2. Use Vimdiff to see what changed: > | |
237 | 567 vimdiff xx_YY.orig.dic xx_YY.new.dic |
258 | 568 3. Take over the changes you like in xx_YY.dic. |
237 | 569 You may also need to change xx_YY.aff. |
258 | 570 4. Rename xx_YY.new.dic to xx_YY.orig.dic and xx_YY.new.aff to xx_YY.new.aff. |
237 | 571 |
353 | 572 |
484 | 573 SPELL FILE VERSIONS *E770* *E771* *E772* |
574 | |
575 Spell checking is a relatively new feature in Vim, thus it's possible that the | |
576 .spl file format will be changed to support more languages. Vim will check | |
577 the validity of the spell file and report anything wrong. | |
578 | |
579 E771: Old spell file, needs to be updated ~ | |
580 This spell file is older than your Vim. You need to update the .spl file. | |
581 | |
582 E772: Spell file is for newer version of Vim ~ | |
583 This means the spell file was made for a later version of Vim. You need to | |
584 update Vim. | |
585 | |
586 E770: Unsupported section in spell file ~ | |
587 This means the spell file was made for a later version of Vim and contains a | |
588 section that is required for the spell file to work. In this case it's | |
589 probably a good idea to upgrade your Vim. | |
590 | |
591 | |
353 | 592 SPELL FILE DUMP |
593 | |
594 If for some reason you want to check what words are supported by the currently | |
595 used spelling files, use this command: | |
596 | |
597 *:spelldump* *:spelld* | |
598 :spelld[ump] Open a new window and fill it with all currently valid | |
500 | 599 words. Compound words are not included. |
378 | 600 Note: For some languages the result may be enormous, |
601 causing Vim to run out of memory. | |
353 | 602 |
625 | 603 :spelld[ump]! Like ":spelldump" and include the word count. This is |
604 the number of times the word was found while | |
605 updating the screen. Words that are in COMMON items | |
606 get a starting count of 10. | |
607 | |
353 | 608 The format of the word list is used |spell-wordlist-format|. You should be |
609 able to read it with ":mkspell" to generate one .spl file that includes all | |
610 the words. | |
611 | |
383 | 612 When all entries to 'spelllang' use the same regions or no regions at all then |
613 the region information is included in the dumped words. Otherwise only words | |
614 for the current region are included and no "/regions" line is generated. | |
353 | 615 |
378 | 616 Comment lines with the name of the .spl file are used as a header above the |
617 words that were generated from that .spl file. | |
353 | 618 |
651 | 619 |
620 SPELL FILE MISSING *spell-SpellFileMissing* *spellfile.vim* | |
621 | |
622 If the spell file for the language you are using is not available, you will | |
623 get an error message. But if the "spellfile.vim" plugin is active it will | |
624 offer you to download the spell file. Just follow the instructions, it will | |
1622 | 625 ask you where to write the file (there must be a writable directory in |
626 'runtimepath' for this). | |
651 | 627 |
628 The plugin has a default place where to look for spell files, on the Vim ftp | |
629 server. If you want to use another location or another protocol, set the | |
630 g:spellfile_URL variable to the directory that holds the spell files. The | |
1219 | 631 |netrw| plugin is used for getting the file, look there for the specific |
651 | 632 syntax of the URL. Example: > |
633 let g:spellfile_URL = 'http://ftp.vim.org/vim/runtime/spell' | |
634 You may need to escape special characters. | |
635 | |
636 The plugin will only ask about downloading a language once. If you want to | |
637 try again anyway restart Vim, or set g:spellfile_URL to another value (e.g., | |
638 prepend a space). | |
639 | |
640 To avoid using the "spellfile.vim" plugin do this in your vimrc file: > | |
641 | |
642 let loaded_spellfile_plugin = 1 | |
643 | |
644 Instead of using the plugin you can define a |SpellFileMissing| autocommand to | |
645 handle the missing file yourself. You can use it like this: > | |
646 | |
647 :au SpellFileMissing * call Download_spell_file(expand('<amatch>')) | |
648 | |
649 Thus the <amatch> item contains the name of the language. Another important | |
650 value is 'encoding', since every encoding has its own spell file. With two | |
651 exceptions: | |
652 - For ISO-8859-15 (latin9) the name "latin1" is used (the encodings only | |
653 differ in characters not used in dictionary words). | |
654 - The name "ascii" may also be used for some languages where the words use | |
655 only ASCII letters for most of the words. | |
656 | |
657 The default "spellfile.vim" plugin uses this autocommand, if you define your | |
1125 | 658 autocommand afterwards you may want to use ":au! SpellFileMissing" to overrule |
651 | 659 it. If you define your autocommand before the plugin is loaded it will notice |
660 this and not do anything. | |
1219 | 661 *E797* |
662 Note that the SpellFileMissing autocommand must not change or destroy the | |
663 buffer the user was editing. | |
651 | 664 |
237 | 665 ============================================================================== |
378 | 666 4. Spell file format *spell-file-format* |
237 | 667 |
668 This is the format of the files that are used by the person who creates and | |
669 maintains a word list. | |
221 | 670 |
237 | 671 Note that we avoid the word "dictionary" here. That is because the goal of |
672 spell checking differs from writing a dictionary (as in the book). For | |
564 | 673 spelling we need a list of words that are OK, thus should not be highlighted. |
674 Person and company names will not appear in a dictionary, but do appear in a | |
675 word list. And some old words are rarely used while they are common | |
676 misspellings. These do appear in a dictionary but not in a word list. | |
237 | 677 |
388 | 678 There are two formats: A straight list of words and a list using affix |
378 | 679 compression. The files with affix compression are used by Myspell (Mozilla |
680 and OpenOffice.org). This requires two files, one with .aff and one with .dic | |
681 extension. | |
301 | 682 |
683 | |
378 | 684 FORMAT OF STRAIGHT WORD LIST *spell-wordlist-format* |
301 | 685 |
314 | 686 The words must appear one per line. That is all that is required. |
378 | 687 |
314 | 688 Additionally the following items are recognized: |
378 | 689 |
301 | 690 - Empty and blank lines are ignored. |
378 | 691 |
625 | 692 # comment ~ |
301 | 693 - Lines starting with a # are ignored (comment lines). |
378 | 694 |
625 | 695 /encoding=utf-8 ~ |
308 | 696 - A line starting with "/encoding=", before any word, specifies the encoding |
697 of the file. After the second '=' comes an encoding name. This tells Vim | |
378 | 698 to setup conversion from the specified encoding to 'encoding'. Thus you can |
699 use one word list for several target encodings. | |
700 | |
625 | 701 /regions=usca ~ |
320 | 702 - A line starting with "/regions=" specifies the region names that are |
703 supported. Each region name must be two ASCII letters. The first one is | |
704 region 1. Thus "/regions=usca" has region 1 "us" and region 2 "ca". | |
378 | 705 In an addition word list the region names should be equal to the main word |
706 list! | |
707 | |
314 | 708 - Other lines starting with '/' are reserved for future use. The ones that |
625 | 709 are not recognized are ignored. You do get a warning message, so that you |
710 know something won't work. | |
301 | 711 |
383 | 712 - A "/" may follow the word with the following items: |
856 | 713 = Case must match exactly. |
383 | 714 ? Rare word. |
715 ! Bad (wrong) word. | |
716 digit A region in which the word is valid. If no regions are | |
856 | 717 specified the word is valid in all regions. |
383 | 718 |
320 | 719 Example: |
720 | |
721 # This is an example word list comment | |
722 /encoding=latin1 encoding of the file | |
723 /regions=uscagb regions "us", "ca" and "gb" | |
724 example word for all regions | |
383 | 725 blah/12 word for regions "us" and "ca" |
726 vim/! bad word | |
727 Campbell/?3 rare word in region 3 "gb" | |
728 's mornings/= keep-case word | |
320 | 729 |
389 | 730 Note that when "/=" is used the same word with all upper-case letters is not |
731 accepted. This is different from a word with mixed case that is automatically | |
732 marked as keep-case, those words may appear in all upper-case letters. | |
733 | |
301 | 734 |
820 | 735 FORMAT WITH .AFF AND .DIC FILES *aff-dic-format* |
301 | 736 |
625 | 737 There are two files: the basic word list and an affix file. The affix file |
738 specifies settings for the language and can contain affixes. The affixes are | |
237 | 739 used to modify the basic words to get the full word list. This significantly |
740 reduces the number of words, especially for a language like Polish. This is | |
741 called affix compression. | |
221 | 742 |
625 | 743 The basic word list and the affix file are combined with the ":mkspell" |
744 command and results in a binary spell file. All the preprocessing has been | |
745 done, thus this file loads fast. The binary spell file format is described in | |
746 the source code (src/spell.c). But only developers need to know about it. | |
221 | 747 |
237 | 748 The preprocessing also allows us to take the Myspell language files and modify |
749 them before the Vim word list is made. The tools for this can be found in the | |
750 "src/spell" directory. | |
751 | |
493 | 752 The format for the affix and word list files is based on what Myspell uses |
753 (the spell checker of Mozilla and OpenOffice.org). A description can be found | |
754 here: | |
755 http://lingucomponent.openoffice.org/affix.readme ~ | |
756 Note that affixes are case sensitive, this isn't obvious from the description. | |
757 | |
758 Vim supports quite a few extras. They are described below |spell-affix-vim|. | |
759 Attempts have been made to keep this compatible with other spell checkers, so | |
625 | 760 that the same files can often be used. One other project that offers more |
761 than Myspell is Hunspell ( http://hunspell.sf.net ). | |
493 | 762 |
237 | 763 |
320 | 764 WORD LIST FORMAT *spell-dic-format* |
237 | 765 |
625 | 766 A short example, with line numbers: |
221 | 767 |
625 | 768 1 1234 ~ |
769 2 aan ~ | |
770 3 Als ~ | |
771 4 Etten-Leur ~ | |
772 5 et al. ~ | |
773 6 's-Gravenhage ~ | |
774 7 's-Gravenhaags ~ | |
775 8 # word that differs between regions ~ | |
776 9 kado/1 ~ | |
777 10 cadeau/2 ~ | |
778 11 TCP,IP ~ | |
779 12 /the S affix may add a 's' ~ | |
780 13 bedel/S ~ | |
237 | 781 |
314 | 782 The first line contains the number of words. Vim ignores it, but you do get |
783 an error message if it's not there. *E760* | |
221 | 784 |
625 | 785 What follows is one word per line. White space at the end of the line is |
786 ignored, all other white space matters. The encoding is specified in the | |
787 affix file |spell-SET|. | |
788 | |
789 Comment lines start with '#' or '/'. See the example lines 8 and 12. Note | |
790 that putting a comment after a word is NOT allowed: | |
791 | |
792 someword # comment that causes an error! ~ | |
793 | |
794 After the word there is an optional slash and flags. Most of these flags are | |
795 letters that indicate the affixes that can be used with this word. These are | |
796 specified with SFX and PFX lines in the .aff file, see |spell-SFX| and | |
797 |spell-PFX|. Vim allows using other flag types with the FLAG item in the | |
798 affix file |spell-FLAG|. | |
237 | 799 |
800 When the word only has lower-case letters it will also match with the word | |
801 starting with an upper-case letter. | |
802 | |
803 When the word includes an upper-case letter, this means the upper-case letter | |
804 is required at this position. The same word with a lower-case letter at this | |
805 position will not match. When some of the other letters are upper-case it will | |
806 not match either. | |
807 | |
625 | 808 The word with all upper-case characters will always be OK, |
221 | 809 |
237 | 810 word list matches does not match ~ |
811 als als Als ALS ALs AlS aLs aLS | |
812 Als Als ALS als ALs AlS aLs aLS | |
813 ALS ALS als Als ALs AlS aLs aLS | |
814 AlS AlS ALS als Als ALs aLs aLS | |
221 | 815 |
624 | 816 The KEEPCASE affix ID can be used to specifically match a word with identical |
817 case only, see below |spell-KEEPCASE|. | |
308 | 818 |
625 | 819 Note: in line 5 to 7 non-word characters are used. You can include any |
820 character in a word. When checking the text a word still only matches when it | |
821 appears with a non-word character before and after it. For Myspell a word | |
822 starting with a non-word character probably won't work. | |
237 | 823 |
493 | 824 In line 12 the word "TCP/IP" is defined. Since the slash has a special |
825 meaning the comma is used instead. This is defined with the SLASH item in the | |
625 | 826 affix file, see |spell-SLASH|. Note that without this SLASH item the word |
827 will be "TCP,IP". | |
828 | |
829 | |
830 AFFIX FILE FORMAT *spell-aff-format* *spell-affix-vim* | |
493 | 831 |
625 | 832 *spell-affix-comment* |
833 Comment lines in the .aff file start with a '#': | |
834 | |
835 # comment line ~ | |
836 | |
1762 | 837 Items with a fixed number of arguments can be followed by a comment. But only |
838 if none of the arguments can contain white space. The comment must start with | |
839 a "#" character. Example: | |
840 | |
841 KEEPCASE = # fix case for words with this flag ~ | |
625 | 842 |
843 | |
844 ENCODING *spell-SET* | |
237 | 845 |
625 | 846 The affix file can be in any encoding that is supported by "iconv". However, |
847 in some cases the current locale should also be set properly at the time | |
848 |:mkspell| is invoked. Adding FOL/LOW/UPP lines removes this requirement | |
849 |spell-FOL|. | |
389 | 850 |
625 | 851 The encoding should be specified before anything where the encoding matters. |
852 The encoding applies both to the affix file and the dictionary file. It is | |
853 done with a SET line: | |
221 | 854 |
625 | 855 SET utf-8 ~ |
856 | |
857 The encoding can be different from the value of the 'encoding' option at the | |
858 time ":mkspell" is used. Vim will then convert everything to 'encoding' and | |
859 generate a spell file for 'encoding'. If some of the used characters to not | |
860 fit in 'encoding' you will get an error message. | |
237 | 861 *spell-affix-mbyte* |
625 | 862 When using a multi-byte encoding it's possible to use more different affix |
863 flags. But Myspell doesn't support that, thus you may not want to use it | |
864 anyway. For compatibility use an 8-bit encoding. | |
221 | 865 |
341 | 866 |
714 | 867 INFORMATION |
868 | |
869 These entries in the affix file can be used to add information to the spell | |
870 file. There are no restrictions on the format, but they should be in the | |
871 right encoding. | |
872 | |
873 *spell-NAME* *spell-VERSION* *spell-HOME* | |
874 *spell-AUTHOR* *spell-EMAIL* *spell-COPYRIGHT* | |
856 | 875 NAME Name of the language |
876 VERSION 1.0.1 with fixes | |
714 | 877 HOME http://www.myhome.eu |
878 AUTHOR John Doe | |
879 EMAIL john AT Doe DOT net | |
856 | 880 COPYRIGHT LGPL |
714 | 881 |
882 These fields are put in the .spl file as-is. The |:spellinfo| command can be | |
883 used to view the info. | |
884 | |
885 *:spellinfo* *:spelli* | |
886 :spelli[nfo] Display the information for the spell file(s) used for | |
887 the current buffer. | |
888 | |
889 | |
341 | 890 CHARACTER TABLES |
258 | 891 *spell-affix-chars* |
314 | 892 When using an 8-bit encoding the affix file should define what characters are |
625 | 893 word characters. This is because the system where ":mkspell" is used may not |
894 support a locale with this encoding and isalpha() won't work. For example | |
895 when using "cp1250" on Unix. | |
493 | 896 *E761* *E762* *spell-FOL* |
897 *spell-LOW* *spell-UPP* | |
258 | 898 Three lines in the affix file are needed. Simplistic example: |
899 | |
341 | 900 FOL áëñ ~ |
901 LOW áëñ ~ | |
902 UPP ÁËÑ ~ | |
258 | 903 |
904 All three lines must have exactly the same number of characters. | |
905 | |
906 The "FOL" line specifies the case-folded characters. These are used to | |
907 compare words while ignoring case. For most encodings this is identical to | |
908 the lower case line. | |
909 | |
910 The "LOW" line specifies the characters in lower-case. Mostly it's equal to | |
911 the "FOL" line. | |
912 | |
913 The "UPP" line specifies the characters with upper-case. That is, a character | |
914 is upper-case where it's different from the character at the same position in | |
915 "FOL". | |
916 | |
493 | 917 An exception is made for the German sharp s ß. The upper-case version is |
918 "SS". In the FOL/LOW/UPP lines it should be included, so that it's recognized | |
919 as a word character, but use the ß character in all three. | |
920 | |
258 | 921 ASCII characters should be omitted, Vim always handles these in the same way. |
922 When the encoding is UTF-8 no word characters need to be specified. | |
923 | |
924 *E763* | |
353 | 925 Vim allows you to use spell checking for several languages in the same file. |
926 You can list them in the 'spelllang' option. As a consequence all spell files | |
927 for the same encoding must use the same word characters, otherwise they can't | |
928 be combined without errors. If you get a warning that the word tables differ | |
929 you may need to generate the .spl file again with |:mkspell|. Check the FOL, | |
930 LOW and UPP lines in the used .aff file. | |
931 | |
932 The XX.ascii.spl spell file generated with the "-ascii" argument will not | |
933 contain the table with characters, so that it can be combine with spell files | |
934 for any encoding. The .add.spl files also do not contain the table. | |
258 | 935 |
341 | 936 |
371 | 937 MID-WORD CHARACTERS |
938 *spell-midword* | |
939 Some characters are only to be considered word characters if they are used in | |
940 between two ordinary word characters. An example is the single quote: It is | |
941 often used to put text in quotes, thus it can't be recognized as a word | |
942 character, but when it appears in between word characters it must be part of | |
943 the word. This is needed to detect a spelling error such as they'are. That | |
944 should be they're, but since "they" and "are" are words themselves that would | |
945 go unnoticed. | |
946 | |
625 | 947 These characters are defined with MIDWORD in the .aff file. Example: |
371 | 948 |
949 MIDWORD '- ~ | |
950 | |
951 | |
497 | 952 FLAG TYPES *spell-FLAG* |
953 | |
954 Flags are used to specify the affixes that can be used with a word and for | |
955 other properties of the word. Normally single-character flags are used. This | |
956 limits the number of possible flags, especially for 8-bit encodings. The FLAG | |
957 item can be used if more affixes are to be used. Possible values: | |
958 | |
959 FLAG long use two-character flags | |
960 FLAG num use numbers, from 1 up to 65000 | |
499 | 961 FLAG caplong use one-character flags without A-Z and two-character |
497 | 962 flags that start with A-Z |
963 | |
964 With "FLAG num" the numbers in a list of affixes need to be separated with a | |
965 comma: "234,2143,1435". This method is inefficient, but useful if the file is | |
966 generated with a program. | |
967 | |
499 | 968 When using "caplong" the two-character flags all start with a capital: "Aa", |
969 "B1", "BB", etc. This is useful to use one-character flags for the most | |
970 common items and two-character flags for uncommon items. | |
497 | 971 |
972 Note: When using utf-8 only characters up to 65000 may be used for flags. | |
973 | |
1762 | 974 Note: even when using "num" or "long" the number of flags available to |
975 compounding and prefixes is limited to about 250. | |
976 | |
497 | 977 |
341 | 978 AFFIXES |
493 | 979 *spell-PFX* *spell-SFX* |
341 | 980 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell |
371 | 981 documentation or the Aspell manual: |
982 http://aspell.net/man-html/Affix-Compression.html). | |
983 | |
625 | 984 Summary: |
985 SFX L Y 2 ~ | |
986 SFX L 0 re [^x] ~ | |
987 SFX L 0 ro x ~ | |
988 | |
989 The first line is a header and has four fields: | |
990 SFX {flag} {combine} {count} | |
991 | |
992 {flag} The name used for the suffix. Mostly it's a single letter, | |
993 but other characters can be used, see |spell-FLAG|. | |
994 | |
995 {combine} Can be 'Y' or 'N'. When 'Y' then the word plus suffix can | |
996 also have a prefix. When 'N' then a prefix is not allowed. | |
997 | |
998 {count} The number of lines following. If this is wrong you will get | |
999 an error message. | |
1000 | |
1001 For PFX the fields are exactly the same. | |
1002 | |
1003 The basic format for the following lines is: | |
809 | 1004 SFX {flag} {strip} {add} {condition} {extra} |
625 | 1005 |
1006 {flag} Must be the same as the {flag} used in the first line. | |
1007 | |
1008 {strip} Characters removed from the basic word. There is no check if | |
1009 the characters are actually there, only the length is used (in | |
1010 bytes). This better match the {condition}, otherwise strange | |
1011 things may happen. If the {strip} length is equal to or | |
1012 longer than the basic word the suffix won't be used. | |
1013 When {strip} is 0 (zero) then nothing is stripped. | |
1014 | |
1015 {add} Characters added to the basic word, after removing {strip}. | |
809 | 1016 Optionally there is a '/' followed by flags. The flags apply |
1017 to the word plus affix. See |spell-affix-flags| | |
625 | 1018 |
1019 {condition} A simplistic pattern. Only when this matches with a basic | |
1020 word will the suffix be used for that word. This is normally | |
1021 for using one suffix letter with different {add} and {strip} | |
1022 fields for words with different endings. | |
1023 When {condition} is a . (dot) there is no condition. | |
1024 The pattern may contain: | |
1025 - Literal characters. | |
1026 - A set of characters in []. [abc] matches a, b and c. | |
1027 A dash is allowed for a range [a-c], but this is | |
1028 Vim-specific. | |
1029 - A set of characters that starts with a ^, meaning the | |
1030 complement of the specified characters. [^abc] matches any | |
1031 character but a, b and c. | |
1032 | |
809 | 1033 {extra} Optional extra text: |
1034 # comment Comment is ignored | |
1035 - Hunspell uses this, ignored | |
1036 | |
625 | 1037 For PFX the fields are the same, but the {strip}, {add} and {condition} apply |
1038 to the start of the word. | |
1039 | |
1040 Note: Myspell ignores any extra text after the relevant info. Vim requires | |
1041 this text to start with a "#" so that mistakes don't go unnoticed. Example: | |
371 | 1042 |
1043 SFX F 0 in [^i]n # Spion > Spionin ~ | |
856 | 1044 SFX F 0 nen in # Bauerin > Bauerinnen ~ |
341 | 1045 |
499 | 1046 Apparently Myspell allows an affix name to appear more than once. Since this |
1047 might also be a mistake, Vim checks for an extra "S". The affix files for | |
1048 Myspell that use this feature apparently have this flag. Example: | |
1049 | |
1050 SFX a Y 1 S ~ | |
1051 SFX a 0 an . ~ | |
1052 | |
1053 SFX a Y 2 S ~ | |
1054 SFX a 0 en . ~ | |
1055 SFX a 0 on . ~ | |
1056 | |
625 | 1057 |
1058 AFFIX FLAGS *spell-affix-flags* | |
1059 | |
1060 This is a feature that comes from Hunspell: The affix may specify flags. This | |
1061 works similar to flags specified on a basic word. The flags apply to the | |
820 | 1062 basic word plus the affix (but there are restrictions). Example: |
625 | 1063 |
1064 SFX S Y 1 ~ | |
1065 SFX S 0 s . ~ | |
1066 | |
1067 SFX A Y 1 ~ | |
1068 SFX A 0 able/S . ~ | |
1069 | |
1070 When the dictionary file contains "drink/AS" then these words are possible: | |
1071 | |
1072 drink | |
1073 drinks uses S suffix | |
1074 drinkable uses A suffix | |
1075 drinkables uses A suffix and then S suffix | |
1076 | |
1077 Generally the flags of the suffix are added to the flags of the basic word, | |
1078 both are used for the word plus suffix. But the flags of the basic word are | |
1079 only used once for affixes, except that both one prefix and one suffix can be | |
1080 used when both support combining. | |
1081 | |
1082 Specifically, the affix flags can be used for: | |
820 | 1083 - Suffixes on suffixes, as in the example above. This works once, thus you |
1084 can have two suffixes on a word (plus one prefix). | |
625 | 1085 - Making the word with the affix rare, by using the |spell-RARE| flag. |
1086 - Exclude the word with the affix from compounding, by using the | |
1087 |spell-COMPOUNDFORBIDFLAG| flag. | |
819 | 1088 - Allow the word with the affix to be part of a compound word on the side of |
1089 the affix with the |spell-COMPOUNDPERMITFLAG|. | |
820 | 1090 - Use the NEEDCOMPOUND flag: word plus affix can only be used as part of a |
1091 compound word. |spell-NEEDCOMPOUND| | |
1092 - Compound flags: word plus affix can be part of a compound word at the end, | |
1093 middle, start, etc. The flags are combined with the flags of the basic | |
1094 word. |spell-compound| | |
1095 - NEEDAFFIX: another affix is needed to make a valid word. | |
1096 - CIRCUMFIX, as explained just below. | |
484 | 1097 |
820 | 1098 |
1099 CIRCUMFIX *spell-CIRCUMFIX* | |
1100 | |
1101 The CIRCUMFIX flag means a prefix and suffix must be added at the same time. | |
1102 If a prefix has the CIRCUMFIX flag than only suffixes with the CIRCUMFIX flag | |
1103 can be added, and the other way around. | |
1104 An alternative is to only specify the suffix, and give the that suffix two | |
1105 flags: The required prefix and the NEEDAFFIX flag. |spell-NEEDAFFIX| | |
1106 | |
1107 | |
856 | 1108 PFXPOSTPONE *spell-PFXPOSTPONE* |
820 | 1109 |
341 | 1110 When an affix file has very many prefixes that apply to many words it's not |
1111 possible to build the whole word list in memory. This applies to Hebrew (a | |
1112 list with all words is over a Gbyte). In that case applying prefixes must be | |
1113 postponed. This makes spell checking slower. It is indicated by this keyword | |
1114 in the .aff file: | |
1115 | |
1116 PFXPOSTPONE ~ | |
1117 | |
820 | 1118 Only prefixes without a chop string and without flags can be postponed. |
1119 Prefixes with a chop string or with flags will still be included in the word | |
1120 list. An exception if the chop string is one character and equal to the last | |
1121 character of the added string, but in lower case. Thus when the chop string | |
1122 is used to allow the following word to start with an upper case letter. | |
341 | 1123 |
481 | 1124 |
493 | 1125 WORDS WITH A SLASH *spell-SLASH* |
481 | 1126 |
1127 The slash is used in the .dic file to separate the basic word from the affix | |
640 | 1128 letters and other flags. Unfortunately, this means you cannot use a slash in |
1129 a word. Thus "TCP/IP" is not a word but "TCP with the flags "IP". To include | |
1130 a slash in the word put a backslash before it: "TCP\/IP". In the rare case | |
1131 you want to use a backslash inside a word you need to use two backslashes. | |
1132 Any other use of the backslash is reserved for future expansion. | |
481 | 1133 |
1134 | |
624 | 1135 KEEP-CASE WORDS *spell-KEEPCASE* |
481 | 1136 |
624 | 1137 In the affix file a KEEPCASE line can be used to define the affix name used |
1138 for keep-case words. Example: | |
308 | 1139 |
624 | 1140 KEEPCASE = ~ |
308 | 1141 |
625 | 1142 This flag is not supported by Myspell. It has the meaning that case matters. |
1143 This can be used if the word does not have the first letter in upper case at | |
1144 the start of a sentence. Example: | |
1145 | |
1146 word list matches does not match ~ | |
1147 's morgens/= 's morgens 'S morgens 's Morgens 'S MORGENS | |
1148 's Morgens 's Morgens 'S MORGENS 'S morgens 's morgens | |
1149 | |
1150 The flag can also be used to avoid that the word matches when it is in all | |
1151 upper-case letters. | |
308 | 1152 |
341 | 1153 |
624 | 1154 RARE WORDS *spell-RARE* |
481 | 1155 |
624 | 1156 In the affix file a RARE line can be used to define the affix name used for |
308 | 1157 rare words. Example: |
1158 | |
624 | 1159 RARE ? ~ |
308 | 1160 |
1161 Rare words are highlighted differently from bad words. This is to be used for | |
1162 words that are correct for the language, but are hardly ever used and could be | |
348 | 1163 a typing mistake anyway. When the same word is found as good it won't be |
1164 highlighted as rare. | |
1165 | |
819 | 1166 This flag can also be used on an affix, so that a basic word is not rare but |
1167 the basic word plus affix is rare |spell-affix-flags|. However, if the word | |
1168 also appears as a good word in another way (e.g., in another region) it won't | |
1169 be marked as rare. | |
1170 | |
348 | 1171 |
493 | 1172 BAD WORDS *spell-BAD* |
481 | 1173 |
348 | 1174 In the affix file a BAD line can be used to define the affix name used for |
1175 bad words. Example: | |
1176 | |
1177 BAD ! ~ | |
1178 | |
1179 This can be used to exclude words that would otherwise be good. For example | |
371 | 1180 "the the" in the .dic file: |
1181 | |
1182 the the/! ~ | |
1183 | |
1184 Once a word has been marked as bad it won't be undone by encountering the same | |
1185 word as good. | |
308 | 1186 |
625 | 1187 The flag also applies to the word with affixes, thus this can be used to mark |
1188 a whole bunch of related words as bad. | |
1189 | |
1762 | 1190 *spell-FORBIDDENWORD* |
1191 FORBIDDENWORD can be used just like BAD. For compatibility with Hunspell. | |
1192 | |
493 | 1193 *spell-NEEDAFFIX* |
484 | 1194 The NEEDAFFIX flag is used to require that a word is used with an affix. The |
625 | 1195 word itself is not a good word (unless there is an empty affix). Example: |
484 | 1196 |
1197 NEEDAFFIX + ~ | |
1198 | |
308 | 1199 |
493 | 1200 COMPOUND WORDS *spell-compound* |
481 | 1201 |
484 | 1202 A compound word is a longer word made by concatenating words that appear in |
1203 the .dic file. To specify which words may be concatenated a character is | |
1204 used. This character is put in the list of affixes after the word. We will | |
1205 call this character a flag here. Obviously these flags must be different from | |
1206 any affix IDs used. | |
481 | 1207 |
1208 *spell-COMPOUNDFLAG* | |
625 | 1209 The Myspell compatible method uses one flag, specified with COMPOUNDFLAG. All |
1210 words with this flag combine in any order. This means there is no control | |
484 | 1211 over which word comes first. Example: |
481 | 1212 COMPOUNDFLAG c ~ |
1213 | |
714 | 1214 *spell-COMPOUNDRULE* |
484 | 1215 A more advanced method to specify how compound words can be formed uses |
1216 multiple items with multiple flags. This is not compatible with Myspell 3.0. | |
1217 Let's start with an example: | |
714 | 1218 COMPOUNDRULE c+ ~ |
1219 COMPOUNDRULE se ~ | |
481 | 1220 |
484 | 1221 The first line defines that words with the "c" flag can be concatenated in any |
1222 order. The second line defines compound words that are made of one word with | |
1223 the "s" flag and one word with the "e" flag. With this dictionary: | |
1224 bork/c ~ | |
1225 onion/s ~ | |
1226 soup/e ~ | |
481 | 1227 |
484 | 1228 You can make these words: |
1229 bork | |
1230 borkbork | |
1231 borkborkbork | |
1232 (etc.) | |
481 | 1233 onion |
1234 soup | |
1235 onionsoup | |
1236 | |
714 | 1237 The COMPOUNDRULE item may appear multiple times. The argument is made out of |
484 | 1238 one or more groups, where each group can be: |
1239 one flag e.g., c | |
1240 alternate flags inside [] e.g., [abc] | |
1241 Optionally this may be followed by: | |
1242 * the group appears zero or more times, e.g., sm*e | |
1243 + the group appears one or more times, e.g., c+ | |
481 | 1244 |
484 | 1245 This is similar to the regexp pattern syntax (but not the same!). A few |
1246 examples with the sequence of word flags they require: | |
714 | 1247 COMPOUNDRULE x+ x xx xxx etc. |
1248 COMPOUNDRULE yz yz | |
1249 COMPOUNDRULE x+z xz xxz xxxz etc. | |
1250 COMPOUNDRULE yx+ yx yxx yxxx etc. | |
481 | 1251 |
714 | 1252 COMPOUNDRULE [abc]z az bz cz |
1253 COMPOUNDRULE [abc]+z az aaz abaz bz baz bcbz cz caz cbaz etc. | |
1254 COMPOUNDRULE a[xyz]+ ax axx axyz ay ayx ayzz az azy azxy etc. | |
1255 COMPOUNDRULE sm*e se sme smme smmme etc. | |
1256 COMPOUNDRULE s[xyz]*e se sxe sxye sxyxe sye syze sze szye szyxe etc. | |
481 | 1257 |
491 | 1258 A specific example: Allow a compound to be made of two words and a dash: |
1259 In the .aff file: | |
714 | 1260 COMPOUNDRULE sde ~ |
491 | 1261 NEEDAFFIX x ~ |
809 | 1262 COMPOUNDWORDMAX 3 ~ |
491 | 1263 COMPOUNDMIN 1 ~ |
1264 In the .dic file: | |
1265 start/s ~ | |
1266 end/e ~ | |
1267 -/xd ~ | |
1268 | |
1269 This allows for the word "start-end", but not "startend". | |
1270 | |
819 | 1271 An additional implied rule is that, without further flags, a word with a |
1272 prefix cannot be compounded after another word, and a word with a suffix | |
1273 cannot be compounded with a following word. Thus the affix cannot appear | |
1274 on the inside of a compound word. This can be changed with the | |
1275 |spell-COMPOUNDPERMITFLAG|. | |
1276 | |
625 | 1277 *spell-NEEDCOMPOUND* |
1278 The NEEDCOMPOUND flag is used to require that a word is used as part of a | |
1279 compound word. The word itself is not a good word. Example: | |
1280 | |
1281 NEEDCOMPOUND & ~ | |
1282 | |
1762 | 1283 *spell-ONLYINCOMPOUND* |
1284 The ONLYINCOMPOUND does exactly the same as NEEDCOMPOUND. Supported for | |
2033
de5a43c5eedc
Update documentation files.
Bram Moolenaar <bram@zimbu.org>
parents:
1762
diff
changeset
|
1285 compatibility with Hunspell. |
1762 | 1286 |
481 | 1287 *spell-COMPOUNDMIN* |
500 | 1288 The minimal character length of a word used for compounding is specified with |
481 | 1289 COMPOUNDMIN. Example: |
1290 COMPOUNDMIN 5 ~ | |
1291 | |
500 | 1292 When omitted there is no minimal length. Obviously you could just leave out |
1293 the compound flag from short words instead, this feature is present for | |
1294 compatibility with Myspell. | |
481 | 1295 |
809 | 1296 *spell-COMPOUNDWORDMAX* |
484 | 1297 The maximum number of words that can be concatenated into a compound word is |
809 | 1298 specified with COMPOUNDWORDMAX. Example: |
1299 COMPOUNDWORDMAX 3 ~ | |
484 | 1300 |
1301 When omitted there is no maximum. It applies to all compound words. | |
1302 | |
1303 To set a limit for words with specific flags make sure the items in | |
714 | 1304 COMPOUNDRULE where they appear don't allow too many words. |
484 | 1305 |
1306 *spell-COMPOUNDSYLMAX* | |
1307 The maximum number of syllables that a compound word may contain is specified | |
1308 with COMPOUNDSYLMAX. Example: | |
1309 COMPOUNDSYLMAX 6 ~ | |
481 | 1310 |
484 | 1311 This has no effect if there is no SYLLABLE item. Without COMPOUNDSYLMAX there |
1312 is no limit on the number of syllables. | |
1313 | |
809 | 1314 If both COMPOUNDWORDMAX and COMPOUNDSYLMAX are defined, a compound word is |
491 | 1315 accepted if it fits one of the criteria, thus is either made from up to |
809 | 1316 COMPOUNDWORDMAX words or contains up to COMPOUNDSYLMAX syllables. |
491 | 1317 |
625 | 1318 *spell-COMPOUNDFORBIDFLAG* |
1319 The COMPOUNDFORBIDFLAG specifies a flag that can be used on an affix. It | |
819 | 1320 means that the word plus affix cannot be used in a compound word. Example: |
1321 affix file: | |
1322 COMPOUNDFLAG c ~ | |
1323 COMPOUNDFORBIDFLAG x ~ | |
1324 SFX a Y 2 ~ | |
1325 SFX a 0 s . ~ | |
1326 SFX a 0 ize/x . ~ | |
1327 dictionary: | |
1328 word/c ~ | |
1329 util/ac ~ | |
1330 | |
1331 This allows for "wordutil" and "wordutils" but not "wordutilize". | |
827 | 1332 Note: this doesn't work for postponed prefixes yet. |
625 | 1333 |
1334 *spell-COMPOUNDPERMITFLAG* | |
1335 The COMPOUNDPERMITFLAG specifies a flag that can be used on an affix. It | |
1336 means that the word plus affix can also be used in a compound word in a way | |
819 | 1337 where the affix ends up halfway the word. Without this flag that is not |
1338 allowed. | |
827 | 1339 Note: this doesn't work for postponed prefixes yet. |
625 | 1340 |
809 | 1341 *spell-COMPOUNDROOT* |
1342 The COMPOUNDROOT flag is used for words in the dictionary that are already a | |
1343 compound. This means it counts for two words when checking the compounding | |
1344 rules. Can also be used for an affix to count the affix as a compounding | |
1345 word. | |
1346 | |
1762 | 1347 *spell-CHECKCOMPOUNDPATTERN* |
1348 CHECKCOMPOUNDPATTERN is used to define patterns that, when matching at the | |
1349 position where two words are compounded together forbids the compound. | |
1350 For example: | |
1351 CHECKCOMPOUNDPATTERN o e ~ | |
1352 | |
1353 This forbids compounding if the first word ends in "o" and the second word | |
1354 starts with "e". | |
1355 | |
1356 The arguments must be plain text, no patterns are actually supported, despite | |
1357 the item name. Case is always ignored. | |
1358 | |
1359 The Hunspell feature to use three arguments and flags is not supported. | |
1360 | |
484 | 1361 *spell-SYLLABLE* |
1362 The SYLLABLE item defines characters or character sequences that are used to | |
1363 count the number of syllables in a word. Example: | |
1364 SYLLABLE aáeéiíoóöõuúüûy/aa/au/ea/ee/ei/ie/oa/oe/oo/ou/uu/ui ~ | |
1365 | |
1366 Before the first slash is the set of characters that are counted for one | |
1367 syllable, also when repeated and mixed, until the next character that is not | |
1368 in this set. After the slash come sequences of characters that are counted | |
1369 for one syllable. These are preferred over using characters from the set. | |
1370 With the example "ideeen" has three syllables, counted by "i", "ee" and "e". | |
1371 | |
1372 Only case-folded letters need to be included. | |
1373 | |
1125 | 1374 Another way to restrict compounding was mentioned above: Adding the |
819 | 1375 |spell-COMPOUNDFORBIDFLAG| flag to an affix causes all words that are made |
1376 with that affix not be be used for compounding. | |
481 | 1377 |
493 | 1378 |
1379 UNLIMITED COMPOUNDING *spell-NOBREAK* | |
1380 | |
1381 For some languages, such as Thai, there is no space in between words. This | |
1382 looks like all words are compounded. To specify this use the NOBREAK item in | |
1383 the affix file, without arguments: | |
1384 NOBREAK ~ | |
1385 | |
1386 Vim will try to figure out where one word ends and a next starts. When there | |
1387 are spelling mistakes this may not be quite right. | |
1388 | |
481 | 1389 |
625 | 1390 *spell-COMMON* |
1391 Common words can be specified with the COMMON item. This will give better | |
1392 suggestions when editing a short file. Example: | |
1393 | |
1394 COMMON the of to and a in is it you that he was for on are ~ | |
1395 | |
1396 The words must be separated by white space, up to 25 per line. | |
1397 When multiple regions are specified in a ":mkspell" command the common words | |
1398 for all regions are combined and used for all regions. | |
1399 | |
1400 *spell-NOSPLITSUGS* | |
699 | 1401 This item indicates that splitting a word to make suggestions is not a good |
1402 idea. Split-word suggestions will appear only when there are few similar | |
1403 words. | |
625 | 1404 |
1405 NOSPLITSUGS ~ | |
1406 | |
1407 *spell-NOSUGGEST* | |
1408 The flag specified with NOSUGGEST can be used for words that will not be | |
1409 suggested. Can be used for obscene words. | |
1410 | |
1411 NOSUGGEST % ~ | |
1412 | |
1413 | |
493 | 1414 REPLACEMENTS *spell-REP* |
323 | 1415 |
1416 In the affix file REP items can be used to define common mistakes. This is | |
1417 used to make spelling suggestions. The items define the "from" text and the | |
1418 "to" replacement. Example: | |
1419 | |
1420 REP 4 ~ | |
1421 REP f ph ~ | |
1422 REP ph f ~ | |
1423 REP k ch ~ | |
1424 REP ch k ~ | |
1425 | |
497 | 1426 The first line specifies the number of REP lines following. Vim ignores the |
625 | 1427 number, but it must be there (for compatibility with Myspell). |
497 | 1428 |
378 | 1429 Don't include simple one-character replacements or swaps. Vim will try these |
1430 anyway. You can include whole words if you want to, but you might want to use | |
1431 the "file:" item in 'spellsuggest' instead. | |
323 | 1432 |
532 | 1433 You can include a space by using an underscore: |
1434 | |
1435 REP the_the the ~ | |
1436 | |
323 | 1437 |
626 | 1438 SIMILAR CHARACTERS *spell-MAP* *E783* |
323 | 1439 |
378 | 1440 In the affix file MAP items can be used to define letters that are very much |
323 | 1441 alike. This is mostly used for a letter with different accents. This is used |
1442 to prefer suggestions with these letters substituted. Example: | |
1443 | |
1444 MAP 2 ~ | |
1445 MAP eéëêè ~ | |
1446 MAP uüùúû ~ | |
1447 | |
497 | 1448 The first line specifies the number of MAP lines following. Vim ignores the |
1449 number, but the line must be there. | |
323 | 1450 |
378 | 1451 Each letter must appear in only one of the MAP items. It's a bit more |
1452 efficient if the first letter is ASCII or at least one without accents. | |
336 | 1453 |
323 | 1454 |
625 | 1455 .SUG FILE *spell-NOSUGFILE* |
1456 | |
1457 When soundfolding is specified in the affix file then ":mkspell" will normally | |
644 | 1458 produce a .sug file next to the .spl file. This file is used to find |
1459 suggestions by their sound-a-like form quickly. At the cost of a lot of | |
1460 memory (the amount depends on the number of words, |:mkspell| will display an | |
1461 estimate when it's done). | |
625 | 1462 |
1463 To avoid producing a .sug file use this item in the affix file: | |
1464 | |
1465 NOSUGFILE ~ | |
1466 | |
644 | 1467 Users can simply omit the .sug file if they don't want to use it. |
1468 | |
625 | 1469 |
493 | 1470 SOUND-A-LIKE *spell-SAL* |
323 | 1471 |
1472 In the affix file SAL items can be used to define the sounds-a-like mechanism | |
1473 to be used. The main items define the "from" text and the "to" replacement. | |
378 | 1474 Simplistic example: |
323 | 1475 |
856 | 1476 SAL CIA X ~ |
1477 SAL CH X ~ | |
1478 SAL C K ~ | |
1479 SAL K K ~ | |
323 | 1480 |
388 | 1481 There are a few rules and this can become quite complicated. An explanation |
378 | 1482 how it works can be found in the Aspell manual: |
375 | 1483 http://aspell.net/man-html/Phonetic-Code.html. |
323 | 1484 |
1485 There are a few special items: | |
1486 | |
1487 SAL followup true ~ | |
1488 SAL collapse_result true ~ | |
1489 SAL remove_accents true ~ | |
1490 | |
1491 "1" has the same meaning as "true". Any other value means "false". | |
1492 | |
375 | 1493 |
493 | 1494 SIMPLE SOUNDFOLDING *spell-SOFOFROM* *spell-SOFOTO* |
375 | 1495 |
1496 The SAL mechanism is complex and slow. A simpler mechanism is mapping all | |
1497 characters to another character, mapping similar sounding characters to the | |
1498 same character. At the same time this does case folding. You can not have | |
378 | 1499 both SAL items and simple soundfolding. |
375 | 1500 |
388 | 1501 There are two items required: one to specify the characters that are mapped |
375 | 1502 and one that specifies the characters they are mapped to. They must have |
1503 exactly the same number of characters. Example: | |
1504 | |
1505 SOFOFROM abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ ~ | |
1506 SOFOTO ebctefghejklnnepkrstevvkesebctefghejklnnepkrstevvkes ~ | |
1507 | |
1508 In the example all vowels are mapped to the same character 'e'. Another | |
378 | 1509 method would be to leave out all vowels. Some characters that sound nearly |
1510 the same and are often mixed up, such as 'm' and 'n', are mapped to the same | |
1511 character. Don't do this too much, all words will start looking alike. | |
375 | 1512 |
1513 Characters that do not appear in SOFOFROM will be left out, except that all | |
1514 white space is replaced by one space. Sequences of the same character in | |
1515 SOFOFROM are replaced by one. | |
1516 | |
1517 You can use the |soundfold()| function to try out the results. Or set the | |
587 | 1518 'verbose' option to see the score in the output of the |z=| command. |
375 | 1519 |
1520 | |
625 | 1521 UNSUPPORTED ITEMS *spell-affix-not-supported* |
1522 | |
1523 These items appear in the affix file of other spell checkers. In Vim they are | |
1524 ignored, not supported or defined in another way. | |
1525 | |
1526 ACCENT (Hunspell) *spell-ACCENT* | |
1527 Use MAP instead. |spell-MAP| | |
1528 | |
1762 | 1529 BREAK (Hunspell) *spell-BREAK* |
1530 Define break points. Unclear how it works exactly. | |
1531 Not supported. | |
1532 | |
625 | 1533 CHECKCOMPOUNDCASE (Hunspell) *spell-CHECKCOMPOUNDCASE* |
1534 Disallow uppercase letters at compound word boundaries. | |
1535 Not supported. | |
1536 | |
1537 CHECKCOMPOUNDDUP (Hunspell) *spell-CHECKCOMPOUNDDUP* | |
1538 Disallow using the same word twice in a compound. Not | |
1539 supported. | |
1540 | |
1541 CHECKCOMPOUNDREP (Hunspell) *spell-CHECKCOMPOUNDREP* | |
1542 Something about using REP items and compound words. Not | |
1543 supported. | |
1544 | |
1545 CHECKCOMPOUNDTRIPLE (Hunspell) *spell-CHECKCOMPOUNDTRIPLE* | |
1546 Forbid three identical characters when compounding. Not | |
1547 supported. | |
1548 | |
1549 COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES* | |
1550 Enables using two prefixes. Not supported. | |
1551 | |
714 | 1552 COMPOUND (Hunspell) *spell-COMPOUND* |
1125 | 1553 This is one line with the count of COMPOUND items, followed by |
856 | 1554 that many COMPOUND lines with a pattern. |
1555 Remove the first line with the count and rename the other | |
1556 items to COMPOUNDRULE |spell-COMPOUNDRULE| | |
714 | 1557 |
809 | 1558 COMPOUNDFIRST (Hunspell) *spell-COMPOUNDFIRST* |
1559 Use COMPOUNDRULE instead. |spell-COMPOUNDRULE| | |
1560 | |
625 | 1561 COMPOUNDBEGIN (Hunspell) *spell-COMPOUNDBEGIN* |
714 | 1562 Use COMPOUNDRULE instead. |spell-COMPOUNDRULE| |
625 | 1563 |
1564 COMPOUNDEND (Hunspell) *spell-COMPOUNDEND* | |
714 | 1565 Use COMPOUNDRULE instead. |spell-COMPOUNDRULE| |
625 | 1566 |
1567 COMPOUNDMIDDLE (Hunspell) *spell-COMPOUNDMIDDLE* | |
714 | 1568 Use COMPOUNDRULE instead. |spell-COMPOUNDRULE| |
625 | 1569 |
1762 | 1570 COMPOUNDRULES (Hunspell) *spell-COMPOUNDRULES* |
1571 Number of COMPOUNDRULE lines following. Ignored, but the | |
1572 argument must be a number. | |
1573 | |
625 | 1574 COMPOUNDSYLLABLE (Hunspell) *spell-COMPOUNDSYLLABLE* |
1575 Use SYLLABLE and COMPOUNDSYLMAX instead. |spell-SYLLABLE| | |
1576 |spell-COMPOUNDSYLMAX| | |
1577 | |
1762 | 1578 KEY (Hunspell) *spell-KEY* |
1579 Define characters that are close together on the keyboard. | |
1580 Used to give better suggestions. Not supported. | |
1581 | |
625 | 1582 LANG (Hunspell) *spell-LANG* |
1583 This specifies language-specific behavior. This actually | |
1584 moves part of the language knowledge into the program, | |
1585 therefore Vim does not support it. Each language property | |
1586 must be specified separately. | |
1587 | |
1588 LEMMA_PRESENT (Hunspell) *spell-LEMMA_PRESENT* | |
809 | 1589 Only needed for morphological analysis. |
625 | 1590 |
1591 MAXNGRAMSUGS (Hunspell) *spell-MAXNGRAMSUGS* | |
1762 | 1592 Set number of n-gram suggestions. Not supported. |
625 | 1593 |
1594 PSEUDOROOT (Hunspell) *spell-PSEUDOROOT* | |
1595 Use NEEDAFFIX instead. |spell-NEEDAFFIX| | |
1596 | |
1597 SUGSWITHDOTS (Hunspell) *spell-SUGSWITHDOTS* | |
1598 Adds dots to suggestions. Vim doesn't need this. | |
1599 | |
1600 SYLLABLENUM (Hunspell) *spell-SYLLABLENUM* | |
1601 Not supported. | |
1602 | |
1603 TRY (Myspell, Hunspell, others) *spell-TRY* | |
1604 Vim does not use the TRY item, it is ignored. For making | |
724 | 1605 suggestions the actual characters in the words are used, that |
1606 is much more efficient. | |
625 | 1607 |
1608 WORDCHARS (Hunspell) *spell-WORDCHARS* | |
1609 Used to recognize words. Vim doesn't need it, because there | |
1610 is no need to separate words before checking them (using a | |
1611 trie instead of a hashtable). | |
1612 | |
221 | 1613 vim:tw=78:sw=4:ts=8:ft=help:norl: |