This page last changed on Mar 23, 2010 by smaddox.

The Documentation theme is one of the themes bundled with Confluence. It provides an inbuilt table of contents for your wiki space, a configurable header and footer, and text styles suited to documentation.

This page tells you how to view pages in your Confluence space when your space uses the Documentation theme. For the full list of features and instructions on applying the theme to a space, see the guide to configuring the Documentation theme.

Quick guide to using the Documentation theme
  • The left-hand panel contains a page tree. This is a table of contents that shows the pages in the space.
  • Click the plus signs in the page tree to see the child pages.
  • Drag the thick vertical bar to change the width of the panels.
  • Click the sidebar icon at top right, next to the search box, to remove the left-hand panel altogether. Click the icon again to restore the panel.

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

On this page:

Using the Documentation Theme

Screenshot: A page in a space that uses the Documentation theme

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.

A space administrator can change the content in the left-hand panel and can also add a header and footer to the page. This means that your own pages may look different from the screenshot above. See Configuring the Documentation Theme.

Here is a summary of the things you can do on a page that uses the Documentation theme:

  • Drag the thick bar between the left-hand panel and the content, to increase or decrease the width of the panel.
  • Click the sidebar icon at top right, next to the search box, to remove the left-hand panel. This will remove the panel for you only. Other people will still see it.
  • Click the sidebar icon again to restore the left-hand panel.
  • Use the scroll bars to scroll the left-hand and right-hand panels independently of each other.

Supported Browsers

The Documentation theme supports the following browsers:

  • Firefox
  • Safari
  • Internet Explorer 7 and later

Hints and Tips

Below are some hints that you may find useful when using the Documentation theme.

Where can I see a working example of the Documentation theme?

The Confluence documentation uses the Documentation theme. If you are reading this documentation online on the Atlassian documentation wiki, you are seeing a working version of the Documentation theme.

Which pages will appear in the Documentation theme's table of contents?

The theme constructs the page tree in the left-hand panel from all pages that are child pages of the space’s home page. Each space has a single page designated as the 'Home' page. You can specify the home page in the space administration section.

Help, my pages do not appear in the Documentation theme table of contents

Cause 1: Your pages are not under the space's home page. The most probable reason why your pages do not appear in the page tree in the left-hand panel is this: The theme constructs that table of contents from all pages that are child pages of the space’s home page. If your pages are above the home page in the page tree, they will not appear in the left-hand panel.

There are two ways to fix the problem:

  • You can change the designated space home page in the space administration section.
  • Or you can drag and drop all your pages to make them children of the current home page. You can drag and drop pages in the 'Pages' section of the space 'Browse' screen. See Moving Pages within a Space.

Cause 2: Problem with upgrade from Confluence 3.1, with Documentation theme as plugin, to Confluence 3.2 with Documentation theme bundled. If your existing Confluence installation already has the Documentation theme plugin installed, you may find that after upgrading to Confluence 3.2 the left-hand navigation bar is empty in the spaces that use the theme. The fix is to enable all modules of the Documentation theme plugin. See the knowledge base article.

Help, my left-hand panel has disappeared

If your entire left-hand panel has disappeared when using the Documentation theme, this is probably because you have clicked the sidebar icon at top right, next to the search box. Click the icon again to restore the panel.

RELATED TOPICS

Configuring the Documentation Theme
Space Jump Macro

Take me back to the Confluence User's Guide


DocTheme.png (image/png)
Documentation Theme (text/xml)
Documentation Theme (application/octet-stream)
DocTheme4.jpg (image/jpeg)
Documentation Theme (application/octet-stream)
DocTheme4.jpg (image/jpeg)
Documentation Theme (application/octet-stream)
Documentation Theme (application/octet-stream)
Documentation Theme (application/octet-stream)
Documentation Theme (application/octet-stream)
Document generated by Confluence on Jul 09, 2010 01:08