X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=68b52bb51368db7ea2bab262a7113c35c66a1276;hb=b77d9662d42abb0169e56eb26bb6d26d487f826c;hp=e89d5ad8ee25edc62df5f7a194f8ea378e85fbc9;hpb=e6d3010b2ce791de6fc2a240110004cd90b07c26;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index e89d5ad8ee..68b52bb513 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,25 +1,4 @@ -@c -*-texinfo-*- - -@tex -\input feta20.tex -\font\fetasixteen=feta16 -\def\fetafont{\fetasixteen} -\def\fetachar#1{\hbox{\fetasixteen#1}} -@end tex - -@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 -@end macro - +@c -*- coding: latin-1; mode: texinfo; -*- @ifnottex @macro texisharp {word} @@ -30,15 +9,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,99 +42,126 @@ @end macro - -@c dup? - @ifhtml +@c ***** HTML ***** - @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 - @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? - @cindex @code{\NAME\} - @end macro +@c annoying parentheses stripped by add-html-footer.py +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} +@end macro - @macro hyphenatedinternalsref{NAME,NODENAME} - @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c - @inforef{\NODENAME\,,lilypond-internals}@c - @c should we do this? - @cindex @code{\NAME\} - @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 - @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 rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro @end ifhtml -@ifinfo -@c **** INFO **** +@ifdocbook +@c ***** DOCBOOK-XML ***** + @macro internalsref{NAME} -@inforef{\NAME\,,lilypond/lilypond-internals}@c -@cindex \NAME\@c +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro -@macro hyphenatedinternalsref{NAME,NODENAME} -@c FIXME: suspicious info file name? -@inforef{\NODENAME\,,lilypond-internals}@c -@c should we do this? -@cindex @code{\NAME\} +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} +@end macro + +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro + +@end ifdocbook + + +@ifinfo +@c **** INFO **** + +@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 @end ifinfo -@iftex + @c **** TEX **** +@iftex -@macro internalsref{NAME}@c -@cindex @code{\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 hyphenatedinternalsref{NAME,NODENAME} -@code{\NAME\}@c -@c should we do this? -@cindex @code{\NAME\} @c +@macro rglos {NAME} +@vindex \NAME\ +@code{\NAME\} @end macro - - @macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +internals document, @internalsref{\NAME\} @end macro + +@macro usermanref{NAME} +user manual, @internalsref{\NAME\} +@end macro + @end iftex +@ifnottex @c **** not TEX **** -@ifnottex - @macro seeinternals{NAME} - @internalsref{\NAME\} - @end macro -@end ifnottex +@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 @@ -170,21 +180,25 @@ internals document, @internalsref{\NAME\} @end macro -@macro context{NAME}@c +@macro context{NAME} +@vindex \NAME\ @code{\NAME\}@c should use internalsref -@cindex \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} -@cindex @code{\WHAT\} -@code{\WHAT\}, +@macro funindex {WORD} +@findex \WORD\ +@kindex \WORD\ @end macro + +