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 711ad408ece389ba732e92adddb610db601fc4b3..aff1155e74373a6045b365b6e7e2fa293e06a77d 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,141 +6,128 @@
     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 **** format-independant ****
-
-@c   regions of a doc subsection
-@macro refcommands
-@noindent
-@subsubheading Predefined commands
-
+@c to get decent quotes in `foo' and ``foo''
+@macro q{TEXT}
+@quoteleft{}\TEXT\@quoteright{}
 @end macro
 
-@macro commonprop
-@noindent
-@subsubheading Commonly tweaked properties
-
+@macro qq{TEXT}
+@quotedblleft{}\TEXT\@quotedblright{}
 @end macro
 
-@macro seealso
-@noindent
-@subsubheading See also
+@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 refbugs
-@noindent
-@subsubheading Bugs
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
+@end macro
+@end ifinfo
 
+@macro smallspace
+@sp 1
 @end macro
 
 
-@c  use inside the text
-@macro context{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}@c should use internalsref
-@end macro
+@c   **** Displaying images not generated by lilypond-book
 
-@macro refcommand{TEXT}
-@vindex \TEXT\
-@code{\TEXT\}
+@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 {TEXT}
-@findex \TEXT\
-@kindex \TEXT\
+@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 ***
+@c obsolete; being removed.
+@macro refcommands
+@noindent
+@subsubheading Predefined commands
 
-@c   Use inside the text
+@end macro
 
-@c to get decent quotes in `foo'
+@macro commonprop
+@noindent
+@c @subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
 
-@c I don't understand why this is necessary, but it is with 4.8. :/
-@ifnotdocbook
-@macro q{TEXT}
-@ifinfo
-`\TEXT\'
-@end ifinfo
-@iftex
-`\TEXT\'
-@end iftex
-@ifhtml
-@html
-‘\TEXT\’
-@end html
-@end ifhtml
 @end macro
-@end ifnotdocbook
 
-@ifdocbook
-@macro q{TEXT}
-@xml
-‘\TEXT\’
-@end xml
+@macro seealso
+@noindent
+@subsubheading See also
+
+@indent
 @end macro
-@end ifdocbook
 
+@macro refbugs
+@noindent
+@subsubheading Known issues and warnings
 
-@c to get decent quotes in ``foo''
-@c I don't understand why this is necessary, but it is with 4.8. :/
-@ifnotdocbook
-@macro qq{TEXT}
-@ifinfo
-``\TEXT\''
-@end ifinfo
-@iftex
-``\TEXT\''
-@end iftex
-@ifhtml
-@html
-“\TEXT\”
-@end html
-@end ifhtml
 @end macro
-@end ifnotdocbook
 
-@ifdocbook
-@macro qq{TEXT}
-@xml
-“\TEXT\”
-@end xml
-@end macro
-@end ifdocbook
 
+@macro funindex {TEXT}
+@findex \TEXT\
+@kindex \TEXT\
+@end macro
 
 
 
+@c   **** Links and references ****
 
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,TEXT}
+@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
@@ -151,14 +138,6 @@
 @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}
@@ -262,7 +241,7 @@
 
 @macro rglos{TEXT}
 @vindex \TEXT\
-@inforef{\TEXT\,,,music-glossary}
+@inforef{\TEXT\,,music-glossary}
 @end macro
 
 @macro rprogram{TEXT}
@@ -293,19 +272,22 @@
 
 @macro rglos {TEXT}
 @vindex \TEXT\
-@code{\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
 
 @macro ruser{TEXT}
-user manual, @internalsref{\TEXT\}
+notation reference, @ref{\TEXT\,,,lilypond}
+@c @internalsref{\TEXT\}
 @end macro
 
 @macro rlearning{TEXT}
-learning manual, @internalsref{\TEXT\}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@c @internalsref{\TEXT\}
 @end macro
 
 @end iftex