X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fuser%2Fmacros.itexi;h=b5c761e530b15dfa55dbe19ffa211daa5876d103;hb=0a8c88636d584611e0d79516469185a810b8dfb2;hp=1bab2256ecb6809ed582e5c9492fe175fc517556;hpb=e3036f22ffdf5dc906bb2491f9fcd7e5a6c27a8d;p=lilypond.git
diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 1bab2256ec..b5c761e530 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,171 +1,310 @@
-@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}
-@ifhtml
-@ref{\NAME\}@c
-@end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
+ 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''
+@c these need to be split up so that "@qq{foo}." looks nice. :(
+@iftex
+@macro q{TEXT}
+`\TEXT\'
+@end macro
+
+@macro qq{TEXT}
+``\TEXT\''
@end macro
+@end iftex
+@ifinfo
+@macro q{TEXT}
+`\TEXT\'
+@end macro
+
+@macro qq{TEXT}
+``\TEXT\''
+@end macro
+@end ifinfo
-@c Reference GLOSsary
-@macro rglos {NAME}
@ifhtml
-@c ugh: @ref assumes that external refs are split documents too
+@macro q{TEXT}
@html
-\NAME\@c
+‘\TEXT\’
@end html
-@end ifhtml
-@ifnothtml
-\NAME\@c
-@end ifnothtml
@end macro
+@macro qq{TEXT}
+@html
+“\TEXT\”
+@end html
+@end macro
+@end ifhtml
+
-@ifnottex
-@macro texisharp {word}
-#
+@ifdocbook
+@macro q{TEXT}
+@xml
+‘\TEXT\’
+@end xml
@end macro
-@end ifnottex
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+@macro qq{TEXT}
+@xml
+“\TEXT\”
+@end xml
@end macro
-@end iftex
+@end ifdocbook
+
+
+
+
+@c **** Headings in a doc subsection ****
+
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
-@ifnottex
-@macro texiflat {word}
-b
@end macro
-@end ifnottex
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
+
@end macro
-@end iftex
+@macro seealso
+@noindent
+@subsubheading See also
+@end macro
+
+@macro refbugs
+@noindent
+@subsubheading Bugs
-@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?
-@c center*** is broken?
+@macro context{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}@c should use internalsref
+@end macro
-@ifinfo
-@macro separate
+@macro refcommand{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
-@quotation
-@end quotation
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
@end macro
-@end ifinfo
+
+
+@c **** Links and references ****
+
+@c usage: @lsr{ancient,custodes.ly}
+@macro lsr{DIR,TEXT}
@ifhtml
-@macro separate
-@html
-
-@end html
+@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
+@end ifhtml
+@ifnothtml
+@file{\DIR\/\TEXT\}
+@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 dup?
+
+@c Definitions for references:
+@c @internalsref
+@c @rglos
+@c @rprogram
+@c @ruser
+@c @rlearning
+
@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}@c
-@cindex \NAME\@c
+@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 inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
@end macro
-@end ifhtml
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
+@end macro
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}@c
-@cindex \NAME\@c
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
@end macro
-@macro inputfileref{DIR,NAME}i
-@file{\DIR\/\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
@end macro
-@end ifinfo
+@end ifset
-@iftex
-@macro internalsref{NAME}@c
-@cindex \NAME\@c
-@code{\NAME\}@c
+
+@ifclear bigpage
+
+@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
-@end iftex
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
-@iftex
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
@end macro
-@end iftex
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
@end macro
-@end ifnottex
-@macro refbugs
-@noindent
-@heading Bugs
+@end ifclear
+@end ifhtml
+
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
@end macro
-@macro seealso
-@noindent
-@heading See also
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
+@end macro
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
@end macro
-@macro refcommands
-@noindent
-@heading Predefined commands
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
+@end macro
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
@end macro
+@end ifdocbook
+
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c --hwn
+@ifinfo
+@c **** INFO ****
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\},
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
@end macro
-@macro syntax
-@noindent
-@heading Syntax
+@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 rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
+@end macro
+
+@end ifinfo
+
+@c **** TEX ****
+@iftex
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
+
+@macro rglos {TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
+
+@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