X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=aff1155e74373a6045b365b6e7e2fa293e06a77d;hb=ece2e45d587f63565e81af44e1937ebe1f5e47a8;hp=ee765f75c4d6a38cc1132738133bbc572bae21ee;hpb=f6895cf1863a4e0b0f6aa35d1dc7375a3d8a26e4;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index ee765f75c4..aff1155e74 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,129 +6,163 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
-@c **** all formats ****
+@c   ***** Displaying text *****
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@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 moreinfo
-@subheading More information
+@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
 
-@macro seealso
-@noindent
-@subsubheading See also
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
+
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
+
+@macro smallspace
+@sp 1
+@end macro
+
+
+@c   **** Displaying images not generated by lilypond-book
+
+@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.
 
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@end macro
+@end ifnotinfo
+
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifinfo
 
+
+@c   **** Headings in a doc subsection ****
+
+@c obsolete; being removed.
 @macro refcommands
 @noindent
 @subsubheading Predefined commands
 
 @end macro
 
-@macro context{NAME}
-@vindex \NAME\
-@code{\NAME\}@c should use internalsref
+@macro commonprop
+@noindent
+@c @subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
+
 @end macro
 
-@macro refcommand{WHAT}
-@vindex \WHAT\
-@code{\WHAT\}
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
 @end macro
 
-@macro commonprop
+@macro refbugs
 @noindent
-@subsubheading Commonly tweaked properties
+@subsubheading Known issues and warnings
 
 @end macro
 
-@macro funindex {WORD}
-@findex \WORD\
-@kindex \WORD\
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
 @end macro
 
 
 
-@c  *** Macros with variable output ***
+@c   **** Links and references ****
 
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,NAME}
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
 @ifhtml
-  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
 @end ifhtml
 @ifnothtml
-  @file{\DIR\/\NAME\}
+@file{\SECTION\/\TEXT\}
 @end ifnothtml
 @end macro
 
-@macro lsrdir{DIR}
+@c usage: @lsrdir{ancient,Ancient-notation}
+@macro lsrdir{SECTION,DIR}
 @ifhtml
-  @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@uref{source/input/lsr/snippets/\DIR\.html,\SECTION\}
 @end ifhtml
 @ifnothtml
-  @file{\DIR\}
+\DIR\
 @end ifnothtml
 @end macro
 
 
-
-
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
-@ifhtml
-@html
-→
-@end html
-@end ifhtml
-@ifinfo
--->
-@end ifinfo
-@end macro
-
-
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
-@c say @q{@value{backslash}} instead
-@set backslash \
-
+@c  Definitions for references:
+@c     @internalsref
+@c     @rglos
+@c     @rprogram
+@c     @ruser
+@c     @rlearning
 
 @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}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary-big-page}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program-big-page}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page}
 @end macro
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-big-page}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page}
 @end macro
 
 @end ifset
@@ -136,42 +170,32 @@
 
 @ifclear bigpage
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program}
 @end macro
 
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@end ifclear
-
-
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@html
-“\TEXT\”
-@end html
-@end macro
+@end ifclear
 
 @end ifhtml
 
@@ -179,38 +203,29 @@
 @ifdocbook
 @c ***** DOCBOOK-XML *****
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals}
 @end macro
 
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,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
-‘\TEXT\’
-@end xml
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @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}
 @end macro
 
 @end ifdocbook
@@ -219,38 +234,29 @@
 @ifinfo
 @c **** INFO ****
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals}
-@end macro
-
-@macro rglos{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,,music-glossary}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals}
 @end macro
 
-@macro usermanref{NAME}
-@inforef{\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary}
 @end macro
 
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,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\'
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond}
 @end macro
 
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning}
 @end macro
 
 @end ifinfo
@@ -259,57 +265,32 @@
 @c **** TEX ****
 @iftex
 
-@macro internalsref{NAME}
-@vindex \NAME\
-@code{\NAME\}
-@end macro
-
-@macro rglos {NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro internalsref{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
 
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro rglos {TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary}
 @end macro
 
-@macro usermanref{NAME}
-user manual, @internalsref{\NAME\}
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
+@c @internalsref{\TEXT\}
 @end macro
 
-@macro rprogram{NAME}
-program usage manual, @internalsref{\NAME\}
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
 @end macro
 
-@alias ruser=usermanref
-
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
-@end macro
-
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
 @end macro
 
 @end iftex
 
 
-@ifnottex
-@c **** not TEX ****
-
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
-@end macro
-
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}
-@end macro
-@end ifnotinfo
-
-@end ifnottex
-
-
 @c EOF