On this page:
|
---|
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
...
Click Space Settings > Look and Feel > Templates.
...
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.
...
Choose Create New Template.
...
Name the template
...
Knowledge Base Article Template
...
In the template editor
...
.
Add a Scaffolding Field Group macro in the template editor.
...
The Field Group settings
...
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.
...
Tip |
---|
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.
...
Tip |
---|
See 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, 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
...
.
Info |
---|
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
...
choose Save at top right
...
field group.
Create a page
...
Create a new page
...
and add a Live Template macro.
Tip |
---|
See Tips below on another alternative to insert a macro quickly. |
...
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.
...
Info |
---|
This includes fonts, text color, lists, links, and more. |
...
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 in the rest of the fields as needed
...
then choose Save Content
Your page will is displayed as below.
...
Step 4 - Update template
...
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, 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
...
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 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 |
|
|
...
See also