Predefined Variables Reference

Common Tree Variable
Current Variable
Directory Variable
Includes Variable
Parent Variable
Relative Root Variable
Site Name Variable

Predefined variables can be used in .tmpl files to echo, or print, certain parameters relating to directory names, includes, and site name directly onto the page. These variables come in particularly handy when needing to dynamically create a path to the root of the site or any other area of the site; you will find them most useful when utilizing recursive includes for, say, a breadcrumb trail.

Common Tree Variable

Prints the name of the current directory.

Syntax:


Example:

<a href="//index.html">

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Current Variable

Prints a path to the current directory from the root of the site.

Syntax:


Example:

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Directory Variable

Prints a path to the current directory from the root of the site, followed by a slash.

Syntax:


Example:

<a href="/index.html">

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Includes Variable

Prints the path from the site root to the parent directory and adds a trailing "includes" directory (i.e., "currentdir/includes").

Syntax:


Example:

<a href="/leftnav.html">

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Parent Variable

Prints the path from the site root to the directory that contains the current directory (i.e., one directory "above" the current location).

Syntax:


Example:

<a href="/index.html">

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Relative Root Variable

Prints the relative path from the current directory to the staging root (i.e., "../../currentdir/"). This variable is particularly useful when used in PCFs or utilized in XSL transformations.

Syntax:


Example:

<config>resources/config/standard.xml</config>

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Site Name Variable

Prints the name of the current site (determined by an administrator).

Syntax:


Example:

This page is part of the  site.

Parameters

var (Required)

The name of the variable which should be printed into the new document. Variable can be defined by a TCF or be a directory variable.
Syntax:
var="string variable name"

Predefined Variables Reference

Contents

Common Tree Variable

Parameters

var (Required)

Current Variable

Parameters

var (Required)

Directory Variable

Parameters

var (Required)

Includes Variable

Parameters

var (Required)

Parent Variable

Parameters

var (Required)

Relative Root Variable

Parameters

var (Required)

Site Name Variable

Parameters

var (Required)

Documents