Documentation

Page Rating

Description

The Page Rating addon allows users to add the rating functionality to their presentations.

Properties

The list starts with the common properties, learn more about them by visiting the Modules description section. The other available properties are described below.

Property name Description
Title Text Text that appears as a module title.
Comment Text Text that appears above the comment area.
Rates List of Rates. Each rate consists of two images: 'Deselected' and 'Selected'. 'Selected' image appears when a rate is chosen. Otherwise 'Deselected' image is shown.

This property allows online resources. Find out more ยป

Supported commands

Command name Params Description
hide --- Hide Addon
show --- Show Addon
getRate --- Return rate of selected item

Advanced Connector integration

Each command supported by the Page Rating addon can be used in the Advanced Connector addon's scripts. The below example shows how it interacts with TrueFalse modules.

EVENTSTART
Source:TrueFalse1
Item:1-1
SCRIPTSTART
   var module = presenter.playerController.getModule('Page_Rating3');
   module.show();
SCRIPTEND
EVENTEND
EVENTSTART
Source:TrueFalse1
Item:1-2
SCRIPTSTART
   var module = presenter.playerController.getModule('Page_Rating3');
   module.hide();
SCRIPTEND
EVENTEND

Events

Page Rating sends events compatible with Advanced Connector.

It sends an event when a user selects the star.

Field name Description
Item Rate id
Value 0 - unselected | 1 - selected
Score N/A

CSS classes

Class name Description
page-rating-wrapper DIV wrapping Addon elements
page-rating-title DIV containing Title Text
page-rating-rates DIV containing rates
page-rating-comment DIV element containing comment text and comment area

Example

.page-rating-title  {
  background-color: orange;
}

.page-rating-rates {
  background-color: blanchedAlmond;
}

.page-rating-comment {
  background-color: white;
}

The above example shows how to change background color in DIVs.

Demo presentation

Demo presentation contains examples on how to use the Page Rating addon.