On 31.10.12 13:54, Stefan Sobernig wrote:
> I have noticed that some of the documentation files are being updated.
> By accident, I noticed that the ns_returnerror documentation is out of
> date, e.g., listing "ns_returnmoved" which is not available as a Tcl
> command:
i've added ns_returnmoved
>
> I haven't checked the others ... (leaving aside that documenting a
> command "ns_returnok" under "ns_returnerror" is not necessarily obvious).
the table of contents lists the sections, not commands. For
most commands, there is one section per command, so it looks
like a command reference. One might have noticed as well,
that the sections are sorted by their titles, which is as
well somewhat wierd.
The documentation is built with dtplite, which is in turn
built on top of tcl's doctools. The latter seem to support
command references, but not via dtplite. One can use cross
reverences ("see_also") and index entries ("keywords"). One
could add all commands as index entries, but this has the
bad effect, that if one clicks on the command in the
synopsis, the browser does not jump to the command
definition in the documentation page, but to the index. The
current markup is not consistent, what to put into keywords
or see_also, it requires more work.
i think, that adding a command reference would be a nice
addition, and is most likely possible with reasonable amount
of work. The other alternative would be to split up the
documentation pages with multiple commands into single pages...
any input/help is welcome
-gustaf neumann
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_sfd2d_oct
_______________________________________________
naviserver-devel mailing list
naviserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/naviserver-devel
