You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 23 Current »

The add-on enables you to define your own rating criterias. You will find the configuration within Confluence Administration area at "Configuration" → "Content Rating" or by clicking the “Configure” buttom from the plugin manager.

Criteria

In “Criteria” tab you will find all existing rating criterias (Default criterias are Perspicuity, Significance, Structure).

Edit

Here you can edit every aspect of the rating criterion. Press “Edit” from the list view and fill in the fields:

OptionDescription
NameRecommended is a noun. This is the only mandatory field.
DescriptionTell users something about the meaning of this criterion.
OrderSorting of criteria order numbers is ascending.
StatusYou can disable and enable criteria.
IconYou can define an optional Font Awesome icon for your criterion. 

Be careful renaming a criterion, as this may alter the original intention of existing user ratings.

Delete

Press “Delete” from the list view and confirm the deletion.

Deleting a criterion also deletes all ratings and feedbacks ( when feedback management is configured) for this criterion. Consider disabling it.

Add Criterion

For adding a criterion just switch to the “Add Criterion” tab and fill in the fields:

OptionDescription
NameRecommended is a noun. This is the only mandatory field.
DescriptionTell users something about the meaning of this criterion.
OrderSorting of criteria order numbers is ascending.
StatusYou can disable and enable criteria.
IconYou can define an optional Font Awesome icon for your criterion. 


Settings

Modify global settings of rating addon in “Settings” tab.

SettingDescription
Insertion

With insertion, you can configure, where the criteria are shown at the frontend. 

  • Title: criteria will be shown near the title of the page
  • Content: criteria will be shown near/within the content
  • Custom: you can define a custom CSS selector (target selector) for showing the criteria
Insertion Placement

Insert the criteria and therefor set the position within the above selected method.

  • Before
  • After
  • Append
  • Prepend
Insertion Style

You can add additional CSS which will be added to the main criteria container as "style" attribute.

Mode

Choose one of the following modes

  • Toggle (default)
  • Toggle Small (unobtrusive design)
  • Knob (wheels for more specific ratings)
MultipleCheck if multiple criteria be selected.

Anonymous Rating for internal users

Check if you want that Confluence user ratings should be anonymous.
HeadlineAdd a headline to the rating criteria  (Optional: If field is empty no headline will be shown.)
Hide UsersCheck to hide users in rating result dialog.

Hide Result

Check to tide rating result for users without content rating.
Replace Like

Select the criterion, which will replace the original like button.

The Confluence like button will be hidden and ratings on the criterion will be stored as like as criterion rating. The criterion will also be hidden for an anonymous user.


Restriction

SettingDescription
Content Type

Check content type to enable content rating for.

  • Page
  • BlogPost
Space
  • Choose space restriction exclude or include to hide or show content rating in defined space keys.
  • Define comma seperated list of space keys to restrict.
  • Use comfortable autocomplete space search field to get and add correct key.
Individual ContentAdd “Disable Content Rating” macro to disable the content rating individually.

Access

SettingDescription
Anonymous User

Configure if anonymous user should have not access, can view or can view and rate in rating criteria area.

  • None (default): No anonymous access of content rating for all contents
  • View: View ratings of all anonymous permitted contents
  • View and Rate: View and rate of all anonymous permitted contents

Statistics

  • User Groups: Define comma seperated list of user groups with access to Content Rating Statistic. Default only system admins have access.

Reset

  • Autors: User with edit permissions can reset statistic of single content.
  • Space Admin: User with space admin permissions can reset statistic of space content.
  • Remove all likes: All likes will be removed when resetting statistic (This works only when "Replace Like" option has selected criterion).
  • Remove all likes: All likes will be removed when resetting statistic (This works only when "Replace Like" option has selected criterion).

Access

  • Anonymous:
    • None (default): No anonymous access of content rating for all contents
    • View: View ratings of all anonymous permitted contents
    • View and Rate: View and rate of all anonymous permitted contents

JIRA Issue Collector

You can use a JIRA issue collector to gather more feedback from your users.

To use a JIRA issue collector, do the following:

  1. Adding an issue collector for the relevant project
  2. Copy the URL from src out of the HTML code
  3. Paste it into the url field



  • No labels