Index: openacs-4/packages/acs-core-docs/www/tcl-doc.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/tcl-doc.adp,v diff -u -r1.4 -r1.5 --- openacs-4/packages/acs-core-docs/www/tcl-doc.adp 25 Apr 2018 08:38:28 -0000 1.4 +++ openacs-4/packages/acs-core-docs/www/tcl-doc.adp 3 Sep 2024 15:37:32 -0000 1.5 @@ -1,7 +1,11 @@ -{/doc/acs-core-docs {ACS Core Documentation}} {Documenting Tcl Files: Page Contracts and Libraries} +{/doc/acs-core-docs/ {ACS Core Documentation}} {Documenting Tcl Files: Page Contracts and Libraries} Documenting Tcl Files: Page Contracts and Libraries +

Documenting Tcl Files: Page Contracts and -Libraries

<authorblurb>

By Jon Salz on 3 July -2000

</authorblurb>
  • Tcl procedures: +Libraries

+

By Jon Salz on 3 July 2000

+OpenACS docs are written by the named authors, and may be edited by +OpenACS documentation staff.
  • Tcl procedures: /packages/acs-kernel/tcl-documentation-procs.tcl

The Big Picture

In versions of the OpenACS prior to 3.4, the standard place to document @@ -24,7 +30,7 @@ # # author's email address, file creation date # -# $‌Id: tcl-doc.xml,v 1.7 2006/07/17 05:38:38 torbenb Exp $ +# $‌Id: tcl-doc.xml,v 1.7.16.1 2023/07/10 08:36:09 gustafn Exp $ #

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 @@ -62,7 +68,7 @@ integrated closely 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, +subject to change, so we don't describe it here yet; for now, you can just consider ad_page_contract a newer, better, documented ad_page_variables.)

Let's look at an example usage of ad_page_contract:

 
@@ -193,7 +199,7 @@
 #
 # jsalz\@mit.edu, 7 Jun 2000
 #
-# $‌Id: tcl-doc.xml,v 1.7 2006/07/17 05:38:38 torbenb Exp $
+# $‌Id: tcl-doc.xml,v 1.7.16.1 2023/07/10 08:36:09 gustafn Exp $
 
 

you'll now write:

 
@@ -220,8 +226,8 @@
 page's CVS identification string. Just use $‌Id: tcl-documentation.html,v 1.2 2000/09/19
 07:22:35 ron Exp $ when creating the file, and CVS will
 substitute an appropriate string when you check the file in.

-

($‌Id: tcl-doc.xml,v 1.7 2006/07/17 05:38:38 -torbenb Exp $)

+
($‌Id: tcl-doc.xml,v 1.7.16.1 2023/07/10 +08:36:09 gustafn Exp $)