DocsObject referenceView source

Date Variable

A calendar date as an ISO YYYY-MM-DD string. No time zone and no clock are involved. '{{<id>}}' inserts it formatted with 'format'.

Metadata

Definition: #/$defs/DateVariable
Type: object
Source: spec/schemas/opf.schema.json

Field index

Field	Type	Req.	Description
type	const	yes	Variable kind. One of color, text, number, date, image, url or list.
value	string	—	ISO calendar date (YYYY-MM-DD) this variable resolves to.
required	boolean	—	Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…
label	string	—	Optional short human label for forms and fill panels.
description	string	—	Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.
example	string	—	Illustrative ISO date shown in fill forms and used when a template is previewed with examples. Never written to output.
format	string	—	Date display pattern, the same LDML-style tokens as header/footer dateFormat: yyyy, yy, MMMM, MMM, MM, M, dd, d, EEEE, EEE and quoted literals. English names. Default 'MMMM d, yyyy'.

`type`

typeconstrequiredyesdefault—

Variable kind. One of color, text, number, date, image, url or list.

type.json

{
  "type": "date"
}

`value`

typestringrequirednodefault—pattern^\d{4}-\d{2}-\d{2}$

ISO calendar date (YYYY-MM-DD) this variable resolves to.

value.json

{
  "value": "value-value"
}

`required`

typebooleanrequirednodefaulttrue

Whether the variable must be filled. Defaults to true: a variable with no 'value' is unfilled, and an unfilled required variable is an error in a normal deck and expected in a template. Set false for an optional slot: an unfilled optional variable resolves to empty text (inline…

required.json

{
  "required": true
}

`label`

typestringrequirednodefault—

Optional short human label for forms and fill panels.

label.json

{
  "label": "label-value"
}

`description`

typestringrequirednodefault—

Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents.

description.json

{
  "description": "description-value"
}

`example`

typestringrequirednodefault—pattern^\d{4}-\d{2}-\d{2}$

Illustrative ISO date shown in fill forms and used when a template is previewed with examples. Never written to output.

example.json

{
  "example": "example-value"
}

`format`

typestringrequirednodefault—

Date display pattern, the same LDML-style tokens as header/footer dateFormat: yyyy, yy, MMMM, MMM, MM, M, dd, d, EEEE, EEE and quoted literals. English names. Default 'MMMM d, yyyy'.

format.json

{
  "format": "MMMM d, yyyy"
}