Form templates

​

Before you begin

​

Template types

​

Template selection

1. Group match first — templates assigned to user groups are considered for a user in those groups; the highest precedence wins.
2. Default fallback — if no group template matches, the template marked Default for that type is used.
3. Nothing selectable — the generic layout is used for previewing and editing, and the document type is not offered on New form.

​

The designer

• Start from — a new template offers three starting points: Scaffold from keywords generates a field (or value, for preview templates) for every keyword of the document type, grouped the way its keyword configuration is; the starters are small generic layouts with placeholder keyword names; Blank is empty.
• Components — the palette lists the form components with their props; select one to insert it.
• Problems — the template is linted as you type: unknown components and props, a keyword component without a binding, keywords the document type does not have, malformed tags. Findings do not block saving, so clear the errors before you make the template the default: an unknown keyword, for example, renders as Unknown keyword on the form.
• Preview — renders the template as it will look. Sample data fills every keyword with a plausible value and lets you type into fields without saving anything; Real document loads an existing form document of the type by ID and shows the template read-only against its stored keywords, including group rows.
• History — every save stores a version. Open a version to compare it with the current source, load it into the editor, or restore it.
• AI assistant — where the AI template generation feature is enabled, describe the form you want or the change to make; the assistant knows the document type’s keywords and the form components, and its suggestion is shown as a diff you accept or discard.

​

Writing a template

<div class="form-view container mx-auto p-4 space-y-4">
    <div>
        <h1 class="text-2xl font-bold">{{Site}}</h1>
        <p class="text-xs text-muted-foreground">{{document.documentTypeName}} — inspected {{document.documentDate}}</p>
    </div>
    <CollapsibleSection title="Visit" defaultExpanded="true">
        <div class="grid grid-cols-1 gap-4 md:grid-cols-2">
            <KeywordField name="Site" label="Site" placeholder="Site or address" />
            <KeywordField name="Inspection date" label="Inspection date" />
            <KeywordField name="Inspector" label="Inspector" />
            <KeywordField name="Result" label="Result" />
        </div>
    </CollapsibleSection>
    <CollapsibleSection title="Findings" defaultExpanded="true">
        <KeywordGroup name="Findings" addLabel="Add finding">
            <div class="grid grid-cols-1 gap-4 md:grid-cols-2">
                <KeywordField name="Finding" label="Finding" />
                <KeywordField name="Severity" label="Severity" />
            </div>
        </KeywordGroup>
    </CollapsibleSection>
    {{#if Remarks}}<MessageCard content="{{Remarks}}" author="{{Inspector}}" />{{/if}}
    <div class="mt-6 flex justify-end">
        <SaveButton label="Save" />
    </div>
</div>

​

The render scope

​

What the form enforces for you

• Required keywords must be filled before saving, including ones the template does not show.
• Masks, lengths and datasets come from the keyword type; cascading children follow their parent and read-only cascading children are derived automatically.
• Autofill keyword sets run when their primary keyword is entered, with the same choice and confirmation dialogs as the keyword panel.
• Keyword defaults of the document type pre-fill a new form.
• Revision comments: if the document type forces a comment, the save button asks for it first.
• Duplicates: if similar documents exist, the create asks before storing anyway.

​

Where to read next