This documentation has moved. For the most recent documentation, check out https://docs.adaptavist.com. Please update your bookmarks and links.

Skip to end of metadata
Go to start of metadata

 Overview

A set of macros for collecting and displaying page ratings

 Rate Macro
Rate Macro

Steps:

  1. Add the Rate macro by selecting if from the Macro Browser or you can by typing {rate m to display a list of matching macros.


2. Add the macro parameters then click Insert.

Parameters

Param

Type

required?

Default

Description

allowAnonymous

boolean


true

false stops anonymous from rating this content

allowUsers

boolean


true

false stops logged in users from rating this content

theme

Enum


v2

Set the theme to use, available themes are: Horizontal (v2 the default) and Vertical (divs)


4. Save the Confluence page.

The Horizontal theme is rendered similar to the following.

When using the divs theme (vertical), the ratings are displayed similar to the following.



 Rate Search macro
Rate Search macro

Steps:

  1. Add the Rate Search macro by selecting if from the Macro Browser or you can by typing {rate m to display a list of matching macros.


2. The macro is added to the page. Click the macro to display the Edit Rate Search Macro window. Add the required parameters.

3. Save the macro.

4. Save the Confluence page. The macro appears similar to the following.

Parameters

Param

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 blog posts 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.




Top of page

  • No labels