Prev: Regular expressions question
Next: Reading images on Excel worksheets with TCOM
From: vitic on 4 May 2008 13:35
Perhaps it would be a good idea to have two versions of TCL
documentation.

1. The official static one created by developers.
2. The wiki type documentation which is a copy of the official one
that also lets users add their comments, examples, workaround, bugs
etc. for each command.

That would lead to a more up to date and detailed documentation that's
created by many people, which will relieve the developers from this
time consuming task.


---Victor
From: Torsten Berg on 4 May 2008 14:46

> 1. The official static one created by developers.
> 2. The wiki type documentation which is a copy of the official one
> that also lets users add their comments, examples, workaround, bugs
> etc. for each command.
>
> That would lead to a more up to date and detailed documentation that's
> created by many people, which will relieve the developers from this
> time consuming task.

Hmm, I like that idea. It is like the commented documentation of
PostgreSQL at http://www.postgresql.org/docs/8.3/interactive/index.html
where you can add comments.

Torsten
From: Gerald W. Lester on 5 May 2008 10:22
vitic wrote:
> Perhaps it would be a good idea to have two versions of TCL
> documentation.
>
> 1. The official static one created by developers.
> 2. The wiki type documentation which is a copy of the official one
> that also lets users add their comments, examples, workaround, bugs
> etc. for each command.
>
> That would lead to a more up to date and detailed documentation that's
> created by many people, which will relieve the developers from this
> time consuming task.

Go ahead an create the pages on wiki.tcl.tk -- it is open to the community,


--
+--------------------------------+---------------------------------------+
| Gerald W. Lester |
|"The man who fights for his ideals is the man who is alive." - Cervantes|
+------------------------------------------------------------------------+
From: vitic on 5 May 2008 14:37
On May 5, 7:22 am, "Gerald W. Lester" <Gerald.Les...(a)cox.net> wrote:
> vitic wrote:
> > Perhaps it would be a good idea to have two versions of TCL
> > documentation.
>
> > 1. The official static one created by developers.
> > 2. The wiki type documentation which is a copy of the official one
> > that also lets users add their comments, examples, workaround, bugs
> > etc. for each command.
>
> > That would lead to a more up to date and detailed documentation that's
> > created by many people, which will relieve the developers from this
> > time consuming task.
>
> Go ahead an create the pages on wiki.tcl.tk -- it is open to the community,
>
> --
> +--------------------------------+---------------------------------------+
> | Gerald W. Lester |
> |"The man who fights for his ideals is the man who is alive." - Cervantes|
> +------------------------------------------------------------------------+

That sounds like an idea. I will try to figure out the best way to do
it.

---Victor
From: Bruce Hartweg on 5 May 2008 16:23
vitic wrote:
> On May 5, 7:22 am, "Gerald W. Lester" <Gerald.Les...(a)cox.net> wrote:
>> vitic wrote:
>>> Perhaps it would be a good idea to have two versions of TCL
>>> documentation.
>>> 1. The official static one created by developers.
>>> 2. The wiki type documentation which is a copy of the official one
>>> that also lets users add their comments, examples, workaround, bugs
>>> etc. for each command.
>>> That would lead to a more up to date and detailed documentation that's
>>> created by many people, which will relieve the developers from this
>>> time consuming task.
>> Go ahead an create the pages on wiki.tcl.tk -- it is open to the community,
>>
>> --
>> +--------------------------------+---------------------------------------+
>> | Gerald W. Lester |
>> |"The man who fights for his ideals is the man who is alive." - Cervantes|
>> +------------------------------------------------------------------------+
>
> That sounds like an idea. I will try to figure out the best way to do
> it.
>
> ---Victor

This is already done for most tcl/tk commands.

Goto http://wiki.tcl.tk/<command>

e.g. <http://wiki.tcl.tk/update>

and you usually get a page with a link to the official
man page docs, and then some discussion/examples/pitfalls
of the command. If a page doesn't exist yet, feel free to
create one. If one exists feel free to add more examples
you feel will be helpful.

Bruce
 |  Next  |  Last
Pages: 1 2
Prev: Regular expressions question
Next: Reading images on Excel worksheets with TCOM