Difference between revisions of "Manual:Extension/BlueSpiceReview"

<bs:bookshelf src="Book:User manual" />
            
            
            
            __TOC__
            
            
            
            ==What is Review?==
            
            
            
            '''Review''' is a simple workflow tool for MediaWiki: users can start a review process of single articles by several users.
            
            
            
            ==Screenshots==
            
            
            
            More menu: 
            
            
            
            [[File:Extension-Review(BlueSpice)-Drowdown.png]]
            
            
            
            
            
            
            
            Dialogue:
            
            
            
            [[File:Extension-Review(BlueSpice)-Dialogue.png|500x317px]]
            
            
            
            
            
            
            
            Statebar:
            
            
            
            [[File:Extension-Review(BlueSpice)-Statebar.png|500x183px]]
            
            
            
            ==See also==
            
            
            
            Our [[Review|reference page.]]{{DISPLAYTITLE:Create a review}}
            
            
            
            '''BlueSpiceReview''' is a workflow tool for MediaWiki. It allows assigning users to a page who then should complete their review within a certain timeframe.
            
            
            
            ==The review page==
            
            All relevant info can be accessed from the ''Review'' flyout in the ''Quality management'' 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.
            
            
            
            
            <br />
            
            [[File:Review1a.png|The review workflow|alt=The review workflow|center|650x650px|thumb]]
            
            ==Starting a review==
            
            All users with sufficient permissions can start (or edit) a review on a page. <br />[[File:Review2.png|Review settings|alt=Review settings|center|650x650px|thumb]]Possible settings:<br />
            
            
            
            *'''Start date:''' The date when the review officially begins. Please note that you cannot schedule a review in advance. The page is locked for editing as soon as the workflow is saved.
            
            
            
            *'''End date:''' The date on which the review is listed as expired. It has no effect on the review itself and is simply used for managing workflow lists.
            
            *'''Type:''' The review type determines what will happen to the page once the review has been succesfuly completed. 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.  BlueSpice 3.1 only ships with this one type. BlueSpice 3.2 has a ''Default'' and an ''Approval'' option which is explained in the steps to set up a workflow template.
            
            *'''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 by 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" button.
            
            
            
            {{#dpl:title=Manual:Extension/BlueSpiceReviewExtended|include=#Review options}}
            
            {{#dpl:title=Manual:Extension/BlueSpiceReviewExtended|include=#Templates}}
            
            
            
            
            
            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 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.
            
            
            
            ==Casting votes==
            
            When assigned reviewers visit that page, they are prompted to cast their vote.
            
            
            <br />[[File:Review3a.png|Voting form|alt=Voting form|center|650x650px|thumb]]The voting form consists of:
            
            
            
            *Comment box - here reviewers can explain the reason for their vote
            
            *Agree button - by clicking this button, users cast a "yes" vote and agree to the proposed version of the page.
            
            *Disagree button - by clicking this button, users cast a "no" vote and reject the proposed version.
            
            *Delegate button - users can delegate their assignment to another user. This button opens a dialog for delegating the vote.
            
            
            
            All  votes along with comments are displayed under "Recent workflow steps" in the same flyout as the vote form and in the page history.
            
            
            
            === Rejecting a task ===
            
            If a reviewer votes with "Disagree" the workflow returns to the beginning. The next reviewer in line is now the originator of the worfklow. The order of the initial reviewers after the originator is kept the same.
            
            
            
            ==Review overview==
            
            The page <code>Special:Review</code>  provides an overview of all ongoing reviews. It can be accessed from the main navigation under "Global actions", item "Review". Clicking on an individual review opens a list of all reviewers assigned to review this page along with their votes (indicated by the eye icon before the username). A grey eye icon means the reviewer has not yet reviewed the page, green means a "yes" vote, while red means a "no" vote.
            
            
            
            
            <br />
            
            [[File:Review4a.png|Review overview|alt=Review overview|center|650x650px|thumb]]
            
            
            
            ==Configuration==
            
            In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings:
            
            
            
            {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceReview}}
            
            
            
            {{Box Links-en|Topic1=[[Reference:BlueSpiceReview]]}}
            
            
            
            {{Translation}}
            
            [[Category:Quality]]