Fix some bugs in the dynamic engraver and PostScript backend

[lilypond.git] / Documentation / user / macros.itexi

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 326a4d290f74748881ce3217f1438963a658c100..d19182bc2670af2ac6f5b6986afe6a5047c25c50 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,167 +1,204 @@
-@ifnottex
-@macro reng {word}
-@ref{ (lilypond-internals)\word\, \word\ }
+@c -*- coding: latin-1; mode: texinfo; -*-
 
-@end macro
+@ifnottex
+  @macro texisharp {word}
+  #
+  @end macro
+  @macro texiflat {word}
+  b
+  @end macro
 @end ifnottex
 
+@c FIXME, use \fetaaccidentalsXMC?
+@c \\kern0.15em\\fetachar\\fetaflat
 @iftex
-@macro reng {word}
-\word\
-@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 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
+→
+@end html
+@end ifhtml
+@ifinfo
+-->
+@end ifinfo
+@end macro
 
 
-@ifnottex
-@macro rint {word}
-@ref{ (lilypond-internals)\word\, \word\ }
-
-@end macro
-@end ifnottex
+@ifhtml
+@c ***** HTML *****
 
-@iftex
-@macro rint {word}
-\word\
-@end macro
-@end iftex
+@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
 
-@ifnottex
-@macro texisharp {word}
-#
+@c annoying parentheses stripped by add-html-footer.py
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end ifnottex
 
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$
-@end tex
+@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
-@end iftex
 
-@ifnottex
-@macro texiflat {word}
-b
+@c annoying parentheses stripped by add-html-footer.py
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
 @end macro
-@end ifnottex
 
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$
-@end tex
-@end macro
-@end iftex
+@end ifhtml
 
 
+@ifdocbook
+@c ***** DOCBOOK-XML *****
 
-@iftex
-@macro separate 
-@c I want some space over here,  not silly characters.
-@tex
-@end tex
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end iftex
-
-@c \heartsf was supposed to be filled?
-
-@c center*** is broken?
-
-@ifinfo
-@macro separate
 
-@quotation
-@end quotation
+@macro inputfileref{DIR,NAME}
+@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 @end macro
-@end ifinfo
 
-@ifhtml
-@macro separate
-@html
-<p></p><br><br>
-@end html
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
 @end macro
-@end ifhtml
 
-@ignore
+@end ifdocbook
 
-@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 c_ {word}
-\word\
-@node \word\
-@section \word\
-@end macro
+@ifinfo
+@c **** INFO ****
 
-@macro c__ {word}
-\word\
-@menu
-* \word\::                      
-@end menu
+@macro internalsref{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,lilypond-internals}
+@end macro
 
-@node \word\
-@subsection \word\
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/\NAME\}
 @end macro
 
-@macro c___ {word}
-\word\
-@node \word\
-@unnumberedsubsubsection \word\
+@macro rglos{NAME}@c
+@vindex \NAME\
+@inforef{\NAME\,,,music-glossary}
 @end macro
 
-@macro c_ {word}
+@macro usermanref{NAME}
+@inforef{\NAME\}
 @end macro
 
-@end ignore
+@end ifinfo
+
 
+@c **** TEX ****
+@iftex
 
-@ifhtml
 @macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}
-@cindex \NAME\
+@vindex \NAME\
+@code{\NAME\}
 @end macro
-@end ifhtml
 
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}
-@cindex \NAME\
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/@/\NAME\}
 @end macro
-@end ifinfo
 
-@iftex
-@macro internalsref{NAME}
-@cindex \NAME\
+@macro rglos {NAME}
+@vindex \NAME\
 @code{\NAME\}
 @end macro
-@end iftex
 
-
-@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
+@subsubheading Bugs
+
+@end macro
+
+@macro seealso
+@noindent
+@subsubheading See also
+
+@end macro
+
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
+
+@end macro
+
+@macro context{NAME}
+@vindex \NAME\
+@code{\NAME\}@c should use internalsref
+@end macro
+
+@macro refcommand{WHAT}
+@vindex \WHAT\
+@code{\WHAT\}
+@end macro
+
+@macro commonprop
+@noindent
+@subsubheading Commonly tweaked properties
+
+@end macro
+
+@c @macro funindex {WORD}
+@c @end macro
+@c @findex \WORD\
+@c @kindex \WORD\
+
+