version that you are working on. See TRANSLATION for details.
@end ignore
+@include version.itexi
+
@c ***** Displaying text *****
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
-@c say @q{@value{backslash}} instead
-@set backslash \
+@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}
@quotedblleft{}\TEXT\@quotedblright{}
@end macro
+@ifhtml
+@macro warning{TEXT}
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end macro
+@end ifhtml
+
+@ifnothtml
@macro warning{TEXT}
@quotation
@quotation
@end quotation
@end quotation
@end macro
+@end ifnothtml
-@c TODO: define different output for info
+@ifnotinfo
@macro notation{TEXT}
@var{\TEXT\}
@end macro
+@end ifnotinfo
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
-
-@c **** Headings in a doc subsection ****
-
-@c not really a heading, but...
@macro smallspace
@sp 1
@end macro
-@c obsolete; being removed.
-@macro refcommands
+
+@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
+
+@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
@end macro
-@macro commonprop
+@macro snippets
@noindent
-@subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
@end macro
@noindent
@subsubheading See also
+@indent
@end macro
-@macro refbugs
+@macro knownissues
@noindent
@subsubheading Known issues and warnings
@end macro
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
+@end macro
@macro funindex {TEXT}
@findex \TEXT\
@c **** Links and references ****
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,TEXT}
-@ifhtml
-@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
-@end ifhtml
-@ifnothtml
-@file{\DIR\/\TEXT\}
-@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 Definitions for references:
-@c @internalsref
@c @rglos
-@c @rprogram
-@c @ruser
@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
-@ifhtml
-@c ***** HTML *****
+@c ***** HTML + bigpage is a special case (other manual names), all other
+@c formats are treated similarly
-@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/\TEXT\.html,\TEXT\}@c
-@c @inforef{} adds ``See'' to the sentence, which is annoying, but
-@c better than a broken link.
-@c @inforef{\TEXT\,,lilypond-internals}@c
-@c using @ref without punctuation is OK without for formats other than info
+@ifnottex
@ifset bigpage
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals-big-page}
+@ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
@end macro
-@macro rglos{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary-big-page}
+@ref{\TEXT\,,\DISPLAY\,music-glossary-big-page,Music Glossary}
@end macro
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page}
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
@end macro
-@macro ruser{TEXT}
+@macro rlearningnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-big-page}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning-big-page,Learning Manual}
@end macro
-@macro rlearning{TEXT}
+@macro ruser{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning-big-page}
+@ref{\TEXT\,,,lilypond-big-page,Notation Reference}
@end macro
-@end ifset
-
-
-@ifclear bigpage
-
-@macro internalsref{TEXT}
+@macro rusernamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals}
+@ref{\TEXT\,,\DISPLAY\,lilypond-big-page,Notation Reference}
@end macro
-@macro rglos{TEXT}
+@macro rprogram{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
@end macro
-@macro rprogram{TEXT}
+@macro rprogramnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program-big-page,Application Usage}
@end macro
-@macro ruser{TEXT}
+@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
+
+@macro rinternals{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
@end macro
-@macro rlearning{TEXT}
+@macro rinternalsnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals-big-page,Internals Reference}
@end macro
-@end ifclear
+@end ifset
-@end ifhtml
+@ifclear bigpage
-@ifdocbook
-@c ***** DOCBOOK-XML *****
+@macro rglos{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,music-glossary,Music Glossary}
+@end macro
-@macro internalsref{TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-internals}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
@end macro
-@macro rglos{TEXT}
+@macro rlearning{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
-@macro rprogram{TEXT}
+@macro rlearningnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
@end macro
@macro ruser{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
-@macro rlearning{TEXT}
+@macro rusernamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
@end macro
-@end ifdocbook
-
-
-@ifinfo
-@c **** INFO ****
-
-@macro internalsref{TEXT}
+@macro rprogram{TEXT}
@vindex \TEXT\
-@inforef{\TEXT\,,lilypond-internals}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
@end macro
-@macro rglos{TEXT}
+@macro rprogramnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@inforef{\TEXT\,,music-glossary}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
@end macro
-@macro rprogram{TEXT}
-@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets,Snippets}
@end macro
-@macro ruser{TEXT}
+@macro rlsrnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-snippets,Snippets}
+@end macro
+
+@macro rinternals{TEXT}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond}
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
@end macro
-@macro rlearning{TEXT}
+@macro rinternalsnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning}
+@ref{\TEXT\,,\DISPLAY\,lilypond-internals,Internals Reference}
@end macro
-@end ifinfo
+@end ifclear
+
+@end ifnottex
+
@c **** TEX ****
@iftex
-@macro internalsref{TEXT}
+@macro rglos{TEXT}
@vindex \TEXT\
-@code{\TEXT\}
+@ref{\TEXT\,,,music-glossary,Music Glossary}
@end macro
-@macro rglos {TEXT}
+@macro rglosnamed{TEXT,DISPLAY}
@vindex \TEXT\
-@ref{\TEXT\,,,music-glossary}
+@ref{\TEXT\,,\DISPLAY\,music-glossary,Music Glossary}
@end macro
-@macro rprogram{TEXT}
-program usage manual, @ref{\TEXT\,,,lilypond-program}
-@c @internalsref{\TEXT\}
+@macro rlearning{TEXT}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
+@end macro
+
+@macro rlearningnamed{TEXT,DISPLAY}
+learning manual, @ref{\TEXT\,,\DISPLAY\,lilypond-learning,Learning Manual}
@end macro
@macro ruser{TEXT}
-notation reference, @ref{\TEXT\,,,lilypond}
-@c @internalsref{\TEXT\}
+@ref{\TEXT\,,,lilypond,Notation Reference}
@end macro
-@macro rlearning{TEXT}
-learning manual, @ref{\TEXT\,,,lilypond-learning}
-@c @internalsref{\TEXT\}
+@macro rusernamed{TEXT,DISPLAY,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
@end macro
-@end iftex
+@macro rusernamed{TEXT,DISPLAY,DISPLAY}
+notation reference, @ref{\TEXT\,,\DISPLAY\,lilypond,Notation Reference}
+@end macro
+
+@macro rprogram{TEXT}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+@ref{\TEXT\,,\DISPLAY\,lilypond-program,Application Usage}
+@end macro
+
+@macro rprogramnamed{TEXT,DISPLAY}
+program usage manual, @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\
+@code{\TEXT\}
+@end macro
+@macro rinternalsnamed{TEXT,DISPLAY}
+@vindex \TEXT\
+@code{\DISPLAY\}
+@end macro
-@c EOF
+@end iftex
projects / lilypond.git / blobdiff