| Parameter |
Required |
Default |
Notes |
Builder Version |
| default |
 |
@space |
Defines where the page tree should start from:
- SPACEKEY:pagename - a specific page in a specific space
- page title - a specific page (defined by it's title) in the current space
- @self - the current page
- @parent - the parent of the current page
- @space - the currently viewed space showing all top-level pages and also news items (default)
- @root - same as @space
- @home - the homepage of currently viewed space (does not include news items)
- @dashboard - the Confluence dashboard showing all spaces the user has access to
|
3.0 |
| space |
 |
current space |
If you want to show a page tree for a different space, specify the space key of that space using this parameter. |
3.0 |
| page |
 |
|
An alternate way to specify the page (by it's title) to use as the root node of the tree. |
3.0 |
| target |
 |
|
The target window that links in the tree should be opened in (eg. _blank or _self). |
3.0 |
| showIcons |
 |
true |
Should icons be shown in the tree?
- true - show icons (default)
- false - do not show icons
|
3.0 |
| selectionMode |
 |
node |
When a node is selected in the tree, what should be highlighted?
- node - highlight the node caption (default)
- row - highlight the entire row
|
3.0 |
| autoCollapse |
 |
false |
Only allow a single node to be expanded?
- false - allow any number of nodes to be expanded (default)
- true - when a node is opened, collapse all other nodes
|
3.0 |
| indent |
 |
true |
Should different levels of the tree be indented?
- true - indent each level (default)
- false - left align all levels
|
3.0 |
| showRoot |
 |
true |
Should the root node of the tree be shown?
- true - show the root node
- false - hide the root node
|
3.0 |
| branchStyle |
 |
plus-lines |
Defines how the structure of the tree is visualised:
- plus-lines - +/- buttons, dotted lines (default)
- plus-nolines - +/- buttons, no lines
- ball-lines - yellow sphere buttons, dotted lines
- ball-nolines - yellow sphere buttons, no lines
- arrow - green arrow buttons, no lines
|
3.0 |
| iconStyle |
 |
computer |
Which icon set should be used?
- computer - computer style icons (default)
- website - website style icons
- builder - Theme Builder style icons
- bookshelf - bookshelf style icons
|
3.0 |
| class |
 |
|
An optional CSS class to assign to the outer wrapper of the page tree. |
3.0 |
| openpage |
 |
true |
When a link is clicked, should the corresponding page be opened?
- true - open the link
- false - highlight the link, but don't open it
|
3.0 |
| allowdrag |
 |
false |
Allow pages in the tree to be dragged to new locations?
- true - allow page moving
- false - do not allow page moving
|
3.0 |
| treename |
 |
|
The name of the tree (for use with pagepanel macro) May be deprecated or changed in future versions |
3.0 |
| titletip |
 |
false |
Should the page title be used as the tooltip when hovering over items in the tree?
- true - display the page title in the tooltip
- false - display the date and author of the item in the tooltip
|
3.0 |
| initialDepth |
 |
1 |
Prevent the tree expanding beyond this depth on page startup. |
3.0 |
Comments (63)
Mar 12, 2008
Lisa Dyer says:
Hi folks, If I'm running standalone Confluence 2.6.2 with Page Manager 0.0.5-sn...Hi folks,
If I'm running standalone Confluence 2.6.2 with Page Manager 0.0.5-snapshot and Builder 2.0.5-snapshot installed on the system, should I expect pagetree2 to work? Browsers: Firefox 2 and IE7.
We just upgraded from Confluence 2.4.5 (with no changes to the Adaptavist bits) and now, the pagetree2 macro no longer works (we get the endlessly looping "Loading..." error instead of a tree). Should I be running a different Page Manager version?
Any help appreciated!
Mar 12, 2008
Alain Moran says:
uninstall the page manager and builder 2.0.5 and install builder 3.0.0uninstall the page manager and builder 2.0.5 and install builder 3.0.0
Mar 14, 2008
Lisa Dyer says:
Thanks, Alain. This fixed it. BTW: nice work on Builder 3! Kudos to the team.Thanks, Alain. This fixed it. BTW: nice work on Builder 3! Kudos to the team.
Mar 28, 2008
Rusty says:
the new icon sets for this macro look great. are there any plans to have matchin...the new icon sets for this macro look great. are there any plans to have matching options for the menus?
Mar 28, 2008
Guy Fraser says:
The icons are all available via the menuicon macro (and therefore also the compo...The icons are all available via the menuicon macro (and therefore also the compound-menuitem macro) - we've just not found a feasible method of documenting all the icons that are available yet as there are something like 800 icons in there now :o If you rename the plugin's ".jar" file to a ".zip" you should be able to extract it using something like WinZIP or StuffIt Expander - the icons are stored in /resources/icons
Mar 28, 2008
Rusty says:
exactly what i needed. cheers!exactly what i needed. cheers!
Mar 29, 2008
Chris Paquin says:
I tossed some markup (in a text file) into the menuicons page that displays all ...I tossed some markup (in a text file) into the menuicons page that displays all of the Builder 3 icons. It's a large Wiki page when it renders, but it works...
Mar 29, 2008
Guy Fraser says:
Awesome! Thanks Chris! Builder 3.x IconsAwesome! Thanks Chris! Builder 3.x Icons
Apr 11, 2008
Boris Dionne says:
Hi there, Is there a way to use that macro to show two trees distinguished by s...Hi there,
Is there a way to use that macro to show two trees distinguished by space types: personal and global spaces ?
We want to show the spaces created by users (global) on top and then another tree at the bottom to show all the personal spaces created by each users. Otherwise everything gets mingled.
We are building up an intranet for our company.
Thanks
Jun 15, 2008
Brandon Faloona says:
Yes, this would be a great feature. Without it, we can't use the (very useful) @...Yes, this would be a great feature. Without it, we can't use the (very useful) @dashboard setting.
Jul 15, 2008
Tomi Strugar says:
Totally agree that this would be VERY useful, especially since Personal and Glob...Totally agree that this would be VERY useful, especially since Personal and Global spaces get mixed up when listed alphabetically. Perhaps need extra @global and @personal options, or @dashboardbytype that lists global spaces first then personal spaces.
Oct 24, 2008
Rupert Shanks says:
I would also find this VERY useful! Does anyone have any workarounds?I would also find this VERY useful!
Does anyone have any workarounds?
Nov 14, 2008
Marcus Heerdegen says:
Me tooo ... I urgently would need a feature to exclude personal spaces!Me tooo ... I urgently would need a feature to exclude personal spaces!
Apr 14, 2008
Christian Spröte says:
How do you get these lower-case-characters into the pagetree? You don't seem to ...How do you get these lower-case-characters into the pagetree? You don't seem to have the problem wie experience: we are using the pagetree2-macro to show the structure of a space, but all words in the page tree start with an upper-case-letter - even when the start with lower-case-letters in den page title.
Thanks,
Chris
Apr 17, 2008
Jessica Britton says:
Is there a way to set the pagetree2 macro to ignore case when sorting? I've got ...Is there a way to set the pagetree2 macro to ignore case when sorting? I've got it set so that the top-level elements that are displayed in the tree are our space names. We have one space with a name that begins with a lowercase character, and that space shows up at the end of the list:
This space
Some other space
missorted space
On the dashboard, the space names are sorted regardless of case:
This space
missorted space
Some other space
It would be nice if there was an attribute to control the sort-type.
Thanks!
Oct 14, 2008
Stefan Baader says:
Good requirement. And by the way: the sorted page order is ignored by the pagetr...Good requirement. And by the way: the sorted page order is ignored by the pagetree2 macro. The order is alphabetically any way.
Any hints?
Dec 02, 2008
Thomas De Wolf says:
a sort function as in the original pagetree of confluence would be very useful: ...a sort function as in the original pagetree of confluence would be very useful:
sort may be one of the following
Jan 09
Joseph Oliansky says:
We see the lack of sort options as potentially a major problem. We would like t...We see the lack of sort options as potentially a major problem. We would like to structure some of our transactional wikis in order of the steps necessary to complete the transaction. We would prefer not to have people devise workarounds like prefixing their page titles with 1,2,3 or a,b,c......
We miss the expand all/collapse all fn too, but that's less important than sorting.
Otherwise, we much prefer pagetree2 over the original.
Are there are plans to add a sort fn any time soon?
Apr 18, 2008
Chris Paquin says:
I know I can turn indenting on and off (indent=true), but am curious if there's ...I know I can turn indenting on and off (indent=true), but am curious if there's a way to control the amount (width) of the indent. I checked out what I think was the right CSS and couldn't find it, but perhaps I'm looking in the wrong place.
TIA! Chris
May 12, 2008
Doods Perea says:
Hi - How can I hide the News link in the pagetree?Hi - How can I hide the News link in the pagetree?
Jun 08
Ludwig Leuschner says:
You have to delete all News which are saved in this spaceYou have to delete all News which are saved in this space
Jun 08
Guy Fraser says:
By default the root of the page tree is the space - if you change it so that it'...By default the root of the page tree is the space - if you change it so that it's a page within the space (such as @home = home page) it won't show the news.
We're investigating developing a new version of the pagetree2 macro that would have some new parameters and use jQuery (rather than the horrendous table monstrosity that the current tree uses) but a date for implementation hasn't been confirmed yet.
Jun 10, 2008
Jeff WIlbert says:
Call me crazy but I am having trouble ordering my results. I am listing several ...Call me crazy but I am having trouble ordering my results. I am listing several children of the page using the pagetree command and would like them to show in reverse order, however cannot figure it out. I could do it with the order statement of the old pagetree, but this new version does not have it. My command is
{pagetree2:@self}The page shows up similar to below - I would like the newest date and version to be on top. Any help please... thanks in advance!
Security Agent Nightly Update Notes - Index
Jun 18, 2008
Chris Paquin says:
We like pagetree2 a lot, and have some spaces where it's placed in a collapsible...We like pagetree2 a lot, and have some spaces where it's placed in a collapsible Left Side Bar. This works fine unless another invocation of pagetree2 is done somewhere else in the content (some Space owners like having a space map in a section of their space home pages) and then all heck breaks loose.
Is there an ID parameter that can be used to allow two invocations of pagetree2 on the same page (one in the sidebar, one in the content) to play nicely with each other? I tried the treename parameter, but that didn't seem to do anything.
TIA! Chris
Jun 18, 2008
Mark Magin says:
I'm using pagetree2 with confluence 2.8 I tried this setting: {pagetree2:allo...I'm using pagetree2 with confluence 2.8
I tried this setting:
{pagetree2:allowdrag=true|showRoot=false|initialDepth=3}All the subitems in the tree never stay open when clicked.
So if I have:
top
If I click on 'a' page 'a' loads fine, but the left nav is collapsed and I can't see 'a', just 'item 1'
Are there more settings I need to use?
Jun 24, 2008
Thomas Heine says:
Hi Mark, try removing the initialDepth parameter (it seems not to work anyway, ...Hi Mark,
try removing the initialDepth parameter (it seems not to work anyway, or does it in your case?). This solved the problem for me.
Jun 23, 2008
Steve Lane says:
At first glance, the macro appears not to respect any custom page ordering I do ...At first glance, the macro appears not to respect any custom page ordering I do in Confluence 2.8. Is this the case, or am I missing something?
Aug 11, 2008
Jessica King says:
I just noticed the same thing. Anyone see the 2.8 page ordering work with the pa...I just noticed the same thing. Anyone see the 2.8 page ordering work with the page tree?
Oct 14, 2008
Stefan Baader says:
Same for me: custom ordering is ignored.Same for me: custom ordering is ignored.
Jun 23, 2008
Chris Paquin says:
Can I do a Div with Scrollbars for Pagetree2? Here's what I'm trying, but it's n...Can I do a Div with Scrollbars for Pagetree2? Here's what I'm trying, but it's not respecting my "height" parameter:
{div:style=height:100px;width:100px;overflow:scroll;} {pagetree2} {div}Width works fine. Height is set, but no scrollbar appears...
*edit: it looks like this only malfunctions in the LSB.. in the content area, it works fine.
*edit 2: never mind! the issue was with my settings on the LSB width. For posterity: if you're doing a scrolling div in the leftsidebar, make sure the sidebar's height and width are both set to "auto".
Thanks...Chris
Jul 01, 2008
Rusty says:
how do permissions work with this macro? i just set allowdrag to 'true', and was...how do permissions work with this macro? i just set allowdrag to 'true', and was able to change the order of pages in a space with a user who only had "view" privileges.
Aug 23, 2008
Arno Bosse says:
I've also found that the initialDepth parameter is ignored. Anyone else see this...I've also found that the initialDepth parameter is ignored. Anyone else see this? Confluence 2.8.2 and TB 3.2.0.
Oct 02, 2008
Michael Dressler says:
Same Problem with 2.9 and 3.2. It appears that this is a long standing problem.Same Problem with 2.9 and 3.2. It appears that this is a long standing problem.
Sep 24, 2008
Don Gamble says:
It would be nice if this macro could display excerpts like the original pagetree...It would be nice if this macro could display excerpts like the original pagetree macro. What would be even nicer is if the excerpt could be displayed as the tooltip! This would still leave a nice clean look, but allow users to decide if they want to click on the link.
Oct 10, 2008
Don Gamble says:
One further powerful feature would be to make the pagetree2 understand a label p...One further powerful feature would be to make the pagetree2 understand a label parameter. To be able to show all of the pages, in a hierarchy, that have a specific set of labels would be great.
Feb 04
vmanuja says:
I am trying to use it to build my left navigation. Each of the sections of the l...I am trying to use it to build my left navigation. Each of the sections of the left nav has a header.
h3. [Section Header - Page Name 1] {pagetree2:page=PageName1} h3. [Section Header - Page Name 2] {pagetree2:page=PageName2}Since I already have the section header (need it for formatting/ styling), is there an option to NOT show "PageName1" and "PageName2" on the Tree?
Feb 04
Alain Moran says:
There are multiple ways to do this, which you use depends on what logic you want...There are multiple ways to do this, which you use depends on what logic you want to apply for when to display and when not to display, if for instance you wanted to display the tree for page 1 when in that hierarchy, but not page 2 and vice versa I would use:
{builder-show:pagetitle=PageName1|recurse=true}h3. [Section Header - Page Name 1] {pagetree2:page=PageName1}{builder-show} {builder-show:pagetitle=PageName2|recurse=true}h3. [Section Header - Page Name 2] {pagetree2:page=PageName2}{builder-show}Feb 04
vmanuja says:
make sense but perhaps I should've been more clear. What my example above yields...make sense but perhaps I should've been more clear. What my example above yields is -
Page Name 1
Since I already have section headers as "Page Name 1", the name repeats as the first element in the output.
End result should be something like -
Page Name 1
Feb 04
Alain Moran says:
set showRoot=false|initialDepth=3 as described aboveset showRoot=false|initialDepth=3 as described above
Feb 05
vmanuja says:
I tried, as I implied in my note above. showRoot=false flushes all nodes in t...I tried, as I implied in my note above.
Feb 05
Alain Moran says:
I only seem to be able to reproduce this behaviour in comments, eg: pagetree tes...I only seem to be able to reproduce this behaviour in comments, eg: pagetree test
The problem in comments seems to be related to retrieving the CEO for the page ... currently the code does not attempt to locate the page that the comment is added to so fails to expand out the tree.
The lines disappearing from the root is the expected behaviour since there is nothing to connect the lines to!
Feb 19
Steve Lane says:
hi all: I must be doing something wrong. Confluence 2.10, latest Builder theme,...hi all:
I must be doing something wrong. Confluence 2.10, latest Builder theme, and I can only get half of pagetree2's drag and drop to work. I set allowDrag=true, and what happens is, I can drag so as to make one page a child of another, by dropping one on another – but I can't reorder the pages, as I can with the default conf 2.10 page tree (which of course only works on the Admin > Pages > Tree view).
I observed this (non-) behavior in FF and Safari on OS X, and FF and IE on Windows, so I must be doing something wrong.
Ideas?
Feb 19
Alain Moran says:
This is down to the fact that builder 3.3.3 has to support confluence 2.7 which ...This is down to the fact that builder 3.3.3 has to support confluence 2.7 which does not support page re-ordering. We will be dropping support for confluence 2.7 in Builder 3.4 where we should finally be able to implement this.
Feb 19
Steve Lane says:
OK,so it's not just me :-)Thanks. Any sense of time frame on 3.4? This is a big ...OK,so it's not just me :-)Thanks. Any sense of time frame on 3.4? This is a big feature for us. Happy to be a guinea pig for early releases!
Feb 19
Alain Moran says:
watch this page ... you should expect to see the first milestone in a few weeks.watch this page ... you should expect to see the first milestone in a few weeks.
Feb 27
Stefan Baader says:
Hi Guy, Alain, in the Release Notes of ATB 3.3.3 I read "Add sorting to pagetre...Hi Guy, Alain,
in the Release Notes of ATB 3.3.3 I read "Add sorting to pagetree2" as a new feature or bug fix.
But in your documentation I can nothing read about the parameter to use for that.
Please give us hint.
Mar 10
Lisa Dyer says:
I had the similar question as Stefan. We rely on the {set-sort-id} macro that ...I had the similar question as Stefan.
We rely on the {set-sort-id} macro that comes with Theme Builder to create a left nav bar where pages are sorted per a page's sort ID (to override Confluence alphanumeric sorting).
I just installed Theme Builder 3.3.3 on Confluence 2.9.2 (and installed the Page Information plugin), added a left side bar with {pagetree2} to my theme, and assigned sort IDs to some wiki pages. But the sorting does not appear to be working in the left side bar - it is alphanumeric.
Can you pls advise? And will the set-sort-id will continue to work as in Theme Builder 2.x, or it is being replaced by something else?
Cheers,
Mar 10
Alain Moran says:
The sorting added to pagetree2 in builder 3.3.3 allows you to sort pages by crea...The sorting added to pagetree2 in builder 3.3.3 allows you to sort pages by creation date, last-modified date, or natural sorting - this is documented in the notation guide, the documentation team are working on updating the website.
In builder 3.4.0 we will be dropping support for confluence 2.7, this will enable us to use the atlassian sort order fields, this will replace the set-sort-id macro which will become deprecated and we will provide a rebuild tool to import the set-sort-id data into the atlassian structure.
Mar 20
Lisa Dyer says:
Thanks, Alain. I'm a bit confused about what our options here are. Is there a d...Thanks, Alain.
I'm a bit confused about what our options here are. Is there a design spec or something that explains how custom sorting will work with 3.4.0 on Confluence 2.9x? I need to know if our system will work with the planned pagetree2 implementation for sorting. It sounds like maybe the rebuild tool might require some changes to our system.
Also, when will 3.4.0 be available?
Cheers,
Apr 17
Stefan Baader says:
Alain, just to clear the dust in our brains: for custom ordering we can use whi...Alain,
just to clear the dust in our brains:
for custom ordering we can use which syntax?
{pagetree2:sort=position}? No that doesn't work either
Will this only work in 3.4.0?
Please give us a hint.
Regards
Stefan
Apr 17
Alain Moran says:
Correct, for pagetree2 to respect the confluence sort order you will need to use...Correct, for pagetree2 to respect the confluence sort order you will need to use Builder 3.4+ - Builder 3.3.x has to support confluence 2.7 which does not have custom sort orders and unfortunatley we have to support the lowest common denominator.
Mar 12
Jamie Pinchot says:
Is it possible to use the pagetree2 macro as a standalone plugin or does it requ...Is it possible to use the pagetree2 macro as a standalone plugin or does it require ThemeBuilder?
Mar 12
Alain Moran says:
You have to install the builder plugin, but pagetree2 does not require builder t...You have to install the builder plugin, but pagetree2 does not require builder to be licensed for it to run.
Mar 18
Davis Darsch says:
It would be great if the Page Tree was cached in the browser so it did not have ...It would be great if the Page Tree was cached in the browser so it did not have to reload every time. We are having some performance issues especially in spaces with a lot of pages. (I have even changed the initial load depth to 1, but when working on a page that is deep within a set of say 5 pages it can take a long time to load).
Another great feature would be fore the tree to remember what sections you had expanded after a page edit. Right now every time I edit a page and save it, the tree view reverts back to the default view.
Apr 20
Herman de Boer says:
Hi, I've read this page and the comments, and there have been some people who w...Hi,
I've read this page and the comments, and there have been some people who would like to see the personal spaces filtered out from the pagetree2 macro.
Is this still not possible with confluence 2.10.3 and ATB 3.3.3-conf210?
Any workaround, or change in behaviour with new releases coming up?
Thanks and regards, Herman.
May 09
Steve Lane says:
Hi: DO any of the prerelease versions of Builder 3.4 support the Confluence pag...Hi:
DO any of the prerelease versions of Builder 3.4 support the Confluence page reordering yet? I worked with a recent one and it did not, but I wondered whether it were on the way?
Thanks,
Steve Lane
May 11
Alain Moran says:
3.4.0-M2 contains the code for confluence page positions3.4.0-M2 contains the code for confluence page positions
May 13
Jessica Britton says:
Is there any way, other than page permissions, to prevent certain pages from bei...Is there any way, other than page permissions, to prevent certain pages from being displayed in the pagetree?
We have certain pages that exist only to be included on other pages. We don't want users to browse to those pages as their content makes no sense in isolation. We can't restrict access to them though, because the content needs to be visible to users when it's included.
Currently what we do is set the pagetree root to the space's homepage, and put the included content outside of that tree. I'd really like to be able to root the pagetree at the dashboard though; providing nav only within a space isn't very robust.
May 13
Alain Moran says:
While it is certainly possible to add that feature, we have no immediate plans t...While it is certainly possible to add that feature, we have no immediate plans to implement it ... if you would like us to prepare a quote for the work please create an issue in either the GSE or BSUP projects on https://tracker.adaptavist.com.
May 18
Ludwig Leuschner says:
Hi all, I have read, that the pagetree2 macro automatically sort alphabetically...Hi all,
I have read, that the pagetree2 macro automatically sort alphabetically. But under some homesites my sites aren´t sort this way.
Is there a parameter that force the order?
greetings
May 18
Ludwig Leuschner says:
I have a second question about the pagetree2 macro =) I will customise the macr...I have a second question about the pagetree2 macro =)
I will customise the macro with css. I have written in my layout-tab > LSB > Content:
{pagetree2:class=lsbpagetree}and in my custom css:
.lsbpagetree item.hover{ border: 2px solid #0000ff; }But nothing is changed. Which macro I have to use when I will change the green highlight?
Thanks to all poster!
Jun 19
Daniel Bonetto says:
Hi, Is it possible to exclude people/individuals spaces from appearing in the p...Hi,
Is it possible to exclude people/individuals spaces from appearing in the pagetree2 macro.
I am trying to limit what the pagetree2 macro displays.
Thanks.
Jun 30
Al Mecklenburg says:
There have been several posts above indicating that pagetree2's initialDepth par...There have been several posts above indicating that pagetree2's initialDepth parameter doesn't work. I find this to be the case also (Confluence 3.0). However, in a Feb 05 post, Alain says it works for him (except when it's inserted into a Comment), and gives a link to a "pagetreee test" page (http://www.adaptavist.com/display/Builder/pagetree+test) to demonstrate that it does work.
Having gone there, I'm confused re the first example shown, but see that the second example seems to illustrate the initialDepth parameter working. My confusion re the first example is that it is, I believe, supposed to show the results of the pagetree2 macro invoked with no parameters. In both IE8 and Firefox, I see 4 levels shown (where I would expect only 1, the default).
That first example aside, when I use the parameter in my environment, it has no effect (i.e., you only see one level).
{pagetree2:initialDepth=3}Getting it to work (either now, or promised for a future Theme Builder release) is important to me, as affects the level of tree-detail a user sees when first entering a Space, and therefore affects how I structure the Space. Has anyone who had this problem earlier found it to work now, any thoughts?