You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

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, then click the 'Edit' button. The 'Edit Page' mode opens.
  2. Next, click the Macro Browser icon on the editor toolbar. The Macro Browser will open in the middle of the screen.
  3. 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 livesearch macro, click 'insert' to add it to your page.

Usage with the Wiki Markup Editor

What you need to type

What you will get

{livesearch}

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.

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

The Livesearch macro allows the following parameters:

Parameter

Required

Default

Description

ID
(id)

no

none

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

Restrict to this Space Key
(spaceKey)

no

all spaces

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

Examples

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}
RELATED TOPICS

Searching Confluence
Search Macro
Working with Macros

Take me back to the Confluence User Guide.

  • No labels

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