]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
Documentation: Fix cross reference names in PDF generation of the docs
[lilypond.git] / Documentation / user / macros.itexi
index 326a4d290f74748881ce3217f1438963a658c100..c533b5156009e44cc815a58eea6a4c5048602e59 100644 (file)
-@ifnottex
-@macro reng {word}
-@ref{ (lilypond-internals)\word\, \word\ }
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
-@end macro
-@end ifnottex
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
-@iftex
-@macro reng {word}
-\word\
+@c @value{version}
+@macro version
+2.11.43
 @end macro
-@end iftex
 
+@c   ***** Displaying text *****
 
-@ifnottex
-@macro rgrob {word}
-@ref{ (lilypond-internals)\word\, \word\ }
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
 
+@c to get decent quotes in `foo' and ``foo''
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
 @end macro
-@end ifnottex
 
-@iftex
-@macro rgrob {word}
-\word\
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
 @end macro
-@end iftex
 
+@macro warning{TEXT}
+@ifhtml
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end ifhtml
+@ifnothtml
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end ifnothtml
+@end macro
 
-@ifnottex
-@macro rint {word}
-@ref{ (lilypond-internals)\word\, \word\ }
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
 
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
 @end macro
-@end ifnottex
+@end ifinfo
 
-@iftex
-@macro rint {word}
-\word\
+@macro smallspace
+@sp 1
 @end macro
-@end iftex
 
-@ifnottex
-@macro texisharp {word}
-#
+
+@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.
+
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
-@end ifnottex
+@end ifnotinfo
 
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$
-@end tex
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
-@end iftex
+@end ifinfo
+
+
+@c   **** Headings in a doc subsection ****
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
 
-@ifnottex
-@macro texiflat {word}
-b
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$
-@end tex
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+
 @end macro
-@end iftex
 
+@macro seealso
+@noindent
+@subsubheading See also
 
+@indent
+@end macro
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
 @end macro
-@end iftex
 
-@c \heartsf was supposed to be filled?
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
 
-@c center*** is broken?
 
-@ifinfo
-@macro separate
 
-@quotation
-@end quotation
-@end macro
-@end ifinfo
+@c   **** Links and references ****
 
+@c  Possibly deprecated; under discussion.
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
 @ifhtml
-@macro separate
-@html
-<p></p><br><br>
-@end html
+@uref{source/input/lsr/lilypond-snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
+@end ifhtml
+@ifnothtml
+@file{\SECTION\/\TEXT\}
+@end ifnothtml
 @end macro
+
+@c usage: @lsrdir{ancient,Ancient-notation}
+@macro lsrdir{SECTION,DIR}
+@ifhtml
+@uref{source/input/lsr/lilypond-snippets/\DIR\.html,\SECTION\}
 @end ifhtml
+@ifnothtml
+\DIR\
+@end ifnothtml
+@end macro
 
-@ignore
 
-@c Huh, do outline mode and texinfo really fight eachother?
-@c Outline can only use spaces to indent topic headers
-@c (or bullets, but then topics can't start with `@c').
-@c Texinfo can't have spaces in macro names.
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
+
+@ifhtml
+@c ***** HTML *****
 
-@macro c_ {word}
-\word\
-@node \word\
-@section \word\
+@ifset bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 @end macro
 
-@macro c__ {word}
-\word\
-@menu
-* \word\::                      
-@end menu
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
+@end macro
 
-@node \word\
-@subsection \word\
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 @end macro
 
-@macro c___ {word}
-\word\
-@node \word\
-@unnumberedsubsubsection \word\
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 @end macro
 
-@macro c_ {word}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 @end macro
 
-@end ignore
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
 
+@end ifset
 
-@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}
-@cindex \NAME\
+
+@ifclear bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@end ifclear
+
 @end ifhtml
 
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@end ifdocbook
+
+
 @ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
+@c **** INFO ****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary,Music Glossary}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
 @end ifinfo
 
+
+@c **** TEX ****
 @iftex
-@macro internalsref{NAME}
-@cindex \NAME\
-@code{\NAME\}
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
-@end iftex
 
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
-@end ifnottex
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@end iftex
+
+
+@c EOF