Description

Rating System

The objective of the Rating System is to allow rate pages and users and calculate average rating of pages and users. Rating can then be used in search results.

This feature is being contributed by EMC and reviewed by the XWiki Community. The current code and deployment guide is attached to this page for review of the current implementation.

Possible Designs

Ratings in Comments

This is the current implementation of the contributed code.

Ratings in a Separate Class

We could store ratings separately. This is less likely because ratings should often come with a comment to explain the rating. In this case it makes sense to treat the comment as a standard XWiki comment. By handling rating as comments is possible to have a clean UI and at the same time encourage people to rate the document when they comment.

Ratings in Separate Pages

The Annotation Feature also contains comments and ratings, but at the same time also allows to annotate or comment the annotation. The comment can also be structured as a change request for the document. For this method it is required to store annotations (including comments and ratings) as separate linked documents. 

We need to study if we should have one unique approach or two approaches (separate or not separate documents). If we have two approaches we might want to handle this as a setting in the plugin and provide a migration system between the two methods.

Design proposal

Issues

We need to check if the Ratings Feature is not the same feature as the Annotation Feature and should have merged design and development.