Index: openacs-4/packages/acs-templating/www/doc/api/request.html
===================================================================
RCS file: /usr/local/cvsroot/openacs-4/packages/acs-templating/www/doc/api/request.html,v
diff -u -r1.1 -r1.2
--- openacs-4/packages/acs-templating/www/doc/api/request.html 13 Mar 2001 22:59:27 -0000 1.1
+++ openacs-4/packages/acs-templating/www/doc/api/request.html 7 Aug 2017 23:48:02 -0000 1.2
@@ -4,7 +4,7 @@
Page Request
- Templating System : API Reference
+ Templating System : API Reference
Summary
@@ -31,33 +31,33 @@
Validates request parameter values and then sets a local variable.
Values are transformed if a transformation procedure exists for the
-specified datatype (i.e. the components of a date are
+specified datatype (i.e. the components of a date are
assembled into a single structure).
- - Options for datatype are the same as for form elements.
-
- The multiple switch indicates that more than one value
+
- Options for datatype are the same as for form elements.
+
- The multiple switch indicates that more than one value
may be submitted. The local variable set by the procedure will
be a list.
-
- The optional switch indicates that the parameter value may be
+
- The optional switch indicates that the parameter value may be
empty or missing. A value is assumed to be required if this switch
is not specified.
-
- The validate switch may be used to perform simple
- custom validation of each parameter value. expression
+
- The validate switch may be used to perform simple
+ custom validation of each parameter value. expression
must be a block of arbitrary Tcl code that evaluates to 1
- (valid) or 0 (not valid). The variable $value may be
+ (valid) or 0 (not valid). The variable $value may be
used in the expression to reference the parameter value.
- message is simply a string
+ message is simply a string
containing a message to return to the user if validation fails.
- The variables $value and $label may be used in
+ The variables $value and $label may be used in
the message to reference the parameter value and label (or name if
no label is supplied).
template::request get_param name
-Returns the value (or values if the multiple is used) of
+
Returns the value (or values if the multiple is used) of
the named parameter.
template::request is_valid error_url
@@ -66,11 +66,11 @@
while setting request parameters.
- - error_url is the location of the template to use for
+
- error_url is the location of the template to use for
reporting request errors. The default is
- /ats/templates/messages/request-error if no URL is
+ /ats/templates/messages/request-error if no URL is
specified. To report request errors in the template of the page
- itself, use self for the URL.
+ itself, use self for the URL.
Example
@@ -94,16 +94,16 @@
Note(s)
- - Error reporting templates may reference the requesterror
+
- Error reporting templates may reference the requesterror
array to access error messages for each parameter.
- The request API provides a simple mechanism for processing
request parameters. It is not intended as a replacement to
- ad_page_contract for sites built on the ArsDigita
+ ad_page_contract for sites built on the ArsDigita
Community System.
-templating@arsdigita.com
+