Skip to content

Template Data Model

A layout template renders one entity (a method, property, type, and so on) by reading properties from a page context object with Mustache. This section is the reference for what each context exposes.

  • Case-insensitive — {{name}}, {{Name}}, and {{NAME}} all resolve to the same property.
  • Plain text vs. HTML — plain-text properties use {{prop}} (HTML-escaped). Properties that are already markup — those named *Html, the syntax/code fields, and custom-field value — use the triple brace {{{prop}}} so they pass through unescaped.
  • Sections — a property that holds a collection exposes its items under items. Iterate with {{#prop}}{{#items}}…{{/items}}{{/prop}}. Most such properties are null when empty, so the outer section doubles as a presence check.
  • Objects — a property that is another context (e.g. parent, assembly) is entered with a section: {{#assembly}}[{{name}}]({{link}}){{/assembly}}, or accessed by dotted path ({{assembly.name}}).

The entity contexts differ by driver flavor:

Every context derives from a shared base. Its members are mostly used by the pipeline itself; the page title and TOC title are normally set in the layout’s frontmatter rather than read as variables, so base members are rarely referenced directly.

Every entity context exposes customFields, which surfaces the content authored in the Help Editor. The built-in Remarks and Units fields are available directly; other fields are rendered through their auto-discovered partial (see Custom Fields).

AccessReturnsNotes
customFields.remarksa field, or nullthe Remarks field
customFields.unitsa field, or nullthe Units field

A field exposes a single value (pre-formatted — render with {{{value}}}):

{{#customFields.remarks}}
## Remarks
{{{value}}}
{{/customFields.remarks}}

These shapes appear inside many entity contexts (referenced from the per-flavor pages).

PropertyTypeDescription
modelstextThe models the command applies to (All Models by default).
commandtextThe instrument command string.

A commands context wrapping these has isSingle (true when one command serves all models), command (the single command, when isSingle), and items (the per-model list).

Member summary — an entry in a listing on an overview page

Section titled “Member summary — an entry in a listing on an overview page”
PropertyTypeDescription
nametextDisplay name.
linktextRelative link to the member’s page.
summarytextHelp summary (collapsed to a single line).

Listing sections (e.g. methods, properties) wrap these in an items collection.

PropertyTypeDescription
valuetextThe value.
descriptiontextIts description (e.g. an enum member’s summary).
PropertyTypeDescription
conditiontextThe model the range applies to.
minimumtextFormatted lower bound (e.g. ≥ 0), or empty.
maximumtextFormatted upper bound (e.g. ≤ 100), or empty.

A supported-models context exposes a single models string (All Models, None, or a comma-separated list); present only on multi-model drivers.