Ratings Application
 | Rate Wiki pages, and browse them by average ratings |
| Type | XAR |
| Developed by | |
| Active Installs | 663 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
This app allows users to rate Wiki pages.
Screenshots
Rating stars displayed in XWiki pages.
Rating stars displayed in Extension Manager.
UI Extension point
The javascript that injected the ratings html after the breadcrumb (id="hierarchy") has been replaced by a UI Extension Point.
This change has the advantage that it allows ratings to be displayed in the flamingo skin.
The problem with the old approach was that in flamingo there is no html element with the id "hierarchy".
Ratings are disabled by default
By default, the ratings are disabled.
You can activate them either globally or at space level.
Please see below how to do that.
New configuration source
As opposed to the older versions, since 6.4 the ratings configuration can now be done via XWiki objects.
This means that it is possible to configure the application on a space basis.
The main configuration source is located at XWiki.RatingsConfig. From the XWiki.RatingsConfig page select Edit > Objects and set the "Display ratings" to Yes, then Save & View.
In order to have separate configurations for each space you need to attach a XWiki.RatingsConfigClass object to the WebPreferences document of that space. Unfortunately, at the moment there is no UI for editing the configuration so it has to be done by editing the objects manually.
A important thing to note is that a fallback to xwiki.[cfg|preferences] has been kept.
The precedence order is as follows:
- *.WebPreferences
- XWiki.RatingsConfig
- xwiki.cfg
- xwiki.preferences
XWiki.RatingsConfigClass
| Property | Description | Values | Default |
|---|---|---|---|
| displayRatings | Display the ratings or not | boolean | true |
| excludedPages | Pages on which ratings should not be displayed | comma separated list of documents | - |
| managerHint | The ratings manager to use. This defines where the ratings are stored | default=same page,separate=different space | default |
| storageSpace | In case of using the separate ratings manager, specify in which space to save the rating information | space name | - |
| storageSeparateSpaces | Store the ratings for each space individually (only takes effect at global level, on space level use storageSpace) | boolean | false |
| storeAverageRating | Store the average rating in an object or keep it in memory | boolean | false |
| reputation | Calculate the user's reputation | boolean | false |
| reputationStored | Store the user reputation in an object or keep it in memory | boolean | false |
| reputationMethod | Name of the methods used for calculating a user's reputation | comma separated list of values | - |
| reputationAlgorithm | The algorithm used to calculate the reputation | default,simple,custom | default |
| reputationCustomAlgorithm | When the reputationAlgorithm property is set to "custom" a reference to the algorithm must be provided | Document containing the groovy script | - |
Tested on
This extension has been tested with the following configurations.
| Extension Version | XWiki Flavor | Notes |
|---|---|---|
| 1.0 | XWiki Enterprise 2.2+ | Compatible with toucan and XWiki 2.2+ using plugin API |
| 1.2 | XWiki Enterprise 2.2+ | Compatible with colibri and toucan and XWiki 2.2+ using plugin API |
| 1.3 | XWiki Enterprise 4.1+ | Compatible with colibri and XWiki 4.1+ using component API |
| 1.3.1 | XWiki Enterprise 6.0.1 | Warning message when installing the app with EM |
| 1.3.1 | XWiki Enterprise 6.2.4 | |
| 7.1.3 | XWiki Enterprise 7.1.3 | |
| 10.10 | XWiki 10.10 | |
| 10.8.3 | XWiki 10.8.3 | |
| 10.11.2 | XWiki 10.11.2 | |
| 11.1 | XWiki 11.1 |
Prerequisites & Installation Instructions
- For 1.3+
- Install using Extension Manager
- For 1.1. and 1.2 only
- This application relies on the Ratings Plugin. Please make sure you have successfully installed this plugin first.
- Add XWiki.RatingsTranslations as an internationalization document bundle
- Visit the Ratings section of the administration UI to activate or deactivate ratings
Release Notes
v6.4
Starting with 6.4 the release notes are now part of the XWiki Enterprise Release Notes.
v1.3.4
XARATINGS-13Improve deprecated warnings from the console
v1.3.3
-
XARATINGS-12The class initializer does not mark the documents as hidden
v1.3.2
-
XARATINGS-7RatingsClass and AverageRatingsClass get a new version everytime the wiki starts -
XARATINGS-5Mark page "XWiki/RatingsMacros" as hidden
v1.3
- Installs automatically using Extension Manager
- Tested with XWiki 4.5
Dependencies
Dependencies for this extension (org.xwiki.platform:xwiki-platform-ratings-ui 11.2):
