X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=4cf09a6c6bc77ffe0fe57258bd920a9aceb349bf;hb=e9c683d7eedcbc52d71682694a2ceb83bad07d75;hp=1bab2256ecb6809ed582e5c9492fe175fc517556;hpb=e3036f22ffdf5dc906bb2491f9fcd7e5a6c27a8d;p=lilypond.git
diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 1bab2256ec..df8844a428 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,171 +1,278 @@
-@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
-@html
-\NAME\@c
-@end html
+@uref{source/input/lsr/snippets/\DIR\.html,\DIR\}
@end ifhtml
@ifnothtml
-\NAME\@c
+\DIR\
@end ifnothtml
@end macro
-@ifnottex
-@macro texisharp {word}
-#
-@end macro
-@end ifnottex
+@c Definitions for references:
+@c @internalsref
+@c @rglos
+@c @rprogram
+@c @ruser
+@c @rlearning
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
-@end macro
-@end iftex
+@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
-@ifnottex
-@macro texiflat {word}
-b
+@ifset bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page}
@end macro
-@end ifnottex
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
@end macro
-@end iftex
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
+@end macro
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
+@end macro
-@iftex
-@macro separate
-@c I want some space over here, not silly characters.
-@tex
-@end tex
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
@end macro
-@end iftex
-@c \heartsf was supposed to be filled?
+@end ifset
-@c center*** is broken?
-@ifinfo
-@macro separate
+@ifclear bigpage
-@quotation
-@end quotation
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
@end macro
-@end ifinfo
-@ifhtml
-@macro separate
-@html
-
-@end html
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
@end macro
-@end ifhtml
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
-@c dup?
-@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}@c
-@cindex \NAME\@c
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
@end macro
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
@end macro
+@end ifclear
+
@end ifhtml
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}@c
-@cindex \NAME\@c
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
@end macro
-@macro inputfileref{DIR,NAME}i
-@file{\DIR\/\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
@end macro
-@end ifinfo
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
-@iftex
-@macro internalsref{NAME}@c
-@cindex \NAME\@c
-@code{\NAME\}@c
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
@end macro
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/\NAME\}@c
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
@end macro
-@end iftex
+@end ifdocbook
-@iftex
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
-@end macro
-@end iftex
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@ifinfo
+@c **** INFO ****
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
@end macro
-@end ifnottex
-@macro refbugs
-@noindent
-@heading Bugs
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary}
+@end macro
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
@end macro
-@macro seealso
-@noindent
-@heading See also
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
+@end macro
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
@end macro
-@macro refcommands
-@noindent
-@heading Predefined commands
+@end ifinfo
-@end macro
+@c **** TEX ****
+@iftex
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c --hwn
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\},
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
@end macro
-@macro syntax
-@noindent
-@heading Syntax
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
+@c @internalsref{\TEXT\}
+@end macro
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
@end macro
+
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
+@end macro
+
+@end iftex
+
+
+@c EOF