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

How to create a blueprint at the page level.

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

HTML Wrap
classcallout

Prerequisites

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

of

consider

  • Consider the substitution fields you'll want to employ

  • make sure Brikit Blueprint Maker is installed and enabled
  • confirm you have administrative permissions
  •  

    Content Block
    nameSteps
    rich-link-hoverstrue
    id494842117
    classsteps-block numbered manual-steps-flex

    Create the page that will become a Page Blueprint

    A blueprint is the archetypical page, or template, from which all subsequent copies will be made. For example, suppose your organization's intranet will be publishing news articles. You don't want to have to create both the article content and the design of the page every time an article is needed. Instead, you can create a "news article" page blueprint which contains the standardized design of a news article. Then, when you need a news article, simply create it from this blueprint, and fill in the content unique to this article.

    Knowing that

    will become a blueprintDefine the blueprint in the pageBlueprints object in the json file
  • Name
  • this will be a "standard" for a type of page you want repeatedly created, the page blueprint should be designed accordingly. 

    Add substitution fields to the Page Blueprint

    One of the most powerful and valuable features of Blueprint Maker is the ability to use substitution fields. These are placeholders for content that is entered during the create from blueprint process.

    For example, on my news page blueprint, I may have an area where I want to have the article's author. Since the author may be different for each article, I'll want to substitute this information each time an article is created. Where I want this author name to appear, I can simply put [[author-name]]. When a user creates a page from this blueprint, they will be prompted to type in an Author Name. What they type will be inserted wherever [[author-name]] appeared in the page blueprint. 

    Navigate to the Blueprint Definitions Page and download the JSON File

    See Accessing and Editing the JSON File for instructions on how to download the file.

    In the JSON File, create a pageBlueprint object

    The pageBlueprint object defines some properties used to help guide users when creating a page from this blueprint.

    These properties include:

      1. Name (A human-readable name of the page blueprint)
      2. Description (Appears below the blueprint name in the Blueprint Menu)
      3. Space Key (
    Space Key:
      1. The key of the space where the page blueprint
    page
      1. resides)
      2. Page Title
    :
      1. Name of the blueprint page
      2. Blueprint Fields
    :
      1. (List of the substitution fields used in the blueprint
  • Both built-in and custom fields
    • Not required, but useful
  • Sets
      1. and sets the order the fields will appear
    in the Wizard
  • 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
      1. to the user creating the page from this Blueprint)
      2. Type (specifies whether it is a "page" or "live" blueprint, or if it should include children as a page "tree")

    Familiarize yourself with the JSON File Data Reference.

    In the JSON file, add and define your substitution fields

    In the same JSON file, you must define each of the substitution fields; again with helpful information to the users creating a page from this blueprint.

    For each substitution field, you must define the a "blueprintField" object with the following properties:

      1. ID (The unique ID for the field–that is, what is between the [[ ]] brackets in your page blueprint)

      2. Name (A human-readable name for the field)

      3. Required (

  • ID: A unique ID for the field

  • Name: A human-readable name

  • Required:
      1. A toggle for whether the field is required)

      2. Type

    :
      1. (Defines the display length of the field)

      2. Help Text

    :
      1. (Additional text to assist the user in filling out the field

    Appears
      1. - appears below the data-entry field in the

    blueprint wizard
      1. creation process)

      2. Placeholder

    : Default text in the field
      1. (Default text inside the field)

    Again, familiarize yourself with the JSON File Data Reference.

    Save and upload the JSON File

    See again Accessing and Editing the JSON File for how to upload the file.

    Create a page from this Blueprint

    1. In the appropriate space, click the 'Blueprints' button in the Confluence Header (not the 'Create' button). 
    2. Select the page blueprint you created
    3. You are now in the "Wizard" which walks you through entering the substitution fields (if there are any) and the creation of the page from this blueprint.
    4. Enter values for each of the substitution fields
    5. Click next
    6. Verify where you want this page created
    7. Click Create



    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