X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=fb4e0e779adf1c184103bc0ce9c3fa3c9e418bbb;hb=5aba3336b881aacc84d35ac93064e93b33c3d873;hp=bbeddc24332d878d04dd7a0b3157e55c527bfcd8;hpb=17df17e4a530a9c724f9f9d6445cac0b86d54e55;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index bbeddc2433..fb4e0e779a 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,11 +6,15 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+@include version.itexi
+
 @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 we need this since @q{\} doesn't work with makeinfo 4.11 --
+@c say @q{@bs{}} instead
+@macro bs
+\\
+@end macro
 
 @c to get decent quotes in `foo' and ``foo''
 @macro q{TEXT}
@@ -22,6 +26,12 @@
 @end macro
 
 @macro warning{TEXT}
+@ifhtml
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end ifhtml
+@ifnothtml
 @quotation
 @quotation
 @cartouche
@@ -29,32 +39,56 @@
 @end cartouche
 @end quotation
 @end quotation
+@end ifnothtml
 @end macro
 
-@c TODO: define different output for info
+@ifnotinfo
 @macro notation{TEXT}
 @var{\TEXT\}
 @end macro
+@end ifnotinfo
 
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
 
-
-@c   **** Headings in a doc subsection ****
-
-@c not really a heading, but...
 @macro smallspace
 @sp 1
 @end macro
 
-@c obsolete; being removed.
-@macro refcommands
+
+@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 ****
+
+@macro predefined
 @noindent
 @subsubheading Predefined commands
 
 @end macro
 
-@macro commonprop
+@macro snippets
 @noindent
-@c @subsubheading Commonly tweaked properties
 @subsubheading Selected Snippets
 
 @end macro
@@ -66,12 +100,16 @@
 @indent
 @end macro
 
-@macro refbugs
+@macro knownissues
 @noindent
 @subsubheading Known issues and warnings
 
 @end macro
 
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
+@end macro
 
 @macro funindex {TEXT}
 @findex \TEXT\
@@ -82,69 +120,46 @@
 
 @c   **** Links and references ****
 
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,TEXT}
-@ifhtml
-@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\DIR\/\TEXT\}}
-@end ifhtml
-@ifnothtml
-@file{\DIR\/\TEXT\}
-@end ifnothtml
-@end macro
-
-@macro lsrdir{DIR}
-@ifhtml
-@uref{source/input/lsr/snippets/\DIR\.html,\DIR\}
-@end ifhtml
-@ifnothtml
-\DIR\
-@end ifnothtml
-@end macro
-
-
 @c  Definitions for references:
-@c     @internalsref
 @c     @rglos
-@c     @rprogram
-@c     @ruser
 @c     @rlearning
+@c     @ruser
+@c     @rprogram
+@c     @rsnippets
+@c     @rinternals
 
 @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
-
 @ifset bigpage
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals-big-page}
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 @end macro
 
-@macro rglos{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary-big-page}
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 @end macro
 
-@macro rprogram{TEXT}
+@macro ruser{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page}
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 @end macro
 
-@macro ruser{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-big-page}
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning-big-page}
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 @end macro
 
 @end ifset
@@ -152,29 +167,33 @@
 
 @ifclear bigpage
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rglos{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
-@macro rprogram{TEXT}
+@macro ruser{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro ruser{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
 @end ifclear
@@ -185,29 +204,33 @@
 @ifdocbook
 @c ***** DOCBOOK-XML *****
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rglos{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
-@macro rprogram{TEXT}
+@macro ruser{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro ruser{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
 @end ifdocbook
@@ -216,29 +239,33 @@
 @ifinfo
 @c **** INFO ****
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@inforef{\TEXT\,,lilypond-internals}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rglos{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@inforef{\TEXT\,,music-glossary}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
-@macro rprogram{TEXT}
+@macro ruser{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro ruser{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
 @end ifinfo
@@ -247,32 +274,31 @@
 @c **** TEX ****
 @iftex
 
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
 @vindex \TEXT\
-@code{\TEXT\}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rglos {TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
 @macro rprogram{TEXT}
-program usage manual, @ref{\TEXT\,,,lilypond-program}
-@c @internalsref{\TEXT\}
+program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
-@macro ruser{TEXT}
-notation reference, @ref{\TEXT\,,,lilypond}
-@c @internalsref{\TEXT\}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
-@macro rlearning{TEXT}
-learning manual, @ref{\TEXT\,,,lilypond-learning}
-@c @internalsref{\TEXT\}
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
 @end macro
 
 @end iftex
 
-
-@c EOF