X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=df8844a4287e9109bdd5531fff67504446dcacd1;hb=e9c683d7eedcbc52d71682694a2ceb83bad07d75;hp=d340e9c476f4c0dc25b64c7547e875578df2655b;hpb=5566dd413f7ff03ef927c9c137759c8c6d0c9b61;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index d340e9c476..df8844a428 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,195 +1,278 @@ -@c -*- coding: latin-1; mode: texinfo; -*- +@c -*- coding: us-ascii; mode: texinfo; -*- +@ignore + Translation of GIT committish: FILL-IN-HEAD-COMMITTISH -@tex -\input feta20.tex -\global\font\fetasixteen=feta16 -\gdef\fetafont{\fetasixteen} -\gdef\fetachar#1{\hbox{\fetasixteen#1}} -@end tex + When revising a translation, copy the HEAD committish of the + version that you are working on. See TRANSLATION for details. +@end ignore -@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 ***** Displaying text ***** + +@c we need this since @q{\} doesn't work with makeinfo 4.8 -- +@c say @q{@value{backslash}} instead +@set backslash \ + +@c to get decent quotes in `foo' and ``foo'' +@macro q{TEXT} +@quoteleft{}\TEXT\@quoteright{} +@end macro + +@macro qq{TEXT} +@quotedblleft{}\TEXT\@quotedblright{} @end macro +@macro warning{TEXT} +@quotation +@quotation +@cartouche +@b{Note:} \TEXT\ +@end cartouche +@end quotation +@end quotation +@end macro -@ifnottex - @macro texisharp {word} - # - @end macro - @macro texiflat {word} - b - @end macro -@end ifnottex +@c TODO: define different output for info +@macro notation{TEXT} +@var{\TEXT\} +@end macro -@iftex - @macro texiflat {word} - @tex - \\kern0.15em\\fetachar\\fetaflat - @end tex - @end macro - @macro texisharp {word} - @tex - \\raise0.5ex\\fetachar\\fetasharp - @end tex - @end macro -@end iftex -@macro arrow{} -@iftex -@tex $\\Rightarrow$ @end tex@c -@end iftex +@c **** Headings in a doc subsection **** + +@c not really a heading, but... +@macro smallspace +@sp 1 +@end macro + +@c obsolete; being removed. +@macro refcommands +@noindent +@subsubheading Predefined commands + +@end macro + +@macro commonprop +@noindent +@c @subsubheading Commonly tweaked properties +@subsubheading Selected Snippets + +@end macro + +@macro seealso +@noindent +@subsubheading See also + +@indent +@end macro + +@macro refbugs +@noindent +@subsubheading Known issues and warnings + +@end macro + + +@macro funindex {TEXT} +@findex \TEXT\ +@kindex \TEXT\ +@end macro + + + +@c **** Links and references **** + +@c usage: @lsr{ancient,Ancient-notation,custodes.ly} +@macro lsr{SECTION,DIR,TEXT} @ifhtml -@html -→ -@end html +@uref{source/input/lsr/snippets/\SECTION\.html#\TEXT\,@file{\DIR\/\TEXT\}} @end ifhtml -@ifinfo ---> -@end ifinfo +@ifnothtml +@file{\DIR\/\TEXT\} +@end ifnothtml +@end macro + +@macro lsrdir{DIR} +@ifhtml +@uref{source/input/lsr/snippets/\DIR\.html,\DIR\} +@end ifhtml +@ifnothtml +\DIR\ +@end ifnothtml @end macro +@c Definitions for references: +@c @internalsref +@c @rglos +@c @rprogram +@c @ruser +@c @rlearning -@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 +@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{\NAME\,,lilypond-internals}@c +@c @inforef{\TEXT\,,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 - - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@ifset bigpage -@end ifhtml +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals-big-page} +@end macro -@c dup? -@ifdocbook +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary-big-page} +@end macro - @c ***** DOCBOOK-XML ***** +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program-big-page} +@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 ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-big-page} +@end macro +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning-big-page} +@end macro - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@end ifset -@end ifdocbook -@ifinfo +@ifclear bigpage -@c **** INFO **** -@macro internalsref{NAME} -@inforef{\NAME\,,lilypond/lilypond-internals}@c -@findex \NAME\@c +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals} @end macro +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary} +@end macro -@macro inputfileref{DIR,NAME} -@file{\DIR\/\NAME\} +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} @end macro +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} +@end macro -@macro usermanref{NAME} -@ref{\NAME\,,,lilypond/lilypond}@c +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro -@end ifinfo +@end ifclear + +@end ifhtml -@iftex -@c **** TEX **** -@macro internalsref{NAME}@c -@findex \NAME\ @c -@code{\NAME\}@c +@ifdocbook +@c ***** DOCBOOK-XML ***** + +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals} @end macro -@macro inputfileref{DIR,NAME}@c -@file{\DIR\/@/\NAME\}@c +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary} @end macro +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} +@end macro -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@end iftex -@c **** not TEX **** +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} +@end macro -@ifnottex - @macro seeinternals{NAME} - @internalsref{\NAME\} - @end macro -@end ifnottex +@end ifdocbook -@ifnotinfo - @macro usermanref{NAME} - @ref{\NAME\}@c - @end macro -@end ifnotinfo -@macro refbugs -@noindent -@subsubheading Bugs +@ifinfo +@c **** INFO **** +@macro internalsref{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,lilypond-internals} @end macro -@macro seealso -@noindent -@subsubheading See also - +@macro rglos{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,music-glossary} @end macro -@macro refcommands -@noindent -@subsubheading Predefined commands +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} +@end macro +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@macro context{NAME}@c -@code{\NAME\}@c should use internalsref -@findex \NAME\@c +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro +@end ifinfo + +@c **** TEX **** +@iftex +@macro internalsref{TEXT} +@vindex \TEXT\ +@code{\TEXT\} +@end macro -@c -@c ARGGGHHHHH! I want -@c @cindex @code{@backslash\WHAT\} -@c how do I do that? -@c --hwn +@macro rglos {TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary} +@end macro + +@macro rprogram{TEXT} +program usage manual, @ref{\TEXT\,,,lilypond-program} +@c @internalsref{\TEXT\} +@end macro -@macro refcommand{WHAT} -@findex \WHAT\ -@code{\WHAT\} +@macro ruser{TEXT} +notation reference, @ref{\TEXT\,,,lilypond} +@c @internalsref{\TEXT\} @end macro + +@macro rlearning{TEXT} +learning manual, @ref{\TEXT\,,,lilypond-learning} +@c @internalsref{\TEXT\} +@end macro + +@end iftex + + +@c EOF