Typo.

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

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index db2c2d8b768547915e1f908114f0fb61cded1cf7..ee765f75c4d6a38cc1132738133bbc572bae21ee 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,169 +1,315 @@
-@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 **** all formats ****
+
+@macro refbugs
+@noindent
+@subsubheading Bugs
+
+@end macro
+
+@macro moreinfo
+@subheading More information
+
+@end macro
+
+@macro seealso
+@noindent
+@subsubheading See also
+
+@end macro
+
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
+
+@end macro
+
+@macro context{NAME}
+@vindex \NAME\
+@code{\NAME\}@c should use internalsref
+@end macro
+
+@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
-@ref{\NAME\}@c
+  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 @end ifhtml
 @ifnothtml
-\NAME\@c
+  @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
 
 
 
-@c Reference GLOSsary
-@macro rglos {NAME}
+
+@macro arrow{}
+@iftex
+@tex $\\Rightarrow$ @end tex@c
+@end iftex
 @ifhtml
-@c ugh: @ref assumes that external refs are split documents too
-@uref{../music-glossary.html#\NAME\,\NAME\}@c
+@html
+→
+@end html
 @end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
+@ifinfo
+-->
+@end ifinfo
 @end macro
 
 
-@ifnottex
-@macro texisharp {word}
-#
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
+
+
+@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
-@end ifnottex
 
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary-big-page}
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program-big-page}
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-big-page}
 @end macro
-@end iftex
 
+@end ifset
 
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
+@ifclear bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end iftex
 
-@c \heartsf was supposed to be filled?
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
 
-@c center*** is broken?
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
 
-@ifinfo
-@macro separate
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@end macro
+
+@end ifclear
 
-@quotation
-@end quotation
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@html
+‘\TEXT\’
+@end html
 @end macro
-@end ifinfo
 
-@ifhtml
-@macro separate
+@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\}
-@cindex \NAME\
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
 @end macro
 
-@end ifhtml
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@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}
+@vindex \NAME\
 @inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
 @end macro
 
-@macro inputfileref{DIR,NAME}i
-@file{\DIR\/\NAME\}
+@macro rglos{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,,music-glossary}
+@end macro
+
+@macro usermanref{NAME}
+@inforef{\NAME\}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@end macro
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
 @end macro
 
 @end ifinfo
 
+
+@c **** TEX ****
 @iftex
+
 @macro internalsref{NAME}
-@cindex \NAME\
+@vindex \NAME\
 @code{\NAME\}
 @end macro
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
-@end macro
-@end iftex
-
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
+@macro rglos {NAME}
+@vindex \NAME\
+@code{\NAME\}
 @end macro
-@end iftex
 
-@ifnottex
 @macro seeinternals{NAME}
-@internalsref{\NAME\}
+internals document, @internalsref{\NAME\}
 @end macro
-@end ifnottex
 
-@macro refbugs
-@noindent
-@heading Bugs
+@macro usermanref{NAME}
+user manual, @internalsref{\NAME\}
+@end macro
 
+@macro rprogram{NAME}
+program usage manual, @internalsref{\NAME\}
 @end macro
 
-@macro seealso
-@noindent
-@heading See also
+@alias ruser=usermanref
 
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
 
-@macro refcommands
-@noindent
-@heading Predefined commands
-
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
 @end macro
 
+@end iftex
 
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
 
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\}, 
-@end macro
+@ifnottex
+@c **** not TEX ****
 
-@macro syntax
-@noindent
-@heading Syntax
+@macro seeinternals{NAME}
+@internalsref{\NAME\}
+@end macro
 
+@ifnotinfo
+@macro usermanref{NAME}
+@ref{\NAME\}
 @end macro
+@end ifnotinfo
+
+@end ifnottex
+
+
+@c EOF