Search modules

Search modules help your users find information in Confluence: on a space, a Refined site, or your entire Confluence instance. The Search module is a simple search bar, while the Search Highlight module is a search bar with a background image or colour.

You can add these modules to homes on your Refined sites.

Basic filter

The simple filter lets you set filters to show only results from a specific space or label. A search module with simple filter looks in content titles and labels: to look in page contents (e.g. the page body), use the advanced filter. Tip: search only the current space with the $spacekey text variable.

Modules with the simple filter are context-aware, meaning they search in the site or category that they are placed on.

Advanced filter

The advanced filter lets you use CQL to create more specific search filters (available since Refined for Confluence version 6.X).

Unlike modules with the simple filter, modules with the advanced filter are not dynamic by default. However, it is possible to make them dynamic with the help of text variables.

To add your own complete CQL statement, make sure to uncheck Include title and label search. When this box is checked, the user entered word, $query, will be used for title and label search, i.e. (title ~"$query" or label in ("$query")) prepended with an and.

Some examples of using CQL:

Search all content:
text ~"*$query*"

Search all content within a space:
text ~"*$query*" and space.key=$spacekey

Search Confluence for users:
siteSearch ~ "*$query*" and type = user

Search my mentions:
siteSearch ~ "*$query*" and mention = currentUser()

Search in a Refined Site that has ID 4:
text ~"*$query*" and refinedSite = 4

Search Confluence Questions for questions or answers (RefinedTheme 6.1):

type = "com.atlassian.confluence.plugins.confluence-questions:answer" or type = "com.atlassian.confluence.plugins.confluence-questions:question"