Ratings Plugin
Version 23.3 by Thomas Mortagne on 2013/06/18 09:12
A plugin to handle ratings of wiki documents |
Type | Plugin |
Category | |
Developed by | |
Rating | |
License | GNU Lesser General Public License 2.1 |
Table of contents
Description
Configuration
Supported parameters :
xwiki.cfg parameter key (XWiki.XWikiPreferences field name) | Description | Accepted values | Default value |
---|---|---|---|
xwiki.ratings.ratingsmanager | The fully qualified name of the class to be used as rating manager | com.xpn.xwiki.plugin.ratings.internal.DefaultRatingsManager | |
xwiki.ratings.averagerating.stored (ratings_averagerating_stored) | Is the average rating stored in a XWiki object ? | 0 or 1 | 0 |
xwiki.ratings.reputation (ratings_reputation) | Is user reputation feature activated ? | 0 or 1 | 0 |
xwiki.ratings.reputation.stored (ratings_reputation_stored) | Is user reputation stored in a XWiki object ? | 0 or 1 | 0 |
xwiki.ratings.reputation.defaultmethod (ratings_reputation_defaultmethod) | name of the methods used for calculating a user reputation. In the user profile, one object per calculation method will be stored, each one referencing the name of the method used. | Coma-separated list of methods | average |
xwiki.ratings.reputation.classname | The default algorithm class to use for calculating user reputation | The fully qualified name of the class to be used as reputation algorithm | com.xpn.xwiki.plugin.ratings.internal.DefaultReputationAlgorythm |
xwiki.ratings.reputation.groovypage (ratings_reputation_groovypage) | The fullname of a document that contains an implementation of a reputation calculation algorithm written in groovy | None | |
xwiki.ratings.separatepagemanager.spacename (ratings_separatepagemanager_spacename) | The name of the space to use to store ratings documents/objects when using the sepearate-page ratings manager | The name of the space to be used | None (uses the same spaces as the page being rated) |
xwiki.ratings.separatepagemanager.hasratingsforeachspace (ratings_separatepagemanager_hasratingsforeachspace) | Should the separate page ratings manager use a space for each of the rated space? | 0 or 1 | 0 |
API
404: Not Found
Prerequisites & Installation Instructions
Follow these steps:
- Add the JAR in your container classpath (WEB-INF/lib)
- Edit xwiki.cfg and add the following line to the list of plugins :xwiki.plugins=\
[...]
... ,\
<plugin package> - Restart your container
- Verify the plugin is properly installed by typing the following in a wiki page :{{velocity}}
$xwiki.<plugin name>.name
{{/velocity}}If the installation has been successful, you will see <plugin name>.
For this plugin replace:
- <plugin package> by com.xpn.xwiki.plugin.ratings.RatingsPlugin
- <plugin name> by ratings
Release Notes
v1.2
- Fixed a NPE when using the default ratings manager
- By default average rating should be stored
v1.1
Changed the default ratings manager for the one that stores ratings object on the same page as the document being rated (was a rating manager that stores rating object in different pages).