|
From: | Graham Percival |
Subject: | Re: Manual index entry for variable |
Date: | Thu, 04 Jan 2007 10:55:09 -0800 |
User-agent: | Thunderbird 1.5.0.9 (Macintosh/20061207) |
Mats Bengtsson wrote:
Graham Percival wrote:Thanks for the suggestion! I've added three index entries for these terms, although not to 2.18 -- we do not put index entries pointing to the tutorial.Why not? Sometimes, the best description is in the Tutorial.
Good question. My initial motivation was that descriptions in the tutorial might gloss over some information to make it easier to explain, and that this wasn't appropriate for an index entry.
I don't remember if we have some index terms that point to several sections. If that's possible in texinfo (it's easy in LaTeX) then you could point both to the reference and the tutorial.
We do have multiple entries for terms.I suppose that as long as a user noticed that he was reading the tutorial description of a term, there's no harm (especially if the index entry also pointed to the real notation manual description). I'm still not convinced that this is a good idea in general, but if I find some specific instance in which the tutorial has a better description than the notation manual, I'll add the index.
... of course, since we have 49 @cindex entries in the tutorial as it is, I don't really have much of an argument here. :|
Cheers, - Graham
[Prev in Thread] | Current Thread | [Next in Thread] |