Quick start
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
Click Space Settings > Look and Feel > Templates.
You need space administrator permission to view all the features in the Space settings menu. Non-space admin users see a limited feature set.
Choose Create New Template.
Name the template Knowledge Base Article Template.
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 Summary above the Paragraph field.
See Tips below on how to quickly insert paragraphs.
Below the 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.
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, do the following:
Fill in the labels for the dropdown, for example, Mac OS X, Windows 10, Ubuntu, etc.
Press enter to create a label.
The label text is auto-saved
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.
Add any other necessary fields like Diagnosis, Cause, and Solution.
Click Insert to insert the Field Group in your template. This will exit the Field Group settings menu and save the field group.
Create a page
Create a new page and add a Live Template macro.
Specify the template name as Knowledge Base Article Template.
Choose Insert to continue.
Enter a page title.
Choose Publish to publish the page.
Add content
To add content to your live template, do the following:
On the newly-published page, click Edit Content on the macro.
Populate the fields accordingly. The Paragraph editor under Summary supports most of the features you would normally find in a standard Confluence Cloud editor.
Continue with the System and Version fields below.
The Version field only allows you to enter numbers.
Fill in the rest of the fields as needed and click Publish to save your data. The end result might look like shown in the image below:
Update template
Go back to the Knowledge Base Article Template you created and edit it.
Click the Edit icon to 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.
Tips
In the Scaffolding editor
| |
In the editor toolbar
| |
Speed up macro entry with autocomplete
|