Index: openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp,v
diff -u -N -r1.2 -r1.2.2.1
--- openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 27 Oct 2014 16:40:22 -0000 1.2
+++ openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 25 Aug 2015 18:02:14 -0000 1.2.2.1
@@ -2,9 +2,11 @@
{/doc/acs-templating {Templating}} {Commenting Tcl procedures for parsing}
Commenting Tcl procedures for parsing
-
-
-Using comments to document Tcl procedures
Templating SystemText divisions, grouping
< blah blah > The Tcl proc parser relies on three main
+Using comments to document Tcl procedures
+Templating System
+Text divisions, grouping
+< blah blah >
+ The Tcl proc parser relies on three main
text markers to divvy the Tcl library file into neat compartments:
namespace, procedure and directive. Each of these divisions has its
own text marker(s). In the end, your Tcl file should look somthing
@@ -52,12 +54,14 @@
# \@namespace ... <other namespaces>
+
Note that comment lines are indented to indicate the manner in
which they should be grouped only, and that there is no required
spacing scheme for comments.
Use of these directive markers is largely straightforward, but a
more in depth guideline of how the markers guide parsing may help
-those documenting their own work:
+those documenting their own work:
+
the \@namespace marker
-
\@namespace is used to indicate the starting
@@ -145,5 +149,6 @@
If you are referring to a namespace or procedure (use
proc for the reference type), the url value is
optional as long as you use the full and completely
-qualified name of the namespace or procedure.
templating\@arsdigita.com
-
+qualified name of the namespace or procedure.
+
+templating\@arsdigita.com