]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
More macro simplifications.
[lilypond.git] / Documentation / user / macros.itexi
index dd912e4176565275e0f858c9741ac9ca97735f7e..711ad408ece389ba732e92adddb610db601fc4b3 100644 (file)
-@c -*- coding: latin-1; mode: 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
+
+@end macro
+
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
 
-@c Reference GLOSsary
-@macro rglos {NAME}
-@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
-@end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
 @end macro
 
+@macro seealso
+@noindent
+@subsubheading See also
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
+@end macro
 
-@c FIXME, use \fetaaccidentalsXMC?
-@c \\kern0.15em\\fetachar\\fetaflat
-@iftex
- @macro texiflat {word}
- @tex
- FIXME: fetaflat
- @end tex
- @end macro
-@c FIXME, use \fetaaccidentalsXC?
-@c  \\raise0.5ex\\fetachar\\fetasharp
- @macro texisharp {word}
-  @tex
-  FIXME: fetasharp
-  @end tex
-  @end macro
-@end iftex
+@macro refbugs
+@noindent
+@subsubheading Bugs
 
+@end macro
+
+
+@c  use inside the text
+@macro context{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}@c should use internalsref
+@end macro
 
-@macro arrow{}
+@macro refcommand{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
+
+
+
+@c  *** Macros with variable output ***
+
+@c   Use inside the text
+
+@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
+`\TEXT\'
+@end ifinfo
 @iftex
-@tex $\\Rightarrow$ @end tex@c
+`\TEXT\'
 @end iftex
 @ifhtml
 @html
-&rarr;
+&lsquo;\TEXT\&rsquo;
 @end html
 @end ifhtml
+@end macro
+@end ifnotdocbook
+
+@ifdocbook
+@macro q{TEXT}
+@xml
+&lsquo;\TEXT\&rsquo;
+@end xml
+@end macro
+@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
+@html
+&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
 
-@c dup?
+@macro lsrdir{DIR}
 @ifhtml
+@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@end ifhtml
+@ifnothtml
+@file{\DIR\}
+@end ifnothtml
+@end macro
+
+
+
 
- @c ***** HTML *****
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
+
+@ifhtml
+@c ***** HTML *****
 
-@macro internalsref{NAME}@c
 @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/\NAME\.html,\NAME\}@c
+@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{\NAME\,,lilypond-internals}@c
+@c @inforef{\TEXT\,,lilypond-internals}@c
 @c using @ref without punctuation is OK without for formats other than info
-@ref{\NAME\,,,lilypond-internals}@c
-@c should we do this? 
-@findex \NAME\
+
+@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 inputfileref{DIR,NAME}
- @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
- @end macro
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
+@end macro
 
-@end ifhtml
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
+@end macro
 
-@c dup?
-@ifdocbook
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
+@end macro
 
- @c ***** DOCBOOK-XML *****
+@end ifset
 
- @macro internalsref{NAME}
- @c makeinfo-4.7 encodes html names
- @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c
- @inforef{\NAME\,,lilypond-internals}@c
- @c should we do this? 
- @findex @code{\NAME\}
- @end macro
- @macro usermanref{NAME}
- @inforef{\NAME\,,lilypond}@c
- @end macro
 
- @macro inputfileref{DIR,NAME}
- @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
- @end macro
+@ifclear bigpage
 
-@end ifdocbook
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
+@end macro
 
-@ifinfo
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
 
-@c **** INFO ****
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond/lilypond-internals}@c
-@findex \NAME\@c
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@macro usermanref{NAME}
-@ref{\NAME\,,,lilypond/lilypond}@c
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@end ifinfo
+@end ifclear
+
+@end ifhtml
 
-@c **** TEX ****
-@iftex
 
-@macro internalsref{NAME}@c
-@findex \NAME\ @c
-@code{\NAME\}@c
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/@/\NAME\}@c
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro usermanref{NAME}
-user manual, @internalsref{\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@end iftex
-@c **** not TEX ****
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
+@end macro
 
-@ifnottex
- @macro seeinternals{NAME}
- @internalsref{\NAME\}
- @end macro
-@end ifnottex
+@end ifdocbook
 
-@ifnottex
- @macro usermanref{NAME}
- @ref{\NAME\}@c
- @end macro
-@end ifnottex
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@ifinfo
+@c **** INFO ****
 
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
-
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,,music-glossary}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
 
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@macro context{NAME}@c
-@code{\NAME\}@c should use internalsref
-@findex \NAME\@c
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@c I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?  --hwn
+@end ifinfo
 
-@ignore
 
-Is this question still relevant?  With texinfo 4.7,
-escape the backslash, like so  --jcn
+@c **** TEX ****
+@iftex
 
-@macro refcommand{WHAT}
-@cindex @code{\\\WHAT\}
-@code{\WHAT\},
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
 
-@end ignore
+@macro rglos {TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
 
-@macro refcommand{WHAT}
-@findex \WHAT\
-@code{\WHAT\} 
+@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