FreeMarker model reference

This chapter contains a reference for all the iKnowBase-specific FreeMarker model objects, with a description of their properties.

Every component which supports FreeMarker templates has its own section in this chapter, with a separate chapter for shared model object at the end.

Understanding the notation

For every component, there are two pieces of information:

• The first table inside the chapter describes the objects made available to the FreeMarker template. For each object there is a short description, as well as information about the type of the model object.
• Subsequent tables describe the properties of each model object type. For each property there is a short description, as well as information about the type of the property.

Often, there is a reference to a property named <default>. This is the value returned from the model object when no property is specified.

Also, there are often references to a property named <name>. These refer to a “generic” notation, where you can use any name. This name is then typically used to look up information for an object of that name.

Wrapped objects

Some of the models may refer to wrapped object properties, with reference to a java class. In those situations, the properties of that model object will be defined by the java class directly, through the use of FreeMarker’s BeanModel. For detailed information, see the FreeMarker documentation of the BeansModel class.