More macro simplifications.

[lilypond.git] / Documentation / user / macros.itexi

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 5e18d7bcb7b8e9ee64b1758312105244abaa63ed..711ad408ece389ba732e92adddb610db601fc4b3 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,173 +1,314 @@
-@c -*-texinfo-*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
+
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
+
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
+
+
+@c **** format-independant ****
+
+@c   regions of a doc subsection
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
 
-@c Only reference in HTML.
-@macro htmlref {NAME}
-@ifhtml
-@ref{\NAME\}@c
-@end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
 @end macro
 
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
 
+@end macro
 
+@macro seealso
+@noindent
+@subsubheading See also
 
-@c Reference GLOSsary
-@macro rglos {NAME}
-@ifhtml
-@c ugh: @ref assumes that external refs are split documents too
-@uref{../music-glossary.html#\NAME\,\NAME\}@c
-@end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
 @end macro
 
+@macro refbugs
+@noindent
+@subsubheading Bugs
 
-@ifnottex
-@macro texisharp {word}
-#
 @end macro
-@end ifnottex
 
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+
+@c  use inside the text
+@macro context{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}@c should use internalsref
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@macro refcommand{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
 @end macro
-@end iftex
 
 
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
-@end macro
-@end iftex
+@c  *** Macros with variable output ***
 
-@c \heartsf was supposed to be filled?
+@c   Use inside the text
 
-@c center*** is broken?
+@c to get decent quotes in `foo'
 
+@c I don't understand why this is necessary, but it is with 4.8. :/
+@ifnotdocbook
+@macro q{TEXT}
 @ifinfo
-@macro separate
+`\TEXT\'
+@end ifinfo
+@iftex
+`\TEXT\'
+@end iftex
+@ifhtml
+@html
+‘\TEXT\’
+@end html
+@end ifhtml
+@end macro
+@end ifnotdocbook
 
-@quotation
-@end quotation
+@ifdocbook
+@macro q{TEXT}
+@xml
+‘\TEXT\’
+@end xml
 @end macro
-@end ifinfo
+@end ifdocbook
+
 
+@c to get decent quotes in ``foo''
+@c I don't understand why this is necessary, but it is with 4.8. :/
+@ifnotdocbook
+@macro qq{TEXT}
+@ifinfo
+``\TEXT\''
+@end ifinfo
+@iftex
+``\TEXT\''
+@end iftex
 @ifhtml
-@macro separate
 @html
-<p></p><br><br>
+&ldquo;\TEXT\&rdquo;
 @end html
+@end ifhtml
+@end macro
+@end ifnotdocbook
+
+@ifdocbook
+@macro qq{TEXT}
+@xml
+&ldquo;\TEXT\&rdquo;
+@end xml
 @end macro
+@end ifdocbook
+
+
+
+
+
+@c usage: @lsr{ancient,custodes.ly}
+@macro lsr{DIR,TEXT}
+@ifhtml
+@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
 @end ifhtml
+@ifnothtml
+@file{\DIR\/\TEXT\}
+@end ifnothtml
+@end macro
+
+@macro lsrdir{DIR}
+@ifhtml
+@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@end ifhtml
+@ifnothtml
+@file{\DIR\}
+@end ifnothtml
+@end macro
 
 
-@c dup?
+
+
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
+
 @ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}
-@cindex \NAME\
+@c ***** HTML *****
+
+@c makeinfo-4.7 encodes html names, which means that nodes that
+@c contain nonalphanum characters will be broken links on the website.
+@c @uref{../lilypond-internals/\TEXT\.html,\TEXT\}@c
+@c @inforef{} adds ``See'' to the sentence, which is annoying, but
+@c better than a broken link.
+@c @inforef{\TEXT\,,lilypond-internals}@c
+@c using @ref without punctuation is OK without for formats other than info
+
+@ifset bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
 @end macro
 
-@end ifhtml
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
+@end macro
 
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
 @end macro
 
-@macro inputfileref{DIR,NAME}i
-@file{\DIR\/\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
 @end macro
 
-@end ifinfo
+@end ifset
 
-@iftex
-@macro internalsref{NAME}
-@cindex \NAME\
-@code{\NAME\}
+
+@ifclear bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
-@end iftex
 
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
-@end ifnottex
 
-@macro refbugs
-@noindent
-@strong{Bugs}
+@end ifclear
 
-@noindent
+@end ifhtml
+
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro seealso
-@noindent
-@strong{See also}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
 
-@noindent
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro refcommands
-@noindent
-@strong{Predefined commands}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
+@end macro
 
-@noindent
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
+@end ifdocbook
 
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
 
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\}
+@ifinfo
+@c **** INFO ****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
 @end macro
 
-@macro syntax
-@noindent
-@strong{Syntax}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,,music-glossary}
+@end macro
 
-@noindent
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
+@end macro
+
+@end ifinfo
+
+
+@c **** TEX ****
+@iftex
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
+
+@macro rglos {TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
+
+@macro rprogram{TEXT}
+program usage manual, @internalsref{\TEXT\}
 @end macro
+
+@macro ruser{TEXT}
+user manual, @internalsref{\TEXT\}
+@end macro
+
+@macro rlearning{TEXT}
+learning manual, @internalsref{\TEXT\}
+@end macro
+
+@end iftex
+
+
+@c EOF