X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Documentation%2Fuser%2Fmacros.itexi;h=599a89727699a02d2ebe6e622d3db102c021ccf2;hb=9079cd048c47b4119b6a19e19667e75e1f323269;hp=c0000cc1790f6a1632d069c9fd99d716159092e9;hpb=d02fb0875e52111272553a47e657b6f58e136e22;p=lilypond.git
diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index c0000cc179..599a897276 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -1,159 +1,304 @@
-@c -*-texinfo-*-
+@c -*- coding: us-ascii; mode: texinfo; -*-
+@ignore
+ Translation of GIT committish: FILL-IN-HEAD-COMMITTISH
+ When revising a translation, copy the HEAD committish of the
+ version that you are working on. See TRANSLATION for details.
+@end ignore
-@c Reference GLOSsary
-@macro rglos {NAME}
+@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 warning{TEXT}
@ifhtml
-@c ugh: @ref assumes that external refs are split documents too
-@html
-\NAME\@c
-@end html
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
@end ifhtml
@ifnothtml
-\NAME\@c
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
@end ifnothtml
@end macro
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
+@end macro
+@end ifnotinfo
-@ifnottex
-@macro texisharp {word}
-#
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
@end macro
-@end ifnottex
+@end ifinfo
-@iftex
-@macro texisharp {word}
-@tex
-$\\sharp$%
-@end tex
+@macro smallspace
+@sp 1
@end macro
-@end iftex
-@ifnottex
-@macro texiflat {word}
-b
+
+@c **** Displaying images not generated by lilypond-book
+
+@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.
+
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
@end macro
-@end ifnottex
+@end ifnotinfo
-@iftex
-@macro texiflat {word}
-@tex
-$\\flat$%
-@end tex
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
@end macro
-@end iftex
+@end ifinfo
+@c **** Headings in a doc subsection ****
+
+@macro predefined
+@noindent
+@subsubheading Predefined commands
-@iftex
-@macro separate
-@c I want some space over here, not silly characters.
-@tex
-@end tex
@end macro
-@end iftex
-@c \heartsf was supposed to be filled?
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
-@c center*** is broken?
+@end macro
-@ifinfo
-@macro separate
+@macro seealso
+@noindent
+@subsubheading See also
-@quotation
-@end quotation
+@indent
@end macro
-@end ifinfo
-@ifhtml
-@macro separate
-@html
-
-@end html
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
+
@end macro
-@end ifhtml
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
+@end macro
+
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
+
+
+
+@c **** Links and references ****
+
+@c Definitions for references:
+@c @rglos
+@c @rlearning
+@c @ruser
+@c @rprogram
+@c @rsnippets
+@c @rinternals
-@c dup?
@ifhtml
-@macro internalsref{NAME}
-@uref{../lilypond-internals/\NAME\.html,\NAME\}@c
-@cindex \NAME\@c
+@c ***** HTML *****
+
+@ifset bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
+@end macro
+
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
+@end macro
+
+@end ifset
+
+
+@ifclear bigpage
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
+
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@macro inputfileref{DIR,NAME}
-@uref{../../../../\DIR\/out-www/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}@c
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
+@end ifclear
+
@end ifhtml
-@ifinfo
-@macro internalsref{NAME}
-@inforef{\NAME\,,lilypond-internals}@c
-@cindex \NAME\@c
+
+@ifdocbook
+@c ***** DOCBOOK-XML *****
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@end ifinfo
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
-@iftex
-@macro internalsref{NAME}@c
-@cindex \NAME\@c
-@code{\NAME\}@c
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@macro inputfileref{DIR,NAME}@c
-@file{\DIR\/\NAME\}@c
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
@end macro
-@end iftex
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
-@iftex
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@end ifdocbook
+
+
+@ifinfo
+@c **** INFO ****
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,music-glossary,Music Glossary}
@end macro
-@end iftex
-@ifnottex
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@end ifnottex
-@macro refbugs
-@noindent
-@heading Bugs
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@macro seealso
-@noindent
-@heading See also
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals,Internals Reference}
@end macro
-@macro refcommands
-@noindent
-@heading Predefined commands
+@end ifinfo
+
+@c **** TEX ****
+@iftex
+
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
-@c
-@c ARGGGHHHHH! I want
-@c @cindex @code{@backslash\WHAT\}
-@c how do I do that?
-@c --hwn
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
+@end macro
-@macro refcommand{WHAT}
-@cindex @code{\WHAT\}
-@code{\WHAT\},
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@macro syntax
-@noindent
-@heading Syntax
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
+@end macro
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
@end macro
+
+@end iftex
+