Tcl Source Code

This page is related to the TIP 700.

The starting point of the current HTML version of the manual pages for Tcl comes as one page listing all commands, variables, functions, etc. alphabetically (see here). Clicking any link, takes the reader to another page from where he cannot see this list anymore. To choose another page, the reader typically can click into the top of the page (containing some backlinks) and then looks for another link there.

The proposal for a new navigation structure is to have a better navigation. The left side of the manual page should have a navigation panel (there is plenty of room, the current HTML displays the lines much too long anyway). The content of the panel is a hierarchical list that possibly can be folded in/out. The right side of the page will then show the content of the clicked manual page.

Navigation structure

The current suggestion for the structure is below. It also contains the Tk manual pages as both should be accessible from the same navigation panel.

Upper-moste level

The upper-most level has the following headers:

• Tcl/Tk syntax (i.e. the Dodekalogue, currently on the "Tcl" man page)
• Tcl/Tk applications
• Tcl
• Tk
• ... other packages following here

The panel could also include some links to other documentation pages (such as http://tkdocs.com/) and to the Tcl homepage ("Tcl Developer Site"; https://www.tcl-lang.org).

Deeper navigations levels

The detailed hierarchical structure below the upper-most level would look like this (if can be wise to not make a deeper level when there is only one entry):

• Tcl/Tk syntax
  • Language syntax
• Tcl/Tk applications
  • tclsh application
  • wish application
• Tcl
  • Tcl commands
    • after
    • append
    • apply
    • ...
  • Tcl variables
    • argc
    • argv
    • ...
  • Tcl math functions
  • Tcl math operators
  • Tcl filename conventions ('filename' manual page)
  • Tcl C API
    • attemptckalloc
    • attemptckrealloc
    • ckalloc
    • ckfree
    • ckrealloc
    • Tcl_Access
    • Tcl_AddErrorInfo
    • ...
• Tk
  • Tk commands
    • bell
    • bind
    • bindtags
    • ...
  • Tk variables
    • tk_library
    • tk_patchLevel
    • ...
  • Tk widgets
    • button
    • canvas
    • entry
    • ...
  • ttk widgets
    • ttk::button
    • ttk::checkbutton
    • ...
  • Tk mouse cursors
  • Tk colors
  • Tk keysyms
  • Tk C API
    • Tk_3DBorderColor
    • Tk_3DBorderGC
    • Tk_3DHorizontalBevel
    • Tk_3DVerticalBevel
    • Tk_AddOption
    • ...