Page Tree Search Macro
Add the Page Tree Search macro to a page to provide users with a way to search for pages in a specific page hierarchy.
This macro is useful when you want to provide a way to search:
- one section of the current space, such as in a knowledge base
- a specific part of a page hierarchy, such as one project in a space that contains multiple projects.
After someone enters a keyword and clicks the Search button on this macro, the results are presented on Confluence's advanced search screen.
Screenshot: Page Tree Search macro on a Confluence page.
For a better search experience, check out the Livesearch Macro, or enable the integrated search field in the Page Tree Macro.
Add this macro to your page
To add the Page Tree Search macro to a page:
- Unable to render {include} The included page could not be found.
- Choose Page Tree Search from the Confluence content category.
- Choose the number of page versions to display.
- Choose Insert.
You can then publish your page to see the macro in action.
Change the macro parameters
Error rendering macro 'excerpt-include'
User 'null' does not have permission to view the page.
Here's a list of the parameters available in this macro.
Parameter | Default | Description |
|---|---|---|
Name of Root Page | none | The name of the root page whose hierarchy of pages will be searched by this macro. If this not specified, the root page is the current page. Note: Unlike the Page Tree macro, the Page Tree Search macro does not accept the special values that start with an @ sign, such as @home or @self. |
Error rendering macro 'excerpt-include'
User 'null' does not have permission to view the page.
Other ways to add this macro
Add this macro as you type
Add this macro using wiki markup
Macro name: pagetreesearch
Macro body: None.
{pagetreesearch:root=My page name}