X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=a00f9c07ffb9f0760351871c17a90b4c36852798;hb=7f9ae4e126b6b0a1ac64b1441712bf59442918d7;hp=840d118de06b4ded5b20d605015f93ca26d75600;hpb=8e3b700d5b1a4227e655bdf8cf3aee4013b416cb;p=lilypond.git

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 840d118de0..a00f9c07ff 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,189 +1,325 @@
-@c -*- coding: latin-1; mode: texinfo; -*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+    Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
 
-@ifnottex
-  @macro texisharp {word}
-  #
-  @end macro
-  @macro texiflat {word}
-  b
-  @end macro
-@end ifnottex
+    When revising a translation, copy the HEAD committish of the
+    version that you are working on.  See TRANSLATION for details.
+@end ignore
 
-@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
+@include version.itexi
 
+@c   ***** Displaying text *****
+
+@c we need this since @q{\} doesn't work with makeinfo 4.11 --
+@c say @q{@bs{}} instead
+@macro bs
+\\
+@end macro
+
+@c to get decent quotes in `foo' and ``foo''
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
+@end macro
+
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
 
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
 @ifhtml
-@html
-→
-@end html
+@macro warning{TEXT}
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end macro
 @end ifhtml
+
+@ifnothtml
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
+@end ifnothtml
+
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
+
 @ifinfo
--->
+@macro notation{TEXT}
+\TEXT\
+@end macro
 @end ifinfo
+
+@macro smallspace
+@sp 1
 @end macro
 
 
-@ifhtml
-@c ***** HTML *****
+@c   **** Displaying images not generated by lilypond-book
 
-@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 current installation setup of Info docs requires that all images are
+@c expected to be found in lilypond/ subdirectory.  lilypond-book already
+@c generates proper @image commands for images of music; these macros
+@c definitions do the same for other images.
 
-@macro internalsref{NAME}@c
-@c annoying parentheses stripped by add-html-footer.py
-@ref{\NAME\,,,lilypond-internals}@c
-@findex \NAME\
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifnotinfo
 
-@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
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
+@end ifinfo
+
+
+@c   **** Headings in a doc subsection ****
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
 
-@macro rglos{NAME}@c
-@c annoying parentheses stripped by add-html-footer.py
-@ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
 @end macro
- 
-@end ifhtml
 
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+
+@end macro
+
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
+@end macro
 
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
 
-@macro internalsref{NAME}
-@ref{\NAME\,,,lilypond-internals}@c
-@findex @code{\NAME\}
 @end macro
- 
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
 @end macro
 
-@macro rglos{NAME}@c
-@ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
 @end macro
 
-@end ifdocbook
 
 
-@ifinfo
-@c **** INFO ****
+@c   **** Links and references ****
+
+@c  Definitions for references:
+@c     @rglos
+@c     @rlearning
+@c     @ruser
+@c     @rprogram
+@c     @rlsr
+@c     @rinternals
+@c  all these also have a @...named version, which allows to specify the
+@c  displayed text for the reference as second argument
 
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}@c
-@findex \NAME\@c
+@c ***** HTML + bigpage is a special case (other manual names), all other
+@c formats are treated similarly
+
+@ifnottex
+
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 @end macro
 
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
 @end macro
 
-@macro rglos{NAME}@c
-@inforef{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 @end macro
 
-@macro usermanref{NAME}
-@inforef{\NAME\}@c
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
 @end macro
 
-@end ifinfo
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
+@end macro
 
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
+@end macro
 
-@c **** TEX ****
-@iftex
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@end macro
 
-@macro internalsref{NAME}@c
-@findex \NAME\ @c
-@code{\NAME\}@c
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
 @end macro
 
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/@/\NAME\}@c
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 @end macro
 
-@macro rglos {NAME}
-@findex \NAME\ @c
-@code{\NAME\}@c
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
 @end macro
 
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 @end macro
 
-@macro usermanref{NAME}
-user manual, @internalsref{\NAME\}
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
 @end macro
 
-@end iftex
+@end ifset
 
-@ifnottex
-@c **** not TEX ****
 
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}@c
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
-@end ifnotinfo
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end ifclear
 
 @end ifnottex
 
-@macro refbugs
-@noindent
-@subsubheading Bugs
 
+
+@c **** TEX ****
+@iftex
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
+@end macro
 
+@macro rlearning{TEXT}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@macro rlearningnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
 
+@macro rusernamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
 @end macro
 
-@macro context{NAME}@c
-@code{\NAME\}@c should use internalsref
-@findex \NAME\@c
+@macro rprogram{TEXT}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
-@macro refcommand{WHAT}
-@findex \WHAT\
-@code{\WHAT\} 
+@macro rprogramnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
 @end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
+@end macro
+
+@end iftex