Gentics CMS Documentation

Chapters

1. Overview

2. Custom Form Part Type

3. Velocity Part Type

4. Breadcrumb Part Type

   • Velocity Variables

   • Breadcrumb Example Implementation

5. Navigation Part Type

   • Velocity Variables

6. Custom Part Type Implementations

1 Overview

2 Custom Form Part Type

The custom part type enables the implementer to create custom user interfaces that can be used by editors. The interface can be customized using javascript and stylesheets.

The custom ui template will be defined within the field which contains the html code.

Available variables:

Additionally typical node properties can also be used when the feature ‘customform_resolve_nodetags’ was enabled (e.g. <node TAGNAME>)

The demo cms project contains the following examples of the custom form tag part type:

• TinyMCE-Editor: This Tag includes the TinyMCE WYSIWYG-Editor.
• HTML Customform Example: This example contains just a custom form field.
• Text Customform Example: The same example like “HTML Customform Example”. In this case the “Text (custom form)” is used.
• [Formular] limitierte Eingabe: An inputfield that can just accept a specified amount of characters.

3 Velocity Part Type

An example for this tag part type can be found within the demo server in the folder “Demo-CMS-Projekt/Home/Node Tags”.

• Parameter “template”
• Type: HTML lang
• Content: The Velocity Template Code that should be rendered by the visible Velocity Part Type.

• Parameter “macros”:
• Type: HTML lang
• Content: VTL Macros which can be used within the implementation.

Example Velocity Tagtyp:

• Part 1: Typ Velocity, Keyword vtl, Visible
• Part 2: Typ HTML lang, Keyword template, Not visible
• Part 3: Typ HTML lang, Keyword macros, Not visible

Errors within the velocity implementation will be diplayed within the Gentics CMS im “error stream”.

Example:

 
#if( $cms.page.object.myprop.toString() == "test" )

4 Breadcrumb Part Type

• Parameter “startfolder”
• Type: URL (folder)
• Content: The start folder of the breadcrumb.

• Parameter “template”
• Type: HTML (long)
• Content: The Velocity-Template of the navigation.

• Parameter “disable_activepage”
• Type: Checkbox
• Content: False if the current page should be linked in the breadcrumb.

• Parameter “tagname_hidden”
• Type: Text (short)
• Content: Name of the object property that is used to hide objects wihtin the navigation.

• Parameter “disable_fallback”
• Type: Datasource
• Content:
  • 0 is used for language fallbacks to the default language,
  • 1 or. “yes” to end breadcrumb path if no page in the current language exists,
  • 2 or. “skip” to skip non exisiting pages in the current language.

• Parameter “tagname_startpage”
• Type: Text (short)
• Content: Name of the object property that is used for the startpage of a folder.

• Parameter “disable_hidden”
• Type: Checkbox
• Content: True when hidden objects should be displayed within the navigation.

4.1 Velocity Variables

4.2 Breadcrumb Example Implementation

Tag Parts: |. Part Type|. Name|. Keyword |_. Changeable|. Required|. Hidden|. inline editable | | Breadcrumb | bc | bc | no | no | no | no | | HTML (long) | template | template | no | no | yes | no | | URL (folder) | startfolder | startfolder | no | no | yes | no |

#*
render all folder startpages in the path to our current location in an orderd list
i.e.
<ol>
    <li><a href="_URL_TO_FIRST_FOLDER_STARTPAGE_">_NAME_OF_FIRST_FOLDER_STARTPAGE_</a></li>
    <li><a href="_URL_TO_SECOMD_FOLDER_STARTPAGE_">_NAME_OF_SECOMD_FOLDER_STARTPAGE_</a></li>
    <li>_NAME_OF_CURRENT_PAGE</li>
</ol>
*#
<ol>#*
    *##foreach($nav in $bc.path)#*
        ## if not the current page
        *##if( ! $nav.startpage.equals($cms.page) )#*
            ## render a link to the startpages of the folders in the path
            *#<li><a href="$!{nav.startpage.url}">$!{nav.object.name}</a></li>#*
        *##else#*
            ## to finish up render the pagename of the current page
            *#<li class="active">$!{cms.page.name}</li>#*
        *##end#*
    *##end##
</ol>##

5 Navigation Part Type

An example can be found within the demo server folder “Demo-CMS-Projekt/Home/Navigation”.

• Parameter “startfolder”
  • Type: URL (folder)
  • Content: The startfolder of the navigation.

• Parameter “template”
  • Type: HTML (long)
  • Content: The velocity template of the navigation.

• Parameter “sortby”
  • Type: Text (short)
  • Content: Name of the object property which should be used to sort the elements. (e.g. object.name).

• Parameter “sortorder”
  • Type: Datasource (ASC, DESC)
  • Content: Sortorder (ascending of descending)

• Parameter “tagname_sort”
  • Type: Text (short)
  • Content: Name of the object property that is used to display a special sortorder. (Format: “sortorder;sortby”)

• Parameter “tagname_hidden”
  • Type: Text (short)
  • Content: Name of the object property that should be used to hide the navigation. By default the object property “navhidden” will be used.

• Parameter “objects”
  • Type: Select (multiple)
  • Content: List of all objects that should be displayed within the navigation (Pages, Folders, Images, Files). By default you should use the following template for the multiselect datasource: "<ds value>,"

• Parameter “disable_hidden”
  • Type: Checkbox
  • Content: True, if hidden objects should be displayed within the navigation. All hidden objects will not be shown by default. (See “tagname_hidden”).

• Parameter “sitemap”
  • Type: Checkbox
  • Content: True, if a sitemap should be displayed (All folders will be flapped open)

5.1 Velocity Variables

Please refere to the list of meta properties for examples and more detailed explanations.

6 Custom Part Type Implementations

Custom part types can be created using the AbstractExtensiblePartType class.

To use extensible parttypes you need to insert a row into the type table of the cms database. Please note that once the row has been inserted, any changes to the row, such as updating the class name, require a tomcat restart (the part type information is cached internally).

To avoid id conflicts please calculate your personal id range for now:

• Take the 1st 4 characters of one of the customers cms license keys.
• Convert them from hex to dec.
• Multiply by 1000. this is the lowest allowed id.
• Add 999. thid is the highest allowed id.
• E.g: license key is A2B4-xxxx-xxxx…
• HEX a2b4 is 41652 in decimal.
• Your personal id range is 41652000 – 41652999.