Search macro

 Include a search bar. Search globally or in a specific space.

On this page


Macro Setup

Search

Macro key: rw-search

Macro body: None.

Promoted: Main Dashboard, Category Dashboards, Main Space Layout, Space Layouts

Using the Search macro

To add the Search macro to a page

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the Search macro.


For Site and Category homes we recommend using the Search Module


Leverage the power of Layout placeholders

The parameters of the Search Macro works great with Layout Placeholders if the macro is placed on a dashboard or space layout.


Preview


Parameters

Parameters are options that you can set to control the content or format of the macro output. When the parameter name used in Confluence storage format or wiki markup is different to the label used in the macro browser, it will be listed below in brackets (example).

Parameter

Default

Description

Available since

Placeholder text

(placeholderText)


Add a custom placeholder text. E.g. "Search the wiki"6.0

Space key

(spaceKey)

 

Specify a space key to only search the specified space. This is added using a space lookup.4.0

Category

 Set the category key to limit the search.6.0
Site
Set the site to limit the search.6.0
CQL
Note: This is an advanced option using Atlassian CQL. Defining a query here will ignore other filtering parameters. The default search query is: (title ~"$query*" or label in ("$query"))6.0

 

Demo


Learn more - Advanced Search

On the documentation for the Search modules you can learn more about how to work with the advanced options. Click here: Search modules in RefinedTheme