]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
add \global to definitions for
[lilypond.git] / Documentation / user / macros.itexi
index e9b28b47498df94f1b5dee4b159fc23dc9b5d193..4cf09a6c6bc77ffe0fe57258bd920a9aceb349bf 100644 (file)
@@ -1,9 +1,19 @@
 @c -*-texinfo-*-
 
-@c Only reference in HTML.
-@macro htmlref {NAME}
+@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
-@ref{\NAME\}@c
+@c ugh: @ref assumes that external refs are split documents too
+@html
+<a style="text-decoration: none; color: inherit;" href="../music-glossary.html#\NAME\">\NAME\</a>@c
+@end html
 @end ifhtml
 @ifnothtml
 \NAME\@c
 @end macro
 
 
-@c Reference ENGraver description
 @ifnottex
-@macro reng {word}
-@ref{ (lilypond-internals)\word\, \word\ }
-
-@end macro
+  @macro texisharp {word}
+  #
+  @end macro
+  @macro texiflat {word}
+  b
+  @end macro
 @end ifnottex
 
 @iftex
-@macro reng {word}
-\word\
-@end macro
+ @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 Reference GROB description
-@ifnottex
-@macro rgrob {word}
-@ref{ (lilypond-internals)\word\, \word\ }
-
-@end macro
-@end ifnottex
-
+@macro arrow{}
 @iftex
-@macro rgrob {word}
-\word\
-@end macro
+@tex $\\Rightarrow$ @end tex@c
 @end iftex
+@ifhtml
+@html
+&rarr;
+@end html
+@end ifhtml
+@ifinfo
+-->
+@end ifinfo
+@end macro
 
 
-@c Reference INTernals document
-@ifnottex
-@macro rint {word}
-@ref{ (lilypond-internals)\word\, \word\ }
 
-@end macro
-@end ifnottex
+@c dup?
+@ifhtml
 
-@iftex
-@macro rint {word}
-\word\
+ @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? 
+@cindex @code{\NAME\}
+@end macro
+
+ @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
+ @cindex @code{\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? 
+ @cindex @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? 
+ @cindex @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
+@cindex \NAME\@c
 @end macro
-@end iftex
 
+@macro hyphenatedinternalsref{NAME,NODENAME}
+@c FIXME: suspicious info file name?
+@inforef{\NODENAME\,,lilypond-internals}@c
+@c should we do this? 
+@cindex @code{\NAME\}
+@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
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/\NAME\}
 @end macro
 
 
-@ifnottex
-@macro texisharp {word}
-#
+@macro usermanref{NAME}
+@ref{\NAME\,,,lilypond/lilypond}@c
 @end macro
-@end ifnottex
+
+@end ifinfo
 
 @iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+@c **** TEX ****
+
+@macro internalsref{NAME}@c
+@cindex @code{\NAME\} @c
+@code{\NAME\}@c
 @end macro
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@macro inputfileref{DIR,NAME}@c
+@file{\DIR\/\NAME\}@c
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@macro hyphenatedinternalsref{NAME,NODENAME}
+@code{\NAME\}@c
+@c should we do this? 
+@cindex @code{\NAME\} @c
 @end macro
-@end iftex
 
 
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
+@macro seeinternals{NAME}
+internals document,  @internalsref{\NAME\}
 @end macro
 @end iftex
 
-@c \heartsf was supposed to be filled?
+@c **** not TEX ****
 
-@c center*** is broken?
+@ifnottex
+ @macro seeinternals{NAME}
+ @internalsref{\NAME\}
+ @end macro
+@end ifnottex
 
-@ifinfo
-@macro separate
+@ifnotinfo
+ @macro usermanref{NAME}
+ @ref{\NAME\}@c
+ @end macro
+@end ifnotinfo
 
-@quotation
-@end quotation
-@end macro
-@end ifinfo
+@macro refbugs
+@noindent
+@subsubheading Bugs
 
-@ifhtml
-@macro separate
-@html
-<p></p><br><br>
-@end html
 @end macro
-@end ifhtml
 
+@macro seealso
+@noindent
+@subsubheading See also
 
-@c dup?
-@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}
-@cindex \NAME\
 @end macro
-@end ifhtml
 
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
+
 @end macro
-@end ifinfo
 
-@iftex
-@macro internalsref{NAME}
-@cindex \NAME\
-@code{\NAME\}
+@macro context{NAME}@c
+@code{\NAME\}@c should use internalsref
+@cindex \NAME\@c
 @end macro
-@end iftex
 
 
-@iftex
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
-@end macro
-@end iftex
 
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+
+@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
-@end ifnottex