Documentation for Confluence 5.5.
Documentation for Confluence Cloud and earlier versions of Confluence is available too.

Skip to end of metadata
Go to start of metadata

The Documentation theme is one of the themes bundled with Confluence.

Advance warning of plans to merge Documentation theme with the default theme

Icon

This is an advance notice that we plan to merge the functionality of the Confluence Documentation theme with the Confluence default theme. We do not yet have a specific date for this plan, and we are interested in your feedback. The new default theme, introduced with Confluence 5.0, includes a sidebar with contextual navigation. Our plan is to include features from the Documentation theme in the default theme, and then remove the Documentation theme from Confluence.

If you are interested in this change and would like to give us feedback, please add a comment on this blog post: Advance warning of plans to merge Documentation theme with the default theme. We are especially interested to know which features of the Documentation theme you use and value the most.

The Documentation theme is designed for spaces containing technical documentation, but you may find it useful for other types of structured content. It provides a table of contents for your space, a configurable header and footer, and text styles suited to documentation. (See features below.)

Quick guide to applying and customising the Documentation theme:

  • Go to the space and choose Space tools > Look and Feel on the sidebar.
  • Choose Themes.
  • Select Documentation Theme and choose Confirm.
  • If you want to customise the theme, choose Configure theme.
    • Select or deselect the default page tree.
    • Select or deselect the space-restricted search.
    • Enter the text and wiki markup for your custom left-hand panel header and footer.
    • Choose Save.

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

Screenshot: The Documentation theme showing the space sidebar replaced by a navigation sidebar.

Applying the Documentation theme to your 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:

  1. Go to the space and choose Space tools > Look and Feel on the sidebar.
    You'll need Space Admin permissions to do this. 
  2. Choose Themes and select a theme option.
  3. Choose Confirm

    Screenshot: Applying a theme

If your space is using the Documentation theme:

  1. Choose Browse > Space Admin at the top of the screen.
    Note: The 'Space Admin' option appears only if you are a space administrator for the space or you are a super user (a member of the confluence-administrators group).
  2. Choose Themes from the space administration options
  3. Select a theme option.
  4. Choose Confirm.

Applying the Documentation theme to your site

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 restrict the search to just one space, change the content of the left-hand navigation panel and add your own header and footer. The following instructions assume you have already applied the Documentation theme.

To customise the Documentation theme:

  1. Choose Browse > Space Admin at the top of the screen.
    Note: The 'Space Admin' option appears only if you are a space administrator for the space or you are a super user (a member of the confluence-administrators group).
  2. Choose Themes in the left-hand panel under the heading 'Look and Feel'.
  3. Choose 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.
  4. 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.
  5. Select or deselect the Limit search results to the current space check box.
    • If you select the check box:
      • The Confluence search will look for matches only in the current space by default. Users can override this restriction when entering their search term. See Using the Documentation Theme.
      • The default page tree in the left-hand panel will not include a search box.
    • If you do not select the check box:
      • The Confluence search will look for matches in the entire Confluence site. This is the default behaviour for other themes too.
      • The default page tree in the left-hand panel will include a search box, which restricts search results to the current space.
  6. Enter text, images, macros and other wiki markup into any or all of the three text boxes.
    (info) 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.
  7. Choose Save.

Screenshot: The 'Configure theme' option



Screenshot: Customising the Documentation theme


Customising the theme at site level

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 Zoom Zoom Customised Documentation Theme


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.
  • You can limit the Confluence search results to the current space. If you choose this option, the Confluence search will look for matches only in the current space by default. Users can override the restriction. See Using the Documentation Theme.

 

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 a Page.

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 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.

Can I change the default width of the left-hand navigation panel?

The Confluence user interface does not offer a way to change the default width of the left-hand navigation panel supplied by the Documentation theme. Users can change the width by dragging the middle bar, but the default width is not configurable. This post on Atlassian Answers gives a way to do it with CSS: Documentation Theme - Default Width (in px) of left panel.

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 sidebar

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 sidebar

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 an expanding All Versions section to the sidebar

If you want to include a an expanding list of links to other spaces, as we have included in this space (see 'Docs for all Confluence releases' in the sidebar), you can use an Expand Macro and an Include Page Macro in the 'Navigation' text box.   For example:

*[Docs for all Confluence releases|_Latest Versions of Confluence Documentation]*
{expand:Choose a version...}
{include:_Latest Versions of Confluence Documentation}
{expand}

If you would like this to display below the page tree, follow the steps above.

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;
}

To edit a space's CSS style sheets:

  1. Go to the space and choose Space tools > Look and Feel on the sidebar.
  2. Choose Stylesheet then Edit.
  3. Paste your custom CSS into the text field.
  4. Save your changes. The new CSS will be visible on all content pages in the space.

If your space uses the Documentation theme:

  1. Choose Browse > Space Admin at the top of the screen.
    Note: The 'Space Admin' option appears only if you are a space administrator for the space or you are a super user (a member of the confluence-administrators group).
  2. Click Stylesheet in the left-hand panel under the heading 'Look and Feel'.
  3. Choose  Edit.
  4. Paste your custom CSS into the text field.
  5. Save your changes. The new CSS will be visible on all content pages in the space.

Notes:

  • You need system administrator permissions to edit the CSS for a space or for the site.
  • This function is turned off by default. To turn it on, go to  > General Configuration > Security Configuration and choose Custom Stylesheets for Spaces.

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 chooses 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.

Hiding the left-hand panel completely

It's not possible to remove the left-hand panel entirely, using the user interface supplied by the theme. There is an improvement request here: CONF-25923 - Provide option to hide the left-hand panel entirely in the Documentation theme Resolved If you like, you can comment on and/or vote for that request. In the meantime, Atlassian Answers is a good place to ask the question and see if other people can help you with custom code to remove the panel.

Notes

  • The Confluence default theme supplies a sidebar, which is different to the left-hand panel in the Documentation theme. For information about the sidebar, see Finding Content and Configuring a Sidebar.
  • The Documentation theme supplies a Browse menu in the Confluence header, which gives access to the space administration and advanced options.

78 Comments

  1. How do we go about:

    • Removing Children from displaying on pages as default
    • Adding
      to bottom of each page by default

    I've tried editing /home/confluence/confluence-3.2-std/confluence/decorators/page.vmd with no success

    1. Hi Mark,

      I have a mere suggestion, you might want to try to edit the Global Page Layouts via Confluence Admin >> Layouts >> Page Layout. Now try to find the following code:

      Replace the above code with the following code:

      NOTE: This will only work for default theme.

      Hope that helps.
      Cheers,
      Zed

      1. Anonymous

        Hi Zed,

        Do you have any idea of how to achieve this on Documentation theme ?

        thank you,

        Alain

        1. Hi Alain,

          I have a mere suggestion, you might want to try the code below in the Documentation Theme via Space admin >> Themes >> Documentation theme >> Configure Theme. Please place the code shown below in the Header:

          NOTE: Please make sure the HTML macro is enable

          Then place the following code at the Footer section:

          After the configuration, please save the changes.

          Hope that helps.
          Cheers,
          Zed

          1. This worked well for me, thank you.
            Please note that the html macro must be enabled inside of Plugins|Installed Plugins|Confluence HTML Macros

            The attachments are showing up but all the way in the left of page with no margin. Where should I play with css to put some padding in there?

          2. Anonymous

            I like to use the documentation theme for my personal space, but don't like to use one third of the space to the personal info sidebar. Using the tip above i managed to remove the information in the sidebar ("personal-info-sidebar" instead of "children-section"), but this just resulted in the rightmost third of the page being empty. 

            Is there a way to remove the personal info sidebar if I use the documentation theme for my personal space? Removing it when I use global look and feel theme works well, but you can't configure the layout when using the documentation theme.

            Btw - thanks for a great product, makes my job of introducing it in the organization easy (or at least a bit easier ;-))

            Ole

          3. Anonymous

            You are a gentleman and a scholar, sir!

  2. Looking at firebug, it looks like the splitter.css comes before the custom space css.

    Splitter.css seems to be preventing me from setting the font size for h2 to 1em (line 70)

    Am I missing something? Or does the splitter.css prevent me from using the space custom stylesheet?

    1. Anonymous

      Similar issue here, trying to customize the h4 style and the splitter.css is taking precedence - a bit frustrating

  3. Anonymous

    If I click a level 1 page link the level 2 pages won't expand until I also press the '+' graphic next to it.

    Is there a way to click the level 1 page link and automatically expand to show the level 2 page at the same time (so only 1 click is necessary).

    E.g.

    1) At the moment - user clicks 'cheese' and navigation doesn't change

    + cheese

    2) Desired - user clicks cheese and level 2 shows

    + cheese

       -the history of cheese

       -why cheese is great

    Any ideas would be appreciated

    1. I am afraid that this will require some changes to the code base of the Pagetree macro. If you are interested, feel free to cast your vote for this feature request. Also, see Implementation of New Features Policy. Hope that helps.

  4. This theme has slightly changed from 3.2 to 3.3 when displayed in Firefox.  There is slightly more vertical space in between each item in the navigation tree in 3.3 than there is in 3.2.  I tested this with the very latest Firefox with no plugins.

    However, in Internet Explorer, the vertical space between items remains the same in 3.3 as it was in 3.2.

    I also tested this on my own site and on this site.

    If I had to guess, I'd say there is about 12% more vertical space than before.

  5. Can you change the default width of the sidebar?

    1. Someone please answer this questions. I have having page layout issues because the sidebar default is too wide for small screens. I need to fix the width of the sidebar.

      1. Anonymous

        I have the same problem. Can anyone answer it?

    2. I managed to nail it by placing this in "Footer" block of theme configuration:

      but make sure you have {html} macro enabled in system admin->plugins

  6. We are using the Documentation theme and Confluence 3.1. I need to add a new style to our style sheet. I tried adding it to the space stylesheet but the new style didn;t get picked up (I use Chrome and inspect the element). it didn't work--it still shows the text as being wiki-content p.

    I tried adding it to the Custom HTML (which affects our site, globally--I would prefer to avoid using this method).

    As we are using the documentation theme, does the new style need to be declared somewhere else, such as in splitter.css?   (We are hosted instance, so I do not have direct access to splitter.css.)

    Or perhaps we need to restart our instance in order to see the new style, as someone suggested elsewhere.

    This is the style. Maybe I just have a typo in there somewhere. 

     .wiki-content steph {

    font-family : "Verdana", Verdana, sans-serif;
    font-size : 11px;
    font-weight : bold;
    line-height:1.2em;
    color:red;
    text-align:left;
    }
    I'd appreciate someone's help on this!

    Thanks,

    Susan

    1. I found that I had to include an ID

      #com-atlassian-confluence .wiki-content h1 {  
      font-size: 120%;  
      padding-top: 10px;  
      padding-bottom: 8px;  

  7. Just had a problem in IE9.  Guess you don't support it yet.  In my hosted instance of Confluence 3.5 the operations menu (Edit Share Add Tools) won't float properly.  The page width seems to be locked so the content won't reform if you make the window smaller.  I tried it with IE8, Firefox and Chrome and they were all OK.  

    At first I blamed the documentation theme, but I tried other themes and they had the problem too.

    I also noticed that the Confluence User Manual was OK in IE9.  Why is it OK for you and not for us?

    1. IE 9 has a feature called Compatibility Mode. Compatibility mode puts an IE7 user agent string in the HTTP headers, and forces IE9 to render pages in IE7 mode, which means old DOM, CSS, and JavaScript support. In IE 9, the setting Compatibility mode for intranet sites is enabled by default (yay!).

      You can turn this "feature" off from the tools menu, or probably via group policy for all your users, but talk with your admin folks. The whole reason this feature exists is so that new versions of IE don't break homegrown apps that are written to be browser specific. 

  8. Anonymous

    Why does confluence add a large gap whenever you press the return key. (double line spacing?)

    how do I make this single line spacing ie. just a <br>, as this very line should be close to the line above, yet confluence is treating it like <br><br> and adding a big gap? If I want a big gap I should be able to press return twice like I would do in any other editor - eg. textpad/microsoft outlook etc..

    I understand I'll need to change the css but what do I do to it to please?

    1. Anonymous

      Ok, Ive worked out I have to press shift and return to get a <br> rather than a <p>, but is there some way of making it so the return key does a <br> instead of a <p>?

      1. I'm trying to set <br> as default as well, can't believe there is no default setting available for line spacing.

        was told I would have to create a CSS style, but that slows down the site noticeably......

        don't have this problem when using MediaWiki

         

  9. After we upgraded to 4.1, all hyperlinks in our space using the Documentation theme are now underlined. We have not customized this theme at all. Did the defaults change?

    The section "Adding Underlines to your Links" on this page suggests that we can turn link underlines on by using a space "Stylesheet". It seems like we now need instructions on how to turn the underlines off. Also, I do not see a "Stylesheets" link under the "Look & Feel" heading on my Space Admin page. I don't see it in the screenshot on this page, either, so I am guessing that this feature is no longer available.

    So how do I turn off link underlines in 4.1?

    1. Hallo Rich

      Here's a partial answer to your questions: In Confluence 4.1, you need system administrator permissions to edit the space stylesheets. That's probably why you can't see the option. That said, the documentation does not mention this fact, which implies that it's a change in a recent version of Confluence.

      I will ask the Confluence team these two questions, and get back to you:

      • Did we add underlines to the links in the Documentation theme, in Confluence 4.1?
      • Did we change the permissions for the space CSS stylesheets in Confluence 4.1?

      Cheers, Sarah

    2. Hallo again Rich

      I've confirmed the fact that you need system administrator permissions to see the "Stylesheet" option, and have updated the page with that information plus the fact that the CSS stylesheet option is disabled by default. The point about the permission is not new. My apologies that the documentation was incorrect on this point.

      What's more, you have uncovered a bug. Evidently in Confluence 4.0, we broke the styling of links in the Documentation theme. They should not be underlined by default, but they are. We have raised the bug here: https://jira.atlassian.com/browse/CONF-24543

      To remove the underlines, you can change "text-decoration: underline;" to "text-decoration: none;" in the above CSS.

      Cheers, Sarah

       

      1. Great, thanks for the follow up. We will update our stylesheet as a workaround and look for the bug fix.

  10. Hello,

    with Confluence 3.5.13 we were able to use the TOC Makro with options in the sidebar of the doc theme
    like:

    After updating to Confluence 4.1.7 the Makro won't be displayed unless we remove all options from toc. How can I get the old behavior back?

  11. I like the Documentation Theme, thanks for it.

    I have two questions:

    a.) If I insert text in the navigation, the text appears before the page tree. How can I revers this?

    b.) Can I add Macros in to the navigation bar? 

    I'd like the latest page changes and latest comments to be shown there, but couldn't find a way to insert the macro (using { doesn't automatically provide the overview of macros). Maybe there is a much better way, so any tip would be highly appreciated.

    1. For b), yes.  

      For a)

      1. Un-check the "show pagetree" checkbox in theme config.
      2. Add your text. (it will not inherit standard page styles as I recall) 
      3. Add \{pagetree} or \{pagetreesearch} after your text.

      I don't really understand the last question. Are you saying that you type a "{" char and want the macro editor to pop up and guide you through it? If that's what you're after, it's not going to happen because you aren't in a page edit context. You are in the admin context. In other words, the regular wiki page rich text editing facilities aren't there because you aren't editing a wiki page. You need to use regular macro markup for the whole macro. The doc page for each macro has section describing the syntax to use along with examples. 

  12. I have seen this question several times on this thread but no answer from Atlassian folks:

    I have designed an extensive internal training site using the Documentation Theme.

    I do not want ppl to see the Tree View in the left nav.

    Is it possible to disable the left nav for a given space?

    When I configure the theme  to Disable Page Tree, I would think that would make the View Left Nav icon disappear for individuals viewing the site, because if they open that left nav, they get a yawning chasm of nothing.

    My hope is that the setting I want is not exposed to me since my perms in Confluence are restricted to Space admin.

    Can someone please explain this? Do I need to cook up some custom CSS just to make this feature work correctly?

     

    1. Hallo Matthew

      It's not possible to remove the left-hand panel entirely, using the user interface supplied by the theme. I've raised the improvement request here: CONF-25923 - Provide option to hide the left-hand panel entirely in the Documentation theme Resolved

      If you like, you can comment on and/or vote for that request.

      In the meantime, Atlassian Answers is a good place to ask the question and see if other people can help you with concocting the CSS or other code for removing the panel.

      I hope this helps. (smile)

      Cheers

      Sarah

       

       

      1. Thanks for the reply. Nother question: If I change themes on a site I built using the Documentation Theme, that will disable the left nav, right? My hesitation is that I don't know what other aspects of the space will be changed.... And if I switch themes and then switch back, is that going to permanently destroy any settings?

         

  13. I would like the pagetree and pagetreesearch macro's to look the same as the Page Title you can configure in the Documentation Theme.
    In the 'included' Page Title, the search bar is more to the right then in the pagetreesearch macro. 

    What should i do to customize the lay-out?

  14. In Documentation Theme, we wanted a way to choose the space home page in the nav column (i.e. in addition to the banner ribbon link) and without exposing all other pages we've got at the same hierarchical level as the home page.  So in the theme configuration's "Navigation" box, in addition to our global navigation header, we added a space-specific link as shown, where TR is the spacekey for the Technical Reference space.

  15. Using the Documentation Theme, I need to add a line break after the logo so the page title starts always in a new line (at least in "view page" mode).

    Why? Because logos are often too large.

    There is an approach/solution for the Confluence default theme - check here on answers.atlassian.com - but unfortunately this does not work for the Documentation Theme (sad)

    Any help would be appreciated to adapt this approach for the Documentation theme.

    1. Anonymous

      -AM- ,

      Have you got an answer for this?

      Thanks,

      Vishali

  16. Anonymous

    Hello,

    after the last update of the ondemand version, the page tree in the left sidebar (part of the documentation theme) disappears a few minutes after logging in, even if I do not work in the browser at that moment. Making it reappear is next to impossible, because the sidebar icon  is no longer available. This is reproducable with quite a few browsers (IE 9, Safari, Chrome, Firefox, all latest versions).

    Regards
    Jimbo 

     

    1. Anonymous

      I am getting the same issues It works fine for me in IE 9,but FireFox and Chrome it no longer shows the Sidebar icon. so I can't restore the nav bar. Also it does not work with the hot key.

       

       

      1. Anyone know how to fix this? After upgrading our Sidebar icon has now disappeared as well.

         


         

  17. Anonymous

     

    How do i get the left hand side to auto expand as per your own set up?

     

    Thanks

    AB

  18. Since Confluence 5, My global CSS settings (that I have been set on admin custom html) do not apply on the documentation theme page, but works on any other Confluence page or other themes...

    Any idea why ?

     

    Thanks.

  19. Anonymous

    The documentation theme works very well and is our default theme. The question I have is how to disable the Global Look and Feel theme in Confluence 5 so it can not be used. Not being able to hide the left side bar is irritating as is hiding where in the page hierarchy the current page is. Neither the minimised more nor the full mode of the Global Look and Feel theme are useful for page navigation. Why is there a 'Create child page' on the navigation bar. Why is the Configure sidebar link always shown.. in the sidebar. Surely this should be a space option located under a menu elsewhere. In the same vein, space tools are in the side bar instead of under the Administration menu, another wtf. Do we really need to have this in a space administrator's face all of the time when the sidebar is opened? Are version 5 users having such a hard time finding these options that they have to be constantly displayed?

    If Atlassian is serious about removing the Documentation Theme as part of the default install then at least they can create a Documentation Theme which can be downloaded from the Space Administration Look and Feel Theme tab.  

  20. Anonymous

    About merging default and documentation theme. In our opinion and use-cases it will be very useful^ new def theme looks lovely, but we are in need of a little bit more functionality (from doc theme) - table of context.

  21. Anonymous

    Hello, I've got a question concerning the left sidebar in the Documentation Theme.

    If I want to see the child pages of one page I have to click on the little arrow ">". But this is a roundabout way. Why can't the childpages be opened by clicking on the whole page-name.

    Looking forward to any solutions!

    Thanks in advance.

    1. Hi anonymous, 

      You are correct, showing and hiding children is triggered by the arrow icons not the page titles in the documentation theme. 

      If you are using Confluence 5.2 or are an OnDemand customer, you might want to look at the sidebar in the default theme, which now allows you to show the page tree, and does show the child pages when you click the page title. There is more information on configuring the sidebar in the default theme on this page - Configuring a Sidebar.

      If you are using other features provided by the Documentation theme and do not want to switch to the default theme, you might want to your feedback to this page - Advance warning of plans to merge Documentation theme with the default theme

      Hope this helps, Rachel. 

  22. Anonymous

    Hey Rachel, thanks a lot for your answer!

    Yes, we are using 5.2 but what we do not like about the default theme is the fact that you can not see whether a page has a child page. I first have to click on it to see whether the page opens or child pages. And because of this incomplete pagetree we prefer to use the Documentation Theme to see the entire tree. Or do you know another solution for this?

    I'm very excited if the planned merge will bring some helpful progresses and when.

    Best regards!

    1. Hi anonymous, the default theme also has arrows to indicate where there are child pages, and a circle or dot to indicate where there are no child pages. See example below from one of my spaces that has the default theme with the page tree showing. Meeting Notes has child pages, and the week in writing does not. 

      If your page tree in the default theme is not displaying like this, it might be a bug.  You can raise the issue here http://jira.atlassian.com/browse/CONF

      1. Anonymous

        Hi Rachel, thanks again.

        Our Confluence is in German and we can switch between "Documentation Theme" and "Integrierte Gestaltung" so I think the second one is the default theme, right?

        I would like to upload a picture to show you how our page tree in the default theme looks like but I do not have the permission to do that. But I found a picture in web and our page tree looks like in the circle. Isn't that right? 

        https://www.atlassian.com/wac/software/confluence/whats-new/confluence-50/pageSections/0/pageSections/05/contentFullWidth/0/screenShotPanes/01/screenShot/0/imageBinary/confluence-5-space-sidebar-compact.jpg

         

        Looking forward to your answer (smile)

        1. Anonymous

          and in addition, I've seen this picture on another page:

           

          But the bottom feature "Change page display options" do not exist in our configuration mode (sad)

          1. Hi again, sorry the page tree mode didn't ship with 5.2 (I thought it had). but if you are running Confluence 5.2 you can upgrade the add-on to get this feature here - Confluence Space Sidebar

  23. Here are some examples that may help people. 

    This code will reduce the spacing before H2 headers.

    This will reduce the borders around code blocks.

    This will change the background color of a code block. (warning: HACK)

  24. If the Documentation theme has be merged with the global look and feel theme, then I think it is very important that the sidebar can be customised just as detailed as the documentation theme. Such as adding own wiki-markup and hide the default functions.

    1. Hi Tom, 

      Thanks for your feedback. Would you specifically be wanting to be able to use wikiMarkup in the sidebar, or would a feature like, for example, being able to edit the contents of the sidebar in the editor, use a Confluence page or define a template to populate the sidebar work for you?   Are there other Doc Theme features you specifically use? 

      Rachel

  25. For us, editing the sidebar in the editor would be fine. 
    The reason for my wish, is that we are using the documentation theme, for all our departments procedures and knowledge base, and we have designed a sidebar, with two navigation trees for different sections, and have styled these differently for easier use. We can not make do with the limited configuration of the 'global look and feel' theme's sidebar.

     

    1. Thanks for your feedback Tom!   Two navigation trees is an interesting use case that I will pass on to our Product Managers (smile)

  26. I'm using the Documentation Theme (on Confluence 5.4) and configuring the sidebar.

    In the Navigation field for the Sidebar, I'm adding links (using wiki markup) to a few pages for easy access.

    Each page has a special character, a colon (:) in the title.

    I've tried the following:

    • [Page: Name]
    • [Page%3A Name]

    Instead of bringing me to the correct page, Confluence pops up an "Add new page" with the title "Page%3A Name."

    Any suggestions?

    1. Hi Jenn, 

      I'm sorry I don't have an answer to your question. In wikimarkup the : is used to indicate a space key, so I am not surprised that it wont interpret it as part of the page title.   I see you've also posted this question on Answers. I hope someone from the community has a nifty workaround for you.  

      One workaround I did try was putting the entire URL in the wikimarkup which appeared to work. Not ideal, but did work. In the example below my page title was Colon: Page.

      If you are not using the Header and Footer functionality in the Documentation theme you might want to try using the default theme instead. You can configure the Default theme to show the whole page tree like the documentation theme does and  easily add and remove shortcuts without needing wikimarkup.  There's info this here Configuring a Sidebar.   The default theme sidebar had no problems with shortcut links to pages that contain colons in the title, and it is much easier to manage the shortcuts.

       

      1. Hi Rachel -

        Thanks for your (very quick!) response. I used the workaround you suggested and it does work.... like you said, not ideal, but at least my links are functioning properly! 

        Jenn

        1. Another workaround that might work is to create a new page where you put the links, and naming the page without special characters. Then in the sidebar wiki markup you put wiki markup for include-page  ( example: {include:DOC:navpage} ). This way it is also much easier to manage the links, as you do not have to edit wiki markup on the sidebar setup each time you need to make changes.

  27. 4US

    Hi Atlassian guys,

    I would like to customize my documentation theme as the current space (Confluence Documentation).

    Could you please share CSS and the content of different parts (header, footer, right, left).

    Thank you very much.

    1. Hi 4US, the Atlassian Documentation Stylesheet is on Bitbucket and is available here. The code is not maintained and is unsupported. Another useful note about using the stylesheet is available in Re: Confluence 5.1 Release Notes.

  28. 4US

    Hi Adrian,

    Thank you very much for your response.

    I really appreciate your quick response.

    Thanks.

  29. Hi, can you please tell me is there a way to hide the sidebar within the documentation theme (knowledge base category)? If not, is there a way to remove the 'navigation display options' altogether (currently either 'child pages' or 'pagetree' can be chosen)? Thanks, Debbie Ryan

    1. Hi Debbie,  individual users can hide the sidebar using the [ keyboard shortcut, but there is no way in Confluence to permanently hide the sidebar (it may be possible using some custom CSS however). 

      You can choose to remove the page tree navigation options in the Documentation theme however.  If you go Browse > Admin > Themes > Configure Theme you can then deselect the Page Tree checkbox. The tree will not appear in the sidebar. (Note you must be in the Documentation theme to do this, the option is not available in the Default theme). 

      Hope this helps. 

      1. Thankyou for your quick response Rachael (smile)

  30. Hello, could somebody to explain how can I make a layout of pages like here with indent from left and right and not with 100% width?

    1. Hi Daniil, we use some custom CSS to get the fixed width layout in this space.  You can have a look at the CSS we use here, but note this CSS is not maintained or officially supported. https://bitbucket.org/atlassian/atlassian-documentation-stylesheet 

      1. Thanks a lot! Got it (smile)

  31. Hello,

    Using the Documentation Theme is it possible to make the footer text print on every page?

     

    1. Hi Colum, by print on every page, do you mean after exporting the space to PDF?  If so, you can add a footer in the PDF layout itself - see Customising Exports to PDF.  Note that the footer that is defined in the Documentation theme wont automatically be part of your PDF export - you'll need to replicate the footer in the PDF layout footer field. 

      1. Hi Rachel,

        No - I have footer text defined which appears on all pages in the space. Where a document is embedded in the page and I print straight from the browser (not using the export function) I would like this text to appear on the printed page. Is this possible?

        1. Sorry Colum, I don't have an answer for you.   You could try asking over at Answers

  32. Is there any way to keep the sidebar from hiding itself while using this theme and viewing a Blog post? Currently if users view a blog post the sidebar disappears and is not able to be show within the Blog.

    1. Hi Gabe,  sorry I'm not aware of a way to do this.  The default theme provides a nicer blogs experience, and can now show the page tree in the sidebar.  You might want to try fhat out on your space and see if it suits your needs better. 

      1. Hi Rachel, thank you for the quick response. I have tried the default theme but I seem to lose the space filtered search bar I can add to the documentation theme's sidebar. I am trying to have this space filtered search feature and the sidebar shown at all times within my space. Is it possible to add this search bar to the sidebar of the default theme on the admin side?

        1. You're correct, the default theme doesn't support search within the current space, so the doc theme is probably your best bet.  I'll pass your feedback on about the usability of blogs in the documentation theme.