Difference between revisions of "Manual:Extension/BlueSpiceReviewExtended"
[unchecked revision] | [quality revision] |
m (Lsireta moved page Manual:Extension/ReviewExtended to Manual:Extension/BlueSpiceReviewExtended) |
(Tag: Visual edit) |
The options for review workflows are provided by the extension BlueSpiceReviewExtended.
Contents
- 1 What is BlueSpiceReviewExtended? 2
- Review options 3
-
2 Templates
- Saving a template
- 3
- 4 See also
Review options[edit | edit source]
BlueSpiceReviewExtended is an extension to 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[edit | edit source]

There are three options that are available, when setting up the review processWhen you set up a new workflow, the following options are available:
- Reviewer can edit the page - everybody : Everybody that is assigned to the page as reviewers reviewer can edit the page while the review is in progress.active. Other users cannot edit the page during this time. If this box is not checked, then reviewers will also not be allowed to make changes to the page.
- Follow the reviewer order - reviewers will be able : Reviewers need to cast their votes in order that they are listed in the grid of assigned reviewerssequence. Only when one is finished casting a vote, the next one reviewer can start. The order of the reviewers can be adjusted by clicking on up and down arrows that appear when hovering above over the reviewer in the grid.
-
Restart review if review a reviewer rejects it - if : If any of the reviewers votes "no" (disagrees), rejects the page, the review is restarted and all of the reviewers must cast their votes again.
Templates[edit | edit source]

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 To minimize the effort when starting a review, templates are introduced. Template controls are located at the bottom of review settings.
Saving a template
Managing templates[edit | edit source]
In BlueSpice 3.2[edit | edit source]
Click Manager next to the template select menu if you are already setting up a review.
Alternatively, you can create a workflow template by going to Global actions > Management > Review template manager in the navigation panel of the wiki.
Create a new template:
- Select if you want to create a template that is available to all users (1) or that is available only to you (2).
-
Click the "+"-button (3). This opens the template dialog. Create your template.
- Enter a name.
-
Select the template type:
- Default: The review is independent of settings in the Config manager. For reviews in namespaces with approvals, the page is not automatically approved at the end of the review.
- Approval: The review applies the setting from the Config manager for automatically deleting the workflow after the page has been approved. Pages in namespaces that do not create draft versions are not affected by this setting.
- If the template should only appear on pages in certain namespaces, specify the appropriate namespaces.
- If the template should only appear on pages that are assigned to certain categories, specify the categories.
- Select the review options described above.
-
Use the "+"-button to add the reviewers. If you enter a comment here, it will be displayed in the version history. Note: A group vote can also be set up for an individual workflow step using the plus button. For this purpose, a wiki group is selected as the reviewer.
- Group: The group that will vote on the selected step.
- Comment: Comment that is displayed in the workflow and in the version history for this step.
- Required approvals: If this number is reached first, the process step will be completed positively.
- Required rejections: If this number is reached first, the process step will be completed negatively.
- Click Done.
Note: The review type can be changed after loading the template and then behaves according to the newly selected type. This means that the "Approval" type from a template can be set to be a "Standard" workflow on a page. In that case, the draft version of the page will not be approved after the workflow has finished.
In BlueSpice 3.1[edit | edit source]
Once the list of reviewers is entered and the other options have been set, enter the name for the template in the input field and click on the arrow in next to the "Load" button. Several options will be offeredare available:
- Save for me - the myself: 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[edit | edit source]
Once there are templates saved, users can choose from the list of templates, and, after clicking . After clicking the "Load" button, all the options and the list of reviewers will be set as saved the reviewers that have been saved in this template are added to the reviewer list.
In BlueSpice 3.1, only the list of reviewers is stored in the template.
Deleting a template[edit | edit source]
To delete a template, choose the desired template to delete, click on the arrow in the "Load" button and select "Delete".
See alsoConfiguration[edit | edit source]
Reference page for this extension.
In the Config manager, you can change the following settings:
- Workflow will be added to page history: This enables that workflow votes are listed under the page history with the corresponding version.
Related info
<bs:bookshelf src="Book:User manual" /> __TOC__ ==What is 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: * {{DISPLAYTITLE:Review settings}} The options for [[Manual:Extension/BlueSpiceReview|review workflows]] are provided by the extension ''BlueSpiceReviewExtended''. ==Review options== When you set up a new workflow, the following options are available: *'''Reviewer can edit the page - everybody :''' Everybody that is assigned to the page as reviewersas reviewer can edit the page while the review is in progress. * Follow the reviewer order - reviewers will be able to cast their votes in order that they are listed in the grid of assigned reviewersactive. Other users cannot edit the page during this time. If this box is not checked, then reviewers will also not be allowed to make changes to the page. *'''Follow the reviewer order:''' Reviewers need to cast their votes in sequence. Only when one is finished casting a vote, the next onereviewer can start. The order of the reviewers can be adjusted by clicking on up and down arrows that appear when hovering aboveover the reviewer in the grid. * '''Restart review if review a reviewer rejects it - if :''' If any of the reviewers votes "no" (disagrees), rejects the page, the review is restarted and all of the reviewers must cast their votes again. ==Templates== [[File:ReviewExtended2a.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=== <br /> [[File:ReviewExtended1a.png|Review options|alt=Review options|center|650x650px|thumb]] ==Templates== To minimize the effort when starting a review, templates are introduced. ===Managing templates=== ====In BlueSpice 3.2==== Click Manager next to the template select menu if you are already setting up a review. <br /> [[File:Manual:flaggedrevs-select-templatemanager-EN.png|alt=Switch to the template manager|center|thumb|350x350px|Switch to the template manager]] Alternatively, you can create a workflow template by going to ''Global actions > Management > Review template manager'' in the navigation panel of the wiki. <br /> [[File:Manual:flaggedrevs-templatemanager-EN.png|alt=Managing review templates in BlueSpice 3.2|center|thumb|650x650px|Managing review templates in BlueSpice 3.2]] Create a new template: #Select if you want to create a template that is available to all users (1) or that is available only to you (2). #Click the "+"-button (3). This opens the template dialog. Create your template. <br />[[File:Manual:reviewtemplate1.png|alt=Creating a review template|center|thumb|450x450px|Creating a review template]]<br /> #Enter a name. #Select the template type: ##'''Default:''' The review is independent of settings in the Config manager. For reviews in '''namespaces with approvals''', the page is not automatically approved at the end of the review. ##'''Approval:''' The review applies the [[Manual:Extension/BlueSpiceConfigManager#Quality assurance|setting from the Config manager]] for automatically deleting the workflow after the page has been approved. Pages in namespaces that do not create draft versions are not affected by this setting. #If the template should only appear on pages in certain namespaces, specify the appropriate namespaces. #If the template should only appear on pages that are assigned to certain categories, specify the categories. #Select the review options described above. #Use the "+"-button to add the reviewers. If you enter a comment here, it will be displayed in the version history. '''Note:''' A group vote can also be set up for an individual workflow step using the plus button. For this purpose, a wiki group is selected as the reviewer. <br />[[File:Manual:groupreview.png|alt=Group vote|center|thumb|450x450px|Group vote]] ##''Group:'' The group that will vote on the selected step. ##''Comment:'' Comment that is displayed in the workflow and in the version history for this step. ##''Required approvals:'' If this number is reached first, the process step will be completed positively. ##''Required rejections'': If this number is reached first, the process step will be completed negatively. #Click ''Done''. The template can now be selected accordingly in a review.{{Box Note|boxtype=note|Note text=The review type can be changed after loading the template and then behaves according to the newly selected type. This means that the "Approval" type from a template can be set to be a "Standard" workflow on a page. In that case, the draft version of the page will not be approved after the workflow has finished.}} ====In BlueSpice 3.1==== Once the list of reviewers is entered and the other options have been set, enter the name for the template in the input field and click on the arrow in next to the "Load" button. Several options will be offered: * Save for me - the are available: *''Save for myself: T''he 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 ===. <br />[[File:ReviewExtended2a.png|Creating a new template in BlueSpice 3.1|alt=Creating a new template in BlueSpice 3.1|center|650x650px|thumb]] ===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 . After clicking the "Load" button, the reviewers that have been saved in this template are added to the reviewer list. In BlueSpice 3.1, only the list of reviewers will be set as saved is stored 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.==Configuration== In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings: {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceReviewExtended}} {{Box Links-en|Topic1=[[Reference:BlueSpiceReviewExtended]]}} {{Translation}}
(11 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
− | + | {{DISPLAYTITLE:Review settings}} | |
− | + | The options for [[Manual:Extension/BlueSpiceReview|review workflows]] are provided by the extension ''BlueSpiceReviewExtended''. | |
+ | ==Review options== | ||
+ | When you set up a new workflow, the following options are available: | ||
+ | |||
+ | *'''Reviewer can edit the page:''' Everybody that is assigned as reviewer can edit the page while the review is active. Other users cannot edit the page during this time. If this box is not checked, then reviewers will also not be allowed to make changes to the page. | ||
+ | |||
+ | *'''Follow the reviewer order:''' Reviewers need to cast their votes in sequence. Only when one is finished casting a vote, the next reviewer can start. The order of the reviewers can be adjusted by clicking on up and down arrows that appear when hovering over the reviewer in the grid. | ||
+ | *'''Restart review if a reviewer rejects it:''' If any of the reviewers rejects the page, the review is restarted and all of the reviewers must cast their votes again.<br /> | ||
− | == | + | [[File:ReviewExtended1a.png|Review options|alt=Review options|center|650x650px|thumb]] |
+ | ==Templates== | ||
+ | To minimize the effort when starting a review, templates are introduced. | ||
− | + | ===Managing templates=== | |
− | |||
− | == | + | ====In BlueSpice 3.2==== |
− | [[File: | + | Click Manager next to the template select menu if you are already setting up a review. |
− | + | <br /> | |
− | + | [[File:Manual:flaggedrevs-select-templatemanager-EN.png|alt=Switch to the template manager|center|thumb|350x350px|Switch to the template manager]] | |
− | + | Alternatively, you can create a workflow template by going to ''Global actions > Management > Review template manager'' in the navigation panel of the wiki. | |
− | + | <br /> | |
+ | [[File:Manual:flaggedrevs-templatemanager-EN.png|alt=Managing review templates in BlueSpice 3.2|center|thumb|650x650px|Managing review templates in BlueSpice 3.2]] | ||
+ | |||
+ | |||
+ | Create a new template: | ||
+ | |||
+ | #Select if you want to create a template that is available to all users (1) or that is available only to you (2). | ||
+ | #Click the "+"-button (3). This opens the template dialog. Create your template. <br />[[File:Manual:reviewtemplate1.png|alt=Creating a review template|center|thumb|450x450px|Creating a review template]]<br /> | ||
+ | #Enter a name. | ||
+ | #Select the template type: | ||
+ | ##'''Default:''' The review is independent of settings in the Config manager. For reviews in '''namespaces with approvals''', the page is not automatically approved at the end of the review. | ||
+ | ##'''Approval:''' The review applies the [[Manual:Extension/BlueSpiceConfigManager#Quality assurance|setting from the Config manager]] for automatically deleting the workflow after the page has been approved. Pages in namespaces that do not create draft versions are not affected by this setting. | ||
+ | #If the template should only appear on pages in certain namespaces, specify the appropriate namespaces. | ||
+ | #If the template should only appear on pages that are assigned to certain categories, specify the categories. | ||
+ | #Select the review options described above. | ||
+ | #Use the "+"-button to add the reviewers. If you enter a comment here, it will be displayed in the version history. '''Note:''' A group vote can also be set up for an individual workflow step using the plus button. For this purpose, a wiki group is selected as the reviewer. <br />[[File:Manual:groupreview.png|alt=Group vote|center|thumb|450x450px|Group vote]] | ||
+ | ##''Group:'' The group that will vote on the selected step. | ||
+ | ##''Comment:'' Comment that is displayed in the workflow and in the version history for this step. | ||
+ | ##''Required approvals:'' If this number is reached first, the process step will be completed positively. | ||
+ | ##''Required rejections'': If this number is reached first, the process step will be completed negatively. | ||
+ | #Click ''Done''. | ||
+ | |||
+ | The template can now be selected accordingly in a review.{{Box Note|boxtype=note|Note text=The review type can be changed after loading the template and then behaves according to the newly selected type. This means that the "Approval" type from a template can be set to be a "Standard" workflow on a page. In that case, the draft version of the page will not be approved after the workflow has finished.}} | ||
+ | ====In BlueSpice 3.1==== | ||
+ | Once the list of reviewers is entered and the other options have been set, enter the name for the template in the input field and click on the arrow next to the "Load" button. Several options are available: | ||
− | + | *''Save for myself: T''he 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. | |
− | |||
− | |||
− | |||
− | Pick the desired option and the template will be saved | ||
+ | <br />[[File:ReviewExtended2a.png|Creating a new template in BlueSpice 3.1|alt=Creating a new template in BlueSpice 3.1|center|650x650px|thumb]] | ||
===Applying a template=== | ===Applying a template=== | ||
− | Once there are templates saved, users can choose from the list of templates | + | Once there are templates saved, users can choose from the list of templates. After clicking the "Load" button, the reviewers that have been saved in this template are added to the reviewer list. |
+ | |||
+ | In BlueSpice 3.1, only the list of reviewers is stored in the template. | ||
===Deleting a template=== | ===Deleting a template=== | ||
− | To delete a template, choose the | + | To delete a template, choose the template to delete, click on the arrow in the "Load" button and select "Delete". |
+ | ==Configuration== | ||
+ | |||
+ | In the [[Manual:Extension/BlueSpiceConfigManager|Config manager]], you can change the following settings: | ||
+ | |||
+ | {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceReviewExtended}} | ||
− | = | + | {{Box Links-en|Topic1=[[Reference:BlueSpiceReviewExtended]]}} |
− | + | {{Translation}} |