X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=4cf09a6c6bc77ffe0fe57258bd920a9aceb349bf;hb=e9c683d7eedcbc52d71682694a2ceb83bad07d75;hp=887837466f784a570c38da5d49e14fe4468be3f3;hpb=93b9f6c30cbeec39615b485f6c2f2a4dd50f5993;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 887837466f..df8844a428 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,186 +1,278 @@ -@c -*-texinfo-*- +@c -*- coding: us-ascii; mode: texinfo; -*- +@ignore + Translation of GIT committish: FILL-IN-HEAD-COMMITTISH -@tex -\input feta20.tex -\font\fetasixteen=feta16 -\def\fetafont{\fetasixteen} -\def\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 -@ifnottex - @macro texisharp {word} - # - @end macro - @macro texiflat {word} - b - @end macro -@end ifnottex +@macro warning{TEXT} +@quotation +@quotation +@cartouche +@b{Note:} \TEXT\ +@end cartouche +@end quotation +@end quotation +@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 +@c TODO: define different output for info +@macro notation{TEXT} +@var{\TEXT\} +@end macro -@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 dup? +@c Definitions for references: +@c @internalsref +@c @rglos +@c @rprogram +@c @ruser +@c @rlearning @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/\TEXT\.html,\TEXT\}@c +@c @inforef{} adds ``See'' to the sentence, which is annoying, but +@c better than a broken link. +@c @inforef{\TEXT\,,lilypond-internals}@c +@c using @ref without punctuation is OK without for formats other than info - @macro internalsref{NAME} - @uref{../lilypond-internals/\NAME\.html,\NAME\}@c - @c should we do this? - @cindex @code{\NAME\} - @end macro +@ifset bigpage - @macro hyphenatedinternalsref{NAME,NODENAME} - @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c - @c should we do this? - @cindex @code{\NAME\} - @end macro +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals-big-page} +@end macro - @macro inputfileref{DIR,NAME} - @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c - @end macro +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary-big-page} +@end macro -@end ifhtml +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program-big-page} +@end macro -@ifinfo +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-big-page} +@end macro -@c **** INFO **** -@macro internalsref{NAME} -@inforef{\NAME\,,lilypond/lilypond-internals}@c -@cindex \NAME\@c +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning-big-page} @end macro -@macro hyphenatedinternalsref{NAME,NODENAME} -@inforef{\NODENAME\,,lilypond-internals}@c -@c should we do this? -@cindex @code{\NAME\} +@end ifset + + +@ifclear bigpage + +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals} @end macro -@macro inputfileref{DIR,NAME} -@file{\DIR\/\NAME\} +@macro rglos{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,music-glossary} @end macro +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} +@end macro -@macro usermanref{NAME} -@ref{\NAME\,,,lilypond/lilypond}@c +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@end ifinfo +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} +@end macro -@iftex -@c **** TEX **** +@end ifclear -@macro internalsref{NAME}@c -@cindex @code{\NAME\} @c -@code{\NAME\}@c -@end macro +@end ifhtml + + +@ifdocbook +@c ***** DOCBOOK-XML ***** -@macro inputfileref{DIR,NAME}@c -@file{\DIR\/\NAME\}@c +@macro internalsref{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-internals} @end macro -@macro hyphenatedinternalsref{NAME,NODENAME} -@code{\NAME\}@c -@c should we do this? -@cindex @code{\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 ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} +@end macro -@macro seeinternals{NAME} -internals document, @internalsref{\NAME\} +@macro rlearning{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-learning} @end macro -@end iftex -@c **** not TEX **** +@end ifdocbook -@ifnottex - @macro seeinternals{NAME} - @internalsref{\NAME\} - @end macro -@end ifnottex -@ifnotinfo - @macro usermanref{NAME} - @ref{\NAME\}@c - @end macro -@end ifnotinfo +@ifinfo +@c **** INFO **** -@macro refbugs -@noindent -@subsubheading Bugs +@macro internalsref{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,lilypond-internals} +@end macro +@macro rglos{TEXT} +@vindex \TEXT\ +@inforef{\TEXT\,,music-glossary} @end macro -@macro seealso -@noindent -@subsubheading See also +@macro rprogram{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond-program} +@end macro +@macro ruser{TEXT} +@vindex \TEXT\ +@ref{\TEXT\,,,lilypond} @end macro -@macro refcommands -@noindent -@subsubheading Predefined commands +@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 -@macro context{NAME}@c -@code{\NAME\}@c should use internalsref -@cindex \NAME\@c +@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 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 -@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\}, -@end macro +@c EOF