Manual:Extension/BlueSpiceReview

What is

BlueSpiceReview

?

BlueSpiceReview is a workflowing workflow tool for MediaWiki. It allows establishing process of reviewing changes on made assigning users to a page through a number of different reviewers.

Locating BlueSpiceReview

who then should complete their review within a certain timeframe.

The review page

All relevant about a review on a page info can be accessed from "the Review" flyout , located in the right navigation, under "Quality management" tab. Flyout that opens shows review settings (if a review is not currently in progress for that particular page), or a form for reviewers to cast their votes (if review is active for the page). In case review is currently active, review settings will be collapsed, but can still be accessed by expanding "Review settings" portion of the flyout. tools. This screen shows the review settings. If a review is running, users see a form to cast their votes. They can also expand the collapsed workflow settings to see the details for this review.

The review workflow

Starting a review

All users who have sufficient permissions to do so, can start (or edit) a review on a page. As mentioned above, review can be started from the flyout, after filling in all the required settings.

Review settings

• Start date - date on which review will startof the review

• End date - date on which review expires and that page is considered reviewed even if no action from reviewers occured. It has no effect on the review itself.
• Type - review type determines what will happen to the page once the review has been succesfuly completed. Default type is "Flagging" which means page will ge approved once the review is finished.The default type is Approval so that it can be used in conjunction with the Approval feature if this feature is activated in a namespace. Currently, BlueSpice only ships with this one type out-of-box.
• Reviewers grid - a list of all reviewers assigned to review a particular page. Reviewers can be added by clicking on the "Plus" button above the grid and typing in the name of the user in the dialog that pops up. Existing reviewers can be removed by selecting a reviewer and clicking on the "

X

• x"

icon

• button.

• Additional options - depending on the wiki configuration, additional options may appear. See BlueSpiceReviewExtended for more information.

Review A review can only be started if at least one review has beed added. Once all settings are set, click save to start the review. At this point, all assigned reviewers will receive a notification (depending on their notification settings) that there is a review pending, and that they need to review it. During the review process, editing of the page is disabled unless the setting to allow editing has been activated.

Reviewing a page

When users who are assigned to a page as reviews, and there is a review in progress, assigned reviewers visit that page, they will be able are prompted to cast their vote. Vote can be casted by opening "Review" flyout, as described above. In the flyout user will see a voting form. This form consist

Voting form

The voting form consists of:

• Comment box - here reviewers can leave a comment on the explain the reason for their vote
• Agree button - by clicking this button, user casts users cast a "yes" vote and agrees agree to the proposed version of the page.
• Disagree button - by clicking this button, users casts cast a "no" vote and rejects reject the proposed verionversion.
• Delegate button - users can delegate their assignment to another user, if they feel some other user is more competent to review this page. This button opens a dialog that opens a dialog with fields to enter username of the user to delegate to, as well as a short note on the reason for delegation, at which point review assignment will be transfered to that other userfor delegating the vote.

All the votes users cast, along with comments , will be are displayed in under "Recent workflow steps" in the same flyout as the vote form and in the page history.

Review overview

The page Special:Review special page provides an overview of all the currently ongoing reviews. It can be accessed from the left main navigation , in tab under "Global actions", item "Review". This special page shows a grid with all relevant information for the review. Clicking on an individual review will open opens a list of all reviewers assigned to review this page along with their votes (shown in indicated by the eye icon before the username). Grey A grey eye icon means the reviewer has not yet reviewed the page, green means a "yes" vote, while red means a "no" vote.

Permissions

In order to create and participate in the review process users must have following permissions:

• workflowview - for accessing the review interface, but not being able to edit it
• workflowlist - for viewing the list of reviewers for the page
• workflowedit - for being able to create and edit reviews
• review - for being able to cast review votes

During the review process, editing of the page is disabled.

Review overview

Configuration

In the Config manager, you can change the following settings:

• Only the owner of a review can change it: If this is unchecked, any user with edit rights can update a workflow.

Related info

• Reference:BlueSpiceReview