Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Content Layer
namePage Info
id278129461
classwatermark-layer
Content Column
namePage Body
width100.00001%
id278129463
Content Block
background-colortransparent
namePrompt
id494677873
classtight manual-prompt-flex

Steps for creating a blueprint that maintains a persistent connection wherever it is used.

Content Block
nameOutcome
rich-link-hoverstrue
id1042866408
classtight manual-outcome-flex

Live Blueprints were introduced with Blueprint Maker 2.0+ and can be a sophisticated way to manage duplicate or similar content. Live Blueprints are particularly useful if you have a case where A) you want to re-use a common form of content (e.g. a table with similar headings but different values) and B) you want to be able to change that source form, from time to time, and ensure that these changes occur wherever the Blueprint is referenced.

present similarly-formed content while maintaining a connection to the source form. Use the steps below to create a blueprint Blueprint, designate define it as 'live' in the JSON fileFile, and then use the Live Blueprint Macro to embed or activate it reference the Blueprint where you see fit.

Determine your use-case

Live 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 change that source form, from time to time, and ensure that these changes occur wherever the Blueprint is referenced.
Content Block
nameSteps
rich-link-hoverstrue
id494842117
classsteps-block numbered manual-steps-flex

Create a

source Blueprint with your content 'form'

Page Blueprint 

Design the Blueprint 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. With this in mind, design the page with a mind towards how it will be used and reused in different places.

( Tip: Brikit typically recommends putting all of your site's Live Blueprint pages in one dedicated space (e.g. with space key of LIVEBLUEPRINTS). This makes it easy to find them again and also to manage permissions for the appropriate editors).

Add substitution fields

As with Page Blueprints and Space Blueprints, Live Blueprints can use on different pages. Add substitution fields in places where content will be different in each use of the blueprint. 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.<SCREENSHOT of the Live Blueprint Page. There is an example here (on Confluence 72 with some wonky styling though...): https://confluence72.brikit.com/display/BlueprintPages/Expert+Profile+Plus+Live+Blueprint>

Navigate to the Blueprint Definitions Page

Now that the source Blueprint has been drafted, it is time to 'define' it as a Blueprint. This is done on the Blueprint Definitions Page.  To access this page, do the following:

HTML Wrap
tagspan
classproduct-navigation

Confluence header Gear icon Image Removed→ General Configuration → Blueprint Definitions

Edit and save the JSON file


Access and Edit the JSON File

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 a new object to define your Blueprint. The fields are all the same for defining Page Blueprints as they are for defining Live 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
languagejs
		{
			"name"				: "Expert Profile",
			"description"		: "A Live Blueprint for generating a common-form Expert Profile.",
			"spaceKey"			: "LIVEBLUEPRINTS",
			"pageTitle"			: "Expert Profile Live Blueprint",
			"BlueprintFields"	: [ "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 file

On 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 a new Page Blueprint of type 'Live' has been added.


Reference the Live Blueprint

Now that the Blueprint has been created and defined, it's time to use it. Navigate to, or create, a page where you want to use (AKA 'reference' or 'activate') this Live Blueprint. Edit the page and insert the Live Blueprints Macro.

Set the macro parameters

HTML Wrap
classdocs-screenshot

Image Added

Click the Live Blueprint Macro and select "Edit". In the first parameter, include the name of the 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.

Add

 Read about the other Live Blueprint Macro Parameters. Save the macro edit screen.


If you have Theme Press, use the "Edit Blueprint" button

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
classdocs-screenshot

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
classdocs-screenshot

Image Added


Or, add substitution field values in the Live Blueprint Macro body

If 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
languagetext
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 fit

You 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


Content Block
nameNote
rich-link-hoverstrue
id495965127
classmanual-note-flex
collapsiblecollapse
Note

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the Steps block above to narrow the gap between the two blocks.
Content Block
nameTip
rich-link-hoverstrue
id894522670
classmanual-tip-flex
collapsiblecollapse
Tip

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Block
nameWarning
rich-link-hoverstrue
id894530759
classmanual-warning-flex
collapsiblecollapse
Warning

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Block
nameInfo
rich-link-hoverstrue
id894537203
classmanual-info-flex
collapsiblecollapse
Info

If using:

  1. Replace me with something to note about this how-to entry that falls outside the scope of all other sections; and
  2. Add the tight-bottom class to the next visible/non-collapsed block above this one to narrow the gap between the two blocks.
Content Layer
background-color$lightGrayColor
nameRelated
id888168050
Content Column
nameRelated
width100%
id888168051
Content Block
rich-links-hide-descriptiontrue
rich-link-hoverstrue
rich-links-columns4
rich-links-verticaltrue
rich-links-image-height100px
rich-links-hide-site-icontrue
rich-links-details-padding10px
nameRelated
rich-links-enabletrue
border-width0
rich-links-details-alignmentleft
rich-links-margin20px 30px 0 0
id496234544
classrelated-block clean manual-related-flex