X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=4ef3123bfdbed271a2cd015e2b581f5ef4a555c9;hb=91708b30fba67f8fd589980e03ff420c26473a5a;hp=11b2b59bf13a56d3e21f78b105390e47fcf69cdc;hpb=5516a43e8bc85c3f58b3c004a9a7fde626408939;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 11b2b59bf1..4ef3123bfd 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,295 +1,315 @@
-@c -*- coding: latin-1; mode: texinfo; -*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
-@c FIXME: rearranged this file; macros that don't depend on the output
-@c format should go at the beginning.  -gp
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
-
-@c in retrospect this is _not_ one of the output-insensitive macros.
-@c I'll fix it soon.
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,NAME}
-@uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@macro version
+@value{version}
 @end macro
 
-@macro lsrdir{DIR}
-@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}}
-@end macro
+@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
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@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 warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
 
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
 
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
-@ifhtml
-@html
-→
-@end html
-@end ifhtml
 @ifinfo
--->
+@macro notation{TEXT}
+\TEXT\
+@end macro
 @end ifinfo
+
+@macro smallspace
+@sp 1
 @end macro
 
 
-@ifhtml
-@c ***** HTML *****
+@c   **** Displaying images not generated by lilypond-book
 
-@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
+@c current installation setup of Info docs requires that all images are
+@c expected to be found in lilypond/ subdirectory.  lilypond-book already
+@c generates proper @image commands for images of music; these macros
+@c definitions do the same for other images.
 
-@ifset bigpage
-
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals-big-page}
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifnotinfo
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary-big-page}
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifinfo
 
-@end ifset
 
+@c   **** Headings in a doc subsection ****
 
-@ifclear bigpage
+@macro predefined
+@noindent
+@subsubheading Predefined commands
 
-@c annoying parentheses stripped by add-html-footer.py
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
 @end macro
 
-@c annoying parentheses stripped by add-html-footer.py
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+
 @end macro
 
-@end ifclear
+@macro seealso
+@noindent
+@subsubheading See also
 
+@indent
+@end macro
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
 
-@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@html
-“\TEXT\”
-@end html
+
+
+@c   **** Links and references ****
+
+@c  Possibly deprecated; under discussion.
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
+@ifhtml
+@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
+@end ifhtml
+@ifnothtml
+@file{\SECTION\/\TEXT\}
+@end ifnothtml
 @end macro
 
+@c usage: @lsrdir{ancient,Ancient-notation}
+@macro lsrdir{SECTION,DIR}
+@ifhtml
+@uref{source/input/lsr/snippets/\DIR\.html,\SECTION\}
 @end ifhtml
+@ifnothtml
+\DIR\
+@end ifnothtml
+@end macro
 
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
+
+@ifhtml
+@c ***** HTML *****
+
+@ifset bigpage
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@xml
-‘\TEXT\’
-@end xml
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@xml
-“\TEXT\”
-@end xml
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
 @end macro
 
-@end ifdocbook
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page}
+@end macro
 
+@end ifset
 
-@ifinfo
-@c **** INFO ****
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals}
+@ifclear bigpage
+
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro rglos{NAME}@c
-@vindex \NAME\
-@inforef{\NAME\,,,music-glossary}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro usermanref{NAME}
-@inforef{\NAME\}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
 @end macro
 
-@end ifinfo
+@end ifclear
 
+@end ifhtml
 
-@c **** TEX ****
-@iftex
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@code{\NAME\}
-@end macro
+@ifdocbook
+@c ***** DOCBOOK-XML *****
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/@/\NAME\}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro rglos {NAME}
-@vindex \NAME\
-@code{\NAME\}
+@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
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
 @end macro
 
-@end iftex
+@end ifdocbook
 
 
-@ifnottex
-@c **** not TEX ****
+@ifinfo
+@c **** INFO ****
 
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
 @end macro
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary}
 @end macro
-@end ifnotinfo
-
-@end ifnottex
-
 
-@c **** ALL ****
-
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
+@end macro
 
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@macro moreinfo
-@subheading More information
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
+@end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
+@end ifinfo
 
-@end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@c **** TEX ****
+@iftex
 
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
 
-@macro context{NAME}
-@vindex \NAME\
-@code{\NAME\}@c should use internalsref
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro refcommand{WHAT}
-@vindex \WHAT\
-@code{\WHAT\}
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@end macro
 
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@macro funindex {WORD}
-@findex \WORD\
-@kindex \WORD\
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
 @end macro
 
+@end iftex
+
+
 @c EOF