FreeMarker API

FreeMarker templates can be used to generate the view component of the Model-View-Controller (MVC) pattern.

The Repository FreeMarker Template API lets you render output using the FreeMarker template engine. This is the full list of public APIs that compose the Repository FreeMarker Template API.

Important: Objects that are available to scripts running in the Repository context are explained here. They are not available to scripts running in the Share context.

Template usage Templates are used widely in SkyVault to render the view of a MVC pattern.
Template files Template files can be stored on the classpath or within the repository store.
Template models Template models provide data which can be used by the template to generate an output view.
Default model objects The default model provides a number of common objects useful for most templates. These are generally known as root objects.
Default model methods Custom template methods can be added to the FreeMarker language for use on template pages. The default model provides the following methods:
TemplateNode APITemplateNode objects and any subsequent child node objects provide access to the common SkyVault concepts, such as properties, aspects, and associations. The following template API is provided. TemplateNode extends BasePermissionsNode.
Classification API The classification object provides read access to classifications and root categories.
Current Date The date object returns the current date.
JSP Page Custom JSP pages can be written to render templates.
People API The People API provides basic user and group query and inspection capabilities.
VersionHistoryNode API The VersionHistoryNode is an extension of the BaseContentNode type. The versionHistory property of the TemplateNode object returns a sequence of VersionHistoryNode objects that represent the version history for the document.
Workflow API The workflow root object provides read access to the in-progress and finished tasks for the current user. It also provides a function to look up a single task by its task ID. The functions described mostly return WorkflowTaskItem objects.

Parent topic: Reference

Search form

Search form

You are here