Gentics CMS-OSS Documentation

Chapters

1. Baseobjects

   • Page

   • Template

   • Folder

   • File

   • Node

   • Tag

   • Rendermode

   • Imps

2. Childobjects

   • Language

   • Pagetag/Templatetag Parttype

   • Markuplanguage

   • User

3. Parttypes

   • Overview Parttype

   • Datasource/Select (Single)/Select (Multiple) Parttype

   • Pageurl/Fileurl/Imageurl/Folderurl Parttype

   • Checkbox Parttype

   • Text Parttypes

   • Node Parttype

1 Baseobjects

1.1 Page

1.2 Template

1.3 Folder

1.4 File

1.5 Node

1.6 Tag

1.7 Rendermode

1.8 Imps

1.8.1 String Formatter Imp

The String Formatter Imp provides methods for escaping and other string manipulation:

1.8.2 Date Formatter Imp

The DateFormatterImp allows you to format date strings and date objects.

  // Format the date using the given pattern and the english locale
  $cms.imps.date.format($date, "dd MMM yyyy HH:mm:ss", "en")

  // Format the date using the given pattern. The local is deduced by inspecting the page language.
  $cms.imps.date.format($date, "dd MMM yyyy HH:mm:ss")

  // Create a date by using a timestamp
  $cms.imps.date.fromTimestamp($timestamp)

  // Parse a date string and create a date object
  $cms.imps.date.parse("22 MAR 1984 12:30:00", "dd MMM yyyy HH:mm:ss", "EN")

  // Calculate difference in years between dateA and dateB
  $cms.imps.date.dateDiff($dateA, $dateB, "y")

  // Example of using the imp with edittimestamps
  $cms.imps.date.format($cms.imps.date.fromTimestamp($cms.page.edittimestamp), "MMMM dd, yyyy", "en")

1.8.3 Sort Imp

Sort the given collection (might also be an array or a map) by the given list of properties.

  $cms.imps.sorter.sort(Collection collection, String[] properties[, boolean caseSensitive][, String languageCode])

Sort the given collection (might also be an array or a map) by the given list of properties. The sortorder can be independently set for each property in the list. When sorting by only one property, one can also pass a single String instead of an array of Strings as value for the parameter properties.

1.8.4 Loader Imp

The Loader Imp can be used to retrieve content objects by id.

1.8.5 URL Include Imp

The URLIncludeImp allows you to include contents from other URLs.

  $cms.imps.url.include(url, cache, timeout, default)

2 Childobjects

2.1 Language

2.2 Pagetag/Templatetag Parttype

2.3 Markuplanguage

2.4 User

3 Parttypes

3.1 Overview Parttype

3.1.1 Velocity Properties

Properties available when rendering an overview using velocity:

#foreach($item in $cms.page.tags.overviewtag.overviewpart.items)
$item.key $item.value
#end

3.1.2 <node> Template Properties

These placeholders are available in overview templates (when the overview part is rendered directly, without the use of velocity):

3.2 Datasource/Select (Single)/Select (Multiple) Parttype

3.2.1 Velocity Properties

#foreach( $item in $cms.tag.parts.multiselect.items )
$item.key - $item.value
#end

3.2.2 <node> Template Properties

These placeholders are available in datasource templates (when the part is rendered directly, without the use of velocity).

3.3 Pageurl/Fileurl/Imageurl/Folderurl Parttype

Node-Style: <node page.tags.tlink1.href.id> 
VTL-Style: $cms.page.tags.tlink1.href.id

3.4 Checkbox Parttype

3.5 Text Parttypes

3.6 Node Parttype

In addition to the properties exposed by nodes in general the parttype can resolve the name of the node directly.