This page last changed on Dec 17, 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

To insert the Pagetree Search macro into a page using the Macro Browser,

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

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

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

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's Guide.

Document generated by Confluence on Sep 19, 2011 02:36