Ratings Application

Last modified by Admin on 2024/03/19 07:38

starRate Wiki pages, and browse them by average ratings
Recommended
TypeXAR
Category
Developed by

XWiki Development Team

Active Installs409
Rating
3 Votes
LicenseGNU Lesser General Public License 2.1

Installable with the Extension Manager

Description

This documentation concerns the Ratings Application after changes performed on XWiki 12.9RC1. For documentation prior to that version please check this page.

Please check the following release notes to understand potential issues you may have (if you were using the old Ratings API in Java code or scripts), and how your rating data will be migrated.

This application allows to rate XWiki pages.
By default, the ratings application allows to perform Ratings on a scale of 5 stars, and performs an automatic computation of the average rating for each pages. 

This application is based on the Ratings API, you might find more details to customize or create your own rating application.

Screenshots

Rating stars displayed in XWiki pages.
RatingsApplication.png

Rating stars displayed in Extension Manager.
stars.png

Administration

The administration page for Ratings is available under the social category, and allows to disable or enable the application.
It's enabled by default, not that disabling it won't remove the Ratings data.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

  1. Log in the wiki with a user having Administration rights
  2. Go to the Administration page and select the Import category
  3. Follow the on-screen instructions to upload the downloaded XAR
  4. Click on the uploaded XAR and follow the instructions
  5. You'll also need to install all dependent Extensions that are not already installed in your wiki

Dependencies

Dependencies for this extension (org.xwiki.platform:xwiki-platform-ratings-ui 16.1.0):

Tags: ratings social
    

Get Connected