Confluence Docs 3.0 : Pagetree Search Macro This page last changed on Jun 03, 2009 by ggaskell. 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 Usage with the Wiki Markup Editor Macro Parameters ## Usage with the Macro Browser To insert the Pagetree Search macro into a page using the Macro Browser, Open your desired Confluence page, then click the 'Edit' button. The 'Edit Page' mode opens. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen. In the Macro Browser, type the name of your desired macro into the search box at the top right of the window. Macros with a matching name will appear in the centre pane. Click on the desired macro to see its options screen. Here, you can set the macro parameters then click 'insert' to put the macro into the page. 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 settings for Confluence macros that allow the user to control their content or presentation. The table below lists relevant parameters for this macro. Parameter names are displayed differently in the macro browser interface and in wiki markup. Below, parameter names used in the macro browser are indicated in Bold text, while their equivalents in wiki markup are indicated in (`bracketed`) text. If the latter is not shown, then in wiki markup, the parameter's name should be omitted and only its value should be added immediately after the colon symbol (`:`).
Parameter | Required? | Default | Description
--- | --- | --- | ---
Name of Root Page (`rootPage`) | 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 Confluence User Guide.

Document generated by Confluence on Nov 05, 2009 23:35