Tcl Library Source Code

View Ticket
Login
Ticket UUID: 1800617
Title: doctools module toc: name vs. titledesc
Type: RFE Version: None
Submitter: sdeasey Created on: 2007-09-23 14:26:49
Subsystem: doctools Assigned To: andreas_kupries
Priority: 5 Medium Severity:
Status: Open Last Modified: 2007-09-23 14:26:49
Resolution: Closed By:
    Closed on:
Description:

dtplite can crate a two level TOC: one for each module and an overview.

Here's an example (only two modules):

  http://naviserver.sourceforge.net/n/toc.html
  http://naviserver.sourceforge.net/n/naviserver/toc.html

The first is a superset of the second, which is not very useful.


What would be great is if the second TOC in the example above (the per-module TOC) could use the 'titledesc' as a heading, and list each command in the page.

So, instead of this (current):

  ns_accesslog  Query and control access log parameters
  ns_atsignal   Server callbacks
  ns_cache      Cache manipulation
  ...

It would look like this:

  Query and control log parameters
  ns_accesslog

  Server callbacks
  ns_atprestartup, ns_atstartup, ns_atsignal, ns_atshutdown, ns_atexit

  Cache manipulation
  ns_cache_create, ns_cache_names, ns_cache_keys, ns_cache_eval, ns_cache_incr, ns_cache_append, ns_cache_lappend, ns_cache_flush, ns_cache_stats

  ...

Each 'titledesc' becomes an h2 heading. The commands are just a paragraph of words separated by commas, each a hyperlink to the command def (including fragment).


With this scheme, the per-module TOC falls somewhere in between the top level TOC and the keyword index in terms of information density.