Add committish to macros.itexi

[lilypond.git] / Documentation / user / macros.itexi

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index e7e01562c2019af8b8328e0a8e4cf6585f8ceb23..809c717743931bdda85fc3277414f4d4e64e190f 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,53 +1,82 @@
-@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 **** all formats ****
+
+@macro refbugs
+@noindent
+@subsubheading Bugs
 
-@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 moreinfo
+@subheading More information
 
-@ifnottex
-@macro texisharp {word}
-#
 @end macro
-@end ifnottex
 
-@iftex
-@macro texisharp {word}
-@tex
-\\raise0.5ex\\fetachar\\fetasharp
-@end tex
+@macro seealso
+@noindent
+@subsubheading See also
+
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
+
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-\\kern0.15em\\fetachar\\fetaflat
-@end tex
+@macro context{NAME}
+@vindex \NAME\
+@code{\NAME\}@c should use internalsref
 @end macro
-@end iftex
+
+@macro refcommand{WHAT}
+@vindex \WHAT\
+@code{\WHAT\}
+@end macro
+
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
+
+@end macro
+
+@macro funindex {WORD}
+@findex \WORD\
+@kindex \WORD\
+@end macro
+
+
+
+@c  *** Macros with variable output ***
+
+@c usage: @lsr{ancient,custodes.ly}
+@macro lsr{DIR,NAME}
+@ifhtml
+  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@end ifhtml
+@ifnothtml
+  @file{\DIR\/\NAME\}
+@end ifnothtml
+@end macro
+
+@macro lsrdir{DIR}
+@ifhtml
+  @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@end ifhtml
+@ifnothtml
+  @file{\DIR\}
+@end ifnothtml
+@end macro
+
+
+
 
 @macro arrow{}
 @iftex
@@ -64,132 +93,235 @@ b
 @end macro
 
 
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
 
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
+@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/\NAME\.html,\NAME\}@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 using @ref without punctuation is OK without for formats other than info
+
+@ifset bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals-big-page}
+@end macro
+
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary-big-page}
 @end macro
-@end iftex
 
-@c \heartsf was supposed to be filled?
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program-big-page}
+@end macro
 
-@c center*** is broken?
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-big-page}
+@end macro
+
+@end ifset
 
-@ifinfo
-@macro separate
 
-@quotation
-@end quotation
+@ifclear bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end ifinfo
 
-@ifhtml
-@macro separate
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@end macro
+
+@end ifclear
+
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@html
+&lsquo;\TEXT\&rsquo;
+@end html
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
 @html
-<p></p><br><br>
+&ldquo;\TEXT\&rdquo;
 @end html
 @end macro
+
 @end ifhtml
 
 
-@c dup?
-@ifhtml
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
 @macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}@c
-@cindex \NAME\@c
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
 
+@macro inputfileref{DIR,NAME}
+@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@end macro
 
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
 @end macro
 
-@end ifhtml
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@end macro
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@xml
+&lsquo;\TEXT\&rsquo;
+@end xml
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@xml
+&ldquo;\TEXT\&rdquo;
+@end xml
+@end macro
+
+@end ifdocbook
+
 
 @ifinfo
+@c **** INFO ****
+
 @macro internalsref{NAME}
-@inforef{\NAME\,,lilypond/lilypond-internals}@c
-@cindex \NAME\@c
+@vindex \NAME\
+@inforef{\NAME\,,lilypond-internals}
 @end macro
 
 @macro inputfileref{DIR,NAME}
 @file{\DIR\/\NAME\}
 @end macro
 
-@end ifinfo
-
-@iftex
-@macro internalsref{NAME}@c
-@cindex \NAME\@c
-@code{\NAME\}@c
+@macro rglos{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,,music-glossary}
 @end macro
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/\NAME\}@c
+
+@macro usermanref{NAME}
+@inforef{\NAME\}
 @end macro
-@end iftex
 
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
 @end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
-@end ifnottex
 
-@ifinfo
-@macro usermanref{NAME}
-@ref{\NAME\,,,lilypond/lilypond}@c
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
 @end macro
+
 @end ifinfo
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}@c
+
+@c **** TEX ****
+@iftex
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@code{\NAME\}
 @end macro
-@end ifnotinfo
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/@/\NAME\}
+@end macro
 
+@macro rglos {NAME}
+@vindex \NAME\
+@code{\NAME\}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
+@macro seeinternals{NAME}
+internals document, @internalsref{\NAME\}
+@end macro
 
+@macro usermanref{NAME}
+user manual, @internalsref{\NAME\}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@macro rprogram{NAME}
+program usage manual, @internalsref{\NAME\}
+@end macro
 
+@alias ruser=usermanref
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
 
-@macro context{NAME}
-@code{\NAME\}@c should use internalsref
-@cindex \NAME\@c
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
 @end macro
 
+@end iftex
 
 
+@ifnottex
+@c **** not TEX ****
 
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
+@macro seeinternals{NAME}
+@internalsref{\NAME\}
+@end macro
 
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\}, 
+@ifnotinfo
+@macro usermanref{NAME}
+@ref{\NAME\}
 @end macro
+@end ifnotinfo
+
+@end ifnottex
+
+
+@c EOF