comparison runtime/doc/spell.txt @ 820:57c7403f6599

updated for version 7.0c11
author vimboss
date Thu, 06 Apr 2006 20:18:50 +0000
parents 23f82b5d2814
children 6675076019ae
comparison
equal deleted inserted replaced
819:23f82b5d2814 820:57c7403f6599
1 *spell.txt* For Vim version 7.0c. Last change: 2006 Apr 03 1 *spell.txt* For Vim version 7.0c. Last change: 2006 Apr 06
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
710 Note that when "/=" is used the same word with all upper-case letters is not 710 Note that when "/=" is used the same word with all upper-case letters is not
711 accepted. This is different from a word with mixed case that is automatically 711 accepted. This is different from a word with mixed case that is automatically
712 marked as keep-case, those words may appear in all upper-case letters. 712 marked as keep-case, those words may appear in all upper-case letters.
713 713
714 714
715 FORMAT WITH .AFF and .DIC FILES 715 FORMAT WITH .AFF AND .DIC FILES *aff-dic-format*
716 716
717 There are two files: the basic word list and an affix file. The affix file 717 There are two files: the basic word list and an affix file. The affix file
718 specifies settings for the language and can contain affixes. The affixes are 718 specifies settings for the language and can contain affixes. The affixes are
719 used to modify the basic words to get the full word list. This significantly 719 used to modify the basic words to get the full word list. This significantly
720 reduces the number of words, especially for a language like Polish. This is 720 reduces the number of words, especially for a language like Polish. This is
1031 1031
1032 AFFIX FLAGS *spell-affix-flags* 1032 AFFIX FLAGS *spell-affix-flags*
1033 1033
1034 This is a feature that comes from Hunspell: The affix may specify flags. This 1034 This is a feature that comes from Hunspell: The affix may specify flags. This
1035 works similar to flags specified on a basic word. The flags apply to the 1035 works similar to flags specified on a basic word. The flags apply to the
1036 basic word plus the affix. Example: 1036 basic word plus the affix (but there are restrictions). Example:
1037 1037
1038 SFX S Y 1 ~ 1038 SFX S Y 1 ~
1039 SFX S 0 s . ~ 1039 SFX S 0 s . ~
1040 1040
1041 SFX A Y 1 ~ 1041 SFX A Y 1 ~
1052 both are used for the word plus suffix. But the flags of the basic word are 1052 both are used for the word plus suffix. But the flags of the basic word are
1053 only used once for affixes, except that both one prefix and one suffix can be 1053 only used once for affixes, except that both one prefix and one suffix can be
1054 used when both support combining. 1054 used when both support combining.
1055 1055
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 - Suffixes on suffixes, as in the example above. This works once, thus you
1058 can have two suffixes on a word (plus one prefix).
1058 - Making the word with the affix rare, by using the |spell-RARE| flag. 1059 - 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 1060 - Exclude the word with the affix from compounding, by using the
1060 |spell-COMPOUNDFORBIDFLAG| flag. 1061 |spell-COMPOUNDFORBIDFLAG| flag.
1061 - Allow the word with the affix to be part of a compound word on the side of 1062 - Allow the word with the affix to be part of a compound word on the side of
1062 the affix with the |spell-COMPOUNDPERMITFLAG|. 1063 the affix with the |spell-COMPOUNDPERMITFLAG|.
1063 1064 - Use the NEEDCOMPOUND flag: word plus affix can only be used as part of a
1064 *spell-PFXPOSTPONE* 1065 compound word. |spell-NEEDCOMPOUND|
1066 - Compound flags: word plus affix can be part of a compound word at the end,
1067 middle, start, etc. The flags are combined with the flags of the basic
1068 word. |spell-compound|
1069 - NEEDAFFIX: another affix is needed to make a valid word.
1070 - CIRCUMFIX, as explained just below.
1071
1072
1073 CIRCUMFIX *spell-CIRCUMFIX*
1074
1075 The CIRCUMFIX flag means a prefix and suffix must be added at the same time.
1076 If a prefix has the CIRCUMFIX flag than only suffixes with the CIRCUMFIX flag
1077 can be added, and the other way around.
1078 An alternative is to only specify the suffix, and give the that suffix two
1079 flags: The required prefix and the NEEDAFFIX flag. |spell-NEEDAFFIX|
1080
1081
1082 PFXPOSTPONE *spell-PFXPOSTPONE*
1083
1065 When an affix file has very many prefixes that apply to many words it's not 1084 When an affix file has very many prefixes that apply to many words it's not
1066 possible to build the whole word list in memory. This applies to Hebrew (a 1085 possible to build the whole word list in memory. This applies to Hebrew (a
1067 list with all words is over a Gbyte). In that case applying prefixes must be 1086 list with all words is over a Gbyte). In that case applying prefixes must be
1068 postponed. This makes spell checking slower. It is indicated by this keyword 1087 postponed. This makes spell checking slower. It is indicated by this keyword
1069 in the .aff file: 1088 in the .aff file:
1070 1089
1071 PFXPOSTPONE ~ 1090 PFXPOSTPONE ~
1072 1091
1073 Only prefixes without a chop string can be postponed, prefixes with a chop 1092 Only prefixes without a chop string and without flags can be postponed.
1074 string will still be included in the word list. An exception if the chop 1093 Prefixes with a chop string or with flags will still be included in the word
1075 string is one character and equal to the last character of the added string, 1094 list. An exception if the chop string is one character and equal to the last
1076 but in lower case. Thus when the chop string is used to allow the following 1095 character of the added string, but in lower case. Thus when the chop string
1077 word to start with an upper case letter. 1096 is used to allow the following word to start with an upper case letter.
1078 1097
1079 1098
1080 WORDS WITH A SLASH *spell-SLASH* 1099 WORDS WITH A SLASH *spell-SLASH*
1081 1100
1082 The slash is used in the .dic file to separate the basic word from the affix 1101 The slash is used in the .dic file to separate the basic word from the affix
1475 supported. 1494 supported.
1476 1495
1477 CHECKCOMPOUNDPATTERN (Hunspell) *spell-CHECKCOMPOUNDPATTERN* 1496 CHECKCOMPOUNDPATTERN (Hunspell) *spell-CHECKCOMPOUNDPATTERN*
1478 Forbid compounding when patterns match. Not supported. 1497 Forbid compounding when patterns match. Not supported.
1479 1498
1480 CIRCUMFIX (Hunspell) *spell-CIRCUMFIX*
1481 This means a prefix and suffix must be added at the same time.
1482 Instead only specify the suffix, and give the that suffix two
1483 flags: The required prefix and the NEEDAFFIX flag.
1484 |spell-NEEDAFFIX|
1485
1486 COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES* 1499 COMPLEXPREFIXES (Hunspell) *spell-COMPLEXPREFIXES*
1487 Enables using two prefixes. Not supported. 1500 Enables using two prefixes. Not supported.
1488 1501
1489 COMPOUND (Hunspell) *spell-COMPOUND* 1502 COMPOUND (Hunspell) *spell-COMPOUND*
1490 This is one line with the count of COMPOUND items, followd by 1503 This is one line with the count of COMPOUND items, followd by