]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
Fix some bugs in the dynamic engraver and PostScript backend
[lilypond.git] / Documentation / user / macros.itexi
index 5e18d7bcb7b8e9ee64b1758312105244abaa63ed..d19182bc2670af2ac6f5b6986afe6a5047c25c50 100644 (file)
-@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
-<p></p><br><br>
-@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 refcommands
 @noindent
-@strong{Predefined commands}
+@subsubheading Predefined commands
 
-@noindent
 @end macro
 
-
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
+@macro context{NAME}
+@vindex \NAME\
+@code{\NAME\}@c should use internalsref
+@end macro
 
 @macro refcommand{WHAT}
-@cindex @code{\WHAT\}
+@vindex \WHAT\
 @code{\WHAT\}
 @end macro
 
-@macro syntax
+@macro commonprop
 @noindent
-@strong{Syntax}
+@subsubheading Commonly tweaked properties
 
-@noindent
 @end macro
+
+@c @macro funindex {WORD}
+@c @end macro
+@c @findex \WORD\
+@c @kindex \WORD\
+
+