]> git.donarmstrong.com Git - lilypond.git/blobdiff - Documentation/user/macros.itexi
Merge branch 'master' of ssh://jomand@git.sv.gnu.org/srv/git/lilypond
[lilypond.git] / Documentation / user / macros.itexi
index 6b531fc814bb38b69a4936e956ae9133a7f9ded2..142edd4405d62cd1c6219ec510aeb22af80244aa 100644 (file)
@@ -1,47 +1,75 @@
-@c -*-texinfo-*-
+@c -*- coding: latin-1; mode: texinfo; -*-
 
-@tex
-\input feta20.tex
-\font\fetasixteen=feta16
-\def\fetafont{\fetasixteen}
-\def\fetachar#1{\hbox{\fetasixteen#1}}
-@end tex
+@c **** all formats ****
 
-@c Reference GLOSsary
-@macro rglos {NAME}
+@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
-@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
+  @uref{source/input/lsr/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
 @end ifhtml
 @ifnothtml
-\NAME\@c
+  @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
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
 
-@iftex
- @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
 
 
 @macro arrow{}
 @end macro
 
 
+@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c say @q{@value{backslash}} instead
+@set backslash \
 
-@c dup?
-@ifhtml
 
- @c ***** HTML *****
+@ifhtml
+@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 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\}
+
+@ifset bigpage
+
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals-big-page}
 @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 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 inputfileref{DIR,NAME}
- @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
- @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}
+@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
+&lsquo;\TEXT\&rsquo;
+@end html
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@html
+&ldquo;\TEXT\&rdquo;
+@end html
+@end macro
 
 @end ifhtml
 
-@c dup?
+
 @ifdocbook
+@c ***** DOCBOOK-XML *****
 
- @c ***** DOCBOOK-XML *****
+@macro internalsref{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-internals}
+@end macro
 
- @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 inputfileref{DIR,NAME}
+@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\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 rglos{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,music-glossary}
+@end macro
 
- @macro inputfileref{DIR,NAME}
- @uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
- @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
+&lsquo;\TEXT\&rsquo;
+@end xml
+@end macro
+
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+@xml
+&ldquo;\TEXT\&rdquo;
+@end xml
+@end macro
 
 @end ifdocbook
 
-@ifinfo
 
+@ifinfo
 @c **** INFO ****
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond/lilypond-internals}@c
-@cindex \NAME\@c
-@end macro
 
-@macro hyphenatedinternalsref{NAME,NODENAME}
-@c FIXME: suspicious info file name?
-@inforef{\NODENAME\,,lilypond-internals}@c
-@c should we do this? 
-@cindex @code{\NAME\}
+@macro internalsref{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,lilypond-internals}
 @end macro
 
 @macro inputfileref{DIR,NAME}
 @file{\DIR\/\NAME\}
 @end macro
 
+@macro rglos{NAME}
+@vindex \NAME\
+@inforef{\NAME\,,,music-glossary}
+@end macro
 
 @macro usermanref{NAME}
-@ref{\NAME\,,,lilypond/lilypond}@c
+@inforef{\NAME\}
 @end macro
 
-@end ifinfo
-
-@iftex
-@c **** TEX ****
-
-@macro internalsref{NAME}@c
-@cindex @code{\NAME\} @c
-@code{\NAME\}@c
+@macro rprogram{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond-program}
 @end macro
 
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/\NAME\}@c
+@macro ruser{NAME}
+@vindex \NAME\
+@ref{\NAME\,,,lilypond}
 @end macro
 
-@macro hyphenatedinternalsref{NAME,NODENAME}
-@code{\NAME\}@c
-@c should we do this? 
-@cindex @code{\NAME\} @c
+@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
 
-@macro seeinternals{NAME}
-internals document,  @internalsref{\NAME\}
-@end macro
-@end iftex
 
-@c **** not TEX ****
+@c **** TEX ****
+@iftex
 
-@ifnottex
- @macro seeinternals{NAME}
- @internalsref{\NAME\}
- @end macro
-@end ifnottex
+@macro internalsref{NAME}
+@vindex \NAME\
+@code{\NAME\}
+@end macro
 
-@ifnotinfo
- @macro usermanref{NAME}
- @ref{\NAME\}@c
- @end macro
-@end ifnotinfo
+@macro inputfileref{DIR,NAME}
+@file{\DIR\/@/\NAME\}
+@end macro
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@macro rglos {NAME}
+@vindex \NAME\
+@code{\NAME\}
+@end macro
 
+@macro seeinternals{NAME}
+internals document, @internalsref{\NAME\}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
+@macro usermanref{NAME}
+user manual, @internalsref{\NAME\}
+@end macro
 
+@macro rprogram{NAME}
+program usage manual, @internalsref{\NAME\}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@alias ruser=usermanref
 
+@c to get decent quotes in `foo'
+@macro q{TEXT}
+`\TEXT\'
 @end macro
 
-@macro context{NAME}@c
-@code{\NAME\}@c should use internalsref
-@cindex \NAME\@c
+@c to get decent quotes in ``foo''
+@macro qq{TEXT}
+``\TEXT\''
 @end macro
 
+@end iftex
 
 
+@ifnottex
+@c **** not TEX ****
 
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c   --hwn
+@macro seeinternals{NAME}
+@internalsref{\NAME\}
+@end macro
 
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\}, 
+@ifnotinfo
+@macro usermanref{NAME}
+@ref{\NAME\}
 @end macro
+@end ifnotinfo
+
+@end ifnottex
+
+
+@c EOF