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.2.3 -r1.2.2.4 --- openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 22 Jun 2016 07:48:44 -0000 1.2.2.3 +++ openacs-4/packages/acs-templating/www/doc/gen/proc-doc.adp 5 Jul 2016 12:14:22 -0000 1.2.2.4 @@ -6,11 +6,11 @@ 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 -like this: + 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 like this: 

 [------------------------------------------------------]
 [------  ignored text at beginning of file  -----------]
@@ -64,11 +64,11 @@
 

 the \@namespace marker
    
 
  • 
-\@namespace is used to indicate the starting
-point of all text -- code and comments -- related to the procedures
-contained within that namespace. All text between one
-\@namespace marker and the next is parsed out as either
-Tcl proc source text or commentary of some sort
  • the body of text that falls between two \@namespace
+\@namespace is used to indicate
+the starting point of all text -- code and comments -- related to
+the procedures contained within that namespace. All text between
+one \@namespace marker and the next is parsed out as
+either Tcl proc source text or commentary of some sort
  • the body of text that falls between two \@namespace
 markers is divided into sections identified by
    • 
 
the \@public/private markers
    
 
  • although this convention is in no way enforced, each Tcl
@@ -90,9 +90,9 @@
 directives. Note: there should be one \@param or
 \@option directive marker for each parameter and option
 accepted by Tcl procedure. For the \@option and
-\@parameter markers, please follow one of the following
-formats, depending on whether or not the parameter or option you
-are detailing has a default value:
+\@parameter markers, please follow one of the
+following formats, depending on whether or not the parameter or
+option you are detailing has a default value:
 
    with a default value:
 
    # \@(param|option) <parameter name>
 {default <description of default value>}
@@ -103,11 +103,11 @@
 
    
 
    
 Note that the literal curly brackets with the word
-default are required to include any information about
-the option or parameter's default values. When default-value
-information is not included, the entry value will be marked as
-required if it is a parameter, or display no information if
-it is an option.
+default are required to include any
+information about the option or parameter's default values.
+When default-value information is not included, the entry value
+will be marked as required if it is a parameter, or
+display no information if it is an option.
 
    For example: the fictional procedure grant_permission might be
 preceded by these comments:
    # \@public grant_permission
 # checks for whether or not a user has the privilege 
@@ -122,7 +122,7 @@
 # id of the privilege specifying 
 # what actions the user can perform upon the object
 
-# \@option granter_id {default taken from the current user's id} id of the user granting the privilege
+# \@option granter_id {default taken from the current user's id} id of the user granting the privilege
 # \@option alert_admin_email email of an admin to be alerted
 
 # \@see namespace util util.html
@@ -134,8 +134,9 @@
 description, and granter_id and
 privilege_id would show the the default info from
 above.
-
    On to \@see directive markers:
    # \@see <type of reference><name of
-reference><url of reference>
+
    On to \@see directive markers:
    # \@see <type of reference><name
+of reference><url of
+reference>
 
    
 Indicating the url of the reference is made somewhat simple because
 all namespaces will be described within their own static html page,
@@ -148,7 +149,8 @@
 
    
 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.

+optional as long as you use the full and
+completely qualified name of the namespace or
+procedure.
templating\@arsdigita.com