[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: Doc indexing confusion
From: |
Graham Percival |
Subject: |
Re: Doc indexing confusion |
Date: |
Tue, 21 Dec 2010 16:07:09 +0000 |
User-agent: |
Mutt/1.5.20 (2009-06-14) |
On Mon, Dec 20, 2010 at 09:12:11PM -0800, Mark Polesky wrote:
> In texinfo:
> @cindex foo -- add foo to the concept index
We use this one.
I think Trevor pretty much explained this stuff. I have a fever
so I'm thinking straight and I might have missed something below.
> @findex foo -- add foo to the function index
> @kindex foo -- add foo to the keystroke index
> @printindex cp -- print the concept index
> @printindex fn -- print the function index
> @printindex ky -- print the keystroke index
We don't use these directly.
> In Documentation/common-macros.itexi, @funindex is defined:
> @macro funindex {TEXT}
> @findex \TEXT\
> @kindex \TEXT\
> @c
> @end macro
Yes.
> The last two appendices of the NR are:
> E. LilyPond command index
> F. LilyPond index
>
> In Documentation/notation.tely:
> @printindex ky -- makes appendix E. "command index"
> @printindex cp -- makes appendix F. "index"
>
> Questions:
> 1) Everything marked with a @funindex in the docs ends up in
> *both* NR indices. How and why do these items end up in
> appendix F?
Because @funindex calls both @findex and @kindex, and we merge a
copy of @findex with @kindex.
> 2) Why do we need @funindex? Why don't we just use these:
> @findex
> @printindex fn
Because then anything in appendix E won't appear in appendix F,
and (at some point in our past) there was a feeling that commands
should be printed in both indices.
> I see that @findex is used in the IR to generate
> appendix A.2 Function index
>
> ...but that shouldn't affect the NR, right?
Correct.
Cheers,
- Graham