• Publicity: Public Only All

acs-integration-procs.tcl

Interface to the ACS for the ArsDigita Templating System Procedures in this file only make sense if you use the template system together with the ArsDigita Community System

Location:
packages/acs-templating/tcl/acs-integration-procs.tcl
Author:
Christian Brechbuehler
CVS Identification:
$Id: acs-integration-procs.tcl,v 1.29 2024/09/11 06:15:48 gustafn Exp $

Procedures in this file

Detailed information

ad_parse_template (public)

 ad_parse_template [ -params params ] template

Return a string containing the parsed and evaluated template to the caller.

Switches:
-params (optional)
The parameters to pass to the template. Note that pass-by-reference params must be in the page namespace, they cannot be in a local procedure, or any other namespace.
Parameters:
template (required)
Name of template file

Testcases:
ad_return_exception_template, create_form_with_form_instance

ad_return_exception_template (public)

 ad_return_exception_template [ -status status ] [ -params params ] \
    template

Return an exception template and abort the current script.

Switches:
-status (optional, defaults to "500")
The HTTP status to return, by default HTTP 500 (Error)
-params (optional)
The parameters to pass to the template.
Parameters:
template (required)
The template filename. Example: ad_return_exception_template -params {errmsg {custom_message "My Message"}} some-template

Testcases:
ad_return_exception_template

ad_return_template (public)

 ad_return_template [ -string ] [ template ]

This function is a wrapper for sundry template:: procs. Will set the template for the current page to the file named in 'template'.

Switches:
-string (optional, boolean)
If specified, will return the resulting page to the caller string instead sending it to the connection.
Parameters:
template (optional)
Name of template file

Testcases:
ad_return_template

get_server_root (public, deprecated)

 get_server_root
Deprecated. Invoking this procedure generates a warning.

Get the server root directory (supposing we run under ACS)
THIS PROC IS SUPERSEDED BY acs_root_dir

See Also:

Testcases:
No testcase defined.
[ show source ]