Documentation for Confluence 5.4.
Documentation for Confluence OnDemand and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

This page is part of the guide to developing a knowledge base on Confluence Wiki. We have already shown you how to create your knowledge base space. Now we offer an introduction to the templates that Confluence provides, and show you some useful macros for formatting your content.

Quick guide to templates

A template is a page with predefined content that can be used as a prototype when creating other pages. Templates are available across the Confluence site (global templates) or per space (space templates).

Both 'global templates' and 'space templates', as described on this page, define the content of a page. They do not define the content of an entire space. To create a template for an entire space, see our guide to creating your documentation space.

You can import predefined page templates from the Atlassian Marketplace.

Space information design

One question that comes up is whether a knowledge base should be implemented as a decision matrix, with a multi-select or other list. We knew that most of our users visit our documentation directly from search engines. Early on, we learned from Google Analytics that most traffic was coming from search engines, not from within our site. So, we knew to focus on optimising page titles and tags rather than focus on a decision matrix.

On this page:

Page templates

Confluence's page templates are a good place to start. Begin by choosing how you want your templates to look. Here's the wiki markup for our page template:

 

Useful add-ons:

Content macros

Some favourite macros for formatting content are the Tip, Info, Warning, and Note Macros, and the Code macro. Try the Noformat Macro for ensuring plain text.

We also use Adaptavist's Content Formatting Macros when we really want to make our content look great.

JIRA Issues macro

Using JIRA for bug tracking? You can't expect your users to have exactly the right JQL filters to show the appropriate topics. We have some nice JIRA Issues macros on display. One of my favourites is in the JIRA KB's Causes for OutOfMemory Errors:

The JQL includes components and sorting, plus the specific columns.

Labels and macros

Sometimes an article needs to be cross listed. For that we label our articles. Some great macros to use for this are {contentbylabel}, {listlabels} and the {dynamiccontentbylabels} macro in the Content Survey add-on.

Next Steps

You now have a good idea of how Confluence templates work, and have seen some useful formatting macros. What next? Take a look at Proactive Communications in a Knowledge Base.

  • No labels

3 Comments

  1. Anonymous

    The link for Page Templates does not exist.

  2. Anonymous

    I am trying to filter content displayed on a page by a field specified in the template. It doesn't seem to work.  Any ideas?