- Created by Gabriela Costa on Nov 27, 2020
- Mentions
- 0 Associations
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
Version 1 Next »
The Spacetree plugin lets you create navigation trees across multiple spaces easily with options for customization.
The macro allows you to group the spaces in the navigation by specific space categories. It even enables you to display the users' favorite spaces for personalizing the navigation tree.
Feature Highlights...
|
---|
Full preview in editor:
Spacetree Macro
The Spacetree macro allows you to group spaces in the navigation tree by specific space categories. It even enables you to display the users favourite spaces for personalizing the navigation tree. You can also leave the space categories field blank to display a list of all spaces.
Tipp: Even though space categories are lower case in Confluence, the Spacetree macro will display the categories as you specifiy them in the macro parameters. This means categories like Products or Support Documents will automatically be matched to the lower case categories products or support-documents. |
You can use the Spacetree macro on wiki pages or in themes like the Default Theme or Documentation Theme to display navigation trees in the sidebar of the theme.
Parameters
Parameter | Default | Description |
---|---|---|
Space Categories spaceCategories | None - list of all spaces will be displayed | A comma-separated list of space categories to select the spaces you want to display in the tree. The space categories are case-insensitive and displayed in the tree as you specify them in the list. Use @favourite to display favorite spaces of the current user. Use @self to display pagetree of current space, if it's not already listed in the spacetree. Leave blank to list all spaces. |
Include Archived SpacesincludeArchivedSpaces | false | Enable to include archived spaces. |
Expand ChildrenexpandChildren | false | Enable to automatically expand the child pages of the current page. |
Start DepthstartDepth | 0 | Enter any number greater than 0 to set how many levels of children the tree should show for the current space when it opens for the first time. |
Sort Ordersort | position | The order the spaces should be sorted by. Valid values are:
|
Sort PagessortPages | true | Choose whether sort order should also be applied to pages in tree. Disable if you just want to sort the spaces in the tree. |
Reverse Orderreverse | false | Enable for reverse ordering. |
Stylestyle | modern | Choose whether you want to display the tree using the modern style (arrow icons) or the classic style (plus/minus icons). Valid values are:
|
@self TitlecurrentSpaceTitle | "Current Space" | Title to display for @self section in tree, when using @self keyword in space categories. Use @self as title to display the name of the current space. |
@favourite TitlefavouriteSpacesTitle | "Favorite Space" | Title to display for @favourite section in tree, when using @favourite keyword in space categories. |
Hide Default PagetreehidePagetree | true | Choose whether the default pagetree should be hidden in the sidebar when the Spacetree macro is being used in the sidebar as well. |
Theme Configuration
Default Theme
Follow the steps below to replace the default page tree in the left sidebar of the Default Theme with the Spacetree macro:
- In the Confluence administration under Look and Feel click on Themes
- Make sure the Default Theme is set as the current theme.
- In the Confluence administration under Look and Feel click on Sidebar, header, and footer
- Insert the Spacetree macro as wiki markup
{spacetree}
into the Sidebar textarea and click on save
Documentation Theme (deprecated)
Follow the steps below to replace the default page tree in the left sidebar of the Documentation Theme with the Spacetree macro:
- In the Confluence administration under Look and Feel click on Themes
- Select the Documentation Theme and click on Configure theme
- Uncheck the Page Tree option
- Insert the Spacetree macro as wiki markup
{spacetree}
into the Navigation textarea
Examples
{spacetree}
- to list all spaces with default options{spacetree:expandChildren=true|style=classic}
- to list all spaces with expandChildren enabled and classic look & feel{spacetree:spaceCategories=Departments,Products}
- to list all spaces of categories departments and products{spacetree:spaceCategories=What's New,Help Desk}
- to list all spaces of categories what's-new and help-desk{spacetree:spaceCategories=Version 1.2.0,Version 1.2.1}
- to list all spaces of categories version-1-2-0 and version-1-2-1{spacetree:spaceCategories=@self,Products}
- to display all spaces of category products, or the pagetree of the current space at the top of the spacetree, if the space is not already in the products category
- No labels