.png)
The {list-pages} macro generates a list of pages based on the parameters given to it.
It allows listing pages based on:
- a specific page name,
- page hierarchy (parent/child relationships),
- page labels, and
- metadata keys or key:value pairs which the pages must have.
The macro searches for pages based on these properties in the current space by default, or in any number of spaces which can be specified in the macro parameters.
If more than one search criterion is specified (e.g. labels and metadata), then only pages meeting all the selection criteria will be returned and listed by the macro (boolean AND relationship between the search criteria). Within a list of search terms (e.g. list of labels or metadata), any page matching at least one of the items in the list will be returned (boolean OR relationship within search terms).
Finally, if no page is found satisfying the selected parameters, a default page can be specified to be listed by the macro instead.
See also the list-* macros page for an overview.
Requirements
This macro requires Builder 3.0 or above.
Usage
{list-pages:direction=ancestors|startPage=My Page|space=DOC|title=Page 1,Page 2|label=test,label2|metadata=key1,key2:value1,key2:value2|default=Default Page}
Examples of common structures can be found in the examples below.
Parameters
| Property | Required | Default | Notes |
|---|---|---|---|
| direction |  |
The direction (in page hierarchy) that the macro should look in when searching for pages. The following values are permitted:
|
|
| startPage or startFrom |
 |
@self | The page to start the search from. The following values are permitted:
|
| space | |
Comma-separated list of spaces to search in | |
| title | |
Comma-separated list of page titles to search for | |
| label | |
Comma-separated list of labels the page(s) should have | |
| metadata | |
Comma-separated list of metadata key:value pairs, or metadata keys which the pages must posess. If a key:value pair is specified, then the key must have that value; if only the key is specified then any value is valid | |
| default | |
Specifies a default page to use if no page was found with the previous search parameters. The following values are permitted:
|
Examples
Let's start with a simple example: listing all ancestor pages (i.e. parent, parent's parent, etc. all the way to the root of the current space).
List of all parent pages (from the current page)
List of all parent pages (from the current page): {list-pages:direction=up}Which results in:
List of all parent pages (from the current page):
As you can see, each page in the space's hierarchy, from the current up to the top (root) is listed as a link to the page itself.
Similarly, we can list all children, and children's children pages from the current page, much like the {children} macro does, but then recursively (at infinite depth):
List of all children pages (from the current page): {list-pages:direction=down}Which results in:
List of all children pages (from the current page):
You may specify the page at which the {list-pages} macro should start searching. By default (if nothing is specified) this will be the current page.
For instance, to list all pages in a space, specify the spacekey: as the parameter for startPage as follows:
List of all children pages in the [Builder|Builder:] space {list-pages:direction=down|startPage=Builder:}Which results in:
List of all children pages in the Builder space
You can set the {list-pages} macro to search for pages in more than one space.
By default, the macro will search for pages in the current space. You can specify a different space with startPage=spacekey: as per the example above. Additionally, you can specify a list of spaces to search in:
List of pages in the [Builder|Builder:] and [Bubbles|Bubbles:] spaces: {list-pages:direction=down|startPage=@home|space=Builder,Bubbles}Which results in:
List of pages in the Builder and Bubbles spaces
- About
- Feature Tours
- Theme Configuration
- Home
- Forum
- Support
- Downloads
- System Administration
- Layout Design
- Stakeholder Benefits
- Content Authoring
- Search Engine Optimisation (SEO)
- Plugin and Play
- Space Administration
- Accessibility
- Flexible Navigation
- The Alternatives
- Custom Sidebar
- Spotlight
- Custom Footer
- Welcome to the Theme Builder Forum
- Builder 3 and Blog-Posts not updating
- Confluence macro to print the space name
- Logic around the menulink remove
- Excerpt generation
- Well Chuffed
- User profile pictures
- Builder 3 and Activity page link
- Possible to modify the HTML head section title value?
- Styling deck and card macros
- show-to and hide-from macros (Visibility plugin)
- Header Text Caption for menus in sidebar?
- Builder 3.0.0 beta requests
- Modifying the format of news items
- Attachments Checkout Plugin compatibility
- Non Admin users cant set Watch Space?
- Potential new user requiring plugin
- Change Powered By text
- Builder 3 Beta- Layout Upload Problem
- multiple languages
- structuring subject data
- List of "Favourites" as a menu?
- centre page layout
- BreadCrumb Trail Strangely Has Year Tacked on at End
- buildericon macro list?
- min-height for page or content panel or a sticky footer
- Way to Remember User's Left & Right Slider Visibility Preferences?
- IE CSS problem
- Builder 3 - Confluence 2.7 Upgrade (Order)
- Global Theme Incomplete Changes
- .current class not appearing
- Session Error
- Iframe syntax
- Is there a way to make dosearchsite.action use a ThemeBuilder layout?
- Is there a way to make it so the left and right sidebars are auto-hidden on certain pages?
- Trying to add margin above breadcrumb bar with CSS... not working
- JMAGE + Builder
- Test
- Unable to link the page within the menu
- Applying builder theme and layout to a plugin module
- Using wiki notation to specify bg image in Theme Builder
- Changes to header not updating
- Gliffy plugin 'Add Diagram" menu option
- Create 2 menu bars on same page
- Is there a way to make a menu item that, when clicked, adds a label?
- Weblogic 8.1 and Theme builder not working
- Recently-Updated macro CSS
- Purpose of dashboard tab in Builder administration
- Adding labels to a template
- Collapseable Comments in IE problem
- Dashboard customization
- Different page with different content in the sidebar
- Setting background image
- Social Bookmarking plugin
- Card Deck in theme builder
- CSS in Breadcrumb
- Bug in Powered By text?
- Apply layout to dashboard
- header Panel
- Adding Tabs, i.e., iGoogle
- Any idea how to implement this
- template trouble
- search box for people directory
- Implementing left navigation theme
- menubar Not licensed
- Creating Menus other than View and Edit
- Company Glossary of terms
- normalView not changing to normal page view
- Dynamic navigation bar based on content structure
- Confluence 2.8 UI Changes
- How to create a new 3.0 theme?
- How to apply CSS to a specific menu?
- how to have a menu title change based on user,group state (ala atlassians login,user menu)
- Don't show sidebars or sliders when in Edit mode
- Apply CSS to popup windows
- ThemeBuilder costs?
- builder-label edit button non-responsive, confluence 2.8.2 + builder 3.2
- Using images to create page border
- Add dropdown icon to right of menu caption
- IE not handling LSB properly
- Right-click functionality on menu items
- Confluence 2.8 default theme
- Choose layout error with Internet Explorer
- Choose Layout screen - should we change it?
- Rich Text Editor and Custom CSS
- menubar troubles
- Layout manager question
- Content by label macro
- How apply a child layout?
- ThemeBuilder administration errors in Internet Explorer
- themebuilder.initialise output on every page (velcocity rendering problem?)
- SOLVED - custom html
- Tag cloud anyone?
- Re-sizeable Wiki Markup Edit panel in Firefox
- wikipage problems
- Getting existing themes into theme builder
- Creating New Decoration macro
- Customer Header
- Theme Builder and Calendar event colours
- How to get right-aligned menu bar above header
- Admin and Edit options disappear
- How to apply custom theme to login & signup page?
- Them Builder plugin issue
- online documentation importation?
- SOLVED. Custom content layouts in themebuilder?
- Centre aligning documents
- NullPointerException
- Flash hides drop-down-menus on linux
- Tabs - View, Edit, Attachments, etc
- Solved - Home menu item
- Add page favorite from menubar
- Making a header without making it a global logo
- Reporting on Menu Usage
- Help (Notatation) Tips missing in 3.30M3 + 2.9.1
- Adding a _Contact Administrators _ link to wiki footer
- Theme Builder Administration not working correctly
- Should the compound-menuitem macro display the icon for web ui links?
- Search Results Page Layout
- Menu questions
- Adding menu items to Title, Footnote or Footer panels
- Does Theme Builder really need an internet connection to load?
- Menu items not displaying properly
- Adding a "(View Change)" link in ThemeBuilder
- Labels in 2.9.x
- Trying to build custom menu
- Theme Builder plugin source code?
- Watches not working - Solved
- Ext-GWT macro breaks TB layout
- Can one create custom actions outside of using macros available in a plugin?
- importing documents
- Setting up Blogs in v. 3.2
- Custom menu - watches (email notifications)
- Inappropriate Escaping
- Upgrading from ThemeBuilder 2 to 3
- How do I get space admins the ability to edit their own layouts?
- CSS help
- CSS for pagetree in lef sidebar
- Layouts no longer listed in Manage Builder Layouts or Builder Administration
- Only global admins can edit themes on 2.10.1 and 3.3.2-conf2.10
- Modify User Profile page with theme Builder
- Using Conf 2.10.xx Quick-Navigation search with Builder
- How do I set menu panel width?
- image rollover
- background image behind search box
- Theme Builder performance
- customizing menu text
- link to viewing global labels
- caption fields in menu names?
- stretch page height to fill visible screen
- link to import word document
- code block overflowing the content panel width
- builder-breadcrumbs macro error on default page
- theme builder profiling
- builder-breadcrumbs output has single quotes (') stripped
- How do I edit menus other than "View" and "Edit" in Themebuilder 3+
- Help in editing custom CSS
- attachments macro woes
- Question on Search-box macro
- Theme Builder Admin - Global Permissions - Javascript Error
- Attachments - visible in the overview table
- Help with Header Alignment
- Question on Layout Hierarchy
- Doc Import not visible
- How did you make this forum?
- is it possible to use a different layout for different spaces or pages?
- Problem using breadcrumbs and jquery
- Theme layout changes unexpectedly
- Builder plugin and java stack traces, Oh Boy!
- Hotkeys in Safari 4
- Menus viewable as tabs?
- Popup Menu not aligning correctly in IE
- Error in installing Theme builder ver3.3.3 in Confluence ver2.10.2
- Relative Linking Menu Bar and Space Admin
- I broke my header... I think
- Sort order in pagetree2 macro -- suggest case insensitve sorting
- Limiting hierarchy expanded displays using pagetree2
- compound-menuitem webui links
- How to do an "accesskey only" menuitem in Builder 3.3.3?
- Comments Not Showing Until User Adds Comment
- Conditional colors, howto?
- A conditional menu item for creating or viewing personal space
- Draft macro and ATB
- Tabs in Wiki page like Decks and Cards
- Attachments view - unable to expand
- I'm having some problems with my text color in the menu
- Confluence CSS overwriting Custom CSS
- theme switching
- Confluence 2.10.2 Compatibility
- Can I remove News from Pagetree2?
- compound menu item not in 3.3.3
- Getting Theme Builder to work with Starter License
- Setting different layouts for home page
- problem with version-history
- Different layout for the Space Admin page?
- Anonymous Access Strategy
- How to remove the version footer?
- Thoughts on hosting public site with Confluence and Theme Builder
- Customizing Text In A Menu
- How to change or add a personal space logo that is not a profile picture
- Adding an extra wrapper div
- Current adaptavist navigation tutorial please...
- Style of menus on Adaptavist site?
- Great new layout adaptavist site
- Compound-menuiten, caption and fields
- Error
- URL arguments and https
- Menu links for "Doc Import" and "View Wiki Markup"
- error using list-pages with label filter
- Threaded comments garbage in EU7 and IE8
- sorting pagetree2 macro
- Menu Slowness on Some Computers Running IE
- How to use builder-show question
- Themebuikder show hide macro
- Problem with Manage Layouts page
- How to set page height to 100%?
- Changing Menu-Text-Color with Content
- Any real life Bubbles examples out there?
- Getting a faster menu - experiences at Ordina
- pagetree2-macro Alphabetical order and customising
- Create-child macro as a standalone plugin ?
- Multiple attachments versions
- Admin page custom HTML breaks in IE 6 when using Themebuilder
- Text in panel layouts getting wrapped in paragraph tags
- Recreating Confluence default menus
- Non-privileged actions showing up for anonymous user
- Confluence 3.0
- Header disappears on subsequent search result pages
- How to fix 'Unable to find configured theme module' ?
- Free Theme Builder License
- text below footer?
- Oversized content within a table
- Display username in theme
- builder 3.3.3
- builder-show and scaffold
- change label in the "Children" view
- Add Comments fails in Theme Builder
- Theme Builder 3.3.4 installation error in Confluence 3.0.0_01
- Dashboard Problem with Recently Updated Macro
- Exceptions when trying to manage layouts in 3.3.4
- Will plugin repository be updated with latest Builder release?
- How to group several pages in a space
- Help need for using jquery plugins in Builder theme
- List Page Alphabetically macro
- Forcing text in tables and columns to wrap
- Custom CSS applied to contents of "Rich Text" and "Preview" tabs?
- Unable to Display Image through CSS( Theme Builder)
- 3.3.5-M3 experiences
- How to build your own shoutbox
- How to delete parts of the generated RSS
- Theme Builder 3.3.4 in Admin section has two links that show ~blank screens
- Can a tooltip be added to the menu macro?
- Upgrading Theme Builder
- "Outdated PDF export link" error in 3.3.4
- builder-favicon macro doesn't work w Conf. 3.0
- Early access Builder 3.4.0-M3
- Alignment of text
- Does a Themebuilder "Move page" Macro exist?
- How to temporarily disable macro-code?
- Render velocity in builder
- can't get accesskey to work in compound-menuitem macro
- Themebuilder and Confluence 3.0 problems
- New Page
- Other user´s login history
- Embedding a macro in a menu?
- comments messed up
- How to pull footnotes up flush against the bottom of the page content?
- embeding .wmv or .swf
- Confluence upgrade to 3.0
- How to add title tag using themebuilder in confluence 3.0
- Keeping the Tab-Focus
- How to remove the free theme builder from bottom
- How to remove the text free theme builder from my site with background color purple
- HTTP Cache Header directives showing up in page
- How Include personal Sidebar
- Flag Logic v2 Please Please Please
- Show and Hide panel based on content
- Unknown macro table
- "menuicon EULA Not yet accepted" issue
- Page Attachment metadata not available
- Searching the forum?
- HTML Comment before DOCTYPE
- Theme Builder Admin Panel Empty in (3.3.5-M3-conf210 on C3.0)
- Title Problem
- Builder-show,hide parameters for watching and forums
- Confluence permissions for using Theme Builder
- Upgrading Confluence 2.7 to 3.0, Adaptavist upgrade procedure?
- default layout
- builder-permission just like builder-labels
- Search auto-completion and business-card hovers not working in Conf 3.0, TB 3.3.5
- Builder admin hangs
- CSS font color and weight
- Where can I download Theme Builder 2.0.5 ?
- List pages in menu
- To change Search-Box Text Color
- Extra Vertical Scroll Bar when the page height width increases
- Custom Layout is ignored in Create or Add New Page mode
- change font of h1
- Remove Edit Comments Link
- Listing of Spaces
- Confluence 3.0 "Missing Requirement" when installing
- Adding a class to dynarch-popup-menu
- Change Layout
- Do I need to use theme builder?
- LSB problem after update to Confluence 3.0
- Possible to use menu macros when TB is installed but not in use as default theme?
- Error when rendering macro menulink
- do i need themebuilder for this?
- Theme builder 3.3.5-M3-conf210 upgrade issue
- Confluence 3.0.0_01 Plugin Repository can't install Builder Theme
- Iframe Borders and crop
- Adaptavist Site theme 5
- Builder Search - Suggestions Misplaced
- Issues with Theme Builder and Composition Plugin
- Only have default layout in Adaptavist Theme Builder version 3.3.5
- CSS for Pagetree2
- Truncated vcard popups
- Flying Labels
- Automated backup of Theme Builder layouts
- blog-list title links
- How to change the page layout?
- Attachment page colors
- Header format questions
- Last issue before we go live
- Span Macro adds P tags
- Custom Themes disappear in Manage Layouts
- Link Alias Not Working In compound-menuitem Custom Icon
- pagetree2 macro not producing correct branchStyle
- Attachment History fails to display
- exporting or importing Theme Builder themes
- Updating all personal Theme Settings to Default
- Two instances of the pagetree2 macro result in a neverending "Loading..." message
- Theme Builder layout content and centering
- menuicon has extra paragraph tags in Confluence 3.0.2
- Please disable the Snip-Snap compatibility plugin
- How do I add the default user menu?
- How to access page excerpt of %thispage%?
- Changing the Header for only one Confluence Space, not affecting other Spaces
- Convert themes from Liferay
- Error in confluence filterFragmentsByCondition Could not evaluate condition
- Error put Unable to locate put method
- compound-menuitem hierarchical navigation sort order
- 'Left Side Nav' Extended to Attach to 'Menu' with 'Navigation' Bar Enabled
- Builder-show parameter for personal space
- TB compatibility with Confluence 3.1-beta
- Errors using IE7 and IE6 with theme builder 3.3.5
- Theme Confluence 500 Errors
- Predictive Search and Tag Input Predictive Search
- Menu Issues
- All tabs empty in "Edit layout"
- including tasklist macro in layout = odd results
- Tabs for menu items
- Problem with IE and builder-comments
- Looking for old versions
- "Edit Page" layout customisation?
- Home Page Layout
- builder-hide macro context inside a page included in another page
- Reverting footnotes content back to default
- Attachments for global theme
- Problem backuping layout with accents like é or è
- Confluence 3.1 support theme builder and bubbles
- What's the best combination of latest code
- builder-show issue
- enable Pagetree2 but disable Theme Builder
- compound menuitem space for icons
- Problems with Confluence 3.1
- New hier, need help
- Suppress Dashboard tree & link from selected pages
- Custom dashboard
- Changing the size of the comment rich text editor
- Problems with Confluence 3.1 - layout editor hanging
- Retrieving parent space information in Builder
- Cannot Add a Layout-"Error marshalling java.util.arraylist" etc
- Confluence 3.1 with ThemeBuilder 4.0 Issue
- Menu Help
- Content Preview iframe madness
- Still having Builder-spacetitle problem
- Bread crumb issue with doexportspace.action
- Edit In Word Link - MenuBar
- Add Favourites not working
- builder-show check for comments?
- Feasibility of dynamically sized layout
- addfav aliases work with one layout but not a similar one
- Issues with display of Search results
- Formatting default sections
- custom menulink for page restrictions
- Confluence 3.1 Attachment Drag and Drop
- Pagetree2 doen't work with arobas home
- Quick search in a Theme, how to do?
- Suggested approach to replicate an existing news app
- Builder-Hide Macro - Problem
- Recently Updated displayed twice on Dashboard
- compound-menuitem edit in word function issue
- Add style to menubar macro
- Card-Deck style gone in builder 4?
- link-window macro - argument for statusbar malfunctions
- Edit in Word
- Set default template for spaces
- Change Top Navigation Menu
- Missing buttons
- Which version of 3.3.6?
- builder-comments not displaying comments correctly
- Restrict Color Scheme to Corporate Colors
- Footer Issues...
- Missing templates? Broken theme builder
- Recently-updated macro - how to limit length
- Bug Fixes? -Confluence 3.0.2 with Theme Builder 3.3.6-conf210
- Background image
- Stylesheet issue in confluence 3.1 w. ThemBuilder 4.0.1
- Implementing "Link to this Page" with Builder
- Page width won't stretch to accomodate content
- Slider Cookies acting weird
- login redirects to dashboard
- Theme Builder Plug-in - Confluence ver 3.0
- editinword working with 4.0.1 or 4.0.2?
- Icons in Coupound-MenuItems Display Tooltips
- list-pages trouble with metadata and wildcard
- DIV macro generates embedded empty P tags
- Does TB require that a "default" theme be specified?
- Removing "Add Comments" using Theme Builder 4.0
- Change location or order of panels
- Builder 4.0.0 and Confluence 3.2?
- Create a page based on a template
- Sidebar with menu uses wrong pageId
- Erroneous Spaces in IE
- builder-show icw permission=edit
- Extra Space In Personal Spaces
- Type Mismatch ERROR in menus under IE8
- Problem with permissions for managing layouts
- Theme Builder & PDF Export
- EULA error
- Need a hidden space to learn Confluence
- Add Gliffy Icon not displaying using compound-menuitem
- Layout Permissions by User
- Pagetree 2 - How to sort?
- ThemeBuilder 4.0.2 - What versions of Confluence
- Theme Builder 4.0.2 or latest with confluence 3.2.x
- Duplicate ancestors using list-ancestors?
- Stretch Background?
- Custome Dashboard changes not displayed
- Theme builder navigation customization
- Unable to restore
- Pagetree2 macro and IE
- Whence set-sort-id macro?
- Tasklist or dynamictasklist problem
- history menuitem is not more working
- Trimming Comments from Page causes system erro
- Theme Builder and lost tabs in Confluence 3.2
- builder-search
- edit mode preview cuts off bottom of page
- Missing Tabs in "Brows Space"
- Error formatting macro builder-breadcrumbs java.lang.StackOverflowError
- Page Restrictions - Constant Page Refresh with Theme Builder
- Putting in individual space headers
- Logout and history Not working using MediaWiki
- Error while trying to add a page as favorite from menu
- Show-hide Notation-Help-Tips when toggling Wiki-Markup-RichText
- Styling the content part of the layout using multiple background images
- blog-list display only first paragraph?
- Theme Builder import macro does not display content
- Templates with Theme?
- Must be a number? No more percentages?
- Them builder conflicting with mail page plugin
- Get rid of View Menu and Search Box
- Setting a parent space changes the layout
- with*macro issue
- I got full spaceadmin rights but it wont work,
- Customize Blog Page View
- Theme builder errors with v4.0.2
- Custom menu "active page"
- Hide spaces from
- Mail archive error in Theme Builder
- Themebuilder 4.1 manage lay out rendering error
- Changing Content
- How did adaptavist realize sub spaces?
- Automatically Picking up Default Menu Items
- Password -not required!
- Using flags for custom user preferences
- Theme builder 4.1 in conjunction with confluence 3.3
- Editor character encoding
- Struggling with builder
- Theme Builder with Jira Studio
- Addbookmark not working in menu
- Update of 3-8-2010 broke menu
- How to get the option to include CSS styles for the deck and card macros
- builder-search text not showing up
- Prem
- Page Not Found, Namespace mapping
- Session error with 3.3 and builder 4.1.3
- Code for "Update Status" menu item
- IE8, CSS, and Theme Builder
- Sidebar appears at each page display
- Issues setting page restrictions
- Show Children in View Menu not working
- Using Confluence 3.3's Manage Page Watchers with TB
- Resources won't upload
- How to add the new Confluence V3 links in a theme?
- You are not permitted to perform this operation?
- Root Space Order
- Locking comments in forum breaks theme
- Changing the theme depending on the location?
- Page restrictions aren't working Conf 3.3.1 and theme builder
- Upgrading Confluence and Builder changes content formatting
- Macro for adding company logo on Menu Panel
- Custom CSS for pagetree2 - Change text size.
- Cannot install Builder 4.1.3 on Confluence 3.3.3
- Macro Browser display off page in IE
- builder-personal-sidebar macro hacks?
- Global Blog Layout Style
- Customise PDF Layout using exportPDF
- RTE scrolls to the top when focus is lost
- Display error with TB 4.1.3 and Confluence 3.4
- Residual data into database, upon TB uninstall
- builder-labels macro not working
- Underlined text with markup + are green
- Cannot hide contents in site search
- Builder-show seems to not work when a title has special characters
- error.gif
- pagetree2 macro and preview
- How to stretch an image in header panel?
- How do I list blog posts older than 30 days
- Any update on 3.4.x compatibility for Builder?
- How to highlight the selected node from a pagetree2?
- Theme Builder 4.2-RC1 Released
- Upgrade Layout Changes, wrappers missing
- Unable to change position of subspace in Space Administration
- Unable to Restrict Page Access when Adaptavist Theme is used
- Pagetree2 macro (builder 4.2 RC2) always highlights parent page
- Manage Spaces shows no spaces
- Builder 3.3.5 not working on Confluence 2.7.3
- Error when applying theme
- Can not upload plugin to confluence
- help pages localized
- User tooltip doesn't work
- Metadata description showing ThemeBuilderr macro
- Truncated Profile popups Confluence 3.4.5
- The EULA has not yet been accepted by a system administrator
- Theme Builder compatibility with v 3.4.6?
- CSS Markup
- Themebuilder Error
- Create-Child to create directory structure
- Menus Opening Behind Graphics and other objects.
- Resize of side bars
- builder-search macro, CSS for drop down not working
- Add Edit Tools menus displaying over other menus
- Macros in Layout Heading Not Working Correctly
- Hide the Add Page Menu Link
- Support for HTML Export?
- Label autocomplete fuction
- Rich Text Editor looses Cursor when using theme builder
- Menubar not displaying in IE
- Hover Profile not displaying
- Custom Menu My Communities Emulation
- Dashboard tab...., where is it?
- Theme to child page
- Change order in Layout Editor?
- Support for Conflu 3.5?
- Confluence Context Path Error
- Missing Header in IE (version 9, emulated as IE7)
- Menubar properties like a Link
- Operation Aborted
- Missing user and group management
- Cannot change menu style Conf 3.5.1 Builder 4.2.1
- Integrating with Yammer
- Duplicating a theme builder layout - broken ?
- Dashboard "Recently Updated" display strangeness in IE
- How to reproduce the "New Share Button" introduced with 3.5 in a custom theme?
- Not recognizing macros
- ThemeBuilder 4.2.1 layout-resources.action failing
- Forcing the Powered By footer to always align bottom
- Current page is hyperlinked in breadcrumbs
- Create Personal Space Button or Link
- apply new css on pages already using layouts
- Left align text on menu panels
- System Requirements
- Troubleshooting Guide
- Help us to help you
- Release Notes
- Early Access Programme
- Layout Library
- Builder 1.x Release Notes
- Builder 2.x Release Notes
- Builder 3.x Release Notes
- Builder 4.x release notes
- Builder 1.6.0 Release Notes
- Builder 1.5.3 Release Notes
- Builder 1.5.2 Release Notes
- Builder 1.5.1 Release Notes
- Builder 1.5.0 Release Notes
- Builder 1.4.1 Release Notes
- Builder 1.4.0 Release Notes
- Builder 2.0.0 Release Notes
- Builder 2.0.1 Release Notes
- Builder 2.0.2 Release Notes
- Builder 2.0.3 Release Notes
- Builder 2.0.4 Release Notes
- Builder 2.0.5 Release Notes
- Builder 2.0.6 Release Notes
- Builder 2.0.7 Release Notes
- Builder 2.0.8 Release Notes
- Builder 2.0.9 Release Notes
- Builder 3.0.1 Release Notes
- Builder 3.0.0 Release Notes
- Builder 3.0.2 Release Notes
- Builder 3.0.3 Release Notes
- Builder 3.1.0 Release Notes
- Builder 3.1.1 Release Notes
- Builder 3.1.2 Release Notes
- Builder 3.1.3 Release Notes
- Builder 3.1.4 Release Notes
- Builder 3.2.0 Release Notes
- Builder 3.2.1 Release Notes
- Builder 3.3.0 Release Notes
- Builder 3.3.1 Release Notes
- Builder 3.3.2 Release Notes
- Builder 3.3.3 release notes
- Builder 3.3.4 release notes
- Builder 3.3.5 release notes
- Builder 3.3.6 release notes
- Builder 4.0.0 release notes
- Builder 4.0.1 release notes
- Builder 4.0.2 release notes
- Builder 4.0.3 release notes
- Builder 4.1.0 release notes
- Builder 4.1.1 Release Notes
- Builder 4.1.2 Release Notes
- Builder 4.1.3 Release Notes
- Builder 4.0.4 Release Notes
- Builder 4.2.0 Release Notes
- Builder 4.2.1 Release Notes
- Yesterday's news
- Early access 4.0.0
- Early access 3.3.5
- Early access 3.3.6
- Early Access 4.0.1
- Early Access 4.0.2
- Early Access 4.1.0
- Early Access 4.0.3
- Early Access 4.1.4
- Early Access 4.2
- Early Access 4.2.1
- Confluence 2.10
- Confluence 2.7
- Clickr
- MediaWiki
- Xen
The {list-pages} macro can retrieve pages based on their names (page titles). For this, use the following syntax:
List of pages titled "Panel Macros", "Menu Macros", or "Utility Macros" in the [Builder|Builder:] space: {list-pages:direction=down|startPage=Builder:|title=Panel Macros,Menu Macros,Utility Macros}Which results in:
List of pages titled "Panel Macros", "Menu Macros", or "Utility Macros" in the Builder space:
The {list-pages} macro can be used to list pages containing any one label in the list specified. Pages listed by the macro will have at least one of the labels.
List of pages labeled 'builder' or 'theme': {list-pages:direction=down|label=builder,theme}Which results in:
List of pages labeled 'builder' or 'theme':
A list of metadata keys, or key:value pairs, can be given to the {list-pages} macro as search criterion.
If you specify a key:value pair, then the macro will return only pages containing both that key and the specific value for that key. If you only specify a key then the macro will return all pages containing that key, regardless of the value.
See the Metadata plugin page for more information on the Metadata plugin and key:value pairs.
List of pages authored by [~gfraser] in the [Builder|Builder:] space: {list-pages:direction=down|startPage=Builder:|metadata=author:gfraser}Which results in:
List of pages authored by Guy Fraser in the Theme Builder Plugin space:
In order to prevent the macro from returning an empty list in case no pages are found meeting the given search criteria, you may specify a default page to return.
List of parent pages: {list-pages:direction=down|startPage=@root|default=@home}Which results in:
List of parent pages:
- Macros
- Panel Macros
- Menu Macros
- Utility Macros
- builder-breadcrumbs macro
- builder-children macro
- builder-comments macro
- builder-favicon macro
- builder-labels macro
- builder-pagetitle macro
- builder-watchicon macro
- builder-sidebar macro
- builder-welcome-message macro
- builder-infopanel macro
- Example Page
- editmenu macro
- menu macro
- menubar macro
- menuicon macro
- menuitem macro
- menulink macro
- menuseparator macro
- sub-submenu macro
- submenu macro
- viewmenu macro
- wikimenu macro
- compound-menuitem macro
- Links - Quick Reference
- webui-list macro
- watch-menu macro
- fav-menu macro
- Builder 3.x Icons
- menulink replacements
- builder-hide macro
- builder-logo macro
- builder-show macro
- builder-spacetitle macro
- move-to macro
- import macro
- use-layout macro
- pagetree2 macro
- with-* macros
- list-* macros
- blog-list macro
- list-spaces macro
- create-child macro
- page-state-interface macro
- blog-archive macro
- blog-calendar macro
- blog-rss macro
- blog-rss-feed macro
- set-flag macro
- sorted-children macro
- pagetree test
- with-page macro
- with-ancestor macro
- with-sibling macro
- with-descendant macro
- list-pages macro
- list-ancestors macro
- list-descendants macro
- list-siblings macro
Hints and Tips
None at present.
Frequently Asked Questions
None at present.
Comments (6)
Oct 06, 2010
Dean Hodge says:
when using the list-pages macro to search across spaces I only get results for t...when using the list-pages macro to search across spaces I only get results for the current space. we are using confluence 3.3
Dec 01, 2010
philipp says:
I can confirm this behavior on Conf 3.3I can confirm this behavior on Conf 3.3
Dec 03, 2010
Keith Brophy says:
Hi Dean, Philipp, I have confirmed this as a bug and have raised it on our inte...Hi Dean, Philipp,
I have confirmed this as a bug and have raised it on our internal issue tracker for further review by the development team.
Regards,
Keith
Dec 17, 2010
Jerren Saunders says:
When using the Start Page option, if using the Macro dialog to add list-pages to...When using the Start Page option, if using the Macro dialog to add list-pages to your page, it incorrectly uses the property "startpage=" instead of "startPage=". If you manually correct the case of the 'P', it should work.
Dec 20, 2010
Keith Brophy says:
Hi Jerren, Thanks for this report - I have raised an internal issue with our de...Hi Jerren,
Thanks for this report - I have raised an internal issue with our developers.
Cheers,
Keith
Jan 25, 2011
Gregory Frank says:
How do I sort the listed pages? I want my list of pages to be alphabetical. Curr...How do I sort the listed pages? I want my list of pages to be alphabetical. Currently, when I use list pages direction = siblings, I get a list, but it's never sorted alphabetically.
Thanks,
Gregory