|
477
|
1 *spell.txt* For Vim version 7.0aa. Last change: 2005 Aug 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
|
|
|
19 ==============================================================================
|
|
|
20 1. Quick start *spell-quickstart*
|
|
|
21
|
|
|
22 This command switches on spell checking: >
|
|
|
23
|
|
|
24 :setlocal spell spelllang=en_us
|
|
|
25
|
|
237
|
26 This switches on the 'spell' option and specifies to check for US English.
|
|
221
|
27
|
|
|
28 The words that are not recognized are highlighted with one of these:
|
|
333
|
29 SpellBad word not recognized |hl-SpellBad|
|
|
388
|
30 SpellCap word not capitalised |hl-SpellCap|
|
|
333
|
31 SpellRare rare word |hl-SpellRare|
|
|
|
32 SpellLocal wrong spelling for selected region |hl-SpellLocal|
|
|
221
|
33
|
|
237
|
34 Vim only checks words for spelling, there is no grammar check.
|
|
|
35
|
|
435
|
36 If the 'mousemodel' option is set to "popup" and the cursor is on a badly
|
|
|
37 spelled word or it is "popup_setpos" and the mouse pointer is on a badly
|
|
|
38 spelled word, then the popup menu will contain an submenu to replace the bad
|
|
|
39 word. Note: this slows down the appearance of the popup menu.
|
|
|
40
|
|
237
|
41 To search for the next misspelled word:
|
|
|
42
|
|
|
43 *]s* *E756*
|
|
|
44 ]s Move to next misspelled word after the cursor.
|
|
253
|
45 A count before the command can be used to repeat.
|
|
237
|
46
|
|
|
47 *[s*
|
|
253
|
48 [s Like "]s" but search backwards, find the misspelled
|
|
348
|
49 word before the cursor. Doesn't recognize words
|
|
|
50 split over two lines, thus may stop at words that are
|
|
386
|
51 not highlighted as bad. Does not stop at word with
|
|
|
52 missing capital at the start of a line.
|
|
253
|
53
|
|
|
54 *]S*
|
|
|
55 ]S Like "]s" but only stop at bad words, not at rare
|
|
|
56 words or words for another region.
|
|
|
57
|
|
|
58 *[S*
|
|
|
59 [S Like "]S" but search backwards.
|
|
237
|
60
|
|
221
|
61
|
|
323
|
62 To add words to your own word list: *E764*
|
|
314
|
63
|
|
|
64 *zg*
|
|
386
|
65 zg Add word under the cursor as a good word to the first
|
|
|
66 name in 'spellfile'. In Visual mode the selected
|
|
|
67 characters are added as a word (including white
|
|
|
68 space!). If the word is explicitly marked as bad word
|
|
|
69 in another spell file the result is unpredictable.
|
|
|
70 A count may precede the command to indicate the entry
|
|
|
71 in 'spellfile' to be used. A count of two uses the
|
|
|
72 second entry.
|
|
314
|
73
|
|
383
|
74 *zG*
|
|
386
|
75 zG Like "zg" but add the word to the internal word list
|
|
|
76 |internal-wordlist|.
|
|
383
|
77
|
|
314
|
78 *zw*
|
|
386
|
79 zw Like "zg" but mark the word as a wrong (bad) word.
|
|
314
|
80
|
|
383
|
81 *zW*
|
|
386
|
82 zW Like "zw" but add the word to the internal word list
|
|
|
83 |internal-wordlist|.
|
|
383
|
84
|
|
333
|
85 *:spe* *:spellgood*
|
|
386
|
86 :[count]spe[llgood] {word}
|
|
391
|
87 Add {word} as a good word to 'spellfile', like with
|
|
386
|
88 "zg". Without count the first name is used, with a
|
|
|
89 count of two the second entry, etc.
|
|
314
|
90
|
|
391
|
91 :spe[llgood]! {word} Add {word} as a good word to the internal word list,
|
|
386
|
92 like with "zG".
|
|
383
|
93
|
|
333
|
94 *:spellw* *:spellwrong*
|
|
386
|
95 :[count]spellw[rong] {word}
|
|
391
|
96 Add {word} as a wrong (bad) word to 'spellfile', as
|
|
386
|
97 with "zw". Without count the first name is used, with
|
|
|
98 a count of two the second entry, etc.
|
|
314
|
99
|
|
391
|
100 :spellw[rong]! {word} Add {word} as a wrong (bad) word to the internal word
|
|
383
|
101 list.
|
|
|
102
|
|
359
|
103 After adding a word to 'spellfile' with the above commands its associated
|
|
378
|
104 ".spl" file will automatically be updated and reloaded. If you change
|
|
|
105 'spellfile' manually you need to use the |:mkspell| command. This sequence of
|
|
|
106 commands mostly works well: >
|
|
386
|
107 :edit <file in 'spellfile'>
|
|
359
|
108 < (make changes to the spell file) >
|
|
|
109 :mkspell! %
|
|
|
110
|
|
|
111 More details about the 'spellfile' format below |spell-wordlist-format|.
|
|
314
|
112
|
|
386
|
113 *internal-wordlist*
|
|
383
|
114 The internal word list is used for all buffers where 'spell' is set. It is
|
|
|
115 not stored, it is lost when you exit Vim. It is also cleared when 'encoding'
|
|
|
116 is set.
|
|
|
117
|
|
314
|
118
|
|
323
|
119 Finding suggestions for bad words:
|
|
|
120 *z?*
|
|
348
|
121 z? For the word under/after the cursor suggest correctly
|
|
378
|
122 spelled words. This also works to find alternatives
|
|
|
123 for a word that is not highlighted as a bad word,
|
|
|
124 e.g., when the word after it is bad.
|
|
348
|
125 The results are sorted on similarity to the word
|
|
|
126 under/after the cursor.
|
|
323
|
127 This may take a long time. Hit CTRL-C when you are
|
|
|
128 bored.
|
|
374
|
129 This does not work when there is a line break halfway
|
|
|
130 a bad word (e.g., "the the").
|
|
323
|
131 You can enter the number of your choice or press
|
|
374
|
132 <Enter> if you don't want to replace. You can also
|
|
|
133 use the mouse to click on your choice (only works if
|
|
|
134 the mouse can be used in Normal mode and when there
|
|
378
|
135 are no line wraps). Click on the first (header) line
|
|
374
|
136 to cancel.
|
|
327
|
137 If 'verbose' is non-zero a score will be displayed to
|
|
|
138 indicate the likeliness to the badly spelled word (the
|
|
|
139 higher the score the more different).
|
|
344
|
140 When a word was replaced the redo command "." will
|
|
|
141 repeat the word replacement. This works like "ciw",
|
|
|
142 the good word and <Esc>.
|
|
|
143
|
|
374
|
144 *:spellr* *:spellrepall* *E752* *E753*
|
|
|
145 :spellr[epall] Repeat the replacement done by |z?| for all matches
|
|
|
146 with the replaced word in the current window.
|
|
|
147
|
|
477
|
148 In Insert mode, when the cursor is after a badly spelled word, you can use
|
|
|
149 CTRL-X s to find suggestions. This works like Insert mode completion. Use
|
|
|
150 CTRL-N to use the next suggestion, CTRL-P to go back. |i_CTRL-X_s|
|
|
|
151
|
|
344
|
152 The 'spellsuggest' option influences how the list of suggestions is generated
|
|
|
153 and sorted. See |'spellsuggest'|.
|
|
323
|
154
|
|
386
|
155 The 'spellcapcheck' option is used to check the first word of a sentence
|
|
|
156 starts with a capital. This doesn't work for the first word in the file.
|
|
|
157 When there is a line break right after a sentence the highlighting of the next
|
|
|
158 line may be postponed. Use |CTRL-L| when needed.
|
|
|
159
|
|
378
|
160 ==============================================================================
|
|
|
161 2. Remarks on spell checking *spell-remarks*
|
|
323
|
162
|
|
227
|
163 PERFORMANCE
|
|
|
164
|
|
378
|
165 Vim does on-the-fly spell checking. To make this work fast the word list is
|
|
|
166 loaded in memory. Thus this uses a lot of memory (1 Mbyte or more). There
|
|
|
167 might also be a noticeable delay when the word list is loaded, which happens
|
|
|
168 when 'spell' is set and when 'spelllang' is set while 'spell' was already set.
|
|
|
169 To minimize the delay each word list is only loaded once, it is not deleted
|
|
|
170 when 'spelllang' is made empty or 'spell' is reset. When 'encoding' is set
|
|
|
171 all the word lists are reloaded, thus you may notice a delay then too.
|
|
227
|
172
|
|
|
173
|
|
221
|
174 REGIONS
|
|
|
175
|
|
|
176 A word may be spelled differently in various regions. For example, English
|
|
|
177 comes in (at least) these variants:
|
|
|
178
|
|
|
179 en all regions
|
|
247
|
180 en_au Australia
|
|
|
181 en_ca Canada
|
|
221
|
182 en_gb Great Britain
|
|
247
|
183 en_nz New Zealand
|
|
|
184 en_us USA
|
|
221
|
185
|
|
|
186 Words that are not used in one region but are used in another region are
|
|
333
|
187 highlighted with SpellLocal |hl-SpellLocal|.
|
|
221
|
188
|
|
237
|
189 Always use lowercase letters for the language and region names.
|
|
221
|
190
|
|
320
|
191 When adding a word with |zg| or another command it's always added for all
|
|
|
192 regions. You can change that by manually editing the 'spellfile'. See
|
|
389
|
193 |spell-wordlist-format|. Note that the regions as specified in the files in
|
|
|
194 'spellfile' are only used when all entries in "spelllang" specify the same
|
|
|
195 region (not counting files specified by their .spl name).
|
|
320
|
196
|
|
221
|
197
|
|
353
|
198 SPELL FILES *spell-load*
|
|
221
|
199
|
|
|
200 Vim searches for spell files in the "spell" subdirectory of the directories in
|
|
320
|
201 'runtimepath'. The name is: LL.EEE.spl, where:
|
|
237
|
202 LL the language name
|
|
|
203 EEE the value of 'encoding'
|
|
221
|
204
|
|
353
|
205 The value for "LL" comes from 'spelllang', but excludes the region name.
|
|
|
206 Examples:
|
|
|
207 'spelllang' LL ~
|
|
|
208 en_us en
|
|
|
209 en-rare en-rare
|
|
|
210 medical_ca medical
|
|
|
211
|
|
320
|
212 Only the first file is loaded, the one that is first in 'runtimepath'. If
|
|
|
213 this succeeds then additionally files with the name LL.EEE.add.spl are loaded.
|
|
|
214 All the ones that are found are used.
|
|
|
215
|
|
386
|
216 Additionally, the files related to the names in 'spellfile' are loaded. These
|
|
|
217 are the files that |zg| and |zw| add good and wrong words to.
|
|
353
|
218
|
|
242
|
219 Exceptions:
|
|
|
220 - Vim uses "latin1" when 'encoding' is "iso-8859-15". The euro sign doesn't
|
|
|
221 matter for spelling.
|
|
|
222 - When no spell file for 'encoding' is found "ascii" is tried. This only
|
|
|
223 works for languages where nearly all words are ASCII, such as English. It
|
|
|
224 helps when 'encoding' is not "latin1", such as iso-8859-2, and English text
|
|
320
|
225 is being edited. For the ".add" files the same name as the found main
|
|
|
226 spell file is used.
|
|
|
227
|
|
|
228 For example, with these values:
|
|
|
229 'runtimepath' is "~/.vim,/usr/share/vim70,~/.vim/after"
|
|
|
230 'encoding' is "iso-8859-2"
|
|
|
231 'spelllang' is "pl"
|
|
|
232
|
|
|
233 Vim will look for:
|
|
|
234 1. ~/.vim/spell/pl.iso-8859-2.spl
|
|
|
235 2. /usr/share/vim70/spell/pl.iso-8859-2.spl
|
|
|
236 3. ~/.vim/spell/pl.iso-8859-2.add.spl
|
|
|
237 4. /usr/share/vim70/spell/pl.iso-8859-2.add.spl
|
|
|
238 5. ~/.vim/after/spell/pl.iso-8859-2.add.spl
|
|
|
239
|
|
|
240 This assumes 1. is not found and 2. is found.
|
|
|
241
|
|
|
242 If 'encoding' is "latin1" Vim will look for:
|
|
|
243 1. ~/.vim/spell/pl.latin1.spl
|
|
|
244 2. /usr/share/vim70/spell/pl.latin1.spl
|
|
|
245 3. ~/.vim/after/spell/pl.latin1.spl
|
|
|
246 4. ~/.vim/spell/pl.ascii.spl
|
|
|
247 5. /usr/share/vim70/spell/pl.ascii.spl
|
|
|
248 6. ~/.vim/after/spell/pl.ascii.spl
|
|
|
249
|
|
|
250 This assumes none of them are found (Polish doesn't make sense when leaving
|
|
|
251 out the non-ASCII characters).
|
|
221
|
252
|
|
227
|
253 Spelling for EBCDIC is currently not supported.
|
|
|
254
|
|
237
|
255 A spell file might not be available in the current 'encoding'. See
|
|
|
256 |spell-mkspell| about how to create a spell file. Converting a spell file
|
|
242
|
257 with "iconv" will NOT work!
|
|
221
|
258
|
|
237
|
259 *E758* *E759*
|
|
|
260 When loading a spell file Vim checks that it is properly formatted. If you
|
|
242
|
261 get an error the file may be truncated, modified or intended for another Vim
|
|
|
262 version.
|
|
237
|
263
|
|
227
|
264
|
|
|
265 WORDS
|
|
|
266
|
|
|
267 Vim uses a fixed method to recognize a word. This is independent of
|
|
|
268 'iskeyword', so that it also works in help files and for languages that
|
|
|
269 include characters like '-' in 'iskeyword'. The word characters do depend on
|
|
|
270 'encoding'.
|
|
|
271
|
|
323
|
272 The table with word characters is stored in the main .spl file. Therefore it
|
|
|
273 matters what the current locale is when generating it! A .add.spl file does
|
|
359
|
274 not contain a word table though.
|
|
323
|
275
|
|
320
|
276 A word that starts with a digit is always ignored. That includes hex numbers
|
|
|
277 in the form 0xff and 0XFF.
|
|
227
|
278
|
|
|
279
|
|
348
|
280 WORD COMBINATIONS
|
|
|
281
|
|
|
282 It is possible to spell-check words that include a space. This is used to
|
|
|
283 recognize words that are invalid when used by themselves, e.g. for "et al.".
|
|
|
284 It can also be used to recognize "the the" and highlight it.
|
|
|
285
|
|
|
286 The number of spaces is irrelevant. In most cases a line break may also
|
|
|
287 appear. However, this makes it difficult to find out where to start checking
|
|
|
288 for spelling mistakes. When you make a change to one line and only that line
|
|
|
289 is redrawn Vim won't look in the previous line, thus when "et" is at the end
|
|
|
290 of the previous line "al." will be flagged as an error. And when you type
|
|
|
291 "the<CR>the" the highlighting doesn't appear until the first line is redrawn.
|
|
|
292 Use |CTRL-L| to redraw right away. "[s" will also stop at a word combination
|
|
|
293 with a line break.
|
|
|
294
|
|
|
295 When encountering a line break Vim skips characters such as '*', '>' and '"',
|
|
|
296 so that comments in C, shell and Vim code can be spell checked.
|
|
|
297
|
|
|
298
|
|
253
|
299 SYNTAX HIGHLIGHTING *spell-syntax*
|
|
227
|
300
|
|
|
301 Files that use syntax highlighting can specify where spell checking should be
|
|
|
302 done:
|
|
|
303
|
|
320
|
304 1. everywhere default
|
|
|
305 2. in specific items use "contains=@Spell"
|
|
|
306 3. everywhere but specific items use "contains=@NoSpell"
|
|
227
|
307
|
|
320
|
308 For the second method adding the @NoSpell cluster will disable spell checking
|
|
|
309 again. This can be used, for example, to add @Spell to the comments of a
|
|
|
310 program, and add @NoSpell for items that shouldn't be checked.
|
|
227
|
311
|
|
348
|
312
|
|
|
313 VIM SCRIPTS
|
|
|
314
|
|
|
315 If you want to write a Vim script that does something with spelling, you may
|
|
|
316 find these functions useful:
|
|
|
317
|
|
|
318 spellbadword() find badly spelled word at the cursor
|
|
|
319 spellsuggest() get list of spelling suggestions
|
|
378
|
320 soundfold() get the sound-a-like version of a word
|
|
348
|
321
|
|
221
|
322 ==============================================================================
|
|
378
|
323 3. Generating a spell file *spell-mkspell*
|
|
237
|
324
|
|
|
325 Vim uses a binary file format for spelling. This greatly speeds up loading
|
|
|
326 the word list and keeps it small.
|
|
371
|
327 *.aff* *.dic* *Myspell*
|
|
237
|
328 You can create a Vim spell file from the .aff and .dic files that Myspell
|
|
|
329 uses. Myspell is used by OpenOffice.org and Mozilla. You should be able to
|
|
|
330 find them here:
|
|
|
331 http://lingucomponent.openoffice.org/spell_dic.html
|
|
348
|
332 You can also use a plain word list. The results are the same, the choice
|
|
378
|
333 depends on what word lists you can find.
|
|
221
|
334
|
|
388
|
335 If you install Aap (from www.a-a-p.org) you can use the recipes in the
|
|
|
336 runtime/spell/??/ directories. Aap will take care of downloading the files,
|
|
|
337 apply patches needed for Vim and build the .spl file.
|
|
|
338
|
|
341
|
339 Make sure your current locale is set properly, otherwise Vim doesn't know what
|
|
|
340 characters are upper/lower case letters. If the locale isn't available (e.g.,
|
|
|
341 when using an MS-Windows codepage on Unix) add tables to the .aff file
|
|
353
|
342 |spell-affix-chars|. If the .aff file doesn't define a table then the word
|
|
|
343 table of the currently active spelling is used. If spelling is not active
|
|
|
344 then Vim will try to guess.
|
|
341
|
345
|
|
353
|
346 *:mksp* *:mkspell*
|
|
|
347 :mksp[ell][!] [-ascii] {outname} {inname} ...
|
|
314
|
348 Generate a Vim spell file word lists. Example: >
|
|
378
|
349 :mkspell /tmp/nl nl_NL.words
|
|
353
|
350 < *E751*
|
|
314
|
351 When {outname} ends in ".spl" it is used as the output
|
|
|
352 file name. Otherwise it should be a language name,
|
|
353
|
353 such as "en", without the region name. The file
|
|
|
354 written will be "{outname}.{encoding}.spl", where
|
|
|
355 {encoding} is the value of the 'encoding' option.
|
|
301
|
356
|
|
378
|
357 When the output file already exists [!] must be used
|
|
333
|
358 to overwrite it.
|
|
|
359
|
|
242
|
360 When the [-ascii] argument is present, words with
|
|
|
361 non-ascii characters are skipped. The resulting file
|
|
314
|
362 ends in "ascii.spl".
|
|
301
|
363
|
|
|
364 The input can be the Myspell format files {inname}.aff
|
|
|
365 and {inname}.dic. If {inname}.aff does not exist then
|
|
|
366 {inname} is used as the file name of a plain word
|
|
|
367 list.
|
|
|
368
|
|
237
|
369 Multiple {inname} arguments can be given to combine
|
|
|
370 regions into one Vim spell file. Example: >
|
|
|
371 :mkspell ~/.vim/spell/en /tmp/en_US /tmp/en_CA /tmp/en_AU
|
|
|
372 < This combines the English word lists for US, CA and AU
|
|
|
373 into one en.spl file.
|
|
|
374 Up to eight regions can be combined. *E754* *755*
|
|
323
|
375 The REP and SAL items of the first .aff file where
|
|
|
376 they appear are used. |spell-affix-REP|
|
|
|
377 |spell-affix-SAL|
|
|
237
|
378
|
|
348
|
379 This command uses a lot of memory, required to find
|
|
|
380 the optimal word tree (Polish requires a few hundred
|
|
|
381 Mbyte). The final result will be much smaller.
|
|
|
382
|
|
378
|
383 After the spell file was written and it was being used
|
|
|
384 in a buffer it will be reloaded automatically.
|
|
308
|
385
|
|
371
|
386 :mksp[ell] [-ascii] {name}.{enc}.add
|
|
|
387 Like ":mkspell" above, using {name}.{enc}.add as the
|
|
378
|
388 input file and producing an output file in the same
|
|
|
389 directory that has ".spl" appended.
|
|
371
|
390
|
|
|
391 :mksp[ell] [-ascii] {name}
|
|
|
392 Like ":mkspell" above, using {name} as the input file
|
|
378
|
393 and producing an output file in the same directory
|
|
|
394 that has ".{enc}.spl" appended.
|
|
314
|
395
|
|
|
396 Since you might want to change a Myspell word list for use with Vim the
|
|
|
397 following procedure is recommended:
|
|
237
|
398
|
|
|
399 1. Obtain the xx_YY.aff and xx_YY.dic files from Myspell.
|
|
|
400 2. Make a copy of these files to xx_YY.orig.aff and xx_YY.orig.dic.
|
|
|
401 3. Change the xx_YY.aff and xx_YY.dic files to remove bad words, add missing
|
|
258
|
402 words, define word characters with FOL/LOW/UPP, etc. The distributed
|
|
|
403 "src/spell/*.diff" files can be used.
|
|
378
|
404 4. Start Vim with the right locale and use |:mkspell| to generate the Vim
|
|
|
405 spell file.
|
|
|
406 5. Try out the spell file with ":set spell spelllang=xx" if you wrote it in
|
|
388
|
407 a spell directory in 'runtimepath', or ":set spelllang=xx.enc.spl" if you
|
|
378
|
408 wrote it somewhere else.
|
|
221
|
409
|
|
237
|
410 When the Myspell files are updated you can merge the differences:
|
|
258
|
411 1. Obtain the new Myspell files as xx_YY.new.aff and xx_UU.new.dic.
|
|
|
412 2. Use Vimdiff to see what changed: >
|
|
237
|
413 vimdiff xx_YY.orig.dic xx_YY.new.dic
|
|
258
|
414 3. Take over the changes you like in xx_YY.dic.
|
|
237
|
415 You may also need to change xx_YY.aff.
|
|
258
|
416 4. Rename xx_YY.new.dic to xx_YY.orig.dic and xx_YY.new.aff to xx_YY.new.aff.
|
|
237
|
417
|
|
353
|
418
|
|
|
419 SPELL FILE DUMP
|
|
|
420
|
|
|
421 If for some reason you want to check what words are supported by the currently
|
|
|
422 used spelling files, use this command:
|
|
|
423
|
|
|
424 *:spelldump* *:spelld*
|
|
|
425 :spelld[ump] Open a new window and fill it with all currently valid
|
|
|
426 words.
|
|
378
|
427 Note: For some languages the result may be enormous,
|
|
|
428 causing Vim to run out of memory.
|
|
353
|
429
|
|
|
430 The format of the word list is used |spell-wordlist-format|. You should be
|
|
|
431 able to read it with ":mkspell" to generate one .spl file that includes all
|
|
|
432 the words.
|
|
|
433
|
|
383
|
434 When all entries to 'spelllang' use the same regions or no regions at all then
|
|
|
435 the region information is included in the dumped words. Otherwise only words
|
|
|
436 for the current region are included and no "/regions" line is generated.
|
|
353
|
437
|
|
378
|
438 Comment lines with the name of the .spl file are used as a header above the
|
|
|
439 words that were generated from that .spl file.
|
|
353
|
440
|
|
237
|
441 ==============================================================================
|
|
378
|
442 4. Spell file format *spell-file-format*
|
|
237
|
443
|
|
|
444 This is the format of the files that are used by the person who creates and
|
|
|
445 maintains a word list.
|
|
221
|
446
|
|
237
|
447 Note that we avoid the word "dictionary" here. That is because the goal of
|
|
|
448 spell checking differs from writing a dictionary (as in the book). For
|
|
378
|
449 spelling we need a list of words that are OK, thus should not to be
|
|
|
450 highlighted. Person and company names will not appear in a dictionary, but do
|
|
|
451 appear in a word list. And some old words are rarely used while they are
|
|
|
452 common misspellings. These do appear in a dictionary but not in a word list.
|
|
237
|
453
|
|
388
|
454 There are two formats: A straight list of words and a list using affix
|
|
378
|
455 compression. The files with affix compression are used by Myspell (Mozilla
|
|
|
456 and OpenOffice.org). This requires two files, one with .aff and one with .dic
|
|
|
457 extension.
|
|
301
|
458
|
|
|
459
|
|
378
|
460 FORMAT OF STRAIGHT WORD LIST *spell-wordlist-format*
|
|
301
|
461
|
|
314
|
462 The words must appear one per line. That is all that is required.
|
|
378
|
463
|
|
314
|
464 Additionally the following items are recognized:
|
|
378
|
465
|
|
301
|
466 - Empty and blank lines are ignored.
|
|
378
|
467
|
|
301
|
468 - Lines starting with a # are ignored (comment lines).
|
|
378
|
469
|
|
308
|
470 - A line starting with "/encoding=", before any word, specifies the encoding
|
|
|
471 of the file. After the second '=' comes an encoding name. This tells Vim
|
|
378
|
472 to setup conversion from the specified encoding to 'encoding'. Thus you can
|
|
|
473 use one word list for several target encodings.
|
|
|
474
|
|
320
|
475 - A line starting with "/regions=" specifies the region names that are
|
|
|
476 supported. Each region name must be two ASCII letters. The first one is
|
|
|
477 region 1. Thus "/regions=usca" has region 1 "us" and region 2 "ca".
|
|
378
|
478 In an addition word list the region names should be equal to the main word
|
|
|
479 list!
|
|
|
480
|
|
314
|
481 - Other lines starting with '/' are reserved for future use. The ones that
|
|
|
482 are not recognized are ignored (but you do get a warning message).
|
|
301
|
483
|
|
383
|
484 - A "/" may follow the word with the following items:
|
|
|
485 = Case must match exactly.
|
|
|
486 ? Rare word.
|
|
|
487 ! Bad (wrong) word.
|
|
|
488 digit A region in which the word is valid. If no regions are
|
|
|
489 specified the word is valid in all regions.
|
|
|
490
|
|
320
|
491 Example:
|
|
|
492
|
|
|
493 # This is an example word list comment
|
|
|
494 /encoding=latin1 encoding of the file
|
|
|
495 /regions=uscagb regions "us", "ca" and "gb"
|
|
|
496 example word for all regions
|
|
383
|
497 blah/12 word for regions "us" and "ca"
|
|
|
498 vim/! bad word
|
|
|
499 Campbell/?3 rare word in region 3 "gb"
|
|
|
500 's mornings/= keep-case word
|
|
320
|
501
|
|
389
|
502 Note that when "/=" is used the same word with all upper-case letters is not
|
|
|
503 accepted. This is different from a word with mixed case that is automatically
|
|
|
504 marked as keep-case, those words may appear in all upper-case letters.
|
|
|
505
|
|
301
|
506
|
|
|
507 FORMAT WITH AFFIX COMPRESSION
|
|
|
508
|
|
237
|
509 There are two files: the basic word list and an affix file. The affixes are
|
|
|
510 used to modify the basic words to get the full word list. This significantly
|
|
|
511 reduces the number of words, especially for a language like Polish. This is
|
|
|
512 called affix compression.
|
|
221
|
513
|
|
237
|
514 The format for the affix and word list files is mostly identical to what
|
|
|
515 Myspell uses (the spell checker of Mozilla and OpenOffice.org). A description
|
|
|
516 can be found here:
|
|
|
517 http://lingucomponent.openoffice.org/affix.readme ~
|
|
|
518 Note that affixes are case sensitive, this isn't obvious from the description.
|
|
314
|
519
|
|
237
|
520 Vim supports a few extras. Hopefully Myspell will support these too some day.
|
|
|
521 See |spell-affix-vim|.
|
|
|
522
|
|
|
523 The basic word list and the affix file are combined and turned into a binary
|
|
|
524 spell file. All the preprocessing has been done, thus this file loads fast.
|
|
|
525 The binary spell file format is described in the source code (src/spell.c).
|
|
|
526 But only developers need to know about it.
|
|
221
|
527
|
|
237
|
528 The preprocessing also allows us to take the Myspell language files and modify
|
|
|
529 them before the Vim word list is made. The tools for this can be found in the
|
|
|
530 "src/spell" directory.
|
|
|
531
|
|
|
532
|
|
320
|
533 WORD LIST FORMAT *spell-dic-format*
|
|
237
|
534
|
|
|
535 A very short example, with line numbers:
|
|
221
|
536
|
|
237
|
537 1 1234
|
|
|
538 2 aan
|
|
|
539 3 Als
|
|
|
540 4 Etten-Leur
|
|
|
541 5 et al.
|
|
|
542 6 's-Gravenhage
|
|
|
543 7 's-Gravenhaags
|
|
|
544 8 bedel/P
|
|
|
545 9 kado/1
|
|
|
546 10 cadeau/2
|
|
|
547
|
|
314
|
548 The first line contains the number of words. Vim ignores it, but you do get
|
|
|
549 an error message if it's not there. *E760*
|
|
221
|
550
|
|
314
|
551 What follows is one word per line. There should be no white space before or
|
|
|
552 after the word.
|
|
237
|
553
|
|
|
554 When the word only has lower-case letters it will also match with the word
|
|
|
555 starting with an upper-case letter.
|
|
|
556
|
|
|
557 When the word includes an upper-case letter, this means the upper-case letter
|
|
|
558 is required at this position. The same word with a lower-case letter at this
|
|
|
559 position will not match. When some of the other letters are upper-case it will
|
|
|
560 not match either.
|
|
|
561
|
|
378
|
562 The word with all upper-case characters will always be OK.
|
|
221
|
563
|
|
237
|
564 word list matches does not match ~
|
|
|
565 als als Als ALS ALs AlS aLs aLS
|
|
|
566 Als Als ALS als ALs AlS aLs aLS
|
|
|
567 ALS ALS als Als ALs AlS aLs aLS
|
|
|
568 AlS AlS ALS als Als ALs aLs aLS
|
|
221
|
569
|
|
314
|
570 The KEP affix ID can be used to specifically match a word with identical case
|
|
336
|
571 only, see below |spell-affix-KEP|.
|
|
308
|
572
|
|
237
|
573 Note in line 5 to 7 that non-word characters are used. You can include
|
|
|
574 any character in a word. When checking the text a word still only matches
|
|
|
575 when it appears with a non-word character before and after it. For Myspell a
|
|
|
576 word starting with a non-word character probably won't work.
|
|
|
577
|
|
|
578 After the word there is an optional slash and flags. Most of these flags are
|
|
378
|
579 letters that indicate the affixes that can be used with this word. These are
|
|
|
580 specified with SFX and PFX lines in the .aff file. See the Myspell
|
|
|
581 documentation.
|
|
221
|
582
|
|
237
|
583 *spell-affix-vim*
|
|
314
|
584 A flag that Vim adds and is not in Myspell is the flag defined with KEP in the
|
|
308
|
585 affix file. This has the meaning that case matters. This can be used if the
|
|
|
586 word does not have the first letter in upper case at the start of a sentence.
|
|
314
|
587 Example (assuming that = was used for KEP):
|
|
237
|
588
|
|
389
|
589 word list matches does not match ~
|
|
|
590 's morgens/= 's morgens 'S morgens 's Morgens 'S MORGENS
|
|
|
591 's Morgens 's Morgens 'S MORGENS 'S morgens 's morgens
|
|
|
592
|
|
|
593 The flag can also be used to avoid that the word matches when it is in all
|
|
|
594 upper-case letters.
|
|
221
|
595
|
|
237
|
596 *spell-affix-mbyte*
|
|
|
597 The basic word list is normally in an 8-bit encoding, which is mentioned in
|
|
|
598 the affix file. The affix file must always be in the same encoding as the
|
|
|
599 word list. This is compatible with Myspell. For Vim the encoding may also be
|
|
|
600 something else, any encoding that "iconv" supports. The "SET" line must
|
|
|
601 specify the name of the encoding. When using a multi-byte encoding it's
|
|
378
|
602 possible to use more different affixes (but Myspell doesn't support that, thus
|
|
|
603 you may not want to use it anyway).
|
|
221
|
604
|
|
341
|
605
|
|
|
606 CHARACTER TABLES
|
|
258
|
607 *spell-affix-chars*
|
|
314
|
608 When using an 8-bit encoding the affix file should define what characters are
|
|
|
609 word characters (as specified with ENC). This is because the system where
|
|
|
610 ":mkspell" is used may not support a locale with this encoding and isalpha()
|
|
|
611 won't work. For example when using "cp1250" on Unix.
|
|
258
|
612
|
|
336
|
613 *E761* *E762* *spell-affix-FOL*
|
|
|
614 *spell-affix-LOW* *spell-affix-UPP*
|
|
258
|
615 Three lines in the affix file are needed. Simplistic example:
|
|
|
616
|
|
341
|
617 FOL áëñ ~
|
|
|
618 LOW áëñ ~
|
|
|
619 UPP ÁËÑ ~
|
|
258
|
620
|
|
|
621 All three lines must have exactly the same number of characters.
|
|
|
622
|
|
|
623 The "FOL" line specifies the case-folded characters. These are used to
|
|
|
624 compare words while ignoring case. For most encodings this is identical to
|
|
|
625 the lower case line.
|
|
|
626
|
|
|
627 The "LOW" line specifies the characters in lower-case. Mostly it's equal to
|
|
|
628 the "FOL" line.
|
|
|
629
|
|
|
630 The "UPP" line specifies the characters with upper-case. That is, a character
|
|
|
631 is upper-case where it's different from the character at the same position in
|
|
|
632 "FOL".
|
|
|
633
|
|
|
634 ASCII characters should be omitted, Vim always handles these in the same way.
|
|
|
635 When the encoding is UTF-8 no word characters need to be specified.
|
|
|
636
|
|
|
637 *E763*
|
|
353
|
638 Vim allows you to use spell checking for several languages in the same file.
|
|
|
639 You can list them in the 'spelllang' option. As a consequence all spell files
|
|
|
640 for the same encoding must use the same word characters, otherwise they can't
|
|
|
641 be combined without errors. If you get a warning that the word tables differ
|
|
|
642 you may need to generate the .spl file again with |:mkspell|. Check the FOL,
|
|
|
643 LOW and UPP lines in the used .aff file.
|
|
|
644
|
|
|
645 The XX.ascii.spl spell file generated with the "-ascii" argument will not
|
|
|
646 contain the table with characters, so that it can be combine with spell files
|
|
|
647 for any encoding. The .add.spl files also do not contain the table.
|
|
258
|
648
|
|
341
|
649
|
|
371
|
650 MID-WORD CHARACTERS
|
|
|
651 *spell-midword*
|
|
|
652 Some characters are only to be considered word characters if they are used in
|
|
|
653 between two ordinary word characters. An example is the single quote: It is
|
|
|
654 often used to put text in quotes, thus it can't be recognized as a word
|
|
|
655 character, but when it appears in between word characters it must be part of
|
|
|
656 the word. This is needed to detect a spelling error such as they'are. That
|
|
|
657 should be they're, but since "they" and "are" are words themselves that would
|
|
|
658 go unnoticed.
|
|
|
659
|
|
|
660 These characters are defined with MIDWORD in the .aff file:
|
|
|
661
|
|
|
662 MIDWORD '- ~
|
|
|
663
|
|
|
664
|
|
341
|
665 AFFIXES
|
|
336
|
666 *spell-affix-PFX* *spell-affix-SFX*
|
|
341
|
667 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell
|
|
371
|
668 documentation or the Aspell manual:
|
|
|
669 http://aspell.net/man-html/Affix-Compression.html).
|
|
|
670
|
|
|
671 Note that Myspell ignores any extra text after the relevant info. Vim
|
|
|
672 requires this text to start with a "#" so that mistakes don't go unnoticed.
|
|
|
673 Example:
|
|
|
674
|
|
|
675 SFX F 0 in [^i]n # Spion > Spionin ~
|
|
|
676 SFX F 0 nen in # Bauerin > Bauerinnen ~
|
|
341
|
677
|
|
371
|
678 An extra item for Vim is the "rare" flag. It must come after the other
|
|
|
679 fields, before a comment. When used then all words that use the affix will be
|
|
|
680 marked as rare words. Example:
|
|
|
681
|
|
|
682 PFX F 0 nene . rare ~
|
|
|
683 SFX F 0 oin n rare # hardly ever used ~
|
|
|
684
|
|
|
685 However, if the word also appears as a good word in another way it won't be
|
|
|
686 marked as rare.
|
|
336
|
687
|
|
341
|
688 *spell-affix-PFXPOSTPONE*
|
|
|
689 When an affix file has very many prefixes that apply to many words it's not
|
|
|
690 possible to build the whole word list in memory. This applies to Hebrew (a
|
|
|
691 list with all words is over a Gbyte). In that case applying prefixes must be
|
|
|
692 postponed. This makes spell checking slower. It is indicated by this keyword
|
|
|
693 in the .aff file:
|
|
|
694
|
|
|
695 PFXPOSTPONE ~
|
|
|
696
|
|
|
697 Only prefixes without a chop string can be postponed, prefixes with a chop
|
|
456
|
698 string will still be included in the word list. An exception if the chop
|
|
|
699 string is one character and equal to the last character of the added string,
|
|
|
700 but in lower case. Thus when the chop string is used to allow the following
|
|
|
701 word to start with an upper case letter.
|
|
341
|
702
|
|
|
703
|
|
|
704 KEEP-CASE WORDS
|
|
314
|
705 *spell-affix-KEP*
|
|
|
706 In the affix file a KEP line can be used to define the affix name used for
|
|
308
|
707 keep-case words. Example:
|
|
|
708
|
|
314
|
709 KEP = ~
|
|
308
|
710
|
|
|
711 See above for an example |spell-affix-vim|.
|
|
|
712
|
|
341
|
713
|
|
|
714 RARE WORDS
|
|
314
|
715 *spell-affix-RAR*
|
|
308
|
716 In the affix file a RAR line can be used to define the affix name used for
|
|
|
717 rare words. Example:
|
|
|
718
|
|
|
719 RAR ? ~
|
|
|
720
|
|
|
721 Rare words are highlighted differently from bad words. This is to be used for
|
|
|
722 words that are correct for the language, but are hardly ever used and could be
|
|
348
|
723 a typing mistake anyway. When the same word is found as good it won't be
|
|
|
724 highlighted as rare.
|
|
|
725
|
|
|
726
|
|
|
727 BAD WORDS
|
|
|
728 *spell-affix-BAD*
|
|
|
729 In the affix file a BAD line can be used to define the affix name used for
|
|
|
730 bad words. Example:
|
|
|
731
|
|
|
732 BAD ! ~
|
|
|
733
|
|
|
734 This can be used to exclude words that would otherwise be good. For example
|
|
371
|
735 "the the" in the .dic file:
|
|
|
736
|
|
|
737 the the/! ~
|
|
|
738
|
|
|
739 Once a word has been marked as bad it won't be undone by encountering the same
|
|
|
740 word as good.
|
|
308
|
741
|
|
|
742
|
|
323
|
743 REPLACEMENTS *spell-affix-REP*
|
|
|
744
|
|
|
745 In the affix file REP items can be used to define common mistakes. This is
|
|
|
746 used to make spelling suggestions. The items define the "from" text and the
|
|
|
747 "to" replacement. Example:
|
|
|
748
|
|
|
749 REP 4 ~
|
|
|
750 REP f ph ~
|
|
|
751 REP ph f ~
|
|
|
752 REP k ch ~
|
|
|
753 REP ch k ~
|
|
|
754
|
|
|
755 The first line specifies the number of REP lines following. Vim ignores it.
|
|
378
|
756 Don't include simple one-character replacements or swaps. Vim will try these
|
|
|
757 anyway. You can include whole words if you want to, but you might want to use
|
|
|
758 the "file:" item in 'spellsuggest' instead.
|
|
323
|
759
|
|
|
760
|
|
|
761 SIMILAR CHARACTERS *spell-affix-MAP*
|
|
|
762
|
|
378
|
763 In the affix file MAP items can be used to define letters that are very much
|
|
323
|
764 alike. This is mostly used for a letter with different accents. This is used
|
|
|
765 to prefer suggestions with these letters substituted. Example:
|
|
|
766
|
|
|
767 MAP 2 ~
|
|
|
768 MAP eéëêè ~
|
|
|
769 MAP uüùúû ~
|
|
|
770
|
|
|
771 The first line specifies the number of MAP lines following. Vim ignores it.
|
|
|
772
|
|
378
|
773 Each letter must appear in only one of the MAP items. It's a bit more
|
|
|
774 efficient if the first letter is ASCII or at least one without accents.
|
|
336
|
775
|
|
323
|
776
|
|
378
|
777 SOUND-A-LIKE *spell-affix-SAL*
|
|
323
|
778
|
|
|
779 In the affix file SAL items can be used to define the sounds-a-like mechanism
|
|
|
780 to be used. The main items define the "from" text and the "to" replacement.
|
|
378
|
781 Simplistic example:
|
|
323
|
782
|
|
|
783 SAL CIA X ~
|
|
|
784 SAL CH X ~
|
|
|
785 SAL C K ~
|
|
|
786 SAL K K ~
|
|
|
787
|
|
388
|
788 There are a few rules and this can become quite complicated. An explanation
|
|
378
|
789 how it works can be found in the Aspell manual:
|
|
375
|
790 http://aspell.net/man-html/Phonetic-Code.html.
|
|
323
|
791
|
|
|
792 There are a few special items:
|
|
|
793
|
|
|
794 SAL followup true ~
|
|
|
795 SAL collapse_result true ~
|
|
|
796 SAL remove_accents true ~
|
|
|
797
|
|
|
798 "1" has the same meaning as "true". Any other value means "false".
|
|
|
799
|
|
375
|
800
|
|
|
801 SIMPLE SOUNDFOLDING *spell-affix-SOFOFROM* *spell-affix-SOFOTO*
|
|
|
802
|
|
|
803 The SAL mechanism is complex and slow. A simpler mechanism is mapping all
|
|
|
804 characters to another character, mapping similar sounding characters to the
|
|
|
805 same character. At the same time this does case folding. You can not have
|
|
378
|
806 both SAL items and simple soundfolding.
|
|
375
|
807
|
|
388
|
808 There are two items required: one to specify the characters that are mapped
|
|
375
|
809 and one that specifies the characters they are mapped to. They must have
|
|
|
810 exactly the same number of characters. Example:
|
|
|
811
|
|
|
812 SOFOFROM abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ ~
|
|
|
813 SOFOTO ebctefghejklnnepkrstevvkesebctefghejklnnepkrstevvkes ~
|
|
|
814
|
|
|
815 In the example all vowels are mapped to the same character 'e'. Another
|
|
378
|
816 method would be to leave out all vowels. Some characters that sound nearly
|
|
|
817 the same and are often mixed up, such as 'm' and 'n', are mapped to the same
|
|
|
818 character. Don't do this too much, all words will start looking alike.
|
|
375
|
819
|
|
|
820 Characters that do not appear in SOFOFROM will be left out, except that all
|
|
|
821 white space is replaced by one space. Sequences of the same character in
|
|
|
822 SOFOFROM are replaced by one.
|
|
|
823
|
|
|
824 You can use the |soundfold()| function to try out the results. Or set the
|
|
|
825 'verbose' option to see the score in the output of the |z?| command.
|
|
|
826
|
|
|
827
|
|
221
|
828 vim:tw=78:sw=4:ts=8:ft=help:norl:
|
