How to document the core Tcl API

From AOLserver Wiki
Jump to navigation Jump to search

So, you'd like to help document the core Tcl API for AOLserver, but you're not sure where to start or how to do it? Read on ...

There's two basic templates for documenting commands, one for plain commands that take arguments, and one for commands that have subcommands (also known as "ensembles").

Here are links to pages containing the documentation templates. To use them, visit the page and click the "Edit" link in the footer menu of the page. Copy-and-paste the contents of the text box, then paste them into the "Edit" text box for the command you want to document. Replace the strings in the template with the appropriate documentation for the command, then click the "Save" button.

A few things to keep in mind when writing anything on the wiki: it doesn't have to be perfect; anyone can go in and edit what's on the wiki at any time, hopefully to improve what's there; even small contributions made regularly to the wiki will accumulate in value over time.

Also, ignore the fact that the "Man page" link at the top is currently a bad link. Once the documentation effort is completed, the pages will be converted to roff format, checked into CVS, and forward-generated into HTML that will be published on the site, making all the links valid.