View Source

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. You can also configure it to restrict the search results to the current space, rather than searching the entire Confluence site.

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.
Show/hide the left-hand panel: 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.
Alternatively, press '[' on your keyboard to show/hide the left-hand panel.
Overriding a space-restricted search: If your theme is configured to restrict the search to the current space, you can enter 'all:' and your search term to search the entire site.

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

On this page:

Related pages:

Using the Documentation theme

By default in a space that uses the Documentation theme, 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.

Diagram: The Documentation theme with default settings

A space administrator can customise the Documentation theme as follows:

Change the content in the left-hand panel and add a header and footer to the page. This means that your own pages may look different from the screenshot above.
Restrict the search so that it will show results from the current space only, not from the entire Confluence site.

Diagram: The Documentation theme with space-restricted search

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

Click the plus signs to open and close the branches of the page tree (table of contents) in the left-hand panel.
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.
Alternatively, press '[' on your keyboard to show/hide the left-hand panel.
Use the scroll bars to scroll the left-hand and right-hand panels independently of each other.
Search the content of the space or the site. See below.

Using the Documentation theme

Searching the space or the site

Hints and tips

Notes