The Pagetree Search macro allows you to 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 on a new screen.
Below we tell you how to add the Pagetree Search macro to your page.
You may be interested in the Pagetree macro
You can also add a search box as part of a dynamic page tree, which looks like a table of contents. Read the instructions on the Pagetree macro.
On this page:
Usage with the Macro Browser
To insert the Pagetree Search macro into a page using the Macro Browser,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
Once you've found the Pagetree Search macro and have added the required parameter values, click 'insert' to add it to your page.
Usage with the Wiki Markup Editor
Include the following markup in your page:
What you need to type |
What you will get |
|---|---|
{pagetreesearch} |
|
Macro Parameters
Parameters are options that you can include in Confluence macros to control the content or format of the macro output. The table below lists relevant parameters for this macro.
Parameter names are different in the macro browser and in wiki markup. Below we show the macro browser parameter names in bold text, and the equivalent wiki markup parameters in (bracketed) text. If we do not show any parameter name for the wiki markup, then you should leave out the parameter name and simply include the parameter value as the first parameter, immediately after the colon (:).
Parameter |
Required? |
Default |
Description |
|---|---|---|---|
Name of Root Page |
no |
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. |
RELATED TOPICS
Pagetree Macro
Adding a Navigation Sidebar
Working with Macros
Take me back to the Wikis Help Guide.