]> 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 cbf3ce2acfc9fd1f70df316ae6cb0f744b2e4dde..c533b5156009e44cc815a58eea6a4c5048602e59 100644 (file)
-@c -*-texinfo-*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
-@tex
-\input feta20.tex
-\font\fetasixteen=feta16
-\def\fetafont{\fetasixteen}
-\def\fetachar#1{\hbox{\fetasixteen#1}}
-@end tex
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
-@c Reference GLOSsary
-@macro rglos {NAME}
+@c @value{version}
+@macro version
+2.11.43
+@end macro
+
+@c   ***** Displaying text *****
+
+@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
+
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
+
+@macro warning{TEXT}
 @ifhtml
-@c ugh: @ref assumes that external refs are split documents too
-@html
-<a style="text-decoration: none; color: inherit;" href="../music-glossary.html#\NAME\">\NAME\</a>@c
-@end html
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
 @end ifhtml
 @ifnothtml
-\NAME\@c
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
 @end ifnothtml
 @end macro
 
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
 
-@ifnottex
-@macro texisharp {word}
-#
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
 @end macro
-@end ifnottex
+@end ifinfo
 
-@iftex
-@macro texisharp {word}
-@tex
-\\raise0.5ex\\fetachar\\fetasharp
-@end tex
+@macro smallspace
+@sp 1
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+
+@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 texiflat {word}
-@tex
-\\kern0.15em\\fetachar\\fetaflat
-@end tex
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
-@end iftex
+@end ifinfo
 
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
+
+@c   **** Headings in a doc subsection ****
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
+
+@end macro
+
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+
+@end macro
+
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
+@end macro
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
+
+@end macro
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
+
+
+
+@c   **** Links and references ****
+
+@c  Possibly deprecated; under discussion.
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
 @ifhtml
-@html
-&rarr;
-@end html
+@uref{source/input/lsr/lilypond-snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 @end ifhtml
-@ifinfo
--->
-@end ifinfo
+@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
 
 
-@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\}@c
-@c should we do this? 
-@cindex @code{\NAME\}
+@c ***** HTML *****
+
+@ifset bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 @end macro
 
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
+@end macro
 
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 @end macro
 
-@end ifhtml
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
+@end macro
 
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond/lilypond-internals}@c
-@cindex \NAME\@c
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@end ifset
+
+
+@ifclear bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
-@end ifinfo
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
 
-@iftex
-@macro internalsref{NAME}@c
-@cindex \NAME\@c
-@code{\NAME\}@c
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/\NAME\}@c
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
-@end iftex
 
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@end ifclear
+
+@end ifhtml
+
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
-@end ifnottex
 
-@ifinfo
-@macro usermanref{NAME}
-@ref{\NAME\,,,lilypond/lilypond}@c
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
-@end ifinfo
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}@c
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
-@end ifnotinfo
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@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 seealso
-@noindent
-@subsubheading See also
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@end ifdocbook
+
+
+@ifinfo
+@c **** INFO ****
 
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals,Internals Reference}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@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 context{NAME}@c
-@code{\NAME\}@c should use internalsref
-@cindex \NAME\@c
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
+@end ifinfo
+
+
+@c **** TEX ****
+@iftex
 
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
 
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
 
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
 
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\}, 
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
+
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@end iftex
+
+
+@c EOF