The dialog rating widget

The dialog rating widget is displayed for individual resources. Users can use the rating widget to view which ratings have already been assigned to a resource and to assign new ratings to it.

By default, the dialog rating widget is available for rating pages and portlets.

The widget is structured as follows:

1. The rating widget shows a headline that identifies the resource with which the user is working.

2. The next area shows the average rating by the community. This is the average of all ratings that all users in the community have applied to the resource. By default the widget displays five stars ( ***** ), where five stars are the highest rating and one star is the lowest ratings that a resource can have. If a user hovers on the stare that represent the community average rating, a tool tip shows the numeric representation of the ratings that the underlying resource has received. Users cannot modify the community average rating.

3. The community average rating bar chart then shows the distribution of ratings that have been applied to the underlying resources that is based on which ratings the community average rating has been calculated.

4. The end of the rating widget shows the personal rating by the current users that is the rating which the user who invoked the widget has applied to the resource that is displayed. The user's personal rating is visualized by the same 1-to-5 star representation as the community average rating. The following rules apply:

   • Hovering over the stars shows the numeric value of the rating.

   • Users who have not applied a rating can apply a rating by hovering over the stars and clicking on of them. Users who have already applied a rating can change the existing rating by clicking the appropriate asterisk. Users can delete their rating entirely by clicking a Delete button.

   • Users can switch between public and private view mode. This defines:

     • whether a ratings that the user applies will be public or private

     • whether the ratings shown are the user's public or private ratings.

     Users can view public ratings from other users, but not private ratings from other users. For more details about public and private ratings refer to Security for tagging and rating.

5. In a default portal installation the dialog rating widget is available for rating pages and portlets. A user can rate the current page by selecting Rate . . . from the portlet menu. A user can rate a portlet by selecting Rate this portlet from the portlet menu.

6. When a user clicks the Save button, the rating is persistently assigned and a success message is shown.

   Only the rating or other change applied in the current view mode - public or private - is saved. Example: If a user marks a rating in public mode, then moves to private mode, marks another rating, and clicks Save, only the last rating applied in private mode is saved. The same applies to other user actions, such as changing or deleting a rating. The widget provides an information text to inform the user about this behavior.

• Configure the dialog rating widget
  Configure the dialog rating widget by either of two methods.
• Add the dialog rating widget to the portal content
  In a default portal installation the dialog rating widget is available for rating pages and portlets. We can make the dialog rating widget available for our own content.

Parent: The default tagging and rating user interface
Related reference:
Configuration reference
CP Configuration Service for tagging and rating