comparison runtime/doc/spell.txt @ 497:73f10d8124f4 v7.0136

updated for version 7.0136
author vimboss
date Wed, 24 Aug 2005 22:16:11 +0000
parents 06364aa0d597
children 08012a1ff8d4
comparison
equal deleted inserted replaced
496:381caa3f6ea8 497:73f10d8124f4
1 *spell.txt* For Vim version 7.0aa. Last change: 2005 Aug 23 1 *spell.txt* For Vim version 7.0aa. Last change: 2005 Aug 24
2 2
3 3
4 VIM REFERENCE MANUAL by Bram Moolenaar 4 VIM REFERENCE MANUAL by Bram Moolenaar
5 5
6 6
643 643
644 The first line contains the number of words. Vim ignores it, but you do get 644 The first line contains the number of words. Vim ignores it, but you do get
645 an error message if it's not there. *E760* 645 an error message if it's not there. *E760*
646 646
647 What follows is one word per line. There should be no white space before or 647 What follows is one word per line. There should be no white space before or
648 after the word. 648 after the word. After the word there is an optional slash and flags. Most of
649 these flags are letters that indicate the affixes that can be used with this
650 word. These are specified with SFX and PFX lines in the .aff file. See the
651 Myspell documentation. Vim allows using other flag types with the FLAG item
652 in the affix file |spell-FLAG|.
649 653
650 When the word only has lower-case letters it will also match with the word 654 When the word only has lower-case letters it will also match with the word
651 starting with an upper-case letter. 655 starting with an upper-case letter.
652 656
653 When the word includes an upper-case letter, this means the upper-case letter 657 When the word includes an upper-case letter, this means the upper-case letter
668 672
669 Note in line 5 to 7 that non-word characters are used. You can include 673 Note in line 5 to 7 that non-word characters are used. You can include
670 any character in a word. When checking the text a word still only matches 674 any character in a word. When checking the text a word still only matches
671 when it appears with a non-word character before and after it. For Myspell a 675 when it appears with a non-word character before and after it. For Myspell a
672 word starting with a non-word character probably won't work. 676 word starting with a non-word character probably won't work.
673
674 After the word there is an optional slash and flags. Most of these flags are
675 letters that indicate the affixes that can be used with this word. These are
676 specified with SFX and PFX lines in the .aff file. See the Myspell
677 documentation.
678 677
679 In line 12 the word "TCP/IP" is defined. Since the slash has a special 678 In line 12 the word "TCP/IP" is defined. Since the slash has a special
680 meaning the comma is used instead. This is defined with the SLASH item in the 679 meaning the comma is used instead. This is defined with the SLASH item in the
681 affix file, see |spell-SLASH|. Note that without this SLASH item the 680 affix file, see |spell-SLASH|. Note that without this SLASH item the
682 word will be "TCP,IP". 681 word will be "TCP,IP".
763 go unnoticed. 762 go unnoticed.
764 763
765 These characters are defined with MIDWORD in the .aff file: 764 These characters are defined with MIDWORD in the .aff file:
766 765
767 MIDWORD '- ~ 766 MIDWORD '- ~
767
768
769 FLAG TYPES *spell-FLAG*
770
771 Flags are used to specify the affixes that can be used with a word and for
772 other properties of the word. Normally single-character flags are used. This
773 limits the number of possible flags, especially for 8-bit encodings. The FLAG
774 item can be used if more affixes are to be used. Possible values:
775
776 FLAG long use two-character flags
777 FLAG num use numbers, from 1 up to 65000
778 FLAG huh use one-character flags without A-Z and two-character
779 flags that start with A-Z
780
781 With "FLAG num" the numbers in a list of affixes need to be separated with a
782 comma: "234,2143,1435". This method is inefficient, but useful if the file is
783 generated with a program.
784
785 When using "huh" the two-character flags all start with a capital: "Aa", "B1",
786 "BB", etc. This is useful to use one-character flags for the most common
787 items and two-character flags for uncommon items.
788
789 Note: When using utf-8 only characters up to 65000 may be used for flags.
768 790
769 791
770 AFFIXES 792 AFFIXES
771 *spell-PFX* *spell-SFX* 793 *spell-PFX* *spell-SFX*
772 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell 794 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell
1063 REP f ph ~ 1085 REP f ph ~
1064 REP ph f ~ 1086 REP ph f ~
1065 REP k ch ~ 1087 REP k ch ~
1066 REP ch k ~ 1088 REP ch k ~
1067 1089
1068 The first line specifies the number of REP lines following. Vim ignores it. 1090 The first line specifies the number of REP lines following. Vim ignores the
1091 number, but it must be there.
1092
1069 Don't include simple one-character replacements or swaps. Vim will try these 1093 Don't include simple one-character replacements or swaps. Vim will try these
1070 anyway. You can include whole words if you want to, but you might want to use 1094 anyway. You can include whole words if you want to, but you might want to use
1071 the "file:" item in 'spellsuggest' instead. 1095 the "file:" item in 'spellsuggest' instead.
1072 1096
1073 1097
1079 1103
1080 MAP 2 ~ 1104 MAP 2 ~
1081 MAP eéëêè ~ 1105 MAP eéëêè ~
1082 MAP uüùúû ~ 1106 MAP uüùúû ~
1083 1107
1084 The first line specifies the number of MAP lines following. Vim ignores it. 1108 The first line specifies the number of MAP lines following. Vim ignores the
1109 number, but the line must be there.
1085 1110
1086 Each letter must appear in only one of the MAP items. It's a bit more 1111 Each letter must appear in only one of the MAP items. It's a bit more
1087 efficient if the first letter is ASCII or at least one without accents. 1112 efficient if the first letter is ASCII or at least one without accents.
1088 1113
1089 1114