Page tree

Page Blueprints

Last updated

Here's what you need to know about building Page Blueprints.

In the second array of the .json file, you define pairs that help users generate a page from a template. The last object in this array shows a complete list of key/value pairs.

The following table describes keys you define in a pageBlueprints object.

 KeyDescriptionNotes

namea name for the Blueprint template; appears in the Blueprints wizard when a user clicks the Blueprints buttonoptional; omit when title of Confluence page equals Blueprint name

descriptiona description for the Blueprint template; appears in the Blueprints wizard when a user click the Blueprints   button 

spaceKeya space holding the Blueprint page template 

pageTitlea Confluence page that acts as the Blueprint template 

blueprintFieldsa list of fields found on the Blueprint page templateoptional; use this key/value pair to order fields visible in the Blueprints wizard

includeChildren

a toggle for including or excluding the template's child pages:

  • true
  • false
 

visibility

a list of space categories in which to limit the appearance of the Blueprint template

 

Once you upload your .json definitions to Confluence, the Page Blueprints section in the Blueprint Definitions screen appears as such.

The following images show how the .json file maps to the Blueprints wizard.

First Screen

Second Screen

Third Screen

Still need help?