Considering Confluence Cloud?
Get the high-level details of Confluence Cloud and available features by plan.
Insert the page tree search macro
Using the Page Tree Search macro, you can add a search box to your Confluence page. When a viewer enters a search term, Confluence will search a hierarchy of pages starting from a specified parent (root) page and return the search results.
You can also add a search box as part of a dynamic page tree, which looks like a table of contents. See the Page Tree macro.
Use the Page Tree Search macro
To add the Page Tree Search macro:
When editing, select from the toolbar
Find the macro by name and select it
Configure it as needed
You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.
To edit the Page Tree Search macro:
Select the macro placeholder.
Select the Edit icon to open the configuration panel.
Configure the parameters. Your changes are saved as you go.
Resume editing the page, and the panel closes.
You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.
Parameters
Parameters are options that you can set to control what and how content from the macro appears on the page.
If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).
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. |
Wiki markup example
Wiki markup is only supported in the legacy editor.
Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.
Macro name: pagetreesearch
Macro body: None.
1
2
3
4
{pagetreesearch:root=My page name}
Was this helpful?