X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=4ef3123bfdbed271a2cd015e2b581f5ef4a555c9;hb=91708b30fba67f8fd589980e03ff420c26473a5a;hp=61b8b4140dfe979081791a79478b7aabadaceac7;hpb=ea0a02af122c42417cbe73cdd2b6966fedc2afa6;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 61b8b4140d..4ef3123bfd 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -6,134 +6,169 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c **** all formats **** +@macro version +@value{version} +@end macro -@macro refbugs -@noindent -@subsubheading Bugs +@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 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 -@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 context{NAME} -@vindex \NAME\ -@code{\NAME\}@c should use internalsref +@macro snippets +@noindent +@subsubheading Selected Snippets + @end macro -@macro refcommand{WHAT} -@vindex \WHAT\ -@code{\WHAT\} +@macro seealso +@noindent +@subsubheading See also + +@indent @end macro -@macro commonprop +@macro knownissues @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 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#\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{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary-big-page} @end macro -@macro rglos{NAME} -@vindex \NAME\ -@ref{\NAME\,,,music-glossary-big-page} +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program-big-page} @end macro -@macro rprogram{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-program-big-page} +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-big-page} @end macro -@macro ruser{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-big-page} +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning-big-page} @end macro -@macro rlearning{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-learning-big-page} +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets-big-page} @end macro @end ifset @@ -141,47 +176,36 @@ @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 -@macro rlearning{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-learning} +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro -@end ifclear - - -@c to get decent quotes in `foo' -@macro q{TEXT} -@html -‘\TEXT\’ -@end html +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} @end macro -@c to get decent quotes in ``foo'' -@macro qq{TEXT} -@html -“\TEXT\” -@end html -@end macro +@end ifclear @end ifhtml @@ -189,44 +213,33 @@ @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} +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@macro rlearning{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-learning} +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro -@c to get decent quotes in `foo' -@c to get decent quotes in `foo' -@macro q{TEXT} -@xml -‘\TEXT\’ -@end xml -@end macro - -@c to get decent quotes in ``foo'' -@macro qq{TEXT} -@xml -“\TEXT\” -@end xml +@macro rlsr{TEXT} +@ref{\TEXT\,,,lilypond-snippets} @end macro @end ifdocbook @@ -235,48 +248,33 @@ @ifinfo @c **** INFO **** -@macro internalsref{NAME} -@vindex \NAME\ -@inforef{\NAME\,,lilypond-internals} -@end macro - -@macro rglos{NAME} -@vindex \NAME\ -@inforef{\NAME\,,music-glossary} -@end macro - -@macro usermanref{NAME} -@inforef{\NAME\} -@end macro - -@macro learningref{NAME} -@inforef{\NAME\} +@macro internalsref{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,lilypond-internals} @end macro -@macro rprogram{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-program} +@macro rglos{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,music-glossary} @end macro -@macro ruser{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond} +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} @end macro -@macro rlearning{NAME} -@vindex \NAME\ -@ref{\NAME\,,,lilypond-learning} +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@c to get decent quotes in `foo' -@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 @@ -285,66 +283,33 @@ @c **** TEX **** @iftex -@macro internalsref{NAME} -@vindex \NAME\ -@code{\NAME\} -@end macro - -@macro rglos {NAME} -@vindex \NAME\ -@code{\NAME\} -@end macro - -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@macro internalsref{TEXT} +@vindex \TEXT\ +@code{\TEXT\} @end macro -@macro usermanref{NAME} -user manual, @internalsref{\NAME\} +@macro rglos {TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary} @end macro -@macro learningref{NAME} -learning manual, @internalsref{\NAME\} +@macro rprogram{TEXT} +program usage manual, @ref{\TEXT\,,,lilypond-program} @end macro -@macro rprogram{NAME} -program usage manual, @internalsref{\NAME\} +@macro ruser{TEXT} +notation reference, @ref{\TEXT\,,,lilypond} @end macro -@alias ruser=usermanref -@alias rlearning=learningref - -@c to get decent quotes in `foo' -@macro q{TEXT} -`\TEXT\' +@macro rlearning{TEXT} +learning manual, @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 -@ifnottex -@c **** not TEX **** - -@macro seeinternals{NAME} -@internalsref{\NAME\} -@end macro - -@ifnotinfo -@macro usermanref{NAME} -@ref{\NAME\} -@end macro - -@macro learningref{NAME} -@ref{\NAME\} -@end macro -@end ifnotinfo - -@end ifnottex - - @c EOF