Difference between revisions of "Manual:Extension/BlueSpiceReviewExtended"

<bs:bookshelf src="Book:User manual" />
        
        
        
        __TOC__
        
        
        
        ==What is ReviewExtended?==
            
            
            
            '''ReviewExtended''', with this workflow tool, users can start a review process of single articles by several users.
            
            
            
            ==Schematic==
            
            
            
            Reviews in '''Teamwork''' uses this following schema:
            
            
            
            ::: [[File:BlueSpice-Teamwork-Prozessdiagramm_en.png]]
            
            
            
            ==Where to find ReviewFull?==
            
            Go to the "More" menu and click on "Edit review". Or you start the dialogue directly by using the special page <code>Special:Review/Name_of_the_site</code>
            
            
            
            ::: [[File:RvwExnd1.jpg|500x293px]]
            
            
            
            ==Create workflow==
            
            ::: [[File:RvwExnd2.jpg|500x297px]]
            
            
            
            * Insert '''start and end date''' for the review: To start a workflow you have to define start and end date. During this period the article can only be edited by reviewers of this article. The end date defines until when all reviewers have to vote. Votes and changes after the end date won't be considered.
            
            
            
            * Choose an '''option''': BlueSpiceReviewExtended?==
            
            
            
            '''BlueSpiceReviewExtended''' is an extension to [[Manual:Extension/BlueSpiceReview|BlueSpiceReview]] extension. It adds more features to its interface. To learn more about review process, read the page for BlueSpiceReview.
            
            All the options added by BlueSpiceReviewExtended are visible under the reviewer grid in Review settings.
            
            
            
            ==Review options==
            
            [[File:ReviewExtended1a.png|thumb|Options added by ReviewExtended]]
            
            There are three options that are available, when setting up the review process:
            
            * Reviewer can edit the page; Follow the reviewer order; Abort review if a reviewer reject it.
            
            ** Editing not allowed/ Don't follow the reviewer order.
            
            ** Editing not allowed/ Follow the reviewer order.
            
            ** Editing allowed/ Don't follow the reviewer order.
            
            ** Editing allowed/  - everybody that is assigned to the page as reviewers can edit the page while review is in progress.
            
            * Follow the reviewer order.
            
            
            
            * '''Add Reviewer''': Click on the green button. Now you can choose a user from the reviewer list and add a comment. Clicking on "OK" confirms the choice. Keep adding reviewers until all the ones you want are in the list.
            
            
            
            * '''Template''': Import a list of reviewers from a template. On the other hand, one can save a list of reviewers as a template so you can use it for recurring processes.
            
            
            
            * '''Sorting and changing reviewers''': You can delete reviewers with the red button. To the right of the list, there is the action column containing a button marked with an arrow. This lets you change the position of reviewers in the list which is particularly important when you have chosen the option "Follow the reviewer order".
            
            
            
            * '''Creating''': Click on "save" to save and activate the workflow. The reviewers will be informed via email.
            
            
            
            ==Review==
            
            ===My reviews===
            
            There are several ways to access an overview of the reviews you are involved in.
            
            
            
            * Click on the review symbol, the eye next to your user profile:
            
            
            
            ::: [[File:RvwExnd3.jpg|500x275px]]
            
            
            
            There are two numbers next to the symbol. The first is the number of workflows you are involved in. This includes both those workflows in which you are named as a reviewer and those you have initiated yourself.
            
            
            
            The second number displays the number of workflows you have already voted in.<br /><br />
            
            
            
            The click on the review icon leads you to your personal overview page. I. e. there are all workflows listed.
            
            
            
            ::: [[File:RvwExnd4.jpg|500x299px]]
            
            
            
            * A second possibility is to click on Reviews in the expanded user menu which you can find next to the avatar. This method takes you to the same user workflow overview described above.
            
            
            
            * In contrast to the options described above, the third variant gives you an overview of all current workflows, not only those relating to the user. This overview can be found on a special page which you can call up in the following way:
            
            ** You will find the menu entry "workflow" in the list of special pages under the heading "BlueSpice". Clicking on this takes you to the special page.
            
            ** Enter the URL instead of that of the currently displayed page name: After the last "/", simply put <code>Special:Review</code> and confirm by hitting enter.<br />The list of workflows you can see there can be sorted with different filter options.
            
            
            
            ===E-mail notification===
            
            The reviewers are (if selected, in the order given) informed by email about the review, if this is selected in the user settings at "BlueSpice":
            
            
            
            * Notify the owner of a review about changes
            
            * Notify the reviewer of a review about changes
            
            
            
            
            
            ===Finish review===
            
            The reviewers finish their work (editing or reviewing) by approving or rejecting the articles content, or delegating further. These are done via the expanded [[StateBar|Statebar]]. The [[Reference:ArticleInfo|ArticleInfo]] function gives information about this. [[Reference:ArticleInfo|ArticleInfo]] also provides information on:
            
            
            
            * Reviews.
            
            * Summary of the latest edit.
            
            * Requests for reviews.
            
            * Review state.
            
            * Field for Approving.
            
            
            
            ::: [[File:RvwExnd5.jpg|500x287px]]
            
            
            
            ===Delegating===
            
            The reviewer can also use the StateBar to delegate the review to other users. To aid in this, a field opens in ArticleInfo which shows all users. When a review is delegated, both the additionally appointed user and the workflow owner are informed by email. The extra user is temporarily added in a special column of the workflow configuration. The person delegated works on the content just like a normal reviewer. He or she can redelegate via a link in the StateBar. Reviewers and workflow owners are informed by email. The name of the person delegated is then deleted from the workflow configuration.
            
            
            
            ===Approving===
            
            At the end of the review process, the article can be approved by users with the correct rights. This makes the draft version into a new article. This function works closely together with the extension [[Reference:FlaggedRevisions|FlaggedRevisions]].
            
            
            
            ==Monitoring progress==
            
            The workflow owner receives emails detailing further steps and reviews. Additionally, the progress and the current status of all active workflows can be seen at the special page <code>Special:Review</code>.
            
            
            
            ::: [[File:RvwExnd6.jpg|500x291px]]
            
            
            
            ==Permissions==
            
            By default, every user can set up workflows and delete them. This permission can, however, be limited in the [[Reference:PermissionManager|permission manager ]].<br />
            
            The following permission belong to ReviewFull:
            
            
            
            {| class="contenttable" border="0"
            
            |-
            
            ! style="width: 20%;"|'''Permissions'''
            
            ! style="width: 80%;"|'''Definition'''
            
            |-
            
            ||workflowview
            
            ||view a workflow
            
            |-
            
            ||workflowedit
            
            ||Create, edit, change and delete a workflow
            
            |-
            
            ||workflowlist
            
            ||Allows viewing the workflow overview on the Review special page.
            
            |}
            
            
            
            ==Preferences for Administrators==
            
            Administrators can define [[Preferences|preferences]] for reviews.
            
            
            
            * Only the owner of a review can change it.
            
            * Notify the owner of a review about changes.
            
            * Notify the reviewer of a review about changes.
            
            
            
            ==Dealing with problems==
            
            If you can still see a review button when a workflow has been deleted, please empty your browser cache.
            
            
            
            ==See also==
            
            
            
            Our [[Reference:ReviewExtended|reference page.]]
            
            
            
            
            <div id="box-info" style="width: 98%; margin: 20px 0; border: solid 2px #99bbe8; padding: 8px; background-color: #d6e3f2;">
            
            [[Image:Icon-link.png|left]]<div style="text-transform: uppercase; color: #99bbe8; font-size: 16px; font-weight: bold; margin: 0;">Related topics</div>
            
            
            <div color:="" 000="">
            
            * [[Teamwork]] - ReviewExtended and FlaggedRevs in a package
            
            * [[Reference:FlaggedRevisions|Integrate approvals]]
            
            
            </div>
            
            
            </div> - reviewers will be able to cast their votes in order that they are listed in the grid of assigned reviewers. Only when one is finished casting a vote, next one can start.  The order of the reviewers can be adjusted by clicking on up and down arrows that appear when hovering above the reviewer in the grid.
            
            * Restart review if review rejects it - if any of the reviewers votes "no" (disagrees), review is restarted and all of the reviewers must cast their votes again.
            
            
            
            ==Templates==
            
            [[File:ReviewExtended2.png|thumb|Template options]]
            
            Review process for some pages and some organization is a lot of times very similar, with same options and same list of reviewers. In order to minimize the effort when starting a review, templates are introduced.
            
            Template controls are located at the bottom of review settings.
            
            
            
            ===Saving a template===
            
            Once the list of reviewers is entered and other options set, enter the name for the template in the input field and click on the arrow in the "Load" button. Several options will be offered:
            
            * Save for me - the template will be shown only to the user who saves it
            
            * Save for everybody - the template will be shown to everybody
            
            Pick the desired option and the template will be saved
            
            
            
            ===Applying a template===
            
            Once there are templates saved, users can choose from the list of templates, and, after clicking "Load" button, all the options and the list of reviewers will be set as saved in the template.
            
            
            
            ===Deleting a template===
            
            To delete a template, choose the desired template to delete, click on the arrow in the "Load" button and select "Delete".
            
            
            
            ==See also==
            
            
            
            [[Reference:ReviewExtended|Reference page]] for this extension.