Substitution Fields

Substitution fields are pieces of data that serve as placeholders for variable values in a Brikit Blueprint.

When a substitution field is planted in a blueprint source page, that field will automatically convert to either a user- or system-supplied text string whenever a new page is generated via that blueprint. Substitution fields in a blueprint are indicated by the field name enclosed in double brackets:

Substitution fields may be used in the generation of space names or keys, page titles, plain text, macro parameter values, and references to attached files. They play a large part in distinguishing new content created from a blueprint from the original source content.

Blueprint authors can employ any number of custom substitution fields by defining them in the JSON file. Users who create spaces or pages from blueprints that use substitution fields will be prompted to supply values for these fields during the initial configuration of the new spaces or pages. These values will most commonly be in the form of text strings, although they can also refer to external files that users can upload during the initial configuration.

Any substitution field defined in the JSON file may be used in multiple blueprints across the site.

In addition to custom substitution fields that map to user-supplied values, blueprint authors may also place built-in substitution fields that will render as system-generated values on blueprint source pages. See Built-In Substitution Fields for a complete list.