Confluence 3.5 : Configuring the Documentation Theme
This page last changed on Feb 24, 2011 by smaddox.
Screenshot above: A wiki page using the Documentation theme Applying the Documentation Theme to your SpaceYou 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. To apply a theme to a space:
Screenshot above: Applying a theme Applying the Documentation Theme to your SiteIf 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 ThemeThe theme works well without any customisation. If necessary, you can restrict the search to just one space, change the content of the left-hand navigation panel and add your own header and footer. To customise the Documentation theme:
Screenshot above: The 'Configure theme' option Screenshot above: Customising the Documentation theme Customising the Theme at Site LevelIf 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 ThemeScreenshot above: A customised header, footer and left-hand panel 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:
Availability of the ThemeConfluence VersionsThe 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. Hints and TipsBelow 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 contentsCause 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:
Cause 2: Problem with upgrade from Confluence 3.1, with Documentation theme as plugin, to Confluence 3.2 or later 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 disappearedIf your entire left-hand panel has disappeared when using the Documentation theme, this is probably because you have clicked the sidebar icon Hiding Pages from the Left-Hand Table of ContentsYou 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 PanelYou 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 PanelIf 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 LinksBy 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; } To edit a space's CSS style sheets:
Jumping to the Same Page in Another SpaceThe {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. RELATED TOPICSUsing the Documentation Theme Take me back to Confluence User's Guide ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
![]() |
Document generated by Confluence on Mar 16, 2011 18:18 |