Mark for Review Plugin

Added by Laura Kolker, last edited by Laura Kolker on Feb 26, 2007  (view change)
Name Mark for Review Plugin
Vendor Atlassian Software Systems (Website)
Authors Laura Kolker, Brendan Patterson
Homepage http://confluence.atlassian.com/display/CONFEXT/Mark+for+Review+Plugin
Issue Management http://developer.atlassian.com/jira/browse/CMFR
Categories Macros
Version 1.4-RC2
Availability Confluence v2.3.3 to v2.9-m5
State Prerelease
Support Unsupported Plugins
License Freeware / Open Source (BSD)
Price Free
Release Docs http://confluence.atlassian.com/display/CONFEXT/Mark+for+Review+Plugin
Java API Docs http://svn.atlassian.com/svn/public/contrib/confluence/markforreview/doc/javadoc
Download Source https://svn.atlassian.com/svn/public/contrib/confluence/markforreview
Download JAR plugins-mark-for-review-1.4-RC2.jar
Versions

Using Confluence 2.2.x ? You'll need to use the older version: plugins-mark-for-review-1.1.jar.

Description

Allows users to mark pages for review by moderators. Imagine Alice, a confluence user, creates a page in some space. This space has a moderator, Bob, whose responsibility it is to make sure that the content of the space is good, for some definition of good. But Bob doesn't have time to read every page in the space. What to do?

With this plugin, Calvin reads Alice's page and decides that the page has some problems. So he Goes to the Review Tab and fills out a review. Bob, the moderator, has a page he checks daily that lists all the reviews for that space where he can see Calvin's report about Alice's page.

Features

  • Review Interface is available via a tab on each page.
  • Reviews are saved to the global bandana context
  • A report of all reviews can be generated by the:
    • {markforreview-report} plugin
    • which is only visible to members of the Moderators group
    • The report plugin can take one parameter: "space", which will scope the results on a per space basis. Example: {markforreview-report:space}
  • Customizations
    • The groups which can view the report can be customized
    • The review types describing the reviews can be customized
    • Customizations can be made globally, from the Mark for Review link on the Admin console
    • Customizations can be made on a per space basis, from the Mark for Review link in the Space Admin console
  • Space tab - Review Report, which provides the report for that space's reviews

Installation

Use the Confluence Plugin Repository or the Plugin Manager to install the Mark for Review plugin.

Usage

Add a review.

  • Go to the 'Review' tab now associated with each page.
  • Fill out and submit the form.

Manage reviews.

Restricted feature

This feature is only available to users who are members of groups with moderator privileges. These are customizable from the Mark for Review link in either the Admin or Space Admin console. No groups are set by default.

Add the following macro to any page. Users who have been given global moderator privileges will be able to see it.

{markforreview-report}

This macro can take one parameter: space, which will only return reviews for pages from this space. Users who have been given global or per space moderator privileges will be able to see it.

{markforreview-report:space}

Alternatively
Browse a space, and click 'Review Report'.

Users who can see the report macro (members of groups with moderator privileges) can delete reviews with the report macro. Either click the on the review, or check of the checkbox for each review you wish to delete, and click 'Delete Multiple Reviews'.

Customize options

Global Options
  • Go to the Admin console.
  • Go to the 'Mark for Review' link in the Security section of the Admin panel.
Per space options
  • Click the 'Browse Space' link for the space you're interested in.
  • Go to the 'Space Admin' tab
  • Go to the 'Mark for Review link in the 'Security' section of the panel.

Assign moderators

  • You can add privileges to groups by typing a comma-separated list of the desired groups in the text field. For example: 'confluence-users, confluence-administrators'.
  • Submit the list by clicking the 'Add' button.
  • You can remove privileges from a group by clicking the next to that group.
  • There's a group-picker popup you can use to help you populate the 'Add Group' text-field.

Define Review Types

  • The default review types are Praise, Review, Spam, Wrong Area, Solicitor and Other.
  • You can add new review types by typing a comma-separated list of the desired types in the text field. For example: 'Right, Wrong, Irrelevant'.
  • Submit the list by clicking the Add button.
  • You can remove types by clicking the next to that group.
  • You will not be allowed to remove the last type.
  • On the per-space configuration screen, you can choose to just use the global types. To switch this on or off, click the 'Use Global Types' checkbox. If this option is checked, the UI will be unavailable, so if you wish to customize the types, uncheck this option.
  • Each Review Type has an image associated with it, to help visually seperate them in the report. You can see what image is associated with a type by choosing a type from the dropdown menu. The image will load to the right.
  • You can change the image by selecting one of the images below the dropdown menu and clicking 'Change Type'.

Version History

Plugin Versions

Version Date State License Price
Show description 1.0 (#1) 18 Oct 2006 Prerelease Freeware / Open Source (BSD) Free

Contributors

Show description 1.1-RC1 (#2) 19 Oct 2006 Prerelease Freeware / Open Source (BSD) Free

Contributors

Show description 1.1-RC2 (#3) 07 Nov 2006 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug Fixes

  • Handles no existing reviews (was throwing NPE)
  • IE styles in review and report are better handled

Features

  • Customize Moderator Groups (globally and on a per space basis)
  • Customize Review Types and the associated images (globally and on a per space basis)

Contributors

Show description 1.1-RC3 (#4) 20 Nov 2006 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug Fixes

  • CMFR 1 - Anonymous users will not see the review tab
  • CMFR 5 - Java/Velocity error fix
  • CMFR 8 - Breadcrumbs in admin config panel
  • CMFR 9 - Delete review permissions fixed

Features

  • New Space Admin tab: Review Report
  • ---- visible to Space and Global moderators
  • ---- provides the report macro for that space

Contributors

Show description 1.1-RC4 (#5) 08 Jan 2007 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug Fixes

  • CMFR-11 - Null Pointer Checking with user email object - useful for external user management

Contributors

Show description 1.1 (#6) 20 Feb 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Stable Release

Contributors

Show description 1.2-RC1 (#7) 20 Feb 2007 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug Fixes

Works with Confluence 2.3.2

Contributors

Show description 1.2 (#8) 27 Feb 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Stable Release

No changes since 1.2-RC1

Contributors

Show description 1.2.1 (#9) 20 Apr 2007 Stable Freeware / Open Source (BSD) Free

Release Notes

Minor Bug Fixes

  • cmfr-19 and 21 - removes some old logging errors
  • cmfr-20 - deleting spaces was causing NPE

Contributors

Show description 1.3-RC2 (#10) 28 Nov 2007 Prerelease Freeware / Open Source (BSD) Free

Release Notes
This release is compatible with Confluence 2.6

Contributors

Show description 1.3-RC3 (#11) 04 Feb 2008 Prerelease Freeware / Open Source (BSD) Free

Release Notes
Completed Internationalization

Contributors

Show description 1.3-RC6 (#12) 20 Mar 2008 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug Fixes

Contributors

Show description 1.3-RC7 (#13) 21 Mar 2008 Prerelease Freeware / Open Source (BSD) Free

Release Notes

i18n bug fixes

Contributors

Show description 1.3 (#14) 27 Mar 2008 Stable Freeware / Open Source (BSD) Free

Release Notes

Stable Release

Contributors

Show description 1.4-RC2 (#15) 06 May 2008 Prerelease Freeware / Open Source (BSD) Free

Release Notes

Bug fixes and updated to work with Confluence 2.8

Contributors

Screenshots

Screenshots

Labels

plugin plugin Delete
Enter labels to add to this page:
Please wait 
Looking for a label? Just start typing.

Comments (81)

 

  1. Oct 18, 2006

    James Matheson says:

    How is this plugin related to the requirements that have recently been written a...

    How is this plugin related to the requirements that have recently been written at Mark For Review?

    1. Oct 18, 2006

      Laura Kolker says:

      ok....

      ok. Here's what I'm noticing as different:

      • It's a tab instead of an icon next to favorites
      • review is saved in global bandana context instead of space bandana context
      • reviewers don't get emailed a link to the review
      • reviewers don't have access to the review
      • reviewers and moderators seem to have different roles than in the the DEVNET version
      • The Review Interface discusses showing a "review level". I'm not sure if that's the same as a review label or what I'm calling a review type (Praise, Spam, etc.)
      • There's no global or space admin interfaces. Customization is limited to choosing which users are moderators via a group.
      • Review types (initial default labels) are different.

  2. Oct 19, 2006

    Hitesh Seth says:

    Interesting plugin, we have been looking for more review etc. capability with co...

    Interesting plugin, we have been looking for more review etc. capability with confluence. I espacially like the fact that you can see all the reviews together. What are some of the limitations (if any), for instance if we have large space with 1000s of pages how do you ensure that you are scaling properly to meet the potential of 10000s (or even more) of reviews for the pages.

    Where do you store all the review information. Can you export it out as XML/text etc.

    BTW, is there a way of capturing all comments in a space in one single page? or even through a SOAP/XML-RPC API?

    1. Oct 19, 2006

      Laura Kolker says:

      re: scaling Well, it needs to be properly tested in a large environment. This ha...

      re: scaling
      Well, it needs to be properly tested in a large environment. This hasn't happened yet. When/if it does I'll be sure to doc any gotchas on this page.

      re: storing. It's stored in the global bandana context/file. So, it's basically saved as serialized XML on the server. To see the data as stored, after you've got some reviews, go to that Confluence's [Data]/config/ directory. Open up the confluence-global.bandana.xml file, and look for an entry with key: com.atlassian.confluence.extra.markforreview

      re: comments in a single page, or through the web service API. I'm not sure. Probably, but that's outside of the scope of this plugin.

  3. Oct 27, 2006

    mark van says:

    I'm pretty happy with this plugin because it gives me the opportunity to let peo...

    I'm pretty happy with this plugin because it gives me the opportunity to let people give me feedback about pages.

    Is it possible to make some customization possible? Because I would really like to translate the texts to Dutch and change some of the feedback options.

    1. Oct 27, 2006

      Laura Kolker says:

      The customization options that are currently planned and soon to be released inc...

      The customization options that are currently planned and soon to be released include:

      • changing which groups have "moderator privileges"
      • changing the "review types" (Praise, Spam, etc.)
      • on both a global or a per space basis

      re: translation - I'm not personally equipped to translate text into Dutch (really, any language ). However, the source is available at https://svn.atlassian.com/svn/public/contrib/confluence/markforreview
      Many (all? should check) of the visible texts are defined in properties files. At this point in the source there should only be one: ViewReviewAction.properties, although at least one more will be added to the source immenently.

      re: other feedback options - what did you have in mind?

      I'm glad to hear you're happy with it. Thanks for the feedback.

      1. Nov 06, 2006

        mark van says:

        I tend to use your mark for review plugin as customer feedback for a public know...

        I tend to use your mark for review plugin as customer feedback for a public knowledge base (non editable). The form mail plugin from adaptavist doesn't give me enough possibility's to change the interface or fields. I have looked at the source code in SVN and seen that almost no texts are defined in the property file but in code. I am eager awaiting you next release. (The more you standardize, the less i need to customize )

        Tab: from 'review' to 'feedback' (or something like it)

        Review types: 'question','tip','other' (or something alike, just thinking aloud here)

        And in Dutch of course . I am not 100% sure how to 'give back' my translation, (same like building language pack for Confluence itself?) but in case you like to have a Dutch translation of your plugin that is a possibility.

        1. Nov 07, 2006

          Laura Kolker says:

          re: next release I just released the Customization release (1.1RC2). re: "seen...

          re: next release
          I just released the Customization release (1.1-RC2).

          re: "seen that almost no texts are defined in the property file but in code."
          I tried to put as many as I noticed in, but I'll admit I haven't made a thorough check.
          Here's a JIRA issue for that:
          http://developer.atlassian.com/jira/browse/CMFR-3

          re: "Tab: from 'review' to 'feedback'
          This is not as easy as it sounds. I'm told there are ways to provide references to resource files from the web-item tag, but I have yet to get any of them to work.
          I've added a JIRA issue for that.
          http://developer.atlassian.com/jira/browse/CMFR-2

          Feel free to add more JIRA issues to that project as you notice bugs, or think of improvements.
          I really appreciate your feedback.

          1. Nov 08, 2006

            Aggelos T. Paraskevopoulos says:

            Laura, when I've tried to upgrade from the repository I've got: The following...

            Laura, when I've tried to upgrade from the repository I've got:

            The following error(s) occurred:

    * Expected plugin version [1.1-RC2] and got [1.1-RC1] from: http://confluence.atlassian.com/download/attachments/194383/plugins-markforreview.jar

            Cheers
            A.

            1. Nov 08, 2006

              Laura Kolker says:

              Confirmed the problem, and it should be fixed now. Thanks for the bug report. :...

              Confirmed the problem, and it should be fixed now.

              Thanks for the bug report.

  4. Nov 07, 2006

    Sim Hua Soon says:

    I am getting the error The following error(s) occurred: The following are ...

    I am getting the error

    The following error(s) occurred:

    • The following are not valid groups: "confluence-users"

    Any idea?

    1. Nov 08, 2006

      Laura Kolker says:

      That's pretty odd. Can you give me some background about what led up to it? I...

      That's pretty odd.

      Can you give me some background about what led up to it?

      I'm assuming you attempted to add confluence-users as a moderater group.

      What was the string you gave to the text field?

      What groups are defined in your confluence?

      You can reply here, or open up a JIRA issue:
      http://developer.atlassian.com/jira/browse/CMFR

      Thanks

  5. Nov 08, 2006

    Sim Hua Soon says:

    i copied the plugin into webinf/lib and restarted the server. The string "conflu...

    i copied the plugin into web-inf/lib and restarted the server.

    The string "confluence-users" was copied and pasted from the mange groups page.

    confluence-users and confluence-admin are defined in the group. There are also other groups linked from LDAP.

    Created an issue @ https://support.atlassian.com/browse/CSP-5813 

    Thanks. 

    1. Nov 09, 2006

      Ivan Benko says:

      We need to determine if this is a problem with the plugin or Confluence. Please ...

      We need to determine if this is a problem with the plugin or Confluence. Please follow the progress at the issue ticket you created or as Laura recommended, please open issue on the CMFR project.
      Ib

      1. Nov 09, 2006

        Laura Kolker says: