[liblouis-liblouisxml] Patch against liblouis-guide.texi

  • From: Christian Egli <christian.egli@xxxxxxxx>
  • To: liblouis-liblouisxml <liblouis-liblouisxml@xxxxxxxxxxxxx>
  • Date: Mon, 22 Dec 2008 12:29:14 +0100

Hi all

I have a patch against liblouis-guide.texi that generates somewhat nicer
links on the html output (the files are now named begnum-opcode.html
instead of begnum_002dopcode.html) and has a bit more explanation around
an example about the syllable opcode where I had a question recently
(//www.freelists.org/post/liblouis-liblouisxml/automake-errors-with-texinfo-patch,1)

The patch is attached below. Is it ok to commit?

Thanks
Christian
-- 
Christian Egli
Swiss Library for the Blind and Visually Impaired
Grubenstrasse 12, CH-8045 Zürich, Switzerland
diff --git a/doc/liblouis-guide.texi b/doc/liblouis-guide.texi
index 5a29326..05eb06c 100644
--- a/doc/liblouis-guide.texi
+++ b/doc/liblouis-guide.texi
@@ -25,21 +25,21 @@
 @c Opcode.
 @macro opcode{name, args}
 @opcodeindex \name\
-@anchor{\name\-opcode}
+@anchor{\name\ opcode}
 @item \name\ \args\
 @end macro
 
 @macro doubleOpcode{name1, args1, name2, args2}
 @opcodeindex \name1\
 @opcodeindex \name2\
-@anchor{\name1\-opcode}
-@anchor{\name2\-opcode}
+@anchor{\name1\ opcode}
+@anchor{\name2\ opcode}
 @item \name1\ \args1\
 @itemx \name2\ \args2\
 @end macro
 
 @macro opcoderef{name}
-@code{\name\} opcode (@pxref{\name\-opcode,\name\,@code{\name\}})
+@code{\name\} opcode (@pxref{\name\ opcode,\name\,@code{\name\}})
 @end macro
 
 @copying
@@ -703,7 +703,7 @@ as the main table, use a full pathname for filename.
 The order of the various types of opcodes or table entries is
 important. Character-definition opcodes should come first. However, if
 the optional @code{display} opcode is used
-(@pxref{display-opcode,display,@code{display}}) it should precede
+(@pxref{display opcode,display,@code{display}}) it should precede
 character-definition opcodes. Braille-indicator opcodes should come
 next. Translation opcodes should follow. The @code{context} opcode is
 a translation opcode, even though it is considered along with the
@@ -911,8 +911,8 @@ The letters in the operand will not be proceeded by a 
letter sign.
 More than one @code{noletsign} opcode can be used. This is equivalent
 to a single entry containing all the letters. In addition, if a single
 letter, such as @samp{a} in English, is defined as a @code{word}
-(@pxref{word-opcode,word,@code{word}}) or @code{largesign}
-(@pxref{largesign-opcode,largesign,@code{largesign}}), it will be
+(@pxref{word opcode,word,@code{word}}) or @code{largesign}
+(@pxref{largesign opcode,largesign,@code{largesign}}), it will be
 treated as though it had also been specified in a @code{noletsign}
 entry.
 
@@ -1286,9 +1286,10 @@ As its name indicates, this opcode defines a "syllable" 
which must be
 represented by exactly the dot patterns given. Contractions may not
 cross the boundaries of this "syllable" either from left or right. The
 character string defined by this opcode need not be a lexical
-syllable, though it usually will be. For example:
+syllable, though it usually will be. The equal sign in the following
+example means that the the default representation for each character
+within the sequence is to be used (@pxref{Translation Opcodes}):
 
-@c FIXME: the example doesn't match the description of the opcode 
 @example
 syllable horse = sawhorse, horseradish
 @end example
@@ -1495,7 +1496,7 @@ ambiguities.
 @section The Context and Multipass Opcodes
 
 @table @code
-@anchor{context-opcode}
+@anchor{context opcode}
 @opcodeindex context
 @opcodeindex pass2
 @opcodeindex pass3

Other related posts: