- Publicity: Public Only All
filter-procs.tcl
Procedures in this file
- content::deploy (public, deprecated)
- content::get_content (public)
- content::get_content_value (public)
- content::get_item_id (public)
- content::get_template_root (public)
- content::get_template_url (public)
- content::has_content (public)
- content::init (public)
Detailed information
content::deploy (public, deprecated)
content::deploy url_stub
Deprecated. Invoking this procedure generates a warning.
render the template and write it to the filesystem with template::util::write_file DEPRECATED: since its birth ~2003 this proc refers to a nonexistent variable and is therefore broken.
- Parameters:
- url_stub (required)
- See Also:
- modern ways to produce templated content e.g. theme packages or xowiki pages
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::get_content (public)
content::get_content [ content_type ]
sets the content in the array "content" in the callers scope assumes item_id or revision_id is set in the ::content namespace.
- Parameters:
- content_type (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::get_content_value (public)
content::get_content_value revision_id
- Parameters:
- revision_id (required)
- Returns:
- content element corresponding to the provided revision_id
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::get_item_id (public)
content::get_item_id
- Returns:
- current value of ::content::item_id
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::get_template_root (public)
content::get_template_root
Find the directory in the filesystem where templates are stored. There are a variety of ways in which this can be set. The proc looks for that directory in the following places in this order: (1) the TemplateRoot parameter of the package for which the request is made, i.e., [ad_conn package_id] (2) the TemplateRoot parameter of the acs-content-repository If it is not found in any of these places, it defaults to $::acs::rootdir/templates If the value resulting from the search does not start with a '/' it is taken to be relative to $::acs::rootdir
- Returns:
- the template root (full path from /)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::get_template_url (public)
content::get_template_url
- Returns:
- current value of ::content::template_url
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::has_content (public)
content::has_content
return true if the request has content associated with it
- Returns:
- 1 if ::content::item_id is defined
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
content::init (public)
content::init [ -resolve_index resolve_index ] [ -revision revision ] \
urlvar rootvar [ content_root ] [ template_root ] [ context ] \
[ rev_id ] [ content_type ]Initialize the namespace variables for the ::content procs and figures out which template to use and set up the template for the required content type etc.
- Switches:
- -resolve_index (optional, defaults to
"f")- -revision (optional, defaults to
"live")- Parameters:
- urlvar (required)
- rootvar (required)
- content_root (optional)
- template_root (optional)
- context (optional, defaults to
"public")- rev_id (optional)
- content_type (optional)
- Partial Call Graph (max 5 caller/called nodes):
- Testcases:
- No testcase defined.
