]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
Update from Ralph.
[lilypond.git] / Documentation / user / macros.itexi
index 6d9bf7c2c86dba6db3fc58d4ac83cb45f60a1ec1..c29ba57026d1fe43c8a4cf04491eff529595b2e7 100644 (file)
+@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   ***** 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}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
+
+@c TODO: define different output for info
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+
+
+
+@c   **** Headings in a doc subsection ****
+
+@c not really a heading, but...
+@macro smallspace
+@sp 1
+@end macro
+
+@c obsolete; being removed.
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
+
+@end macro
+
+@macro commonprop
+@noindent
+@c @subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
+
+@end macro
+
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
+@end macro
+
+@macro refbugs
+@noindent
+@subsubheading Known issues and warnings
+
+@end macro
+
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
+
+
+
+@c   **** Links and references ****
+
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
+@ifhtml
+@uref{source/input/lsr/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/snippets/\DIR\.html,\SECTION\}
+@end ifhtml
+@ifnothtml
+\DIR\
+@end ifnothtml
+@end macro
+
+
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
+
+@ifhtml
+@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 rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
+@end macro
+
+@end ifset
+
+
+@ifclear bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
+
+@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 ifclear
+
+@end ifhtml
+
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
+
+@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 ifdocbook
+
+
 @ifinfo
-@macro reng {word}
-@ref{ (lilypond-internals)Engraver \word\, \word\ },
+@c **** INFO ****
 
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
 @end macro
-@end ifinfo
 
-@ifnotinfo
-@macro reng {word}
-@ref{ (lilypond-internals)Engraver \word\, \word\ }
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary}
+@end macro
 
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
-@end ifnotinfo
 
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
+@end macro
 
-@ignore
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
+@end macro
 
-@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.
+@end ifinfo
+
+
+@c **** TEX ****
+@iftex
 
-@macro c_ {word}
-\word\
-@node \word\
-@section \word\
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
 
-@macro c__ {word}
-\word\
-@menu
-* \word\::                      
-@end menu
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
 
-@node \word\
-@subsection \word\
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
+@c @internalsref{\TEXT\}
 @end macro
 
-@macro c___ {word}
-\word\
-@node \word\
-@unnumberedsubsubsection \word\
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
 @end macro
 
-@macro c_ {word}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
 @end macro
 
-@end ignore
+@end iftex
+
 
+@c EOF