Versions Compared

Key

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

On this page:

Table of Contents
minLevel1
maxLevel6
include
outlinefalse
indent
exclude
typelist
separatorbrackets
class
printabletrue

Overview

Here's a quick start guide to working with Scaffolding.

In this example, we're going you will learn to build a knowledge-base system consisting of a set of knowledge-base articles that would look like the following.

...

...

Set up the template

...

  1. Click Space Settings > Look and Feel > Templates.

...

  1. scaffolding-template-setup-step1.pngImage Added

Space You need space administrator permission is required to view all the features in the Space Settingssettings menu. Non-space admin users see a limited feature set.

...

  1. Choose Create New Template.

...

  1. Name the template

...

  1. Knowledge Base Article Template

...

In the template editor

...

  1. .

  2. Add a Scaffolding Field Group macro in the template editor.

...

  1. scaffolding-template-setup-2.pngImage Added

  2. The Field Group settings

...

  1.  appear with the available fields.

  • drag Drag and drop a Paragraph field from the sidebar into the editor area

  • type in "Type Summary" above the Paragraph field.

...

  • scaffolding-template-setup-3.pngImage Added

Tip

See Tips below on how to quickly insert paragraphs.

  1. Below the

...

  1. Summary paragraph, do the following:

    • Insert a 2x2 table to hold the System and Version fields

...

    • and enter System and Version into the left-hand cells.

...

Tip

See Tips below on how to quickly insert a table.

...

    • scaffolding-template-setup-4.pngImage Added
    • Select the empty cell on the right of the System

...

    • . Then drag and drop a Dropdown List field from the sidebar into the empty cell

...

    • .
      Alternatively, you can

...

    • type /dropdown and click on Dropdown List in the popup.

...

    • This creates a dropdown menu later.

      scaffolding-template-setup-5.pngImage Added
  1. In the sidebar under Field Settings, do the following:

  • fill Fill in the labels for the dropdown, for example, Mac OS X, Windows 10, Ubuntu, etc.

  • press Press enter to create a label

  • select the empty cell on the right of Version to continue

...

  • .

    scaffolding-template-setup-6.pngImage Added

Info

The label text is auto-saved

...

  1. To continue, select the empty cell to the right of Version. Then, drag and drop a Number field from the sidebar into the empty cell

...

  1. .

    scaffolding-template-setup-7.pngImage Added

  2. Add any other necessary fields like Diagnosis, Cause, and Solution

...

  1. .

...

...

  1. scaffolding-template-setup-8.pngImage Added

...

  1. Click Insert to

...

  1. insert the Field Group

...

  1. in your template. This will exit the Field Group settings menu

...

  1. and save the

...

  • choose Save at top right

...

  1. field group.

    scaffolding-template-setup-9.pngImage Added

Create a page

...

  1. Create a new page

...

  1. and add a Live Template macro.

    scaffolding-template-create-page-1.pngImage Added
Tip

See Tips below on another alternative to insert a macro quickly.

...

  1. Specify the template name

...

  1. as Knowledge Base Article Template

...

  1. .

...

  1. Choose Insert to continue.

...

  1. scaffolding-template-create-page-2.pngImage Added

...

  1. Enter a page title.

...

  1. Choose Publish to publish the page.

...

  1. scaffolding-template-create-page-3.pngImage Added

...

Add content

To add content to your live template, do the following:

  1. On the newly

...

  1. published page

...

  1. , click Edit Content on the macro.

...

    ...

    1. Populate the fields accordingly

    ...

    1. . The Paragraph editor under Summary supports most of the features you would normally find in a standard Confluence Cloud editor.

    ...

    Info

    This includes fonts, text color, lists, links, and more.

    ...

    1. Continue with the System and Version fields below.

    ...

    1. scaffolding-template-create-page-6.pngImage Added
    Info

    The System row now includes a dropdown menu which that allows you to pick from the labels you created earlier.

    1. The Version field only allows you to enter numbers.

    ...

    1. scaffolding-template-create-page-7.pngImage Added

    ...

    1. Fill in the rest of the fields as needed

    ...

    then choose Save Content

    Your page will is displayed as below.

    ...

    Step 4 - Update template

    ...

    1. and click Publish to save your data. The end result might look like shown in the image below:

      scaffolding-template-create-page-8.pngImage Added

    Update template

    1. Go back to the Knowledge Base Article Template you created and edit it.

    2. Click the Edit icon to edit the Field Group macro.

    ...

    1. scaffolding-template-update-page-1.pngImage Added

    Let's change this page to demonstrate the benefits of using a Live Template, let's make make some changes to this page.We'll add

    • Add a new text field and change some

    ...

    • existing fields.

    • Add any contact information above the Summary section, add some contact informationin .

    • In the 2x2 table below

      • change Change System to Operating system and

      • and Version to Version affected

    ...

      • scaffolding-template-live-template-1.pngImage Added

    • choose Choose Save to save the Field Group.

    • then choose Save again Click Save on the page again to save the template.

    • load the "Open and refresh the “Page export fails with error 52" page again, or refresh the page

    ...

    • 52” page.

    ...

    The changes you made to the template are now automatically reflected on the "Page export fails with error 52" page , without you having to edit that specific page.

    Info

    This allows you to manage tens or even hundreds of pages easily by just applying changes to the template.

    Tips

    In the Scaffolding editor

    you

    You can insert fields quickly by typing / and the beginning of a field name, e.g., /paragraph.

    Image Removed
    scaffolding-tip1.pngImage Added

    In the editor toolbar

    you

    You can insert a table by clicking on the Table icon.

    Image Removed
    scaffolding-tip2.pngImage Added

    Speed up macro entry with autocomplete

    in
    • In the new editor

      • type / and the beginning of an element (tool or things in the insert menu) to see a list of suggestions.

    in
    • In the legacy editor

      • type { and the beginning of the macro name to see a list of suggested macros.

    Image Removed
    scaffolding-tip3.pngImage Added

    ...

    See also