chiark / gitweb /
Clarify the README.charset a bit
authorIan Jackson <ijackson@chiark.greenend.org.uk>
Fri, 3 Jul 2009 16:34:45 +0000 (17:34 +0100)
committerIan Jackson <Ian.Jackson@eu.citrix.com>
Fri, 3 Jul 2009 16:34:45 +0000 (17:34 +0100)
pctb/README.charset

index 4301a0a..cd9d1c9 100644 (file)
@@ -54,10 +54,11 @@ the uppercase and lowercase dictionaries; if one matches and the other
 doesn't, or one matches a wider character than the other, we use it.
 If that fails to resolve the ambiguity we must ask.
 
-*Do not* make an entry in the character set dictionary mapping `vertical
-stick' to `l' or `I'.  Instead, select enough of the whole word in
-question that no word would start with the other letter, and enter the
-whole word or part of it as a new glyph as a new Word.
+*Do not* make an entry in the character set dictionary mapping
+`vertical stick' to `l' or `I'.  Instead, select enough of the whole
+word in question that no word would start with the other letter, and
+enter the whole word or part of it as a new glyph as a new entry in
+the Word dictionary.
 
 For example, in the supplied dictionary there is already a glyph for
 `Iron'; this is OK because there are no words which start `lron'.
@@ -91,7 +92,8 @@ Overlapping characters - ligatures
 
 Some of the characters in the font used overlap with the next
 character.  When this happens, select both the characters and enter
-them together as one glyph with a multi-character definition.
+them together as one glyph with a multi-character definition, as a new
+entry in the Lower or Upper dictionary.
 
 For example `yw' is rendered with the top right corner of the `y' and
 the top left corner of the `w' overlapping.  This is dealt with by
@@ -132,11 +134,17 @@ display the part of the text it is having trouble with, showing where
 it has got to, and allow you to edit the character set dictionary it
 uses for recognising the text.
 
-*This is subtle* and it is important to understand the way the
+The process is subtle and it is important to understand the way the
 machinery works, and the possible mistakes you can make, before
-answering the program.  *Please read this documentation*, which
+answering the program.  So *Please read this documentation*, which
 explains the meaning of the entries you make.
 
+Be sure to check or specify the dictionary to which the new glyph
+should be added.  Normally the default will be the Word dictionary
+which is right if the match failure is a new word starting with l or I
+(see above).  You will need to change this to the Upper or Lower
+dictionary for new ligatures.  You should not need to add new Digits.
+
 Also, the character set updates you make will by default be submitted
 to my server so that they can be checked by me and shared with other
 users.  See README.privacy.