This page last changed on Dec 17, 2009 by ggaskell.

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. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

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

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.

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

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