X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=aff1155e74373a6045b365b6e7e2fa293e06a77d;hb=ece2e45d587f63565e81af44e1937ebe1f5e47a8;hp=443baad4f05bc7dd7c10a8637e9fa9a81888ca9c;hpb=9d109f3638ce59f9a549b831d05d7bcf3a96b1ba;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 443baad4f0..aff1155e74 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -6,7 +6,6 @@ version that you are working on. See TRANSLATION for details. @end ignore - @c ***** Displaying text ***** @c we need this since @q{\} doesn't work with makeinfo 4.8 -- @@ -14,77 +13,64 @@ @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\' +@quoteleft{}\TEXT\@quoteright{} @end macro @macro qq{TEXT} -``\TEXT\'' +@quotedblleft{}\TEXT\@quotedblright{} @end macro -@end iftex +@macro warning{TEXT} +@quotation +@quotation +@cartouche +@b{Note:} \TEXT\ +@end cartouche +@end quotation +@end quotation +@end macro -@ifinfo -@macro q{TEXT} -`\TEXT\' +@ifnotinfo +@macro notation{TEXT} +@var{\TEXT\} @end macro +@end ifnotinfo -@macro qq{TEXT} -``\TEXT\'' +@ifinfo +@macro notation{TEXT} +\TEXT\ @end macro @end ifinfo - -@ifhtml -@macro q{TEXT} -@html -‘\TEXT\’ -@end html +@macro smallspace +@sp 1 @end macro -@macro qq{TEXT} -@html -“\TEXT\” -@end html -@end macro -@end ifhtml +@c **** Displaying images not generated by lilypond-book -@ifdocbook -@macro q{TEXT} -@xml -‘\TEXT\’ -@end xml -@end macro +@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. -@macro qq{TEXT} -@xml -“\TEXT\” -@end xml +@ifnotinfo +@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT} +@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\} @end macro -@end ifdocbook +@end ifnotinfo -@c TODO: experimental. Don't use unless Graham confirms it. -@macro warning{TEXT} -@quotation -@cartouche -@strong{Warning:} \TEXT\ -@end cartouche -@end quotation +@ifinfo +@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT} +@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\} @end macro - +@end ifinfo @c **** Headings in a doc subsection **** -@c not really a heading, but... -@macro smallspace -@sp 1 -@end macro - -@c absolete; being removed. +@c obsolete; being removed. @macro refcommands @noindent @subsubheading Predefined commands @@ -93,7 +79,8 @@ @macro commonprop @noindent -@subsubheading Commonly tweaked properties +@c @subsubheading Commonly tweaked properties +@subsubheading Selected Snippets @end macro @@ -101,6 +88,7 @@ @noindent @subsubheading See also +@indent @end macro @macro refbugs @@ -110,16 +98,6 @@ @end macro -@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\ @@ -129,22 +107,23 @@ @c **** Links and references **** -@c usage: @lsr{ancient,custodes.ly} -@macro lsr{DIR,TEXT} +@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 @@ -159,14 +138,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} @@ -268,6 +239,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} @@ -296,19 +272,22 @@ @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} +@c @internalsref{\TEXT\} @end macro @macro ruser{TEXT} -user manual, @internalsref{\TEXT\} +notation reference, @ref{\TEXT\,,,lilypond} +@c @internalsref{\TEXT\} @end macro @macro rlearning{TEXT} -learning manual, @internalsref{\TEXT\} +learning manual, @ref{\TEXT\,,,lilypond-learning} +@c @internalsref{\TEXT\} @end macro @end iftex