|
|
| Line 1: |
Line 1: |
| {{DISPLAYTITLE:Page approvals (Acceptance)}}
| | <noinclude>Template is included in Template:BSExtensionInfo and Template:BSExtensionInfobox to check all extensions for accessibility.</noinclude><templatestyles src="WcagCheck/styles.css" /><includeonly>{{#if: {{{wcagStatus|}}}| |
| | | <div class="wcaginfo"> |
| The extension '''FlaggedRevs''' is a MediaWiki extension that activates an approval mechanism. New versions of a page are initially marked as drafts and remain so until a user with ''review'' rights approves the page.
| | ==Accessibility== |
| {{TOC|limit=1}}
| | {{{!}} class="wikitable" {{!}} |
| | | !style="width:200px" {{{!}}Test status: |
| ==Activating the acceptance feature==
| | {{!}}[[wcagStatus::{{{wcagStatus|}}}]] |
| Activating the acceptance feature is done on the namespace level. A user with admin permissions activates the feature in ''Global actions > Management > Namespace manager'' for individual namespaces.
| | {{#ifeq: {{{extensionType|}}}|backend|| |
| The dialog window opens after clicking the edit icon (wrench) in the ''Actions'' column. Select ''Approval'' and click ''Done''.<br />
| | {{!}}- |
| [[File:Manual:approval-namespace.png|center|thumb|450x450px|Activate the Approval feature|link=Special:FilePath/Manual:approval-namespace.png]]
| | !Checked for: |
| | | {{!}}{{#arraymap:{{{wcagCheckedfor|}}}|,|@@@|[[wcagCheckedfor::@@@]]}} }} |
| ===Existing pages===
| | {{!}}- |
| After activating ''Approvals'' for a namespace, all pages in the namespace are set into ''first draft'' mode. [[File:Manual:flaggedrevs-activated-existingpage.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:flaggedrevs-activated-existingpage.png|center|650x650px|thumb|Draft banner notice (1) and page status information in the status bar (2).]]Each page in the namespace now displays a banner at the top of the page with the acceptance status (1) and a quick link to publish the page (2).
| | !Last test date: |
| | | {{!}}[[wcagTestdate::{{{wcagTestdate|}}}]] |
| ===New pages=== | | {{#ifeq: {{{extensionType|}}}|backend| |
| When a new page is created and first saved, it will automatically be visible to all users. Subsequent page edits will be collected in the draft version of the page. If a page is edited and saved multiple times while in draft mode, each edit gets logged in the version history:<br />[[File:Manual:flaggedrevs-revisions.png|center|650x650px|thumb|Draft revisions|link=Special:FilePath/Manual:flaggedrevs-revisions.png]]
| | |{{!}}- |
| | | !WCAG level: |
| | | {{!}}[[wcagLevel::{{{wcagLevel|}}}]] |
| The revisions in draft status have a dotted border and are highlighted in orange. In addition, they are marked as ''pending review''. These revisions can be compared before the pending changes of the page are accepted.
| | {{!}}- |
| | | !WCAG support: |
| ==Accepting a page==
| | {{!}} class="{{#switch:{{{wcagSupport}}}|supports=supports|partially supports=partiallysupports|does not support=notsupports|}}" {{!}}[[wcagSupport::{{{wcagSupport|}}}]] {{#ifeq: {{{wcagSupport}}}|partially supports|<span> (workaround: [[wcagWorkaround::{{{wcagWorkaround|}}}]])</span>|{{#ifeq: {{{wcagSupport}}}|does not support|<span> (workaround: [[wcagWorkaround::{{{wcagWorkaround|}}}]])</span>}}|}} }} |
| Users with ''review'' rights can accept a draft page any time they save a page (''Accept this unreviewed page''):<br />
| | {{#if: {{{wcagComments|}}}| |
| [[File:Manual:flaggedrevs-activated-firstsave.png|link=https://en.wiki.bluespice.com/wiki/File:Manual:flaggedrevs-activated-firstsave.png|center|650x650px|thumb|Accepting pending changes]] | | {{!}}- |
| | | !Comments: |
| | | {{!}} |
| If the page is not accepted at this point, it can be accepted independently from the editing process.
| | {{{wcagComments|}}}|}} |
| | | {{!}}- |
| A user with ''review'' rights can accept the page quickly with the review feature in the title section of the page. The draft message will display an arrow which includes the ''accept'' function:
| | !Extension type: |
| <br />
| | {{!}}[[extensionType::{{{extensionType|}}}]] |
| [[File:Manual:flaggedrevs-acceptdraft.png|center|277x277px|thumb|Accepting a draft from the title section|link=Special:FilePath/Manual:flaggedrevs-acceptdraft.png]]
| | {{#ifeq: {{{extensionType|}}}|backend| | |
| | | {{!}}- |
| | | !Extension focus: |
| Alternatively, the reviewer can go to the Acceptance page in the Quality Management toolbar instead:
| | {{!}}[[extensionFocus::{{{extensionFocus|}}}]] |
| <br />
| | {{!}}} }} |
| [[File:Manual:flaggedrevs-acceptdraft2.png|center|650x650px|thumb|Accepting a draft from the QM-Tools|link=Special:FilePath/Manual:flaggedrevs-acceptdraft2.png]] | | <div>|}}{{#ifeq: {{{extensionType|}}}|backend|{{#set: wcagSupport=not applicable}}|}}</includeonly> |
| | |
| | |
| In both cases, the reviewer can leave a comment. This comment will then be shown in the version history of the page.
| |
| | |
| The page now shows the page version as accepted.
| |
| <br />[[File:Manual:flaggedrevs-acceptedpage.png|center|650x650px|thumb|Accepted page|link=Special:FilePath/Manual:flaggedrevs-acceptedpage.png]]
| |
| | |
| ==Setting read permissions for drafts==
| |
| By default, all users can see the drafts of a page, even readers.
| |
| | |
| To hide drafts from readers, the group ''user'' has to be removed from the configuration. An administrator deletes the group user form "Show unstable pages for the following groups" in ''Global actions > Management > Config manager'':
| |
| <br />
| |
| [[File:Manual:flaggedrevs-config.png|center|650x650px|link=Special:FilePath/Manual:flaggedrevs-config.png]] | |
| <br />{{Box Note|boxtype=warning|Note text=If the group ''user'' is removed from the ''BlueSpiceFlaggedRevs'' configuration, users in this group will not be able to see draft versions when they are added as reviewers in a review process.}}
| |
| When the group user is removed, only ''sysop'' and ''reviewer'' users can access drafts. If you want other groups, for example ''editor'', to see draft versions, you need to add them to the configuration and save it:
| |
| <br />
| |
| [[File:Manual:flaggedrevs-config-addgroup.png|center|650x650px|link=Special:FilePath/Manual:flaggedrevs-config-addgroup.png]]
| |
| <br />The two checkboxes ''Automatically set the page to stable...'' (checkbox is available until version 3.1.) and ''Automatically delete the workflow..''. determine what happens at the end of a workflow, if there is an active [[Manual:Extension/BlueSpiceReview|Review]] for a page. A page can be set to accepted status by a workflow and the workflow can be deleted after the page is marked as stable.
| |
| {{Box Note|boxtype=note|Note text=If no user groups are specified in the configuration field, not even reviewers and sysops users will see a visual status indication of a page. They will have access to drafts through the revision history of a page instead.}} | |
| Anyone with edit permissions will receive a notification that there are pending changes for the page when they access the page in edit mode:
| |
| <br />
| |
| [[File:Manual:flaggedrevs-editnotification.png|center|550x550px|thumb|Pending changes notification|link=Special:FilePath/Manual:flaggedrevs-editnotification.png]] | |
| | |
| ==Changes to embedded templates and files==
| |
| If a page includes templates or files such as images or PDFs and there is a change to these files after the page has been approved, this will also be reflected in the status banner (1) and the QM status information in the title area (2).
| |
| | |
| <br />
| |
| [[File:Manual:fr-changestoresources1.png|center|thumb|650x650px|Changes to embedded resources|link=Special:FilePath/Manual:fr-changestoresources1.png]]
| |
| | |
| | |
| <br /> | |
| If the embedded resources are located in a namespace without its own approval function, the version of the resource at the time of page approval is displayed in the approved version of the page. The draft version accordingly shows the most current version of the embedded resource. To approve the resource change, the page has to be approved again. This creates a new page version.
| |
| | |
| ===Approving a resource===
| |
| Before approving the changed resource(s), you should check which resources are affected.
| |
| | |
| #'''Open''' the quality management tools (1). Here you can see under Approval that there are changes to resources (2).
| |
| #'''Click''' on a changed resource (3) to display the changes between the last two versions of the resource.
| |
| #'''Click''' "''Review now''" (4) under Unapproved changes. This will take you to the draft version of the page. From there you can approve the page in the title area. '''Note:''' If there are several changed resources, they can only be approved together.
| |
| | |
| | |
| [[File:Manual:fr-approvingressource2.png|center|thumb|650x650px|Approving a ressource|link=Special:FilePath/Manual:fr-approvingressource2.png]] | |
| <br /> | |
| | |
| ==Settings for resources on approved pages==
| |
| It is possible via server configuration to show embedded resources (i.e., files, templates or transcluded content) that were changed after the page has been released, in a certain version. The following options exist:
| |
| {| class="wikitable" style="width:100%;" data-ve-attributes="{"style":"width:100%;"}" | |
| !Setting
| |
| !Description
| |
| |- | |
| |FR_INCLUDES_FREEZE | |
| |Shows the resource version that was valid when the page was approved.<div class="infobox notification-warning"><span class="boxlabel"> Warning:</span>The setting FR_INCLUDES_FREEZE for handling the state of included files of an approved wikipage has [https://phabricator.wikimedia.org/rEFLRe4ff4779203d4ec44cdadcfa33f6d634bee1a7f1 no long term support by] and should not be introduced in a new wiki for that reason.</div><br />
| |
| |- | |
| |FR_INCLUDES_STABLE
| |
| |Always shows the latest approved (stable) version of a resource, even if it was approved after the page was approved (this works only if the resource is located in a namespace with active approval feature).
| |
| |-
| |
| |FR_INCLUDES_CURRENT
| |
| |Always shows the latest version of the included resource.
| |
| |}
| |
| {{Box Note|boxtype=important|Note text=Results of a '''semantic query''', unlike attribute values '''cannot''' be "frozen", even if FR_INCLUDES_FREEZE has been set. The query results do not persist in the source text of a page, but are generated dynamically at the time of the query. As a consequence, they are not available for versioning.}} | |
| | |
| ==Effects on Semantic MediaWiki properties==
| |
| Wenn in einem <span class="mw-lingo-term" data-lingo-term-id="4e8b643999af9bbcd46206fddd4f6f53" data-hasqtip="6" style="box-sizing: inherit; border-bottom: 1px dotted rgb(187, 187, 255); cursor: default;">Namensraum</span> gleichzeitig mit der Seitenfreigabe auch [[:de:Handbuch:Semantic_MediaWiki|Semantic MediaWiki]] aktiviert ist, sind je nach Freigabestatus der Seite folgende Attribute für SMW-Abfragen verfügbar:
| |
| {| class="wikitable" style="width:950px;" | |
| ! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Document state | |
| ! style="background-color:rgb(234, 236, 240);text-align:center;box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Available properties | |
| |- style="box-sizing: inherit;"
| |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |First draft | |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Current values
| |
| |- style="box-sizing: inherit;"
| |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Approved
| |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Values of the approved (stable) version
| |
| |- style="box-sizing: inherit;" | |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Draft | |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Values of the approved (stable) version (default setting)
| |
| |- style="box-sizing: inherit;"
| |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Implicit draft<ref>An approved page has an implicit draft, if there have been changes to embedded resources (e.g., a template or an image) since the last page approval.</ref>
| |
| | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Values of the approved (stable) version
| |
| |}
| |
| The availability of the semantic properties is determined by the following configuration setting:
| |
| $bsgFlaggedRevsConnectorStabilizeSMWPropertyValues = true;
| |
| The value for this setting can be set to ''false'' in the ''LocalSettings.php'' <span>of the server file system</span>. If set to f''alse,'' the property values of the draft version are used for semantic queries instead of the values for the stable version.
| |
| | |
| ==Quality management overview==
| |
| The Special page ''Special:Quality_management_overview'' allows users with ''admin'' or ''reviewer'' rights to view and filter a list of wiki pages and their review status.
| |
| | |
| [[File:Manual:qm-overview.png|center|thumb|650x650px|Special page Quality management overview|link=Special:FilePath/Manual:qm-overview.png]] | |
| {{Box Links-en | |
| |Topic1=[[Manual:Quality_management|Quality management tools]] | |
| |Topic2=[[Reference:FlaggedRevs]] | |
| |Topic3=[[Reference:BlueSpiceFlaggedRevsConnector]]|Topic4=[[Manual:Semantic MediaWiki]]}} | |
| [[en:{{FULLPAGENAME}}]]
| |
| [[de:Handbuch:Erweiterung/FlaggedRevs]]
| |
| __FORCETOC__
| |
| [[Category:Quality]]
| |
| <references /> | |
Discussions