]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
Begin using 3-value @lsr macros.
[lilypond.git] / Documentation / user / macros.itexi
index b3dc51087d372cb2e16c5e7dba433f8e1467f245..df8844a4287e9109bdd5531fff67504446dcacd1 100644 (file)
-@c -*-texinfo-*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
-@c Only reference in HTML.
-@macro htmlref {NAME}
+    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
-@ref{\NAME\}@c
+@uref{source/input/lsr/snippets/\SECTION\.html#\TEXT\,@file{\DIR\/\TEXT\}}
 @end ifhtml
 @ifnothtml
-\NAME\@c
+@file{\DIR\/\TEXT\}
 @end ifnothtml
 @end macro
 
-
-
-
-@c Reference GLOSsary
-@macro rglos {NAME}
+@macro lsrdir{DIR}
 @ifhtml
-@c ugh: @ref assumes that external refs are split documents too
-@uref{../music-glossary.html#\NAME\,\NAME\}@c
+@uref{source/input/lsr/snippets/\DIR\.html,\DIR\}
 @end ifhtml
 @ifnothtml
-\NAME\@c
+\DIR\
 @end ifnothtml
 @end macro
 
 
-@ifnottex
-@macro texisharp {word}
-#
+@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
-@end ifnottex
 
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
 @end macro
-@end iftex
 
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
+@end macro
 
+@end ifset
 
-@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?
+@ifclear bigpage
 
-@c center*** is broken?
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
+@end macro
 
-@ifinfo
-@macro separate
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
 
-@quotation
-@end quotation
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
-@end ifinfo
 
-@ifhtml
-@macro separate
-@html
-<p></p><br><br>
-@end html
+@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
 
 
-@c dup?
-@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}
-@cindex \NAME\
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @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}
 @end macro
 
-@end ifhtml
+@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 internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
+@c **** INFO ****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
+@end macro
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\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 inputfileref{DIR,NAME}i
-@file{\DIR\/\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
 @end ifinfo
 
+
+@c **** TEX ****
 @iftex
-@macro internalsref{NAME}
-@cindex \NAME\
-@code{\NAME\}
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @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}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
+@c @internalsref{\TEXT\}
+@end macro
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
 @end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
 @end macro
-@end ifnottex
+
+@end iftex
+
+
+@c EOF