Versions Compared

Key

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

Contents:

Table of Contents
minLevel1
maxLevel6
outlinefalse
typestyleflatnone
separatortypepipelist
printablefalsetrue

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.

...

The Field Group settings appears  appear with the available fields.

...

Tip

See Tips below on how to quickly insert paragraphs.

Below is the Summary paragraph

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

  • type Type in System and Version into the left-hand cells

...

Tip

See the Tips below on how to quickly insert a table.

  • select Select the empty cell on the right of the System.

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

Info

Alternatively, you can also type /dropdown and click on Dropdown List in the popup.

...

In the sidebar under Field Settings

  • 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 Select the empty cell on the right of Version to continue

...

Info

The label text is auto-saved

  • drag Drag and drop a Number field from the sidebar into the empty cell on the right of the Version.

  • add Add any other necessary fields like Diagnosis, Cause, and Solution

The end result will look something like this. 

...

  • choose Choose Save to save the Field Group. This will exit the Field Group settings menu.

  • Finally, to save the overall template

...

  • choose . Choose Save at the top right corner.

...

...

Create a page

  • create Create a new page.

  • add Add a Live Template macro.

Tip

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

  • specify Specify the template name, " Knowledge Base Article Template".

  • choose Choose Insert to continue.

...

  • enter Enter a page title.

  • choose Choose Publish to publish the page.

...

...

Add content

On the newly-published page, choose Edit Content.

...

...

Populate the fields accordingly

...

. 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.

  • continue Continue with the System and Version fields below

...

Info

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

The Version field only allows you to enter numbers.


  • fill Fill in the rest of the fields as needed

  • then Then choose Save Content

Your page will is be displayed as below.

...

...

Update template

  • go Go back to the "Knowledge Base Article Template" Template you created and edit it

  • edit Edit the Field Group macro.

...

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 a new text field and change some of the existing fields.

  • above the Summary section, add some contact information

  • in the 2x2 table below

    • change System system to Operating system and

    • and Version to Version affected

...

  • choose Choose Save to save the Field Group

  • then choose Now Save again to save the template

  • load Load the "fails with error 52" page again, or refresh the 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 can insert fields quickly by typing / and the beginning of a field name, e.g. /paragraph

Image Removed
Image Added

In the editor toolbar

  • you can insert a table by clicking on the Table icon

Image Removed
Image Added

Speed up macro entry with autocomplete

  • 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 the legacy editor

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

Image Removed
Image Added