X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=b5c761e530b15dfa55dbe19ffa211daa5876d103;hb=0a8c88636d584611e0d79516469185a810b8dfb2;hp=1c96e067719da42c8164a45f16b5416a8363f46e;hpb=305b92bf5f7121c4270f7e5e64446ffba4391242;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 1c96e06771..b5c761e530 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -6,129 +6,180 @@ version that you are working on. See TRANSLATION for details. @end ignore -@c **** all formats **** -@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'' +@c these need to be split up so that "@qq{foo}." looks nice. :( +@iftex +@macro q{TEXT} +`\TEXT\' +@end macro +@macro qq{TEXT} +``\TEXT\'' @end macro +@end iftex -@macro moreinfo -@subheading More information +@ifinfo +@macro q{TEXT} +`\TEXT\' @end macro -@macro seealso -@noindent -@subsubheading See also +@macro qq{TEXT} +``\TEXT\'' +@end macro +@end ifinfo + +@ifhtml +@macro q{TEXT} +@html +‘\TEXT\’ +@end html @end macro +@macro qq{TEXT} +@html +“\TEXT\” +@end html +@end macro +@end ifhtml + + +@ifdocbook +@macro q{TEXT} +@xml +‘\TEXT\’ +@end xml +@end macro + +@macro qq{TEXT} +@xml +“\TEXT\” +@end xml +@end macro +@end ifdocbook + + + + +@c **** Headings in a doc subsection **** + @macro refcommands @noindent @subsubheading Predefined commands @end macro -@macro context{NAME} -@vindex \NAME\ -@code{\NAME\}@c should use internalsref +@macro commonprop +@noindent +@subsubheading Commonly tweaked properties + @end macro -@macro refcommand{WHAT} -@vindex \WHAT\ -@code{\WHAT\} +@macro seealso +@noindent +@subsubheading See also + @end macro -@macro commonprop +@macro refbugs @noindent -@subsubheading Commonly tweaked properties +@subsubheading Bugs @end macro -@macro funindex {WORD} -@findex \WORD\ -@kindex \WORD\ + +@macro context{TEXT} +@vindex \TEXT\ +@code{\TEXT\}@c should use internalsref +@end macro + +@macro refcommand{TEXT} +@vindex \TEXT\ +@code{\TEXT\} +@end macro + +@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} +@macro lsr{DIR,TEXT} @ifhtml - @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} +@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}} @end ifhtml @ifnothtml - @file{\DIR\/\NAME\} +@file{\DIR\/\TEXT\} @end ifnothtml @end macro @macro lsrdir{DIR} @ifhtml - @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/} +@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/} @end ifhtml @ifnothtml - @file{\DIR\} +@file{\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 @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{\NAME\,,lilypond-internals}@c +@c @inforef{\TEXT\,,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 +187,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 +220,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} +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@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 rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro @end ifdocbook @@ -219,38 +251,29 @@ @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\} +@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 -@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 +282,29 @@ @c **** TEX **** @iftex -@macro internalsref{NAME} -@vindex \NAME\ -@code{\NAME\} +@macro internalsref{TEXT} +@vindex \TEXT\ +@code{\TEXT\} @end macro -@macro rglos {NAME} -@vindex \NAME\ -@code{\NAME\} +@macro rglos {TEXT} +@vindex \TEXT\ +@code{\TEXT\} @end macro -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@macro rprogram{TEXT} +program usage manual, @internalsref{\TEXT\} @end macro -@macro usermanref{NAME} -user manual, @internalsref{\NAME\} +@macro ruser{TEXT} +user manual, @internalsref{\TEXT\} @end macro -@macro rprogram{NAME} -program usage manual, @internalsref{\NAME\} -@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, @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