version that you are working on. See TRANSLATION for details.
@end ignore
-@c **** all formats ****
+@include version.itexi
-@macro refbugs
-@noindent
-@subsubheading Bugs
+@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
-@macro moreinfo
-@subheading More information
-
+@c to get decent quotes in `foo' and ``foo''
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
@end macro
-@macro seealso
-@noindent
-@subsubheading See also
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
+@ifhtml
+@macro warning{TEXT}
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
@end macro
+@end ifhtml
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
+@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
-@macro context{NAME}
-@vindex \NAME\
-@code{\NAME\}@c should use internalsref
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
@end macro
+@end ifinfo
-@macro refcommand{WHAT}
-@vindex \WHAT\
-@code{\WHAT\}
+@macro smallspace
+@sp 1
@end macro
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
+@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 ifnotinfo
-@macro funindex {WORD}
-@findex \WORD\
-@kindex \WORD\
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
@end macro
+@end ifinfo
+@c **** Headings in a doc subsection ****
-@c *** Macros with variable output ***
+@macro predefined
+@noindent
+@subsubheading Predefined commands
-@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
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
+
@end macro
+@macro seealso
+@noindent
+@subsubheading See also
+@indent
+@end macro
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
-@macro arrow{}
-@iftex
-@tex $\\Rightarrow$ @end tex@c
-@end iftex
-@ifhtml
-@html
-→
-@end html
-@end ifhtml
-@ifinfo
--->
-@end ifinfo
@end macro
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
-@c say @q{@value{backslash}} instead
-@set backslash \
+@end macro
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@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 **** 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
+
+@c ***** HTML + bigpage is a special case (other manual names), all other
+@c formats are treated similarly
+
+@ifnottex
@ifset bigpage
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals-big-page}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
@end macro
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary-big-page}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
@end macro
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program-big-page}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
@end macro
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-big-page}
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
@end macro
-@end ifset
-
-
-@ifclear bigpage
-
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
@end macro
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
@end macro
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
@end macro
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
@end macro
-@end ifclear
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
+@end macro
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets-big-page,Snippets}
+@end macro
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
@end macro
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@html
-“\TEXT\”
-@end html
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
@end macro
-@end ifhtml
+@end ifset
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@ifclear bigpage
-@macro internalsref{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-internals}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
-@macro inputfileref{DIR,NAME}
-@uref{source/\DIR\/collated-files.html#\NAME\,@file{\DIR\/\NAME\}}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
@end macro
-@macro rglos{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,music-glossary}
+@macro rlearning{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rlearningnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro ruser{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@xml
-‘\TEXT\’
-@end xml
+@macro rusernamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
@end macro
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@xml
-“\TEXT\”
-@end xml
+@macro rprogram{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@end ifdocbook
-
-
-@ifinfo
-@c **** INFO ****
-
-@macro internalsref{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,lilypond-internals}
-@end macro
-
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/\NAME\}
+@macro rprogramnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
@end macro
-@macro rglos{NAME}
-@vindex \NAME\
-@inforef{\NAME\,,,music-glossary}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
@end macro
-@macro usermanref{NAME}
-@inforef{\NAME\}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
@end macro
-@macro rprogram{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond-program}
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
@end macro
-@macro ruser{NAME}
-@vindex \NAME\
-@ref{\NAME\,,,lilypond}
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
@end macro
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
-@end macro
+@end ifclear
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
-@end macro
+@end ifnottex
-@end ifinfo
@c **** TEX ****
@iftex
-@macro internalsref{NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
-@macro inputfileref{DIR,NAME}
-@file{\DIR\/@/\NAME\}
+@macro rglosnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
@end macro
-@macro rglos {NAME}
-@vindex \NAME\
-@code{\NAME\}
+@macro rlearning{TEXT}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@macro seeinternals{NAME}
-internals document, @internalsref{\NAME\}
+@macro rlearningnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
@end macro
-@macro usermanref{NAME}
-user manual, @internalsref{\NAME\}
+@macro ruser{TEXT}
+@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
-@macro rprogram{NAME}
-program usage manual, @internalsref{\NAME\}
+@macro rusernamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
@end macro
-@alias ruser=usermanref
-
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-`\TEXT\'
+@macro rprogram{TEXT}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-``\TEXT\''
+@macro rprogramnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
@end macro
-@end iftex
-
-
-@ifnottex
-@c **** not TEX ****
-
-@macro seeinternals{NAME}
-@internalsref{\NAME\}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
@end macro
-@ifnotinfo
-@macro usermanref{NAME}
-@ref{\NAME\}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
@end macro
-@end ifnotinfo
-@end ifnottex
+@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
-@c EOF
+@end iftex
projects / lilypond.git / blobdiff