comparison runtime/doc/spell.txt @ 819:23f82b5d2814 v7.0c10

updated for version 7.0c10
author vimboss
date Wed, 05 Apr 2006 20:41:53 +0000
parents 9f345c48220b
children 57c7403f6599
comparison
equal deleted inserted replaced
818:1f929f3ca806 819:23f82b5d2814
1 *spell.txt* For Vim version 7.0c. Last change: 2006 Mar 27 1 *spell.txt* For Vim version 7.0c. Last change: 2006 Apr 03
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
498 Multiple {inname} arguments can be given to combine 498 Multiple {inname} arguments can be given to combine
499 regions into one Vim spell file. Example: > 499 regions into one Vim spell file. Example: >
500 :mkspell ~/.vim/spell/en /tmp/en_US /tmp/en_CA /tmp/en_AU 500 :mkspell ~/.vim/spell/en /tmp/en_US /tmp/en_CA /tmp/en_AU
501 < This combines the English word lists for US, CA and AU 501 < This combines the English word lists for US, CA and AU
502 into one en.spl file. 502 into one en.spl file.
503 Up to eight regions can be combined. *E754* *755* 503 Up to eight regions can be combined. *E754* *E755*
504 The REP and SAL items of the first .aff file where 504 The REP and SAL items of the first .aff file where
505 they appear are used. |spell-REP| |spell-SAL| 505 they appear are used. |spell-REP| |spell-SAL|
506 506
507 This command uses a lot of memory, required to find 507 This command uses a lot of memory, required to find
508 the optimal word tree (Polish, Italian and Hungarian 508 the optimal word tree (Polish, Italian and Hungarian
1056 Specifically, the affix flags can be used for: 1056 Specifically, the affix flags can be used for:
1057 - Affixes on affixes, as in the example above. 1057 - Affixes on affixes, as in the example above.
1058 - Making the word with the affix rare, by using the |spell-RARE| flag. 1058 - Making the word with the affix rare, by using the |spell-RARE| flag.
1059 - Exclude the word with the affix from compounding, by using the 1059 - Exclude the word with the affix from compounding, by using the
1060 |spell-COMPOUNDFORBIDFLAG| flag. 1060 |spell-COMPOUNDFORBIDFLAG| flag.
1061 1061 - Allow the word with the affix to be part of a compound word on the side of
1062 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=- 1062 the affix with the |spell-COMPOUNDPERMITFLAG|.
1063 OLD STUFF: This needs to be rewritten to use affix flags.
1064 *spell-affix-rare*
1065 An extra item for Vim is the "rare" flag. It must come after the other
1066 fields, before a comment. When used then all words that use the affix will be
1067 marked as rare words. Examples:
1068
1069 PFX F 0 nene . rare ~
1070 SFX F 0 oin n rare # hardly ever used ~
1071
1072 However, if the word also appears as a good word in another way (e.g., in
1073 another region) it won't be marked as rare.
1074
1075 *spell-affix-nocomp*
1076 Another extra item for Vim is the "nocomp" flag. It must come after the other
1077 fields, before a comment. It can be either before or after "rare". When
1078 present then all words that use the affix will not be part of a compound word.
1079 Example:
1080 affix file:
1081 COMPOUNDFLAG c ~
1082 SFX a Y 2 ~
1083 SFX a 0 s . ~
1084 SFX a 0 ize . nocomp ~
1085 dictionary:
1086 word/c ~
1087 util/ac ~
1088
1089 This allows for "wordutil" and "wordutils" but not "wordutilize".
1090 -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
1091 1063
1092 *spell-PFXPOSTPONE* 1064 *spell-PFXPOSTPONE*
1093 When an affix file has very many prefixes that apply to many words it's not 1065 When an affix file has very many prefixes that apply to many words it's not
1094 possible to build the whole word list in memory. This applies to Hebrew (a 1066 possible to build the whole word list in memory. This applies to Hebrew (a
1095 list with all words is over a Gbyte). In that case applying prefixes must be 1067 list with all words is over a Gbyte). In that case applying prefixes must be
1143 1115
1144 Rare words are highlighted differently from bad words. This is to be used for 1116 Rare words are highlighted differently from bad words. This is to be used for
1145 words that are correct for the language, but are hardly ever used and could be 1117 words that are correct for the language, but are hardly ever used and could be
1146 a typing mistake anyway. When the same word is found as good it won't be 1118 a typing mistake anyway. When the same word is found as good it won't be
1147 highlighted as rare. 1119 highlighted as rare.
1120
1121 This flag can also be used on an affix, so that a basic word is not rare but
1122 the basic word plus affix is rare |spell-affix-flags|. However, if the word
1123 also appears as a good word in another way (e.g., in another region) it won't
1124 be marked as rare.
1148 1125
1149 1126
1150 BAD WORDS *spell-BAD* 1127 BAD WORDS *spell-BAD*
1151 1128
1152 In the affix file a BAD line can be used to define the affix name used for 1129 In the affix file a BAD line can be used to define the affix name used for
1241 end/e ~ 1218 end/e ~
1242 -/xd ~ 1219 -/xd ~
1243 1220
1244 This allows for the word "start-end", but not "startend". 1221 This allows for the word "start-end", but not "startend".
1245 1222
1223 An additional implied rule is that, without further flags, a word with a
1224 prefix cannot be compounded after another word, and a word with a suffix
1225 cannot be compounded with a following word. Thus the affix cannot appear
1226 on the inside of a compound word. This can be changed with the
1227 |spell-COMPOUNDPERMITFLAG|.
1228
1246 *spell-NEEDCOMPOUND* 1229 *spell-NEEDCOMPOUND*
1247 The NEEDCOMPOUND flag is used to require that a word is used as part of a 1230 The NEEDCOMPOUND flag is used to require that a word is used as part of a
1248 compound word. The word itself is not a good word. Example: 1231 compound word. The word itself is not a good word. Example:
1249 1232
1250 NEEDCOMPOUND & ~ 1233 NEEDCOMPOUND & ~
1280 accepted if it fits one of the criteria, thus is either made from up to 1263 accepted if it fits one of the criteria, thus is either made from up to
1281 COMPOUNDWORDMAX words or contains up to COMPOUNDSYLMAX syllables. 1264 COMPOUNDWORDMAX words or contains up to COMPOUNDSYLMAX syllables.
1282 1265
1283 *spell-COMPOUNDFORBIDFLAG* 1266 *spell-COMPOUNDFORBIDFLAG*
1284 The COMPOUNDFORBIDFLAG specifies a flag that can be used on an affix. It 1267 The COMPOUNDFORBIDFLAG specifies a flag that can be used on an affix. It
1285 means that the word plus affix cannot be used in a compound word. 1268 means that the word plus affix cannot be used in a compound word. Example:
1269 affix file:
1270 COMPOUNDFLAG c ~
1271 COMPOUNDFORBIDFLAG x ~
1272 SFX a Y 2 ~
1273 SFX a 0 s . ~
1274 SFX a 0 ize/x . ~
1275 dictionary:
1276 word/c ~
1277 util/ac ~
1278
1279 This allows for "wordutil" and "wordutils" but not "wordutilize".
1286 1280
1287 *spell-COMPOUNDPERMITFLAG* 1281 *spell-COMPOUNDPERMITFLAG*
1288 The COMPOUNDPERMITFLAG specifies a flag that can be used on an affix. It 1282 The COMPOUNDPERMITFLAG specifies a flag that can be used on an affix. It
1289 means that the word plus affix can also be used in a compound word in a way 1283 means that the word plus affix can also be used in a compound word in a way
1290 where the affix ends up halfway the word. 1284 where the affix ends up halfway the word. Without this flag that is not
1291 NOT IMPLEMENTED YET. 1285 allowed.
1292 1286
1293 *spell-COMPOUNDROOT* 1287 *spell-COMPOUNDROOT*
1294 The COMPOUNDROOT flag is used for words in the dictionary that are already a 1288 The COMPOUNDROOT flag is used for words in the dictionary that are already a
1295 compound. This means it counts for two words when checking the compounding 1289 compound. This means it counts for two words when checking the compounding
1296 rules. Can also be used for an affix to count the affix as a compounding 1290 rules. Can also be used for an affix to count the affix as a compounding
1307 for one syllable. These are preferred over using characters from the set. 1301 for one syllable. These are preferred over using characters from the set.
1308 With the example "ideeen" has three syllables, counted by "i", "ee" and "e". 1302 With the example "ideeen" has three syllables, counted by "i", "ee" and "e".
1309 1303
1310 Only case-folded letters need to be included. 1304 Only case-folded letters need to be included.
1311 1305
1312 Above another way to restrict compounding was mentioned above: adding "nocomp" 1306 Above another way to restrict compounding was mentioned above: Adding the
1313 after an affix causes all words that are made with that affix not be be used 1307 |spell-COMPOUNDFORBIDFLAG| flag to an affix causes all words that are made
1314 for compounding. |spell-affix-nocomp| 1308 with that affix not be be used for compounding.
1315 1309
1316 1310
1317 UNLIMITED COMPOUNDING *spell-NOBREAK* 1311 UNLIMITED COMPOUNDING *spell-NOBREAK*
1318 1312
1319 For some languages, such as Thai, there is no space in between words. This 1313 For some languages, such as Thai, there is no space in between words. This