Template Variable Types

The page templates in a Portal Theme are provided with various objects representing the content and metadata in the system.

Key Content Access Concepts

Files in Titania Delivery are referred to as Project Items, since they exist within projects. In order to identify content for display, you need the following identifying information:

  • The Project Key.
  • Either the Item Key (database identifier of the file) or the folder path within the project.
  • For DITA topics in the context of a map, the item key of the referencing map, called the Context Key.
  • If a DITA topic is referenced multiple times from the same map, you will also need the resolved ID of the reference to the topic, called the Reference Identifier or refId.

For everything other than DITA topics, the Project Key and Item Key are sufficient to identify the content, and can be encapsulated in an ItemIdentifier. The more robust form for identifying content is the ContentLocator object, which contains the project key, item key, and context identification.

Project Items have properties and metadata associated with them. This information is often accessed using ItemDataAccess objects provided to the page. You can also get one from any page using <@td.fileProperties>.

Key Search Concepts

Rather than return Project Items, the search engine returns special SearchResultDocument objects, containing the identifying properties of the project item, as well as some details and metadata. Most searches return these objects grouped using SearchResultGroup objects, which group contextualized topics by their Context Key (uncontextualized DITA topics and non-topic content will also be contained in groups, but those groups will have only one member). Finally, the search engine provides pagination of groups using SearchResultGroup objects.

Key Assembly Concepts

A custom Assembly object is its own data structure, identified by its key. Items within an assembly are identified by the assembly key and the generated reference ID for that entry.