X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=68b52bb51368db7ea2bab262a7113c35c66a1276;hb=b77d9662d42abb0169e56eb26bb6d26d487f826c;hp=15e446bbab7b97bfe25fa68e25e5a4ccda235c87;hpb=25e0ad87d00c21597de319ed4554f18a7c4e6b1d;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 15e446bbab..68b52bb513 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,152 +1,204 @@ -@ifnottex -@macro reng {word} -@ref{ (lilypond-internals)\word\, \word\ } +@c -*- coding: latin-1; mode: texinfo; -*- -@end macro +@ifnottex + @macro texisharp {word} + # + @end macro + @macro texiflat {word} + b + @end macro @end ifnottex +@c FIXME, use \fetaaccidentalsXMC? +@c \\kern0.15em\\fetachar\\fetaflat @iftex -@macro reng {word} -\word\ -@end macro + @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 -@ifnottex -@macro rgrob {word} -@ref{ (lilypond-internals)\word\, \word\ } +@macro arrow{} +@iftex +@tex $\\Rightarrow$ @end tex@c +@end iftex +@ifhtml +@html +→ +@end html +@end ifhtml +@ifinfo +--> +@end ifinfo +@end macro + + +@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 @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 +@c annoying parentheses stripped by add-html-footer.py +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro -@end ifnottex -@iftex -@macro rgrob {word} -\word\ +@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 -@end iftex +@c annoying parentheses stripped by add-html-footer.py +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} +@end macro + +@end ifhtml -@ifnottex -@macro rint {word} -@ref{ (lilypond-internals)\word\, \word\ } +@ifdocbook +@c ***** DOCBOOK-XML ***** + +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro -@end ifnottex -@iftex -@macro rint {word} -\word\ +@macro inputfileref{DIR,NAME} +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} @end macro -@end iftex -@ifnottex -@macro texisharp {word} -# +@macro rglos{NAME} +@vindex \NAME\ +@ref{\NAME\,,,music-glossary} @end macro -@end ifnottex -@iftex -@macro texisharp {word} -@tex -$\\sharp$ -@end tex +@end ifdocbook + + +@ifinfo +@c **** INFO **** + +@macro internalsref{NAME} +@vindex \NAME\ +@inforef{\NAME\,,lilypond-internals} @end macro -@end iftex -@ifnottex -@macro texiflat {word} -b +@macro inputfileref{DIR,NAME} +@file{\DIR\/\NAME\} @end macro -@end ifnottex -@iftex -@macro texiflat {word} -@tex -$\\flat$ -@end tex +@macro rglos{NAME}@c +@vindex \NAME\ +@inforef{\NAME\,,,music-glossary} @end macro -@end iftex +@macro usermanref{NAME} +@inforef{\NAME\} +@end macro + +@end ifinfo +@c **** TEX **** @iftex -@macro separate -@c I want some space over here, not silly characters. -@tex -@end tex -@end macro -@end iftex -@c \heartsf was supposed to be filled? +@macro internalsref{NAME} +@vindex \NAME\ +@code{\NAME\} +@end macro -@c center*** is broken? +@macro inputfileref{DIR,NAME} +@file{\DIR\/@/\NAME\} +@end macro -@ifinfo -@macro separate +@macro rglos {NAME} +@vindex \NAME\ +@code{\NAME\} +@end macro -@quotation -@end quotation +@macro seeinternals{NAME} +internals document, @internalsref{\NAME\} @end macro -@end ifinfo -@ifhtml -@macro separate -@html -



-@end html +@macro usermanref{NAME} +user manual, @internalsref{\NAME\} @end macro -@end ifhtml -@ignore +@end iftex -@c Huh, do outline mode and texinfo really fight eachother? -@c Outline can only use spaces to indent topic headers -@c (or bullets, but then topics can't start with `@c'). -@c Texinfo can't have spaces in macro names. +@ifnottex +@c **** not TEX **** -@macro c_ {word} -\word\ -@node \word\ -@section \word\ +@macro seeinternals{NAME} +@internalsref{\NAME\} @end macro -@macro c__ {word} -\word\ -@menu -* \word\:: -@end menu - -@node \word\ -@subsection \word\ +@ifnotinfo +@macro usermanref{NAME} +@ref{\NAME\} @end macro +@end ifnotinfo + +@end ifnottex + + +@c **** ALL **** + +@macro refbugs +@noindent +@subsubheading Bugs -@macro c___ {word} -\word\ -@node \word\ -@unnumberedsubsubsection \word\ @end macro -@macro c_ {word} +@macro seealso +@noindent +@subsubheading See also + @end macro -@end ignore +@macro refcommands +@noindent +@subsubheading Predefined commands +@end macro -@ifhtml -@macro internalsref{NAME} -@uref{../lilypond-internals/\NAME\.html,\NAME\} -@cindex \NAME\ +@macro context{NAME} +@vindex \NAME\ +@code{\NAME\}@c should use internalsref @end macro -@macro seeinternals{NAME} -See @internalsref{\NAME\} + +@macro refcommand{WHAT} +@vindex \WHAT\ +@code{\WHAT\} @end macro -@end ifhtml -@ifnothtml -@macro seeinternals{NAME} + +@macro commonprop +@noindent +@subsubheading Commonly tweaked properties + @end macro -@macro internalsref{NAME} -@cindex \NAME\ -\NAME\ + +@macro funindex {WORD} +@findex \WORD\ +@kindex \WORD\ @end macro -@end ifnothtml +