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 macro

You can add the macro using the macro browser.

or you can do this either using the mark-up

2. Add the parameters.

when the macro is selected it opens up the macro window where you can choose your macro parameters.

4. Save the macro and page

the horizontal theme results in

When using the divs theme (vertical)

which results in

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: v2 (the default) and divs.

 Rate Search macro
Rate Search macro

Steps:

  1. Add the Rate Search Macro

    You can add the macro using the macro browser.

or you can do this either using the mark-up

2. Add the parameters.

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

3. Save the macro.

4. Save the page

The macro appears as below.


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 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




Top of page

  • No labels