Ratings for Confluence Server

Rate Search Macro

You can also use the Ratings for Confluence app to add the Rate Search Macro, and the steps to do so are found below:

  1. Go to a page to which you want to add the Ratings macro, and click Edit.

  2. Click the Insert More Content icon, and choose Other Macros from the list.

  3. Add the Rate Search Macro. You can add the macro using the macro browser or by typing the mark-up { rate.

    rate search macro
  4. Add the parameters. When the macro is selected it opens up the macro window where you can choose your macro parameters.

    insert rate search macro
  5. Insert the macro then save the page. The rendered macro appears as in the example below.

    rendered rate search macro

Parameters

Parameters Type Required? Default Description

spaces

spacekey

Takes a comma separated list of space keys to search. By default will search all available spaces.

maxResults

int

10

Set the maximum number of results to be returned.

minRates

int

Only display content that has received the specified amount of ratings.

contentCreatedBy

string

anyone

Search only content that was created by a specific user.

contentType

enum

page and blogpost

Restrict search results to one of the following types of content: (page, blogpost, comment). By default both pages and blogposts are returned.

includeLabel

string

Returned results MUST include the specified label (e.g. global:myLabel or my:favourite) – note that scope for the label needs to be set, as in scope:label

excludeLabel

string

Returned results MUST NOT include the specified label (e.g. global:myLabel or my:favourite) – note that scope for the label needs to be set, as in scope:label

theme

Enum

v2

Set the theme to use, available themes are: v2, divs, basic, and digg.