X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=4ef3123bfdbed271a2cd015e2b581f5ef4a555c9;hb=91708b30fba67f8fd589980e03ff420c26473a5a;hp=695e951bb0bed53fb18aaaefa08e6876dbd5dd23;hpb=d57728b24c46a5d247bca6ee5ed3d346b2785ec1;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 695e951bb0..4ef3123bfd 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -6,6 +6,9 @@ version that you are working on. See TRANSLATION for details. @end ignore +@macro version +@value{version} +@end macro @c ***** Displaying text ***** @@ -32,25 +35,54 @@ @end quotation @end macro +@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 -@subsubheading Commonly tweaked properties +@subsubheading Selected Snippets @end macro @@ -58,20 +90,15 @@ @noindent @subsubheading See also +@indent @end macro -@macro refbugs +@macro knownissues @noindent @subsubheading Known issues and warnings @end macro - -@macro context{TEXT} -@vindex \TEXT\ -@code{\TEXT\}@c should use internalsref -@end macro - @macro funindex {TEXT} @findex \TEXT\ @kindex \TEXT\ @@ -81,22 +108,24 @@ @c **** Links and references **** -@c usage: @lsr{ancient,custodes.ly} -@macro lsr{DIR,TEXT} +@c Possibly deprecated; under discussion. +@c usage: @lsr{ancient,Ancient-notation,custodes.ly} +@macro lsr{SECTION,DIR,TEXT} @ifhtml -@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}} +@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}} @end ifhtml @ifnothtml -@file{\DIR\/\TEXT\} +@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 @@ -111,14 +140,6 @@ @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} @@ -146,6 +167,10 @@ @ref{\TEXT\,,,lilypond-learning-big-page} @end macro +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets-big-page} +@end macro + @end ifset @@ -176,6 +201,10 @@ @ref{\TEXT\,,,lilypond-learning} @end macro +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} +@end macro + @end ifclear @end ifhtml @@ -209,6 +238,10 @@ @ref{\TEXT\,,,lilypond-learning} @end macro +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} +@end macro + @end ifdocbook @@ -220,6 +253,11 @@ @inforef{\TEXT\,,lilypond-internals} @end macro +@macro rglos{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,music-glossary} +@end macro + @macro rprogram{TEXT} @vindex \TEXT\ @ref{\TEXT\,,,lilypond-program} @@ -235,6 +273,10 @@ @ref{\TEXT\,,,lilypond-learning} @end macro +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} +@end macro + @end ifinfo @@ -248,19 +290,23 @@ @macro rglos {TEXT} @vindex \TEXT\ -@code{\TEXT\} +@ref{\TEXT\,,,music-glossary} @end macro @macro rprogram{TEXT} -program usage manual, @internalsref{\TEXT\} +program usage manual, @ref{\TEXT\,,,lilypond-program} @end macro @macro ruser{TEXT} -user manual, @internalsref{\TEXT\} +notation reference, @ref{\TEXT\,,,lilypond} @end macro @macro rlearning{TEXT} -learning manual, @internalsref{\TEXT\} +learning manual, @ref{\TEXT\,,,lilypond-learning} +@end macro + +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} @end macro @end iftex