From: Graham Percival <graham@percival-music.ca>
Date: Sat, 20 May 2006 04:11:32 +0000 (+0000)
Subject: Update framework for command index.  DOC WRITERS: use @funindex instead
X-Git-Tag: release/2.9.6~22
X-Git-Url: https://git.donarmstrong.com/?a=commitdiff_plain;h=f47687228960b3930f851f1757828458a0991262;p=lilypond.git

Update framework for command index.  DOC WRITERS: use @funindex instead
of @cindex @code{}.
---

diff --git a/ChangeLog b/ChangeLog
index e5dacee8db..607445feb7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2006-05-19  Graham Percival  <gpermus@gmail.com>
+
+	* Documentation/user/README.txt, lilypond.tely, macros.itexi:
+	update framework for command index.  DOC WRITERS: use @funindex
+	instead of @cindex @code{}.
+
 2006-05-19  Han-Wen Nienhuys  <hanwen@lilypond.org>
 
 	* lily/beam.cc (set_stem_lengths): trigger 'beaming callback, in
diff --git a/Documentation/user/README.txt b/Documentation/user/README.txt
index 82d313bd30..48e01fa560 100644
--- a/Documentation/user/README.txt
+++ b/Documentation/user/README.txt
@@ -41,6 +41,10 @@ is writtin in formal technical writing style.
 GENERAL GUIDELINES
 
 * Do not forget to create @cindex entries for new sections of text.
+Enter commands with @funindex, i.e.
+@funindex \relative
+do not bother with the @code{} (they are added automatically).  These
+items are added to both the command index and the unified index.
 
 * The use of the word `illegal' is inappropriate in most cases.  Say
   `invalid' instead.
diff --git a/Documentation/user/lilypond.tely b/Documentation/user/lilypond.tely
index e736bee6c8..52ba59228b 100644
--- a/Documentation/user/lilypond.tely
+++ b/Documentation/user/lilypond.tely
@@ -50,16 +50,13 @@ This document is also available as a
 @end ifhtml
 
 
-@documentlanguage en
-@documentencoding utf-8
-
-@c FIXME: Index has two alphabetically sorted lists @code vs plain?
-@syncodeindex fn cp
+@c  This produces the unified index
 @syncodeindex ky cp
-@syncodeindex pg cp
-@syncodeindex tp cp
 @syncodeindex vr cp
 
+@documentlanguage en
+@documentencoding utf-8
+
 
 @finalout
 
@@ -166,6 +163,7 @@ Appendices
 * Example templates::              Ready-made templates.
 * Cheat sheet::                    Summary of LilyPond syntax.
 * GNU Free Documentation License:: License of this document.
+* LilyPond command index::
 * LilyPond index::
 @end menu
 @end ifnottex
@@ -202,6 +200,12 @@ Appendices
 @include cheatsheet.itely
 @include fdl.itexi
 
+
+@node LilyPond command index
+@appendix LilyPond command index
+
+@printindex fn
+
 @node LilyPond index
 @appendix LilyPond index
 
diff --git a/Documentation/user/macros.itexi b/Documentation/user/macros.itexi
index 8051ffcd69..4227b8572b 100644
--- a/Documentation/user/macros.itexi
+++ b/Documentation/user/macros.itexi
@@ -56,7 +56,7 @@
 @macro internalsref{NAME}@c
 @c annoying parentheses stripped by add-html-footer.py
 @ref{\NAME\,,,lilypond-internals}@c
-@findex \NAME\
+@vindex \NAME\
 @end macro
 
 @c usage: @inputfileref{input@/regression,FILE@/-NAME.ly}
@@ -67,7 +67,7 @@
 @macro rglos{NAME}@c
 @c annoying parentheses stripped by add-html-footer.py
 @ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@vindex \NAME\
 @end macro
 
 @end ifhtml
@@ -78,7 +78,7 @@
 
 @macro internalsref{NAME}
 @ref{\NAME\,,,lilypond-internals}@c
-@findex @code{\NAME\}
+@vindex @code{\NAME\}
 @end macro
 
 @macro inputfileref{DIR,NAME}
@@ -87,7 +87,7 @@
 
 @macro rglos{NAME}@c
 @ref{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@vindex \NAME\
 @end macro
 
 @end ifdocbook
@@ -98,7 +98,7 @@
 
 @macro internalsref{NAME}
 @inforef{\NAME\,,lilypond-internals}@c
-@findex \NAME\@c
+@vindex \NAME\@c
 @end macro
 
 @macro inputfileref{DIR,NAME}
@@ -107,7 +107,7 @@
 
 @macro rglos{NAME}@c
 @inforef{\NAME\,,,music-glossary}@c
-@findex \NAME\
+@vindex \NAME\
 @end macro
 
 @macro usermanref{NAME}
@@ -121,7 +121,7 @@
 @iftex
 
 @macro internalsref{NAME}@c
-@findex \NAME\ @c
+@vindex \NAME\ @c
 @code{\NAME\}@c
 @end macro
 
@@ -130,7 +130,7 @@
 @end macro
 
 @macro rglos {NAME}
-@findex \NAME\ @c
+@vindex \NAME\ @c
 @code{\NAME\}@c
 @end macro
 
@@ -159,6 +159,7 @@ user manual, @internalsref{\NAME\}
 
 @end ifnottex
 
+
 @macro refbugs
 @noindent
 @subsubheading Bugs
@@ -179,11 +180,11 @@ user manual, @internalsref{\NAME\}
 
 @macro context{NAME}@c
 @code{\NAME\}@c should use internalsref
-@findex \NAME\@c
+@vindex \NAME\@c
 @end macro
 
 @macro refcommand{WHAT}
-@findex \WHAT\
+@vindex \WHAT\
 @code{\WHAT\}
 @end macro
 
@@ -193,3 +194,9 @@ user manual, @internalsref{\NAME\}
 
 @end macro
 
+@macro funindex {WORD}
+@findex \WORD\
+@kindex \WORD\
+@end macro
+
+