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,
- Open the Confluence page or blog post that you want to edit, then click the 'Edit' button.
- Click the Macro Browser icon
on the toolbar. The macro browser window will open. - Scroll through the list of macros to find the one you want. Alternatively, start typing the macro name into the search box at the top right of the macro browser. Macros with a matching name will appear in the main pane.
- Click the desired macro.
- Set the macro parameters to your requirements. If desired, you can preview these changes by clicking 'Refresh'.
- Click 'Insert' to add the macro onto the page.
You can also insert macros via autocomplete. For more information, see Using Autocomplete in the Rich Text Editor.
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 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:
Parameter |
Required |
Default |
Description |
|---|---|---|---|
ID |
no |
none |
Uniquely identifies the Livesearch when there are multiple livesearch macros in one page. |
Restrict to this Space Key |
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 Wikis Help Guide.