Use doctitle header field of LSR snippets

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

diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 0e4eac5f1cdb55737ff9e9fca1279b1fbf45c1a9..0706c522395fb126c74c117f3516466b84c64461 100644 (file)
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -10,7 +10,7 @@
 
 @c   ***** Displaying text *****
 
-@c we need this since @q{\} doesn't work with makeinfo 4.8 --
+@c we need this since @q{\} doesn't work with makeinfo 4.11 --
 @c say @q{@bs{}} instead
 @macro bs
 \\
@@ -106,6 +106,11 @@
 
 @end macro
 
+@macro lydoctitle {TEXT}
+@emph{\TEXT\}
+
+@end macro
+
 @macro funindex {TEXT}
 @findex \TEXT\
 @kindex \TEXT\
@@ -115,17 +120,7 @@
 
 @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/lilypond-snippets/\DIR\.html#\TEXT\,@file{\SECTION\/\TEXT\}}
-@end ifhtml
-@ifnothtml
-@file{\SECTION\/\TEXT\}
-@end ifnothtml
-@end macro
-
+@c  TO BE DEPRECATED
 @c usage: @lsrdir{ancient,Ancient-notation}
 @macro lsrdir{SECTION,DIR}
 @ifhtml
@@ -138,30 +133,33 @@
 
 
 @c  Definitions for references:
-@c     @internalsref
 @c     @rglos
-@c     @rprogram
-@c     @ruser
 @c     @rlearning
+@c     @ruser
+@c     @rprogram
+@c     @rsnippets
+@c     @rinternals
 
 @ifhtml
 @c ***** HTML *****
 
 @ifset bigpage
 
+@c TO BE DEPRECATED
 @macro internalsref{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
 @end macro
 
+
 @macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary-big-page,Music Glossary}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
+@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
 @end macro
 
 @macro ruser{TEXT}
@@ -169,33 +167,40 @@
 @ref{\TEXT\,,,lilypond-big-page,Notation Reference}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning-big-page,Learning Manual}
+@ref{\TEXT\,,,lilypond-program-big-page,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
 @ref{\TEXT\,,,lilypond-snippets-big-page,Snippets}
 @end macro
 
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals-big-page,Internals Reference}
+@end macro
+
 @end ifset
 
 
 @ifclear bigpage
 
+@c  DEPRECATED
 @macro internalsref{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
+
 @macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Application Usage}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
 @macro ruser{TEXT}
@@ -203,15 +208,20 @@
 @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
 @end ifclear
 
 @end ifhtml
@@ -220,19 +230,22 @@
 @ifdocbook
 @c ***** DOCBOOK-XML *****
 
+@c  DEPRECATED
 @macro internalsref{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,lilypond-internals,Internals Reference}
 @end macro
 
+
+
 @macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Application Usage}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
 @macro ruser{TEXT}
@@ -240,34 +253,42 @@
 @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@ref{\TEXT\,,,lilypond-internals,Internals Reference}
+@end macro
+
 @end ifdocbook
 
 
 @ifinfo
 @c **** INFO ****
 
+@c DEPRECATED
 @macro internalsref{TEXT}
 @vindex \TEXT\
 @inforef{\TEXT\,,lilypond-internals,Internals Reference}
 @end macro
 
+
+
 @macro rglos{TEXT}
 @vindex \TEXT\
 @inforef{\TEXT\,,music-glossary,Music Glossary}
 @end macro
 
-@macro rprogram{TEXT}
+@macro rlearning{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-program,Application Usage}
+@ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
 @macro ruser{TEXT}
@@ -275,48 +296,59 @@
 @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro rlearning{TEXT}
+@macro rprogram{TEXT}
 @vindex \TEXT\
-@ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@inforef{\TEXT\,,lilypond-internals,Internals Reference}
+@end macro
+
 @end ifinfo
 
 
 @c **** TEX ****
 @iftex
 
+@c DEPRECATED
 @macro internalsref{TEXT}
 @vindex \TEXT\
 @code{\TEXT\}
 @end macro
 
-@macro rglos {TEXT}
+
+
+@macro rglos{TEXT}
 @vindex \TEXT\
 @ref{\TEXT\,,,music-glossary,Music Glossary}
 @end macro
 
-@macro rprogram{TEXT}
-program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
+@macro rlearning{TEXT}
+learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
 @end macro
 
 @macro ruser{TEXT}
 notation reference, @ref{\TEXT\,,,lilypond,Notation Reference}
 @end macro
 
-@macro rlearning{TEXT}
-learning manual, @ref{\TEXT\,,,lilypond-learning,Learning Manual}
+@macro rprogram{TEXT}
+program usage manual, @ref{\TEXT\,,,lilypond-program,Application Usage}
 @end macro
 
 @macro rlsr{TEXT}
 @ref{\TEXT\,,,lilypond-snippets,Snippets}
 @end macro
 
-@end iftex
+@macro rinternals{TEXT}
+@vindex \TEXT\
+@code{\TEXT\}
+@end macro
 
+@end iftex
 
-@c EOF