Design the Blueprint with a mind Determine your use-caseLive Blueprints are particularly useful if you have a case where: a. You want to re-use a common 'form' of content, such as a table with similar headings but different values. and b. You want to be able to update that source form, from time to time, and ensure that these updates occur wherever the blueprint is referenced. Create a source blueprint with your content 'form'This page will act as the 'single source of truth' for the form of the blueprint. Any changes to this page will 'persist' to wherever this blueprint is referenced on the site. Therefore, design the page accordingly and with an eye towards how it will be used and reused in different places. (Tip: Brikit typically recommends containing all of your site's live blueprint pages in a space called Live Blueprints. This makes it easy to find them again and also to manage permissions for the appropriate editors). Add substitution fieldsLive Blueprints can use any substitution fields, including built-in substitution fields. Simply add them wherever it makes sense to do so. Remember that part of the power of live blueprints is that they allow content to maintain an identical form while having their individual instances include different on-page content (or data). Substitution fields facilitate this possibility. Navigate to the Blueprint Definitions PageNow that the source blueprint has been drafted, it is time to 'define' it as a blueprint. This is done on the Blueprint Definitions Page. HTML Wrap |
---|
tag | span |
---|
class | product-navigation |
---|
| Confluence header → Gear icon Image Removed→ General Configuration → Blueprint Definitions |
Edit and save the JSON fileon different pages. Add substitution fields in places where content will be different in each use of the Live Blueprint.
In the JSON file, the On the Blueprint Definitions Page, click the 'download blueprints' button to retrieve the JSON file. Under the "PageBlueprints" array, add an object to define your blueprint. The fields are all the same for defining page blueprints Page Blueprints as they are for defining live blueprintsLive Blueprints, except for one: this is the "type" field. Be sure to set the value of "type" to "live" (note: the default value is "page"). Then save and upload the JSON file. For example: Code Block |
---|
| {
"name" : "Expert Profile",
"description" : "A liveLive blueprintBlueprint for generating a common-form Expert Profile.",
"spaceKey" : "LIVEBLUEPRINTS",
"pageTitle" : "Expert Profile Live Blueprint",
"blueprintFieldsBlueprintFields" : [ "expert-name", "username", "pillar-name", "phone-number", "geographic-location", "building-name", "expert-title" ],
"type" : "live"
}, |
Learn more about Accessing and Editing the JSON File. Upload the JSON fileOn the Blueprints Definition Page, click the "upload blueprints" button and upload your JSON File. Unless there is an error (common errors include missing a comma or quote), then you should receive a success message. The Blueprint Definitions Page will refresh to show that the new page blueprint of type 'Live' has been added. Reference the live blueprint
Reference the Live BlueprintNavigate Now navigate to, or create, a page where you want to use (AKA 'reference' or 'activate') this live blueprintthis Live Blueprint. Edit the page and insert the Live Blueprints Macro. Set the macro parameters HTML Wrap |
---|
| Image Added |
Click the Live Blueprint Macro and select "Edit". In the first parameter, include the name of the live blueprint Live Blueprint (this is the "name" field in your JSON file). You may also skip this parameter and point to the page title of the live blueprint, but it is more precise to use the blueprint name. For example, the "name" of the live blueprint in the code above is "Expert Profile" and the "page title" is "Expert Profile Live Blueprint". You may also add or change other parameter values now too. To learn more about these parameters, read about the Live Blueprint Macro Parameters and Key. Save the macro edit screen and then save the edit page screen. Add Read about the other Live Blueprint Macro Parameters. Save the macro edit screen.
Press the "x" key on the page to toggle block editing mode. Under where you placed the Live Blueprint Macro, you will see a button that says "Edit Blueprint". Click it. HTML Wrap |
---|
| Image Added |
A modal window opens that resembles the Blueprint Wizard screen. Type in your unique values for each of the substitution fields then click "Save". You can update these values at any time by repeating this step. HTML Wrap |
---|
| Image Added |
Or, add substitution field values in the Live Blueprint Macro bodyIf you don't have Theme Press installed, "Edit the Blueprint" and add values on the page, edit the page and enter the unique substitution field values into the body of the Live Blueprint Macro. Enter the substitution field name followed by an equals sign ("=") and then the value. Each substitution field gets a new line. For example, Code Block |
---|
| phone-number=(123) 555-1234
geographic-location=St. Louis
pillar-name=SB-13
building-name=Milligan-23
expert-title=System Analyst
expert-name=Jane Smith
username=jane.smith |
You can update these values at any time by editing this macro body. Save the edit page screen. Back on your Repeat as you see fitYou can insert the Live Blueprint Macro on the page as many times and in as many places as you see fit, each will have their own
|