X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=9e595fd779ce64a3cd2a2971e3bedb63a5d1338f;hb=a23264aee8cab5acaa94cdc103f2497c3f042543;hp=9ef47bbbecc73a400d52e6bb9b241c1be4b3b89a;hpb=af51453530b95aee167fe02ee3f4cb0c8dcd1fe2;p=lilypond.git diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi index 9ef47bbbec..9e595fd779 100644 --- a/Documentation/user/macros.itexi +++ b/Documentation/user/macros.itexi @@ -1,52 +1,223 @@ +@c -*- coding: latin-1; mode: texinfo; -*- + +@tex +\input feta20.tex +\global\font\fetasixteen=feta16 +\gdef\fetafont{\fetasixteen} +\gdef\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 + + +@ifnottex + @macro texisharp {word} + # + @end macro + @macro texiflat {word} + b + @end macro +@end ifnottex + +@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 +@ifhtml +@html +→ +@end html +@end ifhtml @ifinfo -@macro rgrob {word} -@ref{ (lilypond-internals)\word\, \word\ }, +--> +@end ifinfo +@end macro + + + +@c dup? +@ifhtml + @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 @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 +@ref{\NAME\,,,lilypond-internals}@c +@c should we do this? +@findex \NAME\ @end macro -@macro reng {word} -@ref{ (lilypond-internals)Engraver \word\, \word\ }, + @c what is this? -- jcn + @macro hyphenatedinternalsref{NAME,NODENAME} + @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c + @c @inforef{\NODENAME\,,lilypond-internals}@c + @c should we do this? + @c using @ref without punctuation is OK without for formats other than info + @ref{\NODENAME\,,\NAME\,lilypond-internals}@c + @findex \NAME\ + @end macro + + @macro inputfileref{DIR,NAME} + @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c + @end macro + +@end ifhtml + +@c dup? +@ifdocbook + + @c ***** DOCBOOK-XML ***** + + @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 hyphenatedinternalsref{NAME,NODENAME} + @c @uref{../lilypond-internals/\NODENAME\.html,\NAME\}@c + @inforef{\NODENAME\,,lilypond-internals}@c + @c should we do this? + @findex @code{\NAME\} + @end macro + + @macro inputfileref{DIR,NAME} + @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c + @end macro + +@end ifdocbook + +@ifinfo + +@c **** INFO **** +@macro internalsref{NAME} +@inforef{\NAME\,,lilypond/lilypond-internals}@c +@findex \NAME\@c @end macro + +@macro hyphenatedinternalsref{NAME,NODENAME} +@c FIXME: suspicious info file name? +@inforef{\NODENAME\,,lilypond-internals}@c +@c should we do this? +@findex @code{\NAME\} +@end macro + +@macro inputfileref{DIR,NAME} +@file{\DIR\/\NAME\} +@end macro + + +@macro usermanref{NAME} +@ref{\NAME\,,,lilypond/lilypond}@c +@end macro + @end ifinfo -@ifnotinfo -@macro rgrob {word} -@ref{ (lilypond-internals)\word\, \word\ } +@iftex +@c **** TEX **** + +@macro internalsref{NAME}@c +@findex \NAME\ @c +@code{\NAME\}@c +@end macro + +@macro inputfileref{DIR,NAME}@c +@file{\DIR\/\NAME\}@c +@end macro +@macro hyphenatedinternalsref{NAME,NODENAME} +@code{\NAME\}@c +@c should we do this? +@cindex @code{\NAME\} @c @end macro -@macro reng {word} -@ref{ (lilypond-internals)Engraver \word\, \word\ } + + +@macro seeinternals{NAME} +internals document, @internalsref{\NAME\} @end macro +@end iftex + +@c **** not TEX **** + +@ifnottex + @macro seeinternals{NAME} + @internalsref{\NAME\} + @end macro +@end ifnottex + +@ifnotinfo + @macro usermanref{NAME} + @ref{\NAME\}@c + @end macro @end ifnotinfo +@macro refbugs +@noindent +@subsubheading Bugs -@ignore +@end macro -@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. +@macro seealso +@noindent +@subsubheading See also -@macro c_ {word} -\word\ -@node \word\ -@section \word\ @end macro -@macro c__ {word} -\word\ -@node \word\ -@subsection \word\ +@macro refcommands +@noindent +@subsubheading Predefined commands + @end macro -@macro c___ {word} -\word\ -@node \word\ -@unnumberedsubsubsection \word\ +@macro context{NAME}@c +@code{\NAME\}@c should use internalsref +@findex \NAME\@c @end macro -@end ignore -@macro c_ {word} + + +@c +@c ARGGGHHHHH! I want +@c @cindex @code{@backslash\WHAT\} +@c how do I do that? +@c --hwn + +@macro refcommand{WHAT} +@findex \WHAT\ +@code{\WHAT\} @end macro