(Created page with "{{DISPLAYTITLE:Page approvals (Acceptance)}} {{BSVersion|bsvFrom=4.3|bsvTo=|bsvFeature=ContentStabilization|info=Up to version 4.2, approvals are handled by the extension Ma...") Tag: 2017 source edit |
No edit summary Tag: 2017 source edit |
||
Line 2: | Line 2: | ||
{{BSVersion|bsvFrom=4.3|bsvTo=|bsvFeature=ContentStabilization|info=Up to version 4.2, approvals are handled by the extension [[Manual:Extension/FlaggedRevs|FlaggedRevs]].}} | {{BSVersion|bsvFrom=4.3|bsvTo=|bsvFeature=ContentStabilization|info=Up to version 4.2, approvals are handled by the extension [[Manual:Extension/FlaggedRevs|FlaggedRevs]].}} | ||
The '''ContentStabilization''' extension is a MediaWiki extension that | The '''ContentStabilization''' extension is a MediaWiki extension that activates an approval mechanism. New versions of a page are initially marked as drafts. These remain in place until a user with approval rights reviews and approves the page. | ||
==Enable page | ==Enable page approval== | ||
Drafts are activated via the namespace administration. A user with administrator rights checks whether '' | Drafts are activated via the namespace administration. A user with administrator rights checks whether A''pproval'' is enabled for a namespace. This is done under ''Global Actions > Administration > Namespaces''. | ||
[[File:Manual:release-namespace.png | |||
Click the edit icon (wrench) in the ''Actions'' column. The namespace dialog opens. Select approval and click ''Done''. | |||
[[File:Manual:release-namespace.png|450x450px|alternative text=enable sharing for a namespace|link=Special:FilePath/Manual:release-namespace.png]] | |||
===Existing Pages=== | ===Existing Pages=== | ||
After ''Approval'' is activated for a namespace, all existing pages in the namespace appear in draft mode. The pages now show the status ''First draft.''[[File:Manual:flaggedrevs-first draft.png|300x300px|alternative text=First Draft|link=Special:FilePath/Manual:flaggedrevs-first_draft.png]]By default, the page status is displayed in the title area of every page with approval function . | |||
Alternatively, the | Alternatively, the status info can be moved below the page content from the [[Manual:Extension/BlueSpiceConfigManager#Positioning of skin elements|Config manager]]. | ||
=== | ===New pages=== | ||
When a new page is created and saved for the first time, it will appear as '''First Draft'''. By default, first drafts are visible to all users with read permissions. However, | When a new page is created and saved for the first time, it will appear as '''First Draft'''. By default, first drafts are visible to all users with read permissions. However, this can be restricted to individual user groups from the [[Manual:Extension/BlueSpiceConfigManager#ContentStabilization|Config manager.]] | ||
=== Drafts === | ===Drafts=== | ||
If a page is edited and saved multiple times in draft mode, each edit is logged in the | If a page is edited and saved multiple times in draft mode, each edit is logged in the page history:<br />[[File:Manual:flaggedrevs-revisions.png|centered|650x650px|mini|draft revisions in the revision history|alternative text=draft revisions in the History]] | ||
Drafts are | Drafts are highlighted in color in the version history. In addition, they are marked with "Release pending". | ||
==Accepting a page== | ==Accepting a page== | ||
A user with [[Manual:Extension/BlueSpicePermissionManager| | A user with [[Manual:Extension/BlueSpicePermissionManager|reviewer permissions]] can approve the page from the status message in the title area of the page. The approval comment is logged in the page's version history.<br /> | ||
[[File:Manual:Share Page.png | [[File:Manual:Share Page.png|277x277px|Page share via title area|link=Special:FilePath/Manual:Share_Page.png]] | ||
The new approval status is | The new approval status is shown accordingly in the title area.<br />[[File:Manual:a2.png|350x350px|alternative text=Approval status display|link=Special:FilePath/Manual:a2.png]] | ||
==Configuration== | ==Configuration== | ||
The following settings are made in the [[Manual:Extension/BlueSpiceConfigManager#ContentStabilization|Config manager]] in combination with namespace settings. | |||
===Changes to templates, embedded files and transclusions=== | ===Changes to templates, embedded files and transclusions=== | ||
If a page uses templates or contains other files such as images and embedded PDFs, or if content from other pages is transcluded and modified after the page was approved, those changes must also be approved. There are two | If a page uses templates or contains other files such as images and embedded PDFs, or if content from other pages is transcluded and modified after the page was approved, those changes must also be approved. There are two mechanisms to accomplish the approval: | ||
#'''The embedded resource is in a namespace without | #'''The embedded resource is in a namespace without approval mechanism:''' If the embedded resource is in a namespace without its own approval function, the approved version of the page shows the resource version that was embedded at the time of the page approval. An implicit draft version shows the most recent version of the embedded resource. <br /> | ||
#'''The embedded resource is in a namespace with | #'''The embedded resource is in a namespace with approval mechanism:''' The approval is done directly for the resource itself to avoid approval on all affected content pages. | ||
{{Messagebox|boxtype=important|icon=|Note text= If the approval mechanism is activated in a resource namespace (e.g. Template, File) in retrospect, all existing pages are then in first draft. If the wiki is configured so that not all users can see drafts, the resources may need to be initially approved via server script if this cannot be accomplished manually.<br><br>[[Manual:Extension/FlaggedRevs/Server script|About approvals via server script.]]|bgcolor=}} | |||
[[Manual:Extension/ | |||
{| class="contenttable" style="width: 100%;" | {| class="contenttable" style="width: 100%;" | ||
!'''Attitude''' | !'''Attitude''' | ||
!Behaviour of | !Behaviour of the approved content page - | ||
'''No resource | '''No resource approval mechanism'''[[File:CS namespace without sharing.png|400x400px|resource without sharing mechanism|link=Special:FilePath/CS_namespace_without_sharing.png]] | ||
! style="width:500px;" |Behaviour of | ! style="width:500px;" |Behaviour of the approved content page - | ||
''' | '''Approval mechanism via resource'''[[File:CS namespace with release.png|400x400px|resources with release mechanism|link=Special:FilePath/CS_namespace_with_release.png]] | ||
|- | |- | ||
!Released version | !Released version | ||
(Default) | (Default) | ||
| style="background-color:#f2f3f9;" class="" |'''This setting has no effect if the resource itself has no | | style="background-color:#f2f3f9;" class="" |'''This setting has no effect if the resource itself has no approval mechanism.''' | ||
Line 51: | Line 53: | ||
| style="width:500px;" |'''Resource display:''' | | style="width:500px;" |'''Resource display:''' | ||
* the ''' | *the '''approved version''' of the resource is shown.[[File:CSresource yes stable standard.png|400x400px|Released page with the currently released version of the resource.|link=Special:FilePath/CSresource_yes_stable_standard.png]] | ||
''' | '''Resource approval:''' | ||
* takes place exclusively via the resource itself. The page contains no indication whether a draft version of the resource exists. | *takes place exclusively via the resource itself. The page contains no indication whether a draft version of the resource exists. | ||
|- | |- | ||
!Time-bound version | !Time-bound version | ||
|'''Resource display:''' | |'''Resource display:''' | ||
* the '''embedded version''' | *the '''embedded version at the time of approval''' is shown:[[File:CSresource yes stable1.png|400x400px|Released page with version of resource included at time of page release.|link=Special:FilePath/CSresource_yes_stable1.png]] | ||
* an implicit draft with the latest version of the resource | *an implicit draft with the latest version of the resource exists:[[File:CSresource yes stable0.png|400x400px|Released page with current released version of resource.|link=Special:FilePath/CSresource_yes_stable0.png]] | ||
''' | '''Resource approval:''' | ||
* the implicit draft '''must be approved on the content page'''. If the resource is embedded on multiple pages in the wiki, all pages must be | *the implicit draft '''must be approved on the content page'''. If the resource is embedded/linked on multiple pages in the wiki, all pages must be approved separately. | ||
| style="width:500px;" |'''Resource display:''' | | style="width:500px;" |'''Resource display:''' | ||
* the '''embedded version''' | * the '''embedded version at the time of approval''' is shown:[[File:CSresource yes stable1.png|400x400px|Released page with version of resource included at time of page release.|link=Special:FilePath/CSresource_yes_stable1.png]] | ||
* an implicit draft with the latest version of the resource | *an implicit draft with the latest version of the resource exists:[[File:CSresource yes stable0.png|400x400px|Released page with current released version of resource.|link=Special:FilePath/CSresource_yes_stable0.png]] | ||
''' | '''Resource approval:''' | ||
*''Case A:'' the implicit draft '''can be | *''Case A:'' the implicit draft '''can be approved on the content page'''. If the resource is embedded on multiple pages in the wiki, all pages must be released separately. | ||
*''<span class="col-turquoise">'''Case B ( | *''<span class="col-turquoise">'''Case B (expected case):'''</span>'' when '''the resource itself is approved,''' '''the implicit draft is removed from all affected content pages. These no longer have to be approved separately.''' | ||
|- | |- | ||
!Current version | !Current version | ||
|'''Resource display:''' | |'''Resource display:''' | ||
*'''the current version''' of the resource is | *'''the current version''' of the resource is shown: | ||
[[File:CSresource yes current.png| | [[File:CSresource yes current.png|400x400px|Shared page with current version of included resource.|link=Special:FilePath/CSresource_yes_current.png]] | ||
''' | '''Resource approval:''' | ||
* | *the resource itself cannot be approved | ||
| style="background-color:#f2f3f9;width:500px;" class="" |'''Resource display:''' | | style="background-color:#f2f3f9;width:500px;" class="" |'''Resource display:''' | ||
*'''the current version''' of the resource is | *'''the current version''' of the resource is shown: | ||
[[File:CSresource yes current.png | [[File:CSresource yes current.png|400x400px|Shared page with current version of included resource.|link=Special:FilePath/CSresource_yes_current.png]] | ||
''' | '''Resource approval:''' | ||
* The resource | *The approval status of the resource has no effect on the page and should therefore not be used in combination with an activated approval mechanism in the resource namespace. | ||
|} | |} | ||
===Reading permissions for drafts=== | ===Reading permissions for drafts=== | ||
By default, all users can see a page's drafts, including users with read | By default, all users can see a page's drafts, including users with only read permissions. | ||
To hide drafts from users, the ''user'' group must be removed from the configuration. This setting then applies to the entire wiki and cannot be further restricted to specific namespaces. | To hide drafts from users, the ''user'' group must be removed from the configuration. This setting then applies to the entire wiki and cannot be further restricted to specific namespaces. | ||
An administrator changes the groups that can see drafts in the ''Show draft versions for the following groups'' box.''<br />{{Note box|boxtype=warning|icon=|Note text=If the group ''user'' is off is removed from the configuration, users in this group cannot see draft versions even if they are assigned a workflow task.|bgcolor=}}After removing the group ''user'', the desired group(s ), e.g. B. the group ''editor'', can be added to the configuration and saved. | An administrator changes the groups that can see drafts in the ''Show draft versions for the following groups'' box.''<br />{{Note box|boxtype=warning|icon=|Note text=If the group ''user'' is off is removed from the configuration, users in this group cannot see draft versions even if they are assigned a workflow task.|bgcolor=}}After removing the group ''user'', the desired group(s ), e.g. B. the group ''editor'', can be added to the configuration and saved.'' | ||
{{Note box|boxtype=note|icon=|Note text=If no user groups are specified in the configuration field, even users with share rights and sysop users will not see a visual status indicator of the page. Instead, you have access to drafts through the page's history. | {{Note box|boxtype=note|icon=|Note text=If no user groups are specified in the configuration field, even users with share rights and sysop users will not see a visual status indicator of the page. Instead, you have access to drafts through the page's history. | ||
Line 100: | Line 102: | ||
In order for administrators to see the status directly on the page, they must be added to a group listed here in the configuration.|bgcolor=}} | In order for administrators to see the status directly on the page, they must be added to a group listed here in the configuration.|bgcolor=}} | ||
=== Read permissions for first drafts === | ===Read permissions for first drafts=== | ||
By default, first drafts are visible to all users who have read permissions in a namespace. However, if first drafts are only visible to those users who can generally view page drafts, this can be done in the configuration management by selecting ''<span class="col-red ve-pasteProtect">Allow viewing of first draft version</span> '' to be disabled. | By default, first drafts are visible to all users who have read permissions in a namespace. However, if first drafts are only visible to those users who can generally view page drafts, this can be done in the configuration management by selecting ''<span class="col-red ve-pasteProtect">Allow viewing of first draft version</span> '' to be disabled. | ||
===Summary: Read Permissions for Draft Pages=== | ===Summary: Read Permissions for Draft Pages=== | ||
Line 109: | Line 111: | ||
'''Export draft pages:''' | '''Export draft pages:''' | ||
*'''Single page export:''' Users with reading rights on a draft page can print it directly as a PDF. | *'''Single page export:''' Users with reading rights on a draft page can print it directly as a PDF. | ||
*'''Book export:''' Only approved pages are exported. If there is only a first draft of a page, it will be exported. '''Exception:''' If the book is printed by a user who does not have access to the first draft, the first draft will not be printed out in the book. Instead, the PDF shows the following message:[[File:Book-First Draft.png | *'''Book export:''' Only approved pages are exported. If there is only a first draft of a page, it will be exported. '''Exception:''' If the book is printed by a user who does not have access to the first draft, the first draft will not be printed out in the book. Instead, the PDF shows the following message:[[File:Book-First Draft.png|550x550px|reference=https://de.wiki.bluespice.com/wiki/ File:Book-First Draft.png|link=Special:FilePath/Book-First_Draft.png]] | ||
== Effects on | ==Effects on Semantic MediaWiki properties== | ||
If [[Manual: | If a namespace has SemanticMediaWiki [[Manual:Semantic_MediaWiki|Semantic MediaWiki]] activated, the following SMW queries are available depending on the approval status of the page: | ||
{| class="wikitable" style="width: | {| 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);" class="" |Document state | ||
!Available | ! 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);" class="" |Available properties | ||
|- | |- style="box-sizing: inherit;" | ||
|First draft | | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |First draft | ||
|Current values | | style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Current values | ||
|- | |- style="box-sizing: inherit;" | ||
| Approved | | 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;" | ||
|Draft | | 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;" | ||
|Implicit draft | | 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 | |||
| | |||
|} | |} | ||
==Quality management overview == | The availability of the semantic properties is determined by the following configuration setting: | ||
The | $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 ''false,'' 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 all users to view and filter a list of wiki pages and their review status. Pages for which a user does not have read permissions are not shown. | |||
Revision as of 15:51, 4 May 2023
The ContentStabilization extension is a MediaWiki extension that activates an approval mechanism. New versions of a page are initially marked as drafts. These remain in place until a user with approval rights reviews and approves the page.
Enable page approval
Drafts are activated via the namespace administration. A user with administrator rights checks whether Approval is enabled for a namespace. This is done under Global Actions > Administration > Namespaces.
Click the edit icon (wrench) in the Actions column. The namespace dialog opens. Select approval and click Done. alternative text=enable sharing for a namespace
Existing Pages
After Approval is activated for a namespace, all existing pages in the namespace appear in draft mode. The pages now show the status First draft.alternative text=First DraftBy default, the page status is displayed in the title area of every page with approval function .
Alternatively, the status info can be moved below the page content from the Config manager.
New pages
When a new page is created and saved for the first time, it will appear as First Draft. By default, first drafts are visible to all users with read permissions. However, this can be restricted to individual user groups from the Config manager.
Drafts
If a page is edited and saved multiple times in draft mode, each edit is logged in the page history:
Drafts are highlighted in color in the version history. In addition, they are marked with "Release pending".
Accepting a page
A user with reviewer permissions can approve the page from the status message in the title area of the page. The approval comment is logged in the page's version history.
Page share via title area
The new approval status is shown accordingly in the title area.
alternative text=Approval status display
Configuration
The following settings are made in the Config manager in combination with namespace settings.
Changes to templates, embedded files and transclusions
If a page uses templates or contains other files such as images and embedded PDFs, or if content from other pages is transcluded and modified after the page was approved, those changes must also be approved. There are two mechanisms to accomplish the approval:
- The embedded resource is in a namespace without approval mechanism: If the embedded resource is in a namespace without its own approval function, the approved version of the page shows the resource version that was embedded at the time of the page approval. An implicit draft version shows the most recent version of the embedded resource.
- The embedded resource is in a namespace with approval mechanism: The approval is done directly for the resource itself to avoid approval on all affected content pages.
Attitude | Behaviour of the approved content page -
No resource approval mechanismresource without sharing mechanism |
Behaviour of the approved content page -
Approval mechanism via resourceresources with release mechanism |
---|---|---|
Released version
(Default) |
This setting has no effect if the resource itself has no approval mechanism.
|
Resource display:
Resource approval:
|
Time-bound version | Resource display:
Resource approval:
|
Resource display:
Resource approval:
|
Current version | Resource display:
Shared page with current version of included resource.
|
Resource display:
Shared page with current version of included resource.
|
Reading permissions for drafts
By default, all users can see a page's drafts, including users with only read permissions.
To hide drafts from users, the user group must be removed from the configuration. This setting then applies to the entire wiki and cannot be further restricted to specific namespaces.
An administrator changes the groups that can see drafts in the Show draft versions for the following groups box.
Template:Note boxAfter removing the group user, the desired group(s ), e.g. B. the group editor, can be added to the configuration and saved.
Read permissions for first drafts
By default, first drafts are visible to all users who have read permissions in a namespace. However, if first drafts are only visible to those users who can generally view page drafts, this can be done in the configuration management by selecting Allow viewing of first draft version to be disabled.
Summary: Read Permissions for Draft Pages
Define groups:
- Group user: Only the user groups that have been given this right in the configuration management can see first drafts and other drafts. By default, this is the user group (=all users who are logged into the wiki and have the appropriate reading rights in a namespace).
- Adjust groups: In the configuration management, the reading rights for (first) drafts can be restricted to other groups.
- Group sysop: Users in group sysop can always view drafts through the history. The sysop group can therefore not be set explicitly in the configuration. If sysop users can directly see the approval status on the page, they need to be added to a group with read permissions for drafts.
Export draft pages:
- Single page export: Users with reading rights on a draft page can print it directly as a PDF.
- Book export: Only approved pages are exported. If there is only a first draft of a page, it will be exported. Exception: If the book is printed by a user who does not have access to the first draft, the first draft will not be printed out in the book. Instead, the PDF shows the following message:reference=https://de.wiki.bluespice.com/wiki/ File:Book-First Draft.png
Effects on Semantic MediaWiki properties
If a namespace has SemanticMediaWiki Semantic MediaWiki activated, the following SMW queries are available depending on the approval status of the page:
Document state | Available properties |
---|---|
First draft | Current values |
Approved | Values of the approved (stable) version |
Draft | Values of the approved (stable) version (default setting) |
Implicit draft[1] | 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 of the server file system. If set to false, 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 all users to view and filter a list of wiki pages and their review status. Pages for which a user does not have read permissions are not shown.
Related info
- ↑ 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.