Creating a Page Blueprint
How to create a blueprint at the page level
The value and power of page blueprints comes from the ability to ask the user to populate a given substitution field, and then populating that field throughout the blueprint
Requirements / Permissions
Before you begin building your page blueprint, you'll want to:
- familiarize yourself with the .json file, substitution fields, and the basics of blueprints
- consider the substitution fields you'll want to employ
- make sure Brikit Blueprint Maker is installed
- you have administrative permissions
- Create a page that will become a blueprint
- Define the blueprint in the pageBlueprints object in the json file
- Name
- Space Key: The key of the space where the blueprint page resides
- Page Title: Name of the blueprint page
- Blueprint Fields: List of the substitution fields used in the blueprint
- Both built-in and custom fields
- Not required, but useful
- Sets the order the fields will appear in the Wizard
- Both built-in and custom fields
- Include Children: Toggles whether child pages will be included when building the blueprint
- Description
- Appears below the blueprint name in the Blueprint Menu
- Define each substitution field in the blueprintFields object in the json file
ID: A unique ID for the field
Name: A human-readable name
Required: A toggle for whether the field is required
Type: Defines the length of the field
Help Text: Additional text to assist the user in filling out the field
- Appears below the data-entry field in the blueprint wizard
Placeholder: Default text in the field