This page is for discussion and planning of the Stackoverflow documentation. Stackoverflow Tcl Documentation
Even if you don't use Stackoverflow, please feel free to add your comments.
bll 2016-7-29: Stackoverflow has added a documentation section that be associated with a tag on Stackoverflow. It is organized as a series of topics with a multitude of examples within each topic. The examples can include both text and code.
There are also syntax, parameters and remarks sections. The remarks section is free-form, so anything can go there. The parameters section expects some particular format, so it doesn't seem to be useful. The syntax section expects a list of one-liners.
Make sure all topics and examples have links to the manual pages and cross reference links to other relevant stackoverflow documentation.
For manual page links, remove the version number from the link so that it points at the current version:
Before: http://tcl.tk/man/tcl8.6/TclCmd/lrepeat.htm
After: http://tcl.tk/man/tcl/TclCmd/lrepeat.htm
Stackoverflow Tcl Documentation
Tcl Documentation Chat room on Stackoverflow
bll 2016-7-29: Obviously we don't want to re-create the manual pages, but we can add discussion and examples of common usage, common questions and common problems.
At this time, there are five or six people who have signed up to work on the Stackoverflow documentation. Not enough people have signed up to start the Tk documentation on Stackoverflow.
It just got started so don't expect too much :-). The introduction topic sucks.
bll 2016-7-29: I don't know if it's better to put the links to manual pages in the topic level (remarks section), example level, or both.
Peter Lewerin 2016-07-30: alternative code suggestion for the Control Structures do command:
proc do {body keyword expression} {
uplevel 1 $body
switch $keyword {
while {tailcall while $expression $body}
until {tailcall while !($expression) $body}
default {
return -code error "unknown keyword \"$keyword\": must be until or while"
}
}
}