Tcl Library Source Code

View Ticket
Login
Ticket UUID: 685345eb4d46207d089d2619616339a23298dd
Title: Idea for documentation index: By command name, map to module/package(s)
Type: RFE Version: 1.16
Submitter: aku Created on: 2014-12-11 19:58:03
Subsystem: (unused) Assigned To:
Priority: 5 Medium Severity: Minor
Status: Open Last Modified: 2015-01-06 10:51:58
Resolution: None Closed By: nobody
    Closed on:
Description:
Might be useful to extend doctools/dtp/dtplite to generate an index mapping from command names to the module/package defining it. In HTML it would link to the proper manpage.

Note that index should possibly have a page based on just the last name of the command, without the parent namespaces.

This might be a special form of keyword index.
Actually I am quite sure that it is.

This puts its implementation into the application layer, i.e. "dtplite" (and "sak localdoc").

The really interesting point is when it comes to overarching documentation for multiple packages and merging them. Not a bundle like Tcllib where the packages are all present at generation time. But a larger help system where packages are added/removed incrementally, requiring updates to such indices.
User Comments: hypnotoad added on 2015-01-06 10:51:58:
I'm on board. ;-)