cTemplate Reference

cTemplate is the COMAND template language used to publish web pages and related files.  It is functionally very similar to cScript, except that it is easier to write inline within other text and markup, such as HTML.

To learn about publishing, see Publishing in Content Manager and Publication Framework.

Here is an example of what cTemplate looks like:

#* A simple list of contacts. *#
	<li><a href="#LINK(Contact,ID=$ID)">$Name</a></li>


cTemplate provides features similar to other template languages, including variables and flow control (if/then conditions, loops and iterators).  Variables and directives are mixed in with other text.  This form is best when most of the content is not template and script code.

  • Variables - A dollar sign ($) followed by a letter and zero or more letters, numbers or underscores will be interpreted as a variable.  A variable represents a value.  When cScript is processed, variables are replaced by their values.  For example, $FullName.  Variables can also be referenced like ${FullName}.
  • Directives - A hash symbol (#) followed by a valid directive will be interpreted as described in the cTemplate Directives section.  For example, #ASSIGN($A,1+2).
  • Escape Sequences - A pair of two-character sequences are used to produce text that might otherwise be interpreted as the start of a variable or statement.  Two dollar signs ($$) will produce a single dollar sign ($).  Two hash symbols (##) will produce a single hash symbol (#).
  • Whitespace - Whitespace on the same line as a cTemplate directive with no other text will be ignored.  In other words, any spaces and tabs before or after a cTemplate directive on its own line will not be output, as well as any trailing carriage return or newline.
  • Text - All other text (and binary data) will pass through unprocessed.  In other words, if the text is not interpreted as a variable, directive or escape sequence, it will be output as-is.

Mixing with cScript

Large scripts and template code can be more cleanly written as cScript inside a #CSCRIPT block.  For example:

    // A simple list of contacts.
    list(Contacts) {
	    echo('<li><a href="'+link(Contact,'ID=$ID')+'">$Name</a></li>');


cTemplate directives provide programmatic access to COMAND Repository content and features, typically without low-level access to the server.  This enables end-users to author templates and procedures without compromising server security.  cTemplate features can be further restricted to "read-only" functionality, eliminating the ability to update the repository.  Or, unrestricted features can be enabled to allow low-level access to the server in trusted code environments.