From: Werner Lemberg <wl@gnu.org>
Date: Sat, 29 Nov 2008 07:31:31 +0000 (+0100)
Subject: Introduce @endpredefined.
X-Git-Tag: release/2.12.0-1~40^2~31
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=7b266127a82295c12b76a979da839dc71e741dcd;p=lilypond.git

Introduce @endpredefined.

Fix @funindex as a preparation for using texi2html to expand macros.
Note that both makeinfo and texi2dvi are buggy currently and can't do
what we need :-(  We have to wait until texi2html is in shape so that
it can replace `makeinfo -E ...'.  Right now, it has some syntax issues
which prevents it, but the maintainer is already going to fix them.

Formatting issues; adding some comments.
---

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 4302b1e7a9..af53b682cf 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,21 +6,29 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+
 @include version.itexi
 
-@c don't replace quotes with directed quotes
+
+@c Don't replace quotes with directed quotes.
+
 @set txicodequoteundirected
 @set txicodequotebacktick
 
+
+
 @c   ***** Displaying text *****
 
-@c we need this since @q{\} doesn't work with makeinfo 4.11 --
-@c say @q{@bs{}} instead
+@c We need this since @q{\} doesn't work with makeinfo 4.11 --
+@c say @q{@bs{}} instead.
+
 @macro bs
 \\
 @end macro
 
-@c to get decent quotes in `foo' and ``foo''
+
+@c To get decent quotes in `foo' and ``foo''.
+
 @macro q{TEXT}
 @quoteleft{}\TEXT\@quoteright{}
 @end macro
@@ -29,15 +37,19 @@
 @quotedblleft{}\TEXT\@quotedblright{}
 @end macro
 
+
 @ifhtml
+
 @macro warning{TEXT}
 @cartouche
 @b{Note:} \TEXT\
 @end cartouche
 @end macro
+
 @end ifhtml
 
 @ifnothtml
+
 @macro warning{TEXT}
 @quotation
 @quotation
@@ -47,101 +59,142 @@
 @end quotation
 @end quotation
 @end macro
+
 @end ifnothtml
 
+
 @ifnotinfo
+
 @macro notation{TEXT}
 @var{\TEXT\}
 @end macro
+
 @end ifnotinfo
 
 @ifinfo
+
 @macro notation{TEXT}
 \TEXT\
 @end macro
+
 @end ifinfo
 
+
 @macro smallspace
 @sp 1
 @end macro
 
 
-@c   **** Displaying images not generated by lilypond-book
 
-@c current installation setup of Info docs requires that all images are
-@c expected to be found in lilypond/ subdirectory.  lilypond-book already
-@c generates proper @image commands for images of music; these macros
-@c definitions do the same for other images.
+@c   ***** Displaying images not generated by lilypond-book *****
+
+@c Current installation setup of Info docs requires that all images are
+@c expected to be found in the `lilypond/' subdirectory.  `lilypond-book'
+@c already generates proper @image commands for images of music; these
+@c macro definitions do the same for other images.
 
 @ifnotinfo
+
 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
 @image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+
 @end ifnotinfo
 
 @ifinfo
+
 @macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
 @image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+
 @end ifinfo
 
 
-@c   **** Headings in a doc subsection ****
+
+@c   ***** Headings in a doc subsection *****
+
+@c Don't insert an empty line after @predefined!  Right now
+@c it doesn't matter, but a future implementation will probably
+@c add some code which needs this restriction.
 
 @macro predefined
 @noindent
 @subsubheading Predefined commands
+@end macro
 
+@c The next macro is a dummy currently since texinfo doesn't
+@c provide a real ragged-right environment yet.
+@c
+@c Due to a bug in texi2html (texi2html.pl CVS versions <= 1.245)
+@c the macro must not be empty.
+
+@macro endpredefined
+@c
 @end macro
 
+
 @macro snippets
 @noindent
 @subsubheading Selected Snippets
-
 @end macro
 
+
+@c Don't insert an empty line after @seealso!  Otherwise we get
+@c unwanted extra vertical space in the PDF output.
+
 @macro seealso
 @noindent
 @subsubheading See also
-
 @indent
 @end macro
 
+
 @macro knownissues
 @noindent
 @subsubheading Known issues and warnings
-
 @end macro
 
+
 @macro lydoctitle {TEXT}
 @emph{\TEXT\}
-
 @end macro
 
+
+@c Don't remove the `@c' within the macro definition!  See section 19.3,
+@c `Macro Details and Caveats', in the texinfo info file for explanation.
+
 @macro funindex {TEXT}
 @findex \TEXT\
 @kindex \TEXT\
+@c
 @end macro
 
 
 
-@c   **** Links and references ****
+@c   ***** Links and references *****
 
 @c  Definitions for references:
+@c
 @c     @rglos
 @c     @rlearning
 @c     @ruser
 @c     @rprogram
 @c     @rlsr
 @c     @rinternals
-@c  all these also have a @...named version, which allows to specify the
-@c  displayed text for the reference as second argument
+@c
+@c  All these also have a @...named version which allows to specify the
+@c  displayed text for the reference as second argument.
+@c
+@c ***** HTML + bigpage is a special case (other manual names); all other
+@c formats are treated similarly.
+
 
-@c ***** HTML + bigpage is a special case (other manual names), all other
-@c formats are treated similarly
+@c *** not TeX ***
 
 @ifnottex
 
+@c ** bigpage **
+
 @ifset bigpage
 
 @macro rglos{TEXT}
@@ -205,6 +258,8 @@
 @end ifset
 
 
+@c ** not bigpage **
+
 @ifclear bigpage
 
 @macro rglos{TEXT}
@@ -270,8 +325,8 @@
 @end ifnottex
 
 
+@c *** TeX ***
 
-@c **** TEX ****
 @iftex
 
 @macro rglos{TEXT}