X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=0274641da2e0b1e0f1d2244653c7f27ef3ae4632;hb=f9214bac21e9926dc3248416f58190c98c4167a9;hp=7d8699e0b8ee640da1639526403a598be186e0bf;hpb=9627516f833fcd89ce59351ae90dc722ec96a2c5;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 7d8699e0b8..0274641da2 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,95 +1,258 @@
+@c -*- coding: latin-1; mode: texinfo; -*-
+
+@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 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
+
+
+@macro arrow{}
+@iftex
+@tex $\\Rightarrow$ @end tex@c
+@end iftex
+@ifhtml
+@html
+→
+@end html
+@end ifhtml
 @ifinfo
-@macro reng {word}
-@ref{ (lilypond-internals)Engraver \word\, \word\ },
+-->
+@end ifinfo
+@end macro
+
+
+@ifhtml
+@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/\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
 
+@c annoying parentheses stripped by add-html-footer.py
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end ifinfo
 
-@ifnotinfo
-@macro reng {word}
-@ref{ (lilypond-internals)Engraver \word\, \word\ }
+@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
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@html
+‘\TEXT\’
+@end html
 @end macro
-@end ifnotinfo
 
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@html
+“\TEXT\”
+@end html
+@end macro
 
+@end ifhtml
 
-@iftex
-@macro separate
 
-@tex
-\\hbox to\\hsize{\\hfill\\vrule width1.4 cm height1.0pt\\hfill}
-@end tex
+@ifdocbook
+@c ***** DOCBOOK-XML *****
 
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
-@end iftex
 
-@c \heartsf was supposed to be filled?
+@macro inputfileref{DIR,NAME}
+@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@end macro
+
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@xml
+‘\TEXT\’
+@end xml
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@xml
+“\TEXT\”
+@end xml
+@end macro
+
+@end ifdocbook
 
-@c center*** is broken?
 
 @ifinfo
-@macro separate
-
-@quotation
-@quotation
-@quotation
-@quotation
-@quotation
-@quotation
-***
-@end quotation
-@end quotation
-@end quotation
-@end quotation
-@end quotation
-@end quotation
+@c **** INFO ****
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,lilypond-internals}
+@end macro
+
+@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
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
+@end macro
+
 @end ifinfo
 
-@ifhtml
-@macro separate
-@html
-<p></p><center>*<font size=+1>*</font>*</center><br>
-@end html
+
+@c **** TEX ****
+@iftex
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@code{\NAME\}
+@end macro
+
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/@/\NAME\}
+@end macro
+
+@macro rglos {NAME}
+@vindex \NAME\
+@code{\NAME\}
+@end macro
+
+@macro seeinternals{NAME}
+internals document, @internalsref{\NAME\}
+@end macro
+
+@macro usermanref{NAME}
+user manual, @internalsref{\NAME\}
+@end macro
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
-@end ifhtml
 
-@c netscape 4.x doesn't handle html chars 4.0 :-(
-@c <p></p><center>&hearts;</center><br>
-@c <p></p><center><font size=-1>*</font><font size=0>*</font><font size=-1>*</font></center><br>
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
+@end macro
+
+@end iftex
 
-@ignore
 
-@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.
+@ifnottex
+@c **** not TEX ****
 
-@macro c_ {word}
-\word\
-@node \word\
-@section \word\
+@macro seeinternals{NAME}
+@internalsref{\NAME\}
+@end macro
+
+@ifnotinfo
+@macro usermanref{NAME}
+@ref{\NAME\}
 @end macro
+@end ifnotinfo
+
+@end ifnottex
+
 
-@macro c__ {word}
-\word\
-@menu
-* \word\::                      
-@end menu
+@c **** ALL ****
+
+@macro refbugs
+@noindent
+@subsubheading Bugs
 
-@node \word\
-@subsection \word\
 @end macro
 
-@macro c___ {word}
-\word\
-@node \word\
-@unnumberedsubsubsection \word\
+@macro moreinfo
+@subheading More information
+
 @end macro
 
-@macro c_ {word}
+@macro seealso
+@noindent
+@subsubheading See also
+
 @end macro
 
-@end ignore
+@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
+
+@macro funindex {WORD}
+@findex \WORD\
+@kindex \WORD\
+@end macro
 
+@c EOF