version that you are working on. See TRANSLATION for details.
@end ignore
+@macro version
+@value{version}
+@end macro
+
+@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 to get decent quotes in `foo' and ``foo''
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
+@end macro
-@c **** format-independant ****
-
-@c regions of a doc subsection
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
-
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
@end macro
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
@end macro
+@end ifnotinfo
-@macro seealso
-@noindent
-@subsubheading See also
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
+@macro smallspace
+@sp 1
@end macro
-@macro refbugs
-@noindent
-@subsubheading Bugs
-@end macro
+@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.
-@c use inside the text
-@macro context{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}@c should use internalsref
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
@end macro
+@end ifnotinfo
-@macro refcommand{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
@end macro
+@end ifinfo
-@macro funindex {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
-@end macro
+@c **** Headings in a doc subsection ****
+@macro predefined
+@noindent
+@subsubheading Predefined commands
-@c *** Macros with variable output ***
+@end macro
-@c Use inside the text
+@macro snippets
+@noindent
+@subsubheading Selected Snippets
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@ifinfo
-`\TEXT\'
-@end ifinfo
-@iftex
-`\TEXT\'
-@end iftex
-@ifhtml
-@html
-‘\TEXT\’
-@end html
-@end ifhtml
-@ignore
-@ifdocbook
-@xml
-‘\TEXT\’
-@end xml
-@end docbook
-@end ignore
@end macro
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
+@end macro
+
+@macro knownissues
+@noindent
+@subsubheading Known issues and warnings
-@c to get decent quotes in ``foo''
-@macro qq{TEXT}
-@ifinfo
-``\TEXT\''
-@end ifinfo
-@iftex
-``\TEXT\''
-@end iftex
-@ifhtml
-@html
-“\TEXT\”
-@end html
-@end ifhtml
-@ignore
-@ifdocbook
-@xml
-“\TEXT\”
-@end xml
-@end docbook
-@end ignore
@end macro
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,TEXT}
+@c **** Links and references ****
+
+@c Possibly deprecated; under discussion.
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
@ifhtml
-@uref{source/input/lsr/\DIR\/collated-files.html#\TEXT\,@file{\DIR\/\TEXT\}}
+@uref{source/input/lsr/snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
@end ifhtml
@ifnothtml
-@file{\DIR\/\TEXT\}
+@file{\SECTION\/\TEXT\}
@end ifnothtml
@end macro
-@macro lsrdir{DIR}
+@c usage: @lsrdir{ancient,Ancient-notation}
+@macro lsrdir{SECTION,DIR}
@ifhtml
-@uref{source/input/lsr/\DIR\/collated-files.html,@file{\DIR\}/}
+@uref{source/input/lsr/snippets/\DIR\.html,\SECTION\}
@end ifhtml
@ifnothtml
-@file{\DIR\}
+\DIR\
@end ifnothtml
@end macro
-
-
+@c Definitions for references:
+@c @internalsref
+@c @rglos
+@c @rprogram
+@c @ruser
+@c @rlearning
@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/\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
-
@ifset bigpage
@macro internalsref{TEXT}
@ref{\TEXT\,,,lilypond-learning-big-page}
@end macro
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page}
+@end macro
+
@end ifset
@ref{\TEXT\,,,lilypond-learning}
@end macro
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
@end ifclear
@end ifhtml
@ref{\TEXT\,,,lilypond-learning}
@end macro
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
@end ifdocbook
@macro rglos{TEXT}
@vindex \TEXT\
-@inforef{\TEXT\,,,music-glossary}
-@end macro
-
-@macro usermanref{TEXT}
-@inforef{\TEXT\}
-@end macro
-
-@macro learningref{TEXT}
-@inforef{\TEXT\}
+@inforef{\TEXT\,,music-glossary}
@end macro
@macro rprogram{TEXT}
@ref{\TEXT\,,,lilypond-learning}
@end macro
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
@end ifinfo
@macro rglos {TEXT}
@vindex \TEXT\
-@code{\TEXT\}
-@end macro
-
-@macro seeinternals{TEXT}
-internals document, @internalsref{\TEXT\}
-@end macro
-
-@macro usermanref{TEXT}
-user manual, @internalsref{\TEXT\}
-@end macro
-
-@macro learningref{TEXT}
-learning manual, @internalsref{\TEXT\}
+@ref{\TEXT\,,,music-glossary}
@end macro
@macro rprogram{TEXT}
-program usage manual, @internalsref{\TEXT\}
+program usage manual, @ref{\TEXT\,,,lilypond-program}
@end macro
-@alias ruser=usermanref
-@alias rlearning=learningref
-
-@end iftex
-
-
-@ifnottex
-@c **** not TEX ****
-
-@macro seeinternals{TEXT}
-@internalsref{\TEXT\}
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
@end macro
-@ifnotinfo
-@macro usermanref{TEXT}
-@ref{\TEXT\}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
@end macro
-@macro learningref{TEXT}
-@ref{\TEXT\}
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
@end macro
-@end ifnotinfo
-@end ifnottex
+@end iftex
@c EOF
projects / lilypond.git / blobdiff