Index: openacs-4/packages/acs-core-docs/www/xml/kernel/tcl-doc.xml =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/xml/kernel/tcl-doc.xml,v diff -u -r1.3 -r1.3.2.1 --- openacs-4/packages/acs-core-docs/www/xml/kernel/tcl-doc.xml 10 Aug 2002 19:34:42 -0000 1.3 +++ openacs-4/packages/acs-core-docs/www/xml/kernel/tcl-doc.xml 7 Apr 2003 16:49:22 -0000 1.3.2.1 @@ -14,36 +14,9 @@ The Big Picture +We use functions to document Tcl files and a web-based user +interface for browsing the documentation: -In versions of the OpenACS prior to 3.4, the standard -place to document Tcl files (both Tcl pages and Tcl library files) was in -a comment at the top of the file: - - - - -# -# path from server home/filename -# -# Brief description of the file's purpose -# -# author's email address, file creation date -# -# $Id$ -# - - - -In addition, the inputs expected by a Tcl page (i.e., form variables) would -be enumerated in a call to ad_page_variables, in effect, -documenting the page's argument list. - - -The problem with these practices is that the documentation is only -accessible by reading the source file itself. For this reason, ACS 3.4 -introduces a new API for documenting Tcl files and, on top of that, a -web-based user interface for browsing the documentation: - ad_page_contract: Every Tcl page has a contract that explicitly defines what inputs the page @@ -89,7 +62,7 @@ with the documents API so that each script's contract will document precisely the set of properties available to graphical designers in templates. (Document API integration is subject to change, so we don't -decsribe it here yet; for now, you can just consider +desrribe it here yet; for now, you can just consider ad_page_contract a newer, better, documented ad_page_variables.)