Content Rating for Confluence – Documentation

Installation

Install the add-on direc­t­ly from the Atlassian Mar­ket­place. Read more about instal­ling an add-on.

Usage

The add-on auto­ma­ti­cal­ly adds a new rating sec­tion to each page and blog post, which will enab­le users to rate the con­tent using the pre­di­fi­ned cri­te­ri­as in one of fol­lo­wing modes:

  • Togg­le (default)
  • Togg­le Small (unob­trusi­ve design)
  • Knob (wheels for more spe­ci­fic ratings)

Modes - Content Rating for Confluence

Statistic

Sta­tis­tic of con­tent ratings for cur­rent space can be found under “Space tools -> Con­tent Tools -> Con­tent Rating Sta­tis­tic”.

Sta­tis­tic table lists only per­mit­ted items for cur­rent user of space.

Content Rating Statistics

Disable Content Rating Macro

disable-content-rating-macro

Aut­hors can dis­able the con­tent rating on the­re con­tent indi­vi­dual­ly. To do that the “Dis­able Con­tent Rating” macro can be inser­ted into con­tent.

Configuration

The add-on enab­les you to defi­ne your own rating cri­te­ri­as. You will find the con­fi­gu­ra­ti­on wit­hin Confluence Admi­nis­tra­ti­on area at “Con­fi­gu­ra­ti­on” -> “Con­tent Rating” or by cli­cking the “Con­fi­gu­re” but­tom from the plugin mana­ger.

Configuration Link - Content Rating for Confluence

Criteria

In “Cri­te­ria” tab you will find all exis­ting rating cri­te­ri­as (Default cri­te­ri­as are Per­spi­cui­ty, Signi­fi­can­ce, Struc­tu­re).

 

Criteria - Content Rating for ConfluenceEdit

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

  • Name: Recom­men­ded is a noun. This is the only man­dato­ry field.
  • Descrip­ti­on: Tell users some­thing about the mea­ning of this cri­ter­ion.
  • Enab­le: You can dis­able and enab­le cri­te­ria.
  • Icon: You can defi­ne an optio­nal Font Awe­so­me icon for your cri­ter­ion. Just put the Font Awe­so­me 4.4.0 iden­ti­fier in it.

Be care­ful ren­aming a cri­ter­ion, as this may alter the ori­gi­nal inten­ti­on of exis­ting user ratings.

Delete

Press “Dele­te” from the list view and con­firm the dele­ti­on.

Dele­ting a cri­ter­ion also dele­tes all ratings for this cri­ter­ion. Con­si­der dis­ab­ling it.

Add criterion

For adding a cri­ter­ion just switch to the “Add Cri­ter­ion” tab and fill in the fields:

  • Name: Recom­men­ded is a noun. This is the only man­dato­ry field.
  • Descrip­ti­on: Tell users some­thing about the mea­ning of this cri­ter­ion.
  • Enab­le: You can dis­able and enab­le cri­te­ria.
  • Icon: You can defi­ne an optio­nal Font Awe­so­me icon for your cri­ter­ion. Just put the Font Awe­so­me 4.6.1 iden­ti­fier in it.

Add Criterion - Content Rating for Confluence

Settings

Modi­fiy glo­bal set­tings of rating addon in “Set­tings” tab.

Settings - Content Rating for Confluence

  • Mode: Choo­se one of fol­lo­wing modes
    • Togg­le (default)
    • Togg­le Small (unob­trusi­ve design)
    • Knob (wheels for more spe­ci­fic ratings)
  • Mul­ti­ple: Check for mul­ti­ple selec­tion of rating cri­te­ria.
  • Head­line: Add a head­line to request user to add an rating. (Optio­nal: If field is empty no head­line will be shown.)
  • Hide Result: Hide rating result in tool­tip for users wit­hout con­tent rating.
  • Replace Like: Select the cri­ter­ion, which will replace the ori­gi­nal like but­ton.
    The Confluence like but­ton will be hid­den and votes on the cri­ter­ion will be stored as like ins­tead as cri­ter­ion vote. Besi­de this cri­ter­ion will be hid­den for anony­mous user.

Restriction

  • Con­tent Type: Check con­tent type to enab­le con­tent rating for.
  • Space:
    • Choo­se space restric­tion exclu­de or inclu­de to hide or show con­tent rating in defi­ned space keys.
    • Defi­ne com­ma sepe­ra­ted list of space keys to restrict.
    • Use com­for­ta­ble auto­com­ple­te space search field to get and add cor­rect key.
  • Add “Dis­able Con­tent Rating” macro to dis­able the con­tent rating indi­vi­dual­ly.

Access

  • Anony­mous:
    • None (default): No anony­mous access of con­tent rating for all con­tents
    • View: View ratings of all anony­mous per­mit­ted con­tents
    • View and Vote: View and rate of all anony­mous per­mit­ted con­tents

Jira Issue Collector

You can use a JIRA issue collec­tor to gather more feed­back from your users.

To use a JIRA issue collec­tor, do the fol­lo­wing:

  1. Adding an issue collec­tor for the rele­vant pro­ject
  2. Copy the URL from src out of the HTML code
    Jira Issue Collector
  3. Pas­te it into the url field

What can we do for you?

Plea­se pro­vi­de us infor­ma­ti­ons about con­text whe­re the pro­blem occurs. e.g. con­tent tools under space con­fi­gu­ra­ti­on

Cookies erleichtern die Bereitstellung unserer Dienste. Mit der Nutzung unserer Dienste erklären Sie sich damit einverstanden, dass wir Cookies verwenden. Weitere Informationen

Die Cookie-Einstellungen auf dieser Website sind auf "Cookies zulassen" eingestellt, um das beste Surferlebnis zu ermöglichen. Wenn du diese Website ohne Änderung der Cookie-Einstellungen verwendest oder auf "Akzeptieren" klickst, erklärst du sich damit einverstanden.

Schließen