Change Info docs setup and clean up Documentation/user/GNUmakefile

[lilypond.git] / Documentation / user / macros.itexi

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 5ef01312bb9448d4967607d49121cabf38379cef..aff1155e74373a6045b365b6e7e2fa293e06a77d 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,14 +6,71 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+@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
+
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
+@end macro
+
+@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
+
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
+
+@macro smallspace
+@sp 1
+@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 **** format-independant ****
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@end macro
+@end ifnotinfo
 
-@c   regions of a doc subsection
+@ifinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{lilypond/\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
+@end macro
+@end ifinfo
+
+
+@c   **** Headings in a doc subsection ****
+
+@c obsolete; being removed.
 @macro refcommands
 @noindent
 @subsubheading Predefined commands
@@ -22,7 +79,8 @@
 
 @macro commonprop
 @noindent
-@subsubheading Commonly tweaked properties
+@c @subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
 
 @end macro
 
@@ -30,26 +88,16 @@
 @noindent
 @subsubheading See also
 
+@indent
 @end macro
 
 @macro refbugs
 @noindent
-@subsubheading Bugs
+@subsubheading Known issues and warnings
 
 @end macro
 
 
-@c  use inside the text
-@macro context{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}@c should use internalsref
-@end macro
-
-@macro refcommand{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}
-@end macro
-
 @macro funindex {TEXT}
 @findex \TEXT\
 @kindex \TEXT\
@@ -57,92 +105,39 @@
 
 
 
-@c  *** Macros with variable output ***
-
-@c   Use inside the text
+@c   **** Links and references ****
 
-@c to get decent quotes in `foo'
-@macro q{TEXT}
-@ifinfo
-`\TEXT\'
-@end ifinfo
-@iftex
-`\TEXT\'
-@end iftex
+@c usage: @lsr{ancient,Ancient-notation,custodes.ly}
+@macro lsr{SECTION,DIR,TEXT}
 @ifhtml
-@html
-‘\TEXT\’
-@end html
-@end ifhtml
-@ignore
-@ifdocbook
-@xml
-‘\TEXT\’
-@end xml
-@end docbook
-@end ignore
-@end macro
-
-
-@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
-
-
-
-
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{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}
@@ -246,15 +241,7 @@
 
 @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}
@@ -285,49 +272,25 @@
 
 @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}
+@c @internalsref{\TEXT\}
 @end macro
 
-@alias ruser=usermanref
-@alias rlearning=learningref
-
-@end iftex
-
-
-@ifnottex
-@c **** not TEX ****
-
-@macro seeinternals{TEXT}
-@internalsref{\TEXT\}
-@end macro
-
-@ifnotinfo
-@macro usermanref{TEXT}
-@ref{\TEXT\}
+@macro ruser{TEXT}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
 @end macro
 
-@macro learningref{TEXT}
-@ref{\TEXT\}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
 @end macro
-@end ifnotinfo
 
-@end ifnottex
+@end iftex
 
 
 @c EOF