Change Snippets compilation

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

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index b5c761e530b15dfa55dbe19ffa211daa5876d103..4ef3123bfdbed271a2cd015e2b581f5ef4a555c9 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -6,6 +6,9 @@
     version that you are working on.  See TRANSLATION for details.
 @end ignore
 
+@macro version
+@value{version}
+@end macro
 
 @c   ***** Displaying text *****
 
@@ -14,72 +17,72 @@
 @set backslash \
 
 @c to get decent quotes in `foo' and ``foo''
-@c  these need to be split up so that "@qq{foo}." looks nice.  :(
-@iftex
 @macro q{TEXT}
-`\TEXT\'
+@quoteleft{}\TEXT\@quoteright{}
 @end macro
 
 @macro qq{TEXT}
-``\TEXT\''
+@quotedblleft{}\TEXT\@quotedblright{}
 @end macro
-@end iftex
 
+@macro warning{TEXT}
+@quotation
+@quotation
+@cartouche
+@b{Note:} \TEXT\
+@end cartouche
+@end quotation
+@end quotation
+@end macro
 
-@ifinfo
-@macro q{TEXT}
-`\TEXT\'
+@ifnotinfo
+@macro notation{TEXT}
+@var{\TEXT\}
 @end macro
+@end ifnotinfo
 
-@macro qq{TEXT}
-``\TEXT\''
+@ifinfo
+@macro notation{TEXT}
+\TEXT\
 @end macro
 @end ifinfo
 
-
-@ifhtml
-@macro q{TEXT}
-@html
-‘\TEXT\’
-@end html
+@macro smallspace
+@sp 1
 @end macro
 
-@macro qq{TEXT}
-@html
-“\TEXT\”
-@end html
-@end macro
-@end ifhtml
 
+@c   **** Displaying images not generated by lilypond-book
 
-@ifdocbook
-@macro q{TEXT}
-@xml
-‘\TEXT\’
-@end xml
-@end macro
+@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.
 
-@macro qq{TEXT}
-@xml
-“\TEXT\”
-@end xml
+@ifnotinfo
+@macro sourceimage{FILENAME,WIDTH,HEIGHT,ALTTEXT}
+@image{\FILENAME\,\WIDTH\,\HEIGHT\,\ALTTEXT\}
 @end macro
-@end ifdocbook
-
+@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 refcommands
+@macro predefined
 @noindent
 @subsubheading Predefined commands
 
 @end macro
 
-@macro commonprop
+@macro snippets
 @noindent
-@subsubheading Commonly tweaked properties
+@subsubheading Selected Snippets
 
 @end macro
 
@@ -87,25 +90,15 @@
 @noindent
 @subsubheading See also
 
+@indent
 @end macro
 
-@macro refbugs
+@macro knownissues
 @noindent
-@subsubheading Bugs
+@subsubheading Known issues and warnings
 
 @end macro
 
-
-@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\
@@ -115,28 +108,28 @@
 
 @c   **** Links and references ****
 
-@c usage: @lsr{ancient,custodes.ly}
-@macro lsr{DIR,TEXT}
+@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
@@ -147,14 +140,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}
@@ -182,6 +167,10 @@
 @ref{\TEXT\,,,lilypond-learning-big-page}
 @end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets-big-page}
+@end macro
+
 @end ifset
 
 
@@ -212,6 +201,10 @@
 @ref{\TEXT\,,,lilypond-learning}
 @end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
 @end ifclear
 
 @end ifhtml
@@ -245,6 +238,10 @@
 @ref{\TEXT\,,,lilypond-learning}
 @end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
 @end ifdocbook
 
 
@@ -276,6 +273,10 @@
 @ref{\TEXT\,,,lilypond-learning}
 @end macro
 
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
+@end macro
+
 @end ifinfo
 
 
@@ -289,19 +290,23 @@
 
 @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}
 @end macro
 
 @macro ruser{TEXT}
-user manual, @internalsref{\TEXT\}
+notation reference, @ref{\TEXT\,,,lilypond}
 @end macro
 
 @macro rlearning{TEXT}
-learning manual, @internalsref{\TEXT\}
+learning manual, @ref{\TEXT\,,,lilypond-learning}
+@end macro
+
+@macro rlsr{TEXT}
+@ref{\TEXT\,,,lilypond-snippets}
 @end macro
 
 @end iftex