If you’re looking for detailed description on how meta attributes are used head over to using meta attributes.
1 Baseobjects
1.1 Page
Property name |
Description |
id |
id of the actual page |
url |
address of the actual page |
template |
template of the actual page |
name |
name of the actual page |
filename |
filename of the actual page |
description |
description of the actual page |
priority |
priority of the actual page |
tags |
tags of the actual page |
publishtimestamp |
UNIX timestamp of the last time a user clicked “publish” |
publishdate |
date of the last time a user clicked “publish” |
creationtimestamp |
UNIX timestamp of the creationdate |
creationdate |
date of the page creation |
edittimestamp |
UNIX timestamp of last page update |
editdate |
date of last page update |
folder |
reference to pages folder |
creator |
reference to pages creator |
editor |
reference to last editor of the page |
publisher |
reference to the last publisher of the page |
language |
reference to the language of the page |
languageset.id |
id of the pages languageset. A languageset is a collection that groups pages of the same contents but with different translations together. So an English version and a German version of a page have the same languageset.id |
languageset.pages |
reference to other language layouts of the page |
online |
true, in case page is online, else false |
ispage |
returns true |
versions |
version history of the page (see ‘version’ attribute) |
version |
last version of the page |
version.number |
version (e.g. 3.0) |
version.date |
creationdate of the page |
version.editor |
editor of the version |
version.major |
true, if its major version |
object |
object properties of the page |
pagevariants |
returns all page layouts (independent of the page status |
1.2 Template
Property name |
Description |
id |
id of the template |
name |
name of the template |
tags |
list of all available tags of the template |
ml |
markup language of the template (e.g. php3, php4, etc.) |
1.3 Folder
Property name |
Description |
id |
id of the folder |
name |
name of the folder |
description |
description of the folder |
node |
reference to the folders node |
parent |
reference to parent folder or NULL on top level |
path |
publish path of the folder |
creator |
the folders creator |
editor |
the last user who edited the folder |
creationtimestamp |
see file.createtimestamp |
creationdate |
see file.createdate |
edittimestamp |
see file.edittimestamp |
editdate |
see file.editdate |
folders |
list of all subfolders or NULL |
pages |
list of pages in this folder or NULL |
files |
list of files of files in this folder or NULL |
images |
list of images in this folder or NULL |
filesandimages |
list of all files and images in this folder or NULL |
children |
list of all subfolders, images and files or NULL |
isfolder |
true |
folders |
list of all subfolders or NULL |
object |
prefix to access object properties of this folder |
1.4 File
Property name |
Description |
id |
id of this file |
name |
filename |
description |
description of the file |
size |
size in bytes (int). same as sizeb |
sizeb |
size in bytes (int) |
sizekb |
size in kb (double) |
sizemb |
size in mb (double) |
folder |
reference to the files folder |
extension |
file extension (eg. “jpg”) |
creator |
the user who created the file |
editor |
last user who edited the file |
createtimestamp |
UNIX timestamp of creation time |
createdate |
creation date |
edittimestamp |
UNIX timestamp of last edit |
editdate |
last editdate |
type |
MIME-type of the file |
url |
link to file |
width* |
image width (int) |
height* |
image height (int) |
dpix* |
horizontal dpi resolution (int) |
dpiy* |
vertical dpi resolution (int) |
dpi* |
dpi resolution (int) |
isfile |
true, in case its a file, false (e.g. file is an image). The system will check the MIME-type of the file. If it starts with “image” isfile will return false. |
isimage |
analog to isfile only for images. If the MIME-type of the file starts with “image” isimage will return true. |
object |
object properties of the file |
* these properties are only available for images
1.5 Node
Property name |
Description |
id |
id of the node |
host |
hostname of the node |
folder |
the nodes root folder |
path |
path of the node (alias for pub_dir) |
pub_dir |
Publish directory for pages |
pub_dir_bin |
Publish directory for binary files and images |
languages |
list of references of languages of the node |
1.6 Tag
Property name |
Description |
TAGNAME |
references to the tag |
tag |
references to the current tag |
id |
id of the tag |
name |
name of the tag |
parts |
list of parts of the tag |
parts.PARTNAME |
references a single part of a tag |
empty |
1 in case the tag does not render any output, 0 otherwise |
visible |
1 if the tag is active, else 0 |
istag (since GCN 5.1.3) |
will always return true for tags |
1.7 Rendermode
Property name |
Description |
publish |
true if the page is rendered during a publish process |
live |
true in case of using the Live Preview |
edit |
true in case of using the Edit Mode |
preview |
true in case of using the Preview Mode |
real |
true in case of using the Real Edit Mode |
frontend |
true when rendering in frontend mode. The return value is valid in edit mode only. |
backend |
true when rendering in backend mode. The return value is valid in edit mode only. |
1.8 Imps
Property name |
Description |
velocitytools |
Velocity ToolsImp |
velocitytools.date |
DateTool |
velocitytools.math |
MathTool |
velocitytools.number |
NumberTool |
velocitytools.esc |
EscapeTool |
velocitytools.alternator |
AlternatorTool |
velocitytools.list |
ListTool |
velocitytools.iterator |
IteratorTool |
string |
String Formatter |
sorter |
SortImp |
date |
Date Formatter see PN3 reference index term “Imps” for additional information and examples |
loader |
The LoaderImp can be used to retrieve content objects by id (since build 20090110) It supports the following methods to retrieve objects (they return the same objects which are available under $cms.page, $cms.file, etc.) getObject(type, id): Returns the content object of the given type with the given id. type can be one of: “page”, “folder”, “image”, “file”, “node”. getPage(id) getFolder(id) getImage(id) getFile(id) getNode(id) |
url |
The URLIncludeImp can be used to include contents fetched from a given URL into the rendered page. |
1.8.1 URLIncludeImp
The URLIncludeImp allows you to include contents from other URLs.
Example: using the URLIncludeImp
$cms.imps.url.include(url, cache, timeout, default)
url |
URL to be requested |
cache |
cache lifetime in secs, defaults to 300 secs (5 mins) |
timeout |
timeout for accessing the URL and getting the contents in ms, defaults to 2000 ms (2 secs) |
default |
default content to be returned, if the URL cannot be accessed (default: null, will result in an error if URL cannot be accessed) |
2 Childobjects
2.1 Language
Property name |
Description |
id |
id of current language |
code |
code of current language (e.g. “de”) |
name |
name of current language (e.g. “Deutsch”) |
2.2 Pagetag/Templatetag Parttype
Property name |
Description |
id |
id of the pagetag |
tag |
reference to the tag itself |
container |
page or template the tag is referencing to |
2.3 Markuplanguage
Property name |
Description |
id |
id of the markuplanguage |
extension |
fileextension for this markuplanguage |
name |
name of the markuplanguage |
contenttype |
MIME type of the content |
2.4 User
Property name |
Description |
id |
id number of the user |
firstname |
the users first name |
lastname |
the users last name |
login |
login name of the user |
email |
mail address of the user |
active |
true, in case user is active now |
creator |
creator of the user |
creationdate |
date of the creation of the user |
creationtimestamp |
timestamp (time in seconds since 1.1.1970) of the creation of the user |
editor |
editor of the user |
editdate |
date where the user was edited last time |
edittimestamp |
timestamp (time in seconds since 1.1.1970) where the user was edited last time |
description |
description of the user |
3 Parttypes
3.1 Overview Parttype
Only available when using Velocity syntax
Property name |
Description |
items |
Collection, viewable objects of the overview |
Example: iterating an overview using velocity
#foreach($item in $cms.page.tags.overviewtag.overviewpart.items)
$item.key $item.value
#end
3.1.1 <node> template properties
Property name |
Description |
<node ds.nr> |
iteration counter |
<node ds.count> |
item count for this overview |
<node ds.container> |
container object of the overview (eg. a page) |
3.2 Datasource/Select (Single)/Select (Multiple) Parttype
Property name |
Description |
items |
Collection of all entries in the database |
selection |
Collection of all selected entries in the database |
nr |
id of the entry |
key |
entry name |
value |
value of the entry |
keys |
name of the dataset in the database |
values |
values of the database |
dsid |
internal id of the element |
Example: list items of a multiselect part
#foreach( $item in $cms.tag.parts.multiselect.items )
$item.key - $item.value
#end
3.2.1 <node> template properties
Property name |
Description |
<ds value> |
the selected value |
<ds name> |
name of the selected value |
<ds nr> |
id of the selected value |
<ds dsid> |
internal id of the element |
3.3 Pageurl/Fileurl Parttype
Property name |
Description |
id |
id of the parttype |
internal |
true if an internal link, false otherwise. Only available for Pageurl Parttype. |
target |
reference to the target object |
url |
url of the target |
Example: Output of the id of the url parttype
Node-Style: <node page.tags.tlink1.href.id>
VTL-Style: $cms.page.tags.tlink1.href.id
3.4 Checkbox Parttype
Property name |
Description |
checked |
true, in case checkbox was checked, else false |
3.5 Text Parttypes
Property name |
Description |
text |
textual contents of the part |