X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=142edd4405d62cd1c6219ec510aeb22af80244aa;hb=c69439a2389be2a111c22571081596d2b7341721;hp=1247acd3a0840546d9f69f8effabd6cc73615a9e;hpb=4a677f1e49cc2558bb925a7493221f751aef2d1c;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 1247acd3a0..142edd4405 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,30 +1,75 @@
 @c -*- coding: latin-1; mode: texinfo; -*-
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
+@c **** all formats ****
+
+@macro refbugs
+@noindent
+@subsubheading Bugs
+
+@end macro
+
+@macro moreinfo
+@subheading More information
+
+@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
+
+@macro funindex {WORD}
+@findex \WORD\
+@kindex \WORD\
+@end macro
+
+
+
+@c  *** Macros with variable output ***
+
+@c usage: @lsr{ancient,custodes.ly}
+@macro lsr{DIR,NAME}
+@ifhtml
+  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@end ifhtml
+@ifnothtml
+  @file{\DIR\/\NAME\}
+@end ifnothtml
+@end macro
+
+@macro lsrdir{DIR}
+@ifhtml
+  @uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@end ifhtml
+@ifnothtml
+  @file{\DIR\}
+@end ifnothtml
+@end macro
+
 
-@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{}
@@ -42,6 +87,11 @@
 @end macro
 
 
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
+
+
 @ifhtml
 @c ***** HTML *****
 
@@ -53,23 +103,75 @@
 @c @inforef{\NAME\,,lilypond-internals}@c
 @c using @ref without punctuation is OK without for formats other than info
 
-@macro internalsref{NAME}@c
-@c annoying parentheses stripped by add-html-footer.py
-@ref{\NAME\,,,lilypond-internals}@c
-@findex \NAME\
+@ifset bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals-big-page}
 @end macro
 
-@c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary-big-page}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program-big-page}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-big-page}
+@end macro
+
+@end ifset
+
+
+@ifclear bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
 
-@macro rglos{NAME}@c
-@c annoying parentheses stripped by add-html-footer.py
-@ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
 @end macro
- 
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@end macro
+
+@end ifclear
+
+
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+@html
+‘\TEXT\’
+@end html
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@html
+“\TEXT\”
+@end html
+@end macro
+
 @end ifhtml
 
 
@@ -77,17 +179,41 @@
 @c ***** DOCBOOK-XML *****
 
 @macro internalsref{NAME}
-@ref{\NAME\,,,lilypond-internals}@c
-@findex @code{\NAME\}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
 @end macro
- 
+
 @macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 @end macro
 
-@macro rglos{NAME}@c
-@ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@macro rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@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
@@ -97,21 +223,41 @@
 @c **** INFO ****
 
 @macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}@c
-@findex \NAME\@c
+@vindex \NAME\
+@inforef{\NAME\,,lilypond-internals}
 @end macro
 
 @macro inputfileref{DIR,NAME}
 @file{\DIR\/\NAME\}
 @end macro
 
-@macro rglos{NAME}@c
-@inforef{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@macro rglos{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,,music-glossary}
 @end macro
 
 @macro usermanref{NAME}
-@inforef{\NAME\,,lilypond}@c
+@inforef{\NAME\}
+@end macro
+
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
+@end macro
+
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
+@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
@@ -120,18 +266,18 @@
 @c **** TEX ****
 @iftex
 
-@macro internalsref{NAME}@c
-@findex \NAME\ @c
-@code{\NAME\}@c
+@macro internalsref{NAME}
+@vindex \NAME\
+@code{\NAME\}
 @end macro
 
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/@/\NAME\}@c
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/@/\NAME\}
 @end macro
 
 @macro rglos {NAME}
-@findex \NAME\ @c
-@code{\NAME\}@c
+@vindex \NAME\
+@code{\NAME\}
 @end macro
 
 @macro seeinternals{NAME}
@@ -142,8 +288,25 @@ internals document, @internalsref{\NAME\}
 user manual, @internalsref{\NAME\}
 @end macro
 
+@macro rprogram{NAME}
+program usage manual, @internalsref{\NAME\}
+@end macro
+
+@alias ruser=usermanref
+
+@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 iftex
 
+
 @ifnottex
 @c **** not TEX ****
 
@@ -153,37 +316,11 @@ user manual, @internalsref{\NAME\}
 
 @ifnotinfo
 @macro usermanref{NAME}
-@ref{\NAME\}@c
+@ref{\NAME\}
 @end macro
 @end ifnotinfo
 
 @end ifnottex
 
-@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}@c
-@code{\NAME\}@c should use internalsref
-@findex \NAME\@c
-@end macro
-
-@macro refcommand{WHAT}
-@findex \WHAT\
-@code{\WHAT\} 
-@end macro
 
+@c EOF