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. Open your desired Confluence page or blog post, then click the 'Edit' button. The page or blog post opens in edit mode.
  2. Click the Macro Browser icon on the toolbar. The macro browser window opens in the middle of the screen in 'macro selection' mode.
  3. Scroll through the list of macros. Alternatively, start typing part of the name of your desired macro into the search box at the top right of the macro browser window. Macros with a matching name will appear in the main pane.
  4. Click on the desired macro to access its parameters and preview parameter changes ('preview mode').
  5. Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
  6. 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:

必要な入力項目

表示結果

{pagetreesearch}

マクロ パラメーター

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 (:).

パラメーター

必須かどうか

既定

説明

Name of Root Page
(rootPage)

いいえ

なし

このマクロでページ階層が検索されるルート ページの名前。指定しない場合、ルート ページは現在のページとなります。


関連トピック

Pagetree Macro
Adding a Navigation Sidebar
Working with Macros

Take me back to the Confluence User's Guide.

  • ラベルなし

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.