The Livesearch Macro allows you to add a search box to a Confluence page. When users enter a search term into the search box, Confluence will dynamically display matching results as they type.

The livesearch macro appears as shown in the screenshot below:

Screenshot: The Livesearch Macro in Confluence

On this page:

Usage with the Macro Browser

To insert the livesearch 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 livesearch macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

必要な入力項目

表示結果

{livesearch}

パラメーター

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

The Livesearch macro allows the following parameters:

パラメーター

必須

既定

説明

ID
(id)

いいえ

なし

Uniquely identifies the Livesearch when there are multiple livesearch macros in one page.

Restrict to this Space Key
(spaceKey)

いいえ

すべてのスペース

Specify a space key to limit the search to the given space.

例

Restricting the Search to a Single Space

The sample code below restricts the search to the space which has a space key of 'DS'.

{livesearch:spaceKey=DS}
関連トピック

Searching Confluence
Search Macro
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.