X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=68fdfae80f3e72a14d52c5a68fe9fe84d01e7ea7;hb=f84a2401f9c5c997bdd7e18e38ca2b974add1c7f;hp=703546a688f0bd6c860947549d87a7615cb15332;hpb=17e82122bc09f2030ab7c87452c3f37540ade6ae;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 703546a688..68fdfae80f 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,25 +1,21 @@ -@c -*-texinfo-*- +@c -*- coding: latin-1; mode: texinfo; -*- -@tex -\input feta20.tex -\global\font\fetasixteen=feta16 -\gdef\fetafont{\fetasixteen} -\gdef\fetachar#1{\hbox{\fetasixteen#1}} -@end tex +@c FIXME: rearranged this file; macros that don't depend on the output +@c format should go at the beginning. -gp -@c Reference GLOSsary -@macro rglos {NAME} -@ifhtml -@c ugh: @ref assumes that external refs are split documents too -@html -\NAME\@c -@end html -@end ifhtml -@ifnothtml -\NAME\@c -@end ifnothtml + +@c in retrospect this is _not_ one of the output-insensitive macros. +@c I'll fix it soon. +@c usage: @lsr{ancient,custodes.ly} +@macro lsr{DIR,NAME} +@uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} @end macro +@macro lsrdir{DIR} +@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}} +@end macro + + @ifnottex @macro texisharp {word} @@ -30,15 +26,19 @@ @end macro @end ifnottex +@c FIXME, use \fetaaccidentalsXMC? +@c \\kern0.15em\\fetachar\\fetaflat @iftex @macro texiflat {word} @tex - \\kern0.15em\\fetachar\\fetaflat + FIXME: fetaflat @end tex @end macro +@c FIXME, use \fetaaccidentalsXC? +@c \\raise0.5ex\\fetachar\\fetasharp @macro texisharp {word} @tex - \\raise0.5ex\\fetachar\\fetasharp + FIXME: fetasharp @end tex @end macro @end iftex @@ -59,13 +59,9 @@ @end macro - -@c dup? @ifhtml +@c ***** HTML ***** - @c ***** HTML ***** - -@macro internalsref{NAME}@c @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 @@ -73,124 +69,176 @@ @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 -@ref{\NAME\,,,lilypond-internals}@c -@c should we do this? -@findex \NAME\ -@end macro - - @c what is this? -- jcn - @macro hyphenatedinternalsref{NAME,NODENAME} - @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c - @c @inforef{\NODENAME\,,lilypond-internals}@c - @c should we do this? - @c using @ref without punctuation is OK without for formats other than info - @ref{\NODENAME\,,\NAME\,lilypond-internals}@c - @findex \NAME\ - @end macro - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@c annoying parentheses stripped by add-html-footer.py +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} +@end macro + +@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly} +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c +@end macro + +@c annoying parentheses stripped by add-html-footer.py +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro + +@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 -@c dup? + @ifdocbook +@c ***** DOCBOOK-XML ***** - @c ***** DOCBOOK-XML ***** +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} +@end macro - @macro internalsref{NAME} - @c makeinfo-4.7 encodes html names - @c @uref{../lilypond-internals/\NAME\.html,\NAME\}@c - @inforef{\NAME\,,lilypond-internals}@c - @c should we do this? - @findex @code{\NAME\} - @end macro +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} +@end macro - @macro hyphenatedinternalsref{NAME,NODENAME} - @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c - @inforef{\NODENAME\,,lilypond-internals}@c - @c should we do this? - @findex @code{\NAME\} - @end macro +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @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 -@ifinfo +@ifinfo @c **** INFO **** -@macro internalsref{NAME} -@inforef{\NAME\,,lilypond/lilypond-internals}@c -@findex \NAME\@c -@end macro -@macro hyphenatedinternalsref{NAME,NODENAME} -@c FIXME: suspicious info file name? -@inforef{\NODENAME\,,lilypond-internals}@c -@c should we do this? -@findex @code{\NAME\} +@macro internalsref{NAME} +@vindex \NAME\ +@inforef{\NAME\,,lilypond-internals} @end macro @macro inputfileref{DIR,NAME} @file{\DIR\/\NAME\} @end macro +@macro rglos{NAME}@c +@vindex \NAME\ +@inforef{\NAME\,,,music-glossary} +@end macro @macro usermanref{NAME} -@ref{\NAME\,,,lilypond/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 -@iftex + @c **** TEX **** +@iftex + +@macro internalsref{NAME} +@vindex \NAME\ +@code{\NAME\} +@end macro -@macro internalsref{NAME}@c -@findex \NAME\ @c -@code{\NAME\}@c +@macro inputfileref{DIR,NAME} +@file{\DIR\/@/\NAME\} @end macro -@macro inputfileref{DIR,NAME}@c -@file{\DIR\/\NAME\}@c +@macro rglos {NAME} +@vindex \NAME\ +@code{\NAME\} @end macro -@macro hyphenatedinternalsref{NAME,NODENAME} -@code{\NAME\}@c -@c should we do this? -@cindex @code{\NAME\} @c +@macro seeinternals{NAME} +internals document, @internalsref{\NAME\} @end macro +@macro usermanref{NAME} +user manual, @internalsref{\NAME\} +@end macro +@c to get decent quotes in `foo' +@macro q{TEXT} +`\TEXT\' +@end macro -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@c to get decent quotes in ``foo'' +@macro qq{TEXT} +``\TEXT\'' @end macro + @end iftex -@c **** not TEX **** @ifnottex - @macro seeinternals{NAME} - @internalsref{\NAME\} - @end macro -@end ifnottex +@c **** not TEX **** + +@macro seeinternals{NAME} +@internalsref{\NAME\} +@end macro @ifnotinfo - @macro usermanref{NAME} - @ref{\NAME\}@c - @end macro +@macro usermanref{NAME} +@ref{\NAME\} +@end macro @end ifnotinfo +@end ifnottex + + +@c **** ALL **** + @macro refbugs @noindent @subsubheading Bugs @end macro +@macro moreinfo +@subheading More information + +@end macro + @macro seealso @noindent @subsubheading See also @@ -203,21 +251,25 @@ internals document, @internalsref{\NAME\} @end macro -@macro context{NAME}@c +@macro context{NAME} +@vindex \NAME\ @code{\NAME\}@c should use internalsref -@findex \NAME\@c @end macro +@macro refcommand{WHAT} +@vindex \WHAT\ +@code{\WHAT\} +@end macro +@macro commonprop +@noindent +@subsubheading Commonly tweaked properties +@end macro -@c -@c ARGGGHHHHH! I want -@c @cindex @code{@backslash\WHAT\} -@c how do I do that? -@c --hwn - -@macro refcommand{WHAT} -@findex \WHAT\ -@code{\WHAT\} +@macro funindex {WORD} +@findex \WORD\ +@kindex \WORD\ @end macro + +@c EOF