SpecDefinition referenceView source

Url Variable

A link target (http, https, mailto or tel). Use it as '{{<id>}}' inside a link string or reference it whole as 'var:<id>' in a link field.

Metadata

Definition: #/$defs/UrlVariable
Form: 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. `type` · Allowed values `"url"`
value	string	—	Link target 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 tokens) or the field that references it is omitted.
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 link shown in fill forms and used when a template is previewed with examples. Never written to output.

`type`

typeconstrequiredyesdefault—

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

type · Allowed values: "url"

Field fragment · type.json

{
  "type": "url"
}

`value`

typestringrequirednodefault—pattern^(?:https?://|mailto:|tel:)\S+$

Link target this variable resolves to.

`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 tokens) or the field that references it is omitted.

`label`

typestringrequirednodefault—

Optional short human label for forms and fill panels.

`description`

typestringrequirednodefault—

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

`example`

typestringrequirednodefault—pattern^(?:https?://|mailto:|tel:)\S+$

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

Complete definition constraints

Exact schema constraints

{
  "type": "object",
  "required": [
    "type"
  ],
  "additionalProperties": false,
  "properties": {
    "type": {
      "type": "string",
      "const": "url",
      "description": "Variable kind. One of color, text, number, date, image, url or list."
    },
    "value": {
      "type": "string",
      "pattern": "^(?:https?://|mailto:|tel:)\\S+$",
      "description": "Link target this variable resolves to."
    },
    "required": {
      "type": "boolean",
      "default": true,
      "description": "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 tokens) or the field that references it is omitted."
    },
    "label": {
      "type": "string",
      "description": "Optional short human label for forms and fill panels."
    },
    "description": {
      "type": "string",
      "description": "Optional prose describing what the variable is for, surfaced by pickers, fill forms and agents."
    },
    "example": {
      "type": "string",
      "pattern": "^(?:https?://|mailto:|tel:)\\S+$",
      "description": "Illustrative link shown in fill forms and used when a template is previewed with examples. Never written to output."
    }
  },
  "description": "A link target (http, https, mailto or tel). Use it as '{{<id>}}' inside a link string or reference it whole as 'var:<id>' in a link field."
}