Skip to end of banner
Go to start of banner

Quick start

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

Contents:

Overview

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

In this example, 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.

    scaffolding-template-setup-step1.png

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

  1. Choose Create New Template.

  2. Name the template Knowledge Base Article Template.

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

The Field Group settings appear with the available fields.

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

  • type in "Summary" above the Paragraph field

See Tips below on how to quickly insert paragraphs.

Below is the Summary paragraph

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

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

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

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

In the sidebar under Field Settings

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

  • Press enter to create a label

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

The label text is auto-saved

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

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

The end result will look something like this. 

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

  • Finally, to save the overall template. Choose Save at the top right corner.

Create a page

  • Create a new page.

  • Add a Live Template macro.

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

  • Specify the template name, Knowledge Base Article Template.

  • Choose Insert to continue.

  • Enter a page title.

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

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

  • Continue with the System and Version fields below

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

The Version field only allows you to enter numbers.


  • Fill in the rest of the fields as needed

  • Then choose Save Content

Your page will be displayed as below.

Update template

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

  • Edit the Field Group macro.

Let's change this page to demonstrate the benefits of using a Live Template.

We'll add a new text field and change some existing fields.

  • above the Summary section, add some contact information

  • in the 2x2 table below

    • change system to Operating system and

    • Version to Version affected

  • Choose Save to save the Field Group

  • Now Save again to save the template

  • Load the "fails with error 52" page again, or refresh the page


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

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

In the editor toolbar

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

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



  • No labels