X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=68b52bb51368db7ea2bab262a7113c35c66a1276;hb=9b79b0f4972f7ac809cdaddaa7c01ea549a781b4;hp=ea010f304ff652415dd8439f0b430ddb782715c4;hpb=879eaa27daf32bb3dad69e92a3f94788e9d8f784;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index ea010f304f..68b52bb513 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,154 +1,204 @@ -@c -*-texinfo-*- - -@c Only reference in HTML. -@macro htmlref {NAME} -@ifhtml -@ref{\NAME\}@c -@end ifhtml -@ifnothtml -\NAME\@c -@end ifnothtml -@end macro - - - - -@c Reference GLOSsary -@macro rglos {NAME} -@ifhtml -@c ugh: @ref assumes that external refs are split documents too -@uref{../music-glossary.html#\NAME\,\NAME\}@c -@end ifhtml -@ifnothtml -\NAME\@c -@end ifnothtml -@end macro - +@c -*- coding: latin-1; mode: texinfo; -*- @ifnottex -@macro texisharp {word} -# -@end macro + @macro texisharp {word} + # + @end macro + @macro texiflat {word} + b + @end macro @end ifnottex +@c FIXME, use \fetaaccidentalsXMC? +@c \\kern0.15em\\fetachar\\fetaflat @iftex -@macro texisharp {word} -@tex -$\\sharp$% -@end tex -@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 texiflat {word} -b -@end macro -@end ifnottex +@macro arrow{} @iftex -@macro texiflat {word} -@tex -$\\flat$% -@end tex -@end macro +@tex $\\Rightarrow$ @end tex@c @end iftex - - - -@iftex -@macro separate -@c I want some space over here, not silly characters. -@tex -@end tex +@ifhtml +@html +→ +@end html +@end ifhtml +@ifinfo +--> +@end ifinfo @end macro -@end iftex -@c \heartsf was supposed to be filled? -@c center*** is broken? +@ifhtml +@c ***** HTML ***** -@ifinfo -@macro separate +@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 -@quotation -@end quotation +@c annoying parentheses stripped by add-html-footer.py +@macro internalsref{NAME} +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro -@end ifinfo -@ifhtml -@macro separate -@html -



-@end html +@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 + @end ifhtml -@c dup? -@ifhtml +@ifdocbook +@c ***** DOCBOOK-XML ***** + @macro internalsref{NAME} -@uref{../lilypond-internals/\NAME\.html,\NAME\} -@cindex \NAME\ +@vindex \NAME\ +@ref{\NAME\,,,lilypond-internals} @end macro @macro inputfileref{DIR,NAME} -@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} +@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}} @end macro -@end ifhtml +@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} -@cindex \NAME\ @end macro -@macro inputfileref{DIR,NAME}i +@macro inputfileref{DIR,NAME} @file{\DIR\/\NAME\} @end macro +@macro rglos{NAME}@c +@vindex \NAME\ +@inforef{\NAME\,,,music-glossary} +@end macro + +@macro usermanref{NAME} +@inforef{\NAME\} +@end macro + @end ifinfo + +@c **** TEX **** @iftex + @macro internalsref{NAME} -@cindex \NAME\ +@vindex \NAME\ @code{\NAME\} @end macro + @macro inputfileref{DIR,NAME} -@file{\DIR\/\NAME\} +@file{\DIR\/@/\NAME\} @end macro -@end iftex +@macro rglos {NAME} +@vindex \NAME\ +@code{\NAME\} +@end macro -@iftex @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 **** + @macro seeinternals{NAME} @internalsref{\NAME\} @end macro + +@ifnotinfo +@macro usermanref{NAME} +@ref{\NAME\} +@end macro +@end ifnotinfo + @end ifnottex + +@c **** ALL **** + @macro refbugs @noindent -@strong{Bugs} +@subsubheading Bugs -@noindent @end macro @macro seealso @noindent -@strong{See also} +@subsubheading See also -@noindent @end macro -@macro syntax +@macro refcommands @noindent -@strong{Syntax} +@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 + +