Hi,

I wanted to get an overview of the Automake manual. I did "make html"
(since I prefer to view doc in HTML format), and found myself confused:

  - The doc starts with a list of chapters. Fine, but not detailed enough
    (I was searching for stuff about shared libraries).
  - Then comes a detailed list of nodes. Not useful, because it's a
    flattened list, that is 1. the hierarchy level is not visible,
    2. chapters without subsections don't appear in this list.
  - There is no chapter called "Table of Contents".
  - After looking for @contents in the .texi file, I found that the table
    of contents exists but is hidden in the "General Index" HTML page
    <http://www.gnu.org/software/automake/manual/html_node/General-Index.html>.

The Autoconf manual
<http://www.gnu.org/software/autoconf/manual/html_node/index.html> does it
nicely: It puts a hierarchical table of contents at the beginning. Here is
a suggestion to do the same in the Automake manual.


2010-08-15  Bruno Haible  <br...@clisp.org>

        Don't hide the table of contents.
        * doc/automake.texi: Move the table of contents to the beginning.

--- doc/automake.texi.orig      Sun Aug 15 16:31:08 2010
+++ doc/automake.texi   Sun Aug 15 16:28:59 2010
@@ -63,6 +63,7 @@
 @insertcopying
 @end titlepage
 
+...@contents
 
 @c We use the following macros to define indices:
 @c   @cindex   concepts, and anything that does not fit elsewhere
@@ -12887,8 +12888,6 @@
 @printindex cp
 
 
-...@page
-...@contents
 @bye
 
 @c  LocalWords:  texinfo setfilename settitle setchapternewpage texi direntry

Reply via email to