View Source

The Documentation theme is one of the themes bundled with Confluence. (See availability below). The theme is designed for spaces containing technical documentation, but you may find it useful for other types of content too. It provides an inbuilt table of contents for your wiki space, a configurable header and footer, and text styles suited to documentation. (See features below.)

Go to 'Space Admin' and click 'Themes'.
Select 'Documentation Theme' and click 'Confirm'.
If you want to customise the theme, click 'Configure theme' and enter the text and wiki markup for your custom header, footer and left-hand panel. Click 'Save'.

The rest of this page gives more details of the above procedure.

On this page:

Screenshot: A wiki page using the Documentation theme

Confluence 3.2 > Configuring the Documentation Theme > DocTheme.png

Applying the Documentation Theme to your Space

You need space administrator permissions to apply a theme to a space.

Follow the steps below to apply the 'Documentation Theme' to your space. All pages in the space will start using the theme immediately.

If you have site administrator permissions, you can apply the theme at site level. It will then be the default theme for all spaces in the site. See the administrator's guide to applying a theme.

Customising the Documentation Theme

The theme works well without any customisation. If necessary, you can change the left-hand navigation panel and add your own header and footer.

To customise the Documentation theme,

Click 'Themes' in the left-hand panel under the heading 'Look and Feel'.
If the space is not yet using the Documentation theme, apply the theme as described above.
Click 'Configure theme' in the yellow area of the 'Current Theme' section at the top of the page. See screenshot below.
The 'Documentation Theme Configuration' screen appears. See screenshot below.
Select or deselect the 'Page Tree' check box. This determines whether your space will display the default search box and table of contents (page tree) in the left-hand panel.
Enter text, images, macros and other wiki markup into any or all of the three text boxes.
You can use the Include or Excerpt Include to include re-usable content into your footer. See hint below.
- 'Navigation' – This text box contains content for the left-hand panel. If the 'Page Tree' check box is selected, the navigation panel contains the default search box and page tree. Any content you enter into the 'Navigation' text box will appear above the page tree and search box.
  You can include your own content underneath the page tree as well as above. See hint below. In summary: Deselect the 'Page Tree' check box. Insert your own page tree using the Pagetree macro, then add your own content under the macro.
- 'Header' – This text box contains content for a page header that will appear above the page title on all pages in the space. See example screenshot below.
- 'Footer' – This text box contains content for a page footer that will appear after the comments and above the site footer, on all pages in the space. See example screenshot below.
Click 'Save'.

Screenshot: The 'Configure theme' option

Confluence 3.2 > Configuring the Documentation Theme > DocThemeConfigOption.png

Screenshot: Customising the Documentation theme

Confluence 3.2 > Configuring the Documentation Theme > DocThemeConfig.png

If you have site administrator permissions, you can apply and customise the theme at site level. The customisation options are the same as the space level options, as described above.

Features of the Documentation Theme

Screenshot: A customised header, footer and left-hand panel

{gliffy:name=Customised Documentation Theme|align=left|size=L}

The above screenshot shows a wiki space with a customised left-hand panel, header and footer.

Here is a summary of the features that the Documentation theme provides:

By default, the left-hand panel contains a search box and a table of contents (page tree) showing all the pages in your space. Specifically, it shows the pages that are children of the space's home page.
The left-hand panel is fully customisable. You can choose to include or exclude the search box and page tree. You can enter your own text, images and wiki markup.
People viewing the page can drag the thick bar between the left-hand panel and the content, to increase or decrease the width of the panel. They can also remove the panel altogether, by clicking the sidebar icon at top right, next to the search box.
The left-hand and right-hand panels scroll independently of each other.
The page title is neatly above the page content, and not uncomfortably above the navigation panel as tends to happen when you insert the navigation panel yourself.
Because the left-hand panel is part of the theme, it will be upgraded whenever Confluence is upgraded. There is no need to remove and then re-apply your customisations on each upgrade, as you would do if you added your own left-hand navigation bar.
The theme also provides a customisable header and footer, which will appear at the top and bottom of every page.
The text and heading styles are designed to enhance the content typically found in a documentation space.
You can use the Space Jump macro to link from a page in one wiki space to a page with the same name in another space, without knowing the name of the page when you create the link.

Availability of the Theme

Confluence Versions

The Documentation theme is bundled with Confluence 3.2 and later. If you have Confluence 3.1, your Confluence Administrator can download the theme from the Atlassian Plugin Exchange and install it as a plugin.

The theme is not available for versions of Confluence earlier than Confluence 3.1.

Browsers

Hints and Tips

Hiding Pages from the Left-Hand Table of Contents

You can 'hide' pages by putting them at the same level as or higher than the space home page.

Each space has a single page designated as the 'Home' page. You can specify the home page in the space administration section.

The theme constructs the page tree in the left-hand panel from all pages that are child pages of the space’s home page.

If your documentation pages are at the same level as the space home page, they will not appear in the left-hand navigation bar. So you can 'hide' pages by putting them at the same level as or higher than the space home page. The pages will show up in the search results and people can see the content if they open the page, but the pages will not appear in the left-hand panel.

More detail: The theme uses the Pagetree macro to produce the table of contents. When entering the Pagetree macro, you can choose the top page in the page tree. The Documentation theme chooses the space home page as the top page.

Using reusable Content in your Header, Footer or Left-Hand Panel

You can use any text or wiki markup in your theme header, footer or left-hand panel. One useful hint is to use the Include or Excerpt Include to include re-usable content into your footer.

The screenshot above shows the theme customisation options, with examples of the macros used to include content from other pages. And the example screenshot also above shows the resulting header, footer and left-hand panel.

Adding Content Below the Page Tree in your Left-Hand Panel

If you want to include your own content underneath the page tree, you can deselect the 'Page Tree' check box, add your own page tree using the Pagetree macro in the 'Navigation' text box, and then add your own content under the macro.

The screenshot above shows the theme customisation options, with the default page tree deselected and a custom page tree inserted, along with additional content in the left-hand panel. The example screenshot also above shows the resulting left-hand panel.

Adding Underlines to your Links

By default, the Documentation theme does not underline hyperlinks. If you prefer to have your links underlined, you can edit the CSS stylesheet for your space and add the following CSS code:

.wiki-content a:link, .wiki-content a:visited, .wiki-content a:active {
    text-decoration: underline;
}

Jumping to the Same Page in Another Space

The {spacejump} macro is provided along with the Documentation theme. You can use space jumping to link from a page in one wiki space to a page with the same name in another space, without knowing the name of the page when you create the link. When a reader is viewing a page and clicks the link provided by the macro, they will go to a page with the same name, but in the space specified in the macro. See more about the Space Jump macro.