X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=32536c3cd5d5c1b1dea9dc6b9a0df809ed4614ab;hb=8e55792ab12ca7114777b1b1d99168a7c6f9aa35;hp=6bcfaf2f54b6e8372901178145584a3dbb918f13;hpb=f81641423b285ca42142d31dcf2f0efd9213936a;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 6bcfaf2f54..32536c3cd5 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,30 +1,75 @@ @c -*- coding: latin-1; mode: texinfo; -*- -@ifnottex - @macro texisharp {word} - # - @end macro - @macro texiflat {word} - b - @end macro -@end ifnottex +@c **** all formats **** + +@macro refbugs +@noindent +@subsubheading Bugs + +@end macro + +@macro moreinfo +@subheading More information + +@end macro + +@macro seealso +@noindent +@subsubheading See also + +@end macro + +@macro refcommands +@noindent +@subsubheading Predefined commands + +@end macro + +@macro context{NAME} +@vindex \NAME\ +@code{\NAME\}@c should use internalsref +@end macro + +@macro refcommand{WHAT} +@vindex \WHAT\ +@code{\WHAT\} +@end macro + +@macro commonprop +@noindent +@subsubheading Commonly tweaked properties + +@end macro + +@macro funindex {WORD} +@findex \WORD\ +@kindex \WORD\ +@end macro + + + +@c *** Macros with variable output *** + +@c usage: @lsr{ancient,custodes.ly} +@macro lsr{DIR,NAME} +@ifhtml + @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} +@end ifhtml +@ifnothtml + @file{\DIR\/\NAME\} +@end ifnothtml +@end macro + +@macro lsrdir{DIR} +@ifhtml + @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}} +@end ifhtml +@ifnothtml + @file{\DIR\} +@end ifnothtml +@end macro + -@c FIXME, use \fetaaccidentalsXMC? -@c \\kern0.15em\\fetachar\\fetaflat -@iftex - @macro texiflat {word} - @tex - FIXME: fetaflat - @end tex - @end macro -@c FIXME, use \fetaaccidentalsXC? -@c \\raise0.5ex\\fetachar\\fetasharp - @macro texisharp {word} - @tex - FIXME: fetasharp - @end tex - @end macro -@end iftex @macro arrow{} @@ -42,6 +87,11 @@ @end macro +@c we need this since @q{\} doesn't work with makeinfo 4.8 -- +@c say @q{@value{backslash}} instead +@set backslash \ + + @ifhtml @c ***** HTML ***** @@ -53,21 +103,57 @@ @c @inforef{\NAME\,,lilypond-internals}@c @c using @ref without punctuation is OK without for formats other than info -@macro internalsref{NAME}@c -@ref{\NAME\,,,lilypond-internals}@c -@findex \NAME\ +@ifset bigpage + +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals-big-page} @end macro +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary-big-page} +@end macro + +@end ifset + + +@ifclear bigpage + +@c annoying parentheses stripped by add-html-footer.py +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} +@end macro + +@c annoying parentheses stripped by add-html-footer.py +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro + +@end ifclear + + +@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly} @macro inputfileref{DIR,NAME} -@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c @end macro -@macro rglos{NAME}@c -@c annoying parentheses -@ref{\NAME\,,,music-glossary}@c -@findex \NAME\ +@c to get decent quotes in `foo' +@macro q{TEXT} +@html +‘\TEXT\’ +@end html +@end macro + +@c to get decent quotes in ``foo'' +@macro qq{TEXT} +@html +“\TEXT\” +@end html @end macro - + @end ifhtml @@ -75,17 +161,31 @@ @c ***** DOCBOOK-XML ***** @macro internalsref{NAME} -@ref{\NAME\,,,lilypond-internals}@c -@findex @code{\NAME\} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro - + @macro inputfileref{DIR,NAME} -@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} @end macro -@macro rglos{NAME}@c -@ref{\NAME\,,,music-glossary}@c -@findex \NAME\ +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@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 @end macro @end ifdocbook @@ -95,8 +195,8 @@ @c **** INFO **** @macro internalsref{NAME} -@inforef{\NAME\,,lilypond-internals}@c -@findex \NAME\@c +@vindex \NAME\ +@inforef{\NAME\,,lilypond-internals} @end macro @macro inputfileref{DIR,NAME} @@ -104,12 +204,22 @@ @end macro @macro rglos{NAME}@c -@inforef{\NAME\,,,music-glossary}@c -@findex \NAME\ +@vindex \NAME\ +@inforef{\NAME\,,,music-glossary} @end macro @macro usermanref{NAME} -@inforef{\NAME\,,lilypond}@c +@inforef{\NAME\} +@end macro + +@c to get decent quotes in `foo' +@macro q{TEXT} +`\TEXT\' +@end macro + +@c to get decent quotes in ``foo'' +@macro qq{TEXT} +``\TEXT\'' @end macro @end ifinfo @@ -118,18 +228,18 @@ @c **** TEX **** @iftex -@macro internalsref{NAME}@c -@findex \NAME\ @c -@code{\NAME\}@c +@macro internalsref{NAME} +@vindex \NAME\ +@code{\NAME\} @end macro -@macro inputfileref{DIR,NAME}@c -@file{\DIR\/@/\NAME\}@c +@macro inputfileref{DIR,NAME} +@file{\DIR\/@/\NAME\} @end macro @macro rglos {NAME} -@findex \NAME\ @c -@code{\NAME\}@c +@vindex \NAME\ +@code{\NAME\} @end macro @macro seeinternals{NAME} @@ -140,8 +250,19 @@ internals document, @internalsref{\NAME\} user manual, @internalsref{\NAME\} @end macro +@c to get decent quotes in `foo' +@macro q{TEXT} +`\TEXT\' +@end macro + +@c to get decent quotes in ``foo'' +@macro qq{TEXT} +``\TEXT\'' +@end macro + @end iftex + @ifnottex @c **** not TEX **** @@ -151,37 +272,11 @@ user manual, @internalsref{\NAME\} @ifnotinfo @macro usermanref{NAME} -@ref{\NAME\}@c +@ref{\NAME\} @end macro @end ifnotinfo @end ifnottex -@macro refbugs -@noindent -@subsubheading Bugs - -@end macro - -@macro seealso -@noindent -@subsubheading See also - -@end macro - -@macro refcommands -@noindent -@subsubheading Predefined commands - -@end macro - -@macro context{NAME}@c -@code{\NAME\}@c should use internalsref -@findex \NAME\@c -@end macro - -@macro refcommand{WHAT} -@findex \WHAT\ -@code{\WHAT\} -@end macro +@c EOF