diff 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
line wrap: on
line diff
--- a/runtime/doc/spell.txt
+++ b/runtime/doc/spell.txt
@@ -1,4 +1,4 @@
-*spell.txt*	For Vim version 7.0aa.  Last change: 2005 Aug 23
+*spell.txt*	For Vim version 7.0aa.  Last change: 2005 Aug 24
 
 
 		  VIM REFERENCE MANUAL	  by Bram Moolenaar
@@ -645,7 +645,11 @@ The first line contains the number of wo
 an error message if it's not there.  *E760*
 
 What follows is one word per line.  There should be no white space before or
-after the word.
+after the word.  After the word there is an optional slash and flags.  Most of
+these flags are letters that indicate the affixes that can be used with this
+word.  These are specified with SFX and PFX lines in the .aff file.  See the
+Myspell documentation.  Vim allows using other flag types with the FLAG item
+in the affix file |spell-FLAG|.
 
 When the word only has lower-case letters it will also match with the word
 starting with an upper-case letter.
@@ -671,11 +675,6 @@ any character in a word.  When checking 
 when it appears with a non-word character before and after it.  For Myspell a
 word starting with a non-word character probably won't work.
 
-After the word there is an optional slash and flags.  Most of these flags are
-letters that indicate the affixes that can be used with this word.  These are
-specified with SFX and PFX lines in the .aff file.  See the Myspell
-documentation.
-
 In line 12 the word "TCP/IP" is defined.  Since the slash has a special
 meaning the comma is used instead.  This is defined with the SLASH item in the
 affix file, see |spell-SLASH|.  Note that without this SLASH item the
@@ -767,6 +766,29 @@ These characters are defined with MIDWOR
 	MIDWORD	'- ~
 
 
+FLAG TYPES						*spell-FLAG*
+
+Flags are used to specify the affixes that can be used with a word and for
+other properties of the word.  Normally single-character flags are used.  This
+limits the number of possible flags, especially for 8-bit encodings.  The FLAG
+item can be used if more affixes are to be used.  Possible values:
+
+	FLAG long	use two-character flags
+	FLAG num	use numbers, from 1 up to 65000
+	FLAG huh	use one-character flags without A-Z and two-character
+			flags that start with A-Z
+
+With "FLAG num" the numbers in a list of affixes need to be separated with a
+comma: "234,2143,1435".  This method is inefficient, but useful if the file is
+generated with a program.
+
+When using "huh" the two-character flags all start with a capital: "Aa", "B1",
+"BB", etc.  This is useful to use one-character flags for the most common
+items and two-character flags for uncommon items.
+
+Note: When using utf-8 only characters up to 65000 may be used for flags.
+
+
 AFFIXES
 					    *spell-PFX* *spell-SFX*
 The usual PFX (prefix) and SFX (suffix) lines are supported (see the Myspell
@@ -1065,7 +1087,9 @@ used to make spelling suggestions.  The 
 	REP k ch ~
 	REP ch k ~
 
-The first line specifies the number of REP lines following.  Vim ignores it.
+The first line specifies the number of REP lines following.  Vim ignores the
+number, but it must be there.
+
 Don't include simple one-character replacements or swaps.  Vim will try these
 anyway.  You can include whole words if you want to, but you might want to use
 the "file:" item in 'spellsuggest' instead.
@@ -1081,7 +1105,8 @@ to prefer suggestions with these letters
 	MAP eéëêè ~
 	MAP uüùúû ~
 
-The first line specifies the number of MAP lines following.  Vim ignores it.
+The first line specifies the number of MAP lines following.  Vim ignores the
+number, but the line must be there.
 
 Each letter must appear in only one of the MAP items.  It's a bit more
 efficient if the first letter is ASCII or at least one without accents.