[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Akim Demaille <address@hidden>] 39-doc-index.patch
From: |
Akim Demaille |
Subject: |
Re: [Akim Demaille <address@hidden>] 39-doc-index.patch |
Date: |
20 Aug 2001 20:17:02 +0200 |
User-agent: |
Gnus/5.0808 (Gnus v5.8.8) XEmacs/21.4 (Artificial Intelligence) |
>>>>> "Eli" == Eli Zaretskii <address@hidden> writes:
>> From: Akim Demaille <address@hidden> Date: 20 Aug 2001 17:24:49
>> +0200
>>
>> This is just for your information. I'm not willing to enter any
>> kind of debate. FYI, we did lose some time to understand why the
>> indexes were no longer working.
Eli> You mean, that the node name of an index must include "Index"
Eli> somewhere in it? Yes, that's a nasty gotcha ;-)
Eli> Karl, I'd suggest to add to the manual a special section (under
Eli> the "Indices" chapter) which explains how to write an Index
Eli> appendix. Right now, it seems that "Indices" explains everything
Eli> except this aspect.
Yep, I really thought browser would find that by themselves :( In the
printed documentation I'm very happy with `Index' in the title, but
for nodes, I'm looking for short sentences, and I especially rely on
the menu to clarify things when there are doubts. In the case of the
patch I presented, I really prefer `-' over `+' as for readability.
-* Environment Variables:: Index of environment variables used
-* Output Variables:: Index of variables set in output files
-* Preprocessor Symbols:: Index of C preprocessor symbols defined
-* Autoconf Macros:: Index of Autoconf macros
-* M4 Macros:: Index of M4, M4sugar, and M4sh macros
-* Autotest Macros:: Index of Autotest macros
-* Programs and Functions:: Index of those with portability problems
+* Environment Variable Index:: Index of environment variables used
+* Output Variable Index:: Index of variables set in output files
+* Preprocessor Symbol Index:: Index of C preprocessor symbols defined
+* Autoconf Macro Index:: Index of Autoconf macros
+* M4 Macro Index:: Index of M4, M4sugar, and M4sh macros
+* Autotest Macro Index:: Index of Autotest macros
+* Program & Function Index:: Index of those with portability problems
With `+', that makes quite many occurrences of `Index'.