Cookie consent settingsAccept all
Browse history interactively
← Older edit
Visual
Redaktion (talk | contribs)
ES_editors, Administrators
7,648 edits
No edit summary
Redaktion (talk | contribs)
ES_editors, Administrators
7,648 edits
No edit summary
 
(34 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Page approvals (Acceptance)}}
The '''ContentStabilization''' extension  activates an approval mechanism for namespaces. New versions of a page are initially marked as drafts. Users with approval rights can then review and approve the page.
{{BSVersion|bsvFrom=4.3|bsvTo=|bsvFeature=ContentStabilization|info=Up to version 4.2, approvals are handled by the extension [[Manual:Extension/FlaggedRevs|FlaggedRevs]].}}
==Activating page approval==
Drafts are activated via the namespace manager. A user with administrator rights checks whether A''pproval'' is enabled for a namespace. This is done under ''Global Actions > Administration > Namespaces''.


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.
Click the edit icon (wrench) in the ''Actions'' column of a namespace. The namespace dialog opens. Select approval and click ''Done'' or ''Save '''(depending on the version)'''''.
==Enable page approval==
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''.
 
Click the edit icon (wrench) in the ''Actions'' column. The namespace dialog opens. Select approval and click ''Done''.
[[File:Manual:approval-namespace.png|alt=Namespace settings screen|center|thumb|450x450px|Activated Approval feature for a namespace]]
[[File:Manual:approval-namespace.png|alt=Namespace settings screen|center|thumb|450x450px|Activated Approval feature for a namespace]]


Line 12: Line 9:
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.''
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-firstdraft.png|alt=First draft indicator in the title area|center|thumb|250x250px|First draft]]
[[File:Manual:flaggedrevs-firstdraft.png|alt=First draft indicator in the title area|center|thumb|250x250px|First draft]]




By default, the page status is displayed in the title area of every page with approval function .
By 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 [[Manual:Extension/BlueSpiceConfigManager#Positioning of skin elements|Config manager]].
Alternatively, the status info can be moved below the page content with a skin setting for BlueSpiceDiscovery in the [[Manual:Extension/BlueSpiceConfigManager#Positioning of skin elements|Configuration manager]].


===New pages===
===First drafts===
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.]]
When a new page is created and saved for the first time, its status is '''first draft''' until the page gets approved. By default, first drafts are visible to all users with read permissions. However,  this can be restricted to individual user groups in the settings of the [[Manual:Extension/ContentStabilization#Configuration|Configuration manager.]]
   
   
===Drafts===
===Drafts===
If a page is edited and saved multiple times in draft mode, each edit is logged in the page history:<br />
If a page is edited and saved multiple times in draft mode, each edit is listed in the version history. The Status column shows which revision is a draft and which is approved. Additionally, approved versions are highlighted in color.
 
[[File:Approval version history.png|alt=5 page revision entries, 3 of which are approved versions|center|thumb|750x750px|Version history with highlighted approvals]]
Drafts are highlighted in color in the version history. In addition, they are marked with "Release pending".
 
==Accepting a page==
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|277x277px|Page share via title area|link=Special:FilePath/Manual:Share_Page.png]]


The new approval status is shown accordingly in the title area.<br />
== Approving a page ==
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:flaggedrevs-acceptdraft.png|alt=approval feature in the title area|center|thumb|250x250px|Approval from the title area]]
The new approval status is then shown in the title area.
[[File:Manual:flagged-revs-accepted.png|alt=Approval status indication|center|thumb|Approved page status]]
<br />


==Configuration==
==Configuration==
The following settings are made in the [[Manual:Extension/BlueSpiceConfigManager#ContentStabilization|Config manager]] in combination with namespace settings.
The approval mechanism is managed in the [[Manual:Extension/BlueSpiceConfigManager#ContentStabilization|Configuration manager]]  
{{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#ContentStabilization}}


===Changes to templates, embedded files and transclusions===
===Changes to embedded resources===
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:
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 considered. Their approval is determined by the settings in the Configuration manager.


#'''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 />
{{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 in the resource namespace 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>[[Setup:Installation_Guide/Advanced/Maintenance_scripts/batchStabilize|Approvals via server script.]]|bgcolor=}}   
#'''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=}}   
{| class="contenttable" style="width: 100%;"
{| class="contenttable" style="width: 100%;"
!'''Attitude'''
!Behaviour of the approved content page -
'''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  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
! style="" |'''Setting'''
(Default)
! style="" |Behaviour of the approved content page -
| style="background-color:#f2f3f9;" class="" |'''This setting has no effect if the resource itself has no approval mechanism.'''
'''No resource approval mechanism'''


Same behavior as "Time-bound version" (see below).
[[File:CS namespace resource no approval.png|alt=Namespace settings dialog|center|thumb|450x450px|Resource without approval feature]]
! style="width:500px;" |Behaviour of  the approved content page -
'''Approval mechanism via resource namespace'''


| style="width:500px;" |'''Resource display:'''
[[File:CS namespace resource with approval.png|alt=Namespace manager settings|center|thumb|450x450px|Resource with approval feature]]
*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.
|-
!Time-bound version
|'''Resource display:'''
*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 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/linked on multiple pages in the wiki, all pages must be approved separately.
| style="width:500px;" |'''Resource display:'''
* 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 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 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 (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
! style="" |'''Versions that were current at the time of approval'''
|'''Resource display:'''
'''(Default)'''
*'''the current version''' of the resource is shown:
| style="" class="" |'''Resource display:'''
*The '''embedded version of the resource at the time of page approval''' is displayed on the approved version of the page.
*An implicit draft is generated.[[File:CS resource yes stable1.png|alt=screenshot of the approved page with the frozen resource|center|thumb|450x450px|Approved page version with the version of the resource that was embedded at the time of page approval]]
'''Ressource approval:'''


[[File:CSresource yes current.png|400x400px|Shared page with current version of included resource.|link=Special:FilePath/CSresource_yes_current.png]]
* The resource is updated '''the next time the page is approved'''. If the resource is embedded on multiple pages in the wiki, each page must be approved separately.


'''Resource approval:'''
[[File:CS resource yes stable0.png|alt=Page draft with preview of changed resource and resource change banner|center|thumb|450x450px|Page draft due to change of embedded resource]]


*the resource itself cannot be approved
| style="width:500px;" |'''Resource display:'''
| style="background-color:#f2f3f9;width:500px;" class="" |'''Resource display:'''
* The '''embedded version of the resource at the time of page approval''' is displayed on the approved version of the page.
*'''the current version''' of the resource is shown:
*An implicit draft is generated.[[File:CS resource yes stable1.png|alt=screenshot of the approved page with the frozen resource|center|thumb|450x450px|Approved page version with the version of the resource that was valid at the time of page approval]]
'''Ressource approval:'''
*The approval status of the ressource has no effect on the page.
*The resource is updated '''the next time the page is approved'''. If the resource is embedded on multiple pages in the wiki, each page must be approved separately.[[File:CS resource yes stable0.png|alt=Page draft with preview of changed resource and resource change banner|center|thumb|450x450px|Page draft due to change of embedded resource]]
|-
! style="" |Approved versions of included pages
| style="background-color:#f2f3f9;" class="" |'''Resource display:'''


[[File:CSresource yes current.png|400x400px|Shared page with current version of included resource.|link=Special:FilePath/CSresource_yes_current.png]]
* This setting has no effect since the resource itself has no approval mechanism.  
* The '''latest version''' of the resource is always displayed.
* An implicit draft is not generated.


[[File:CS resource yes current.png|alt=Approved page with approved status|center|thumb|450x450px|Approved page with the latest version of the resource]]
| style="width:500px;" |'''Resource display:'''
*The '''approved version of the resource''' is shown.[[File:CS resource yes stable standard.png|alt=Approved page with currently approved version of the resource.|center|thumb|450x450px|The currently approved version of the resource is shown.]]
'''Resource approval:'''
'''Resource approval:'''
*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.
*This is done exclusively via the resource itself.
*The page does not indicate whether a draft version of the resource exists.
|-
! style="" |Current versions of included pages
| style="" |'''Resource display:'''
*The '''latest version''' of the resource is always displayed.
* An implicit draft is not generated.
[[File:CS resource yes current.png|alt=Approved page with approved status|center|thumb|450x450px|Approved page with the current version of the resource]]'''Resource approval:'''
*The resource itself is neither necessary nor possible.
| style="" |'''Resource display:'''
*The '''latest version''' of the resource is always displayed.
* An implicit draft is not generated.
[[File:CS resource yes current.png|alt=Approved page with approved status|center|thumb|450x450px|Approved page with the current version of the resource]]'''Resource approval:'''
*The approval status of the resource has no effect on the page.


|}
|}


===Reading permissions for drafts===
===Read-permissions for drafts===
By default, all users can see a page's drafts, including users with only read permissions.
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 />{{Messagebox|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. 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.
{{Messagebox|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.




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 ''Allow viewing of first draft version for users who can normally not see drafts'' to be disabled.
===Summary: Read Permissions for Draft Pages===
===Summary: Read Permissions for Draft Pages===
'''Define groups:'''
'''Define groups:'''
Line 110: Line 116:
'''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|550x550px|reference=https://de.wiki.bluespice.com/wiki/ File:Book-First Draft.png|link=Special:FilePath/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:CS first draft export.png|alt=Error message in the PDF|center|thumb|550x550px|Permissions error PDF export]]
 
 
==Effects on Semantic MediaWiki properties==
==Effects on Semantic MediaWiki properties==
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:
If a namespace has [[Manual:Semantic_MediaWiki|Semantic MediaWiki]] activated, the following approval states are available as properties:
{| class="wikitable" style="width:950px;"
{| 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
! 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
! 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="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;"
|- 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);" | First draft
| style="box-sizing:inherit;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Current values
| 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;"
Line 126: Line 130:
|- style="box-sizing: inherit;"
|- 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);" |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;padding:0.2em 0.4em;border:1px solid rgb(162, 169, 177);" |Values of the approved (stable) version (default setting)<br />The value for this setting can be set to ''false'' in the Configuration manager of the wiki. If set to ''false,'' the property values of the draft version are used for semantic queries instead of the values for the stable version.
|- style="box-sizing: inherit;"
|}{{Textbox|boxtype=note|header=|text=There is no document state for implicit drafts. The state is shown as "approved".|icon=yes}}
| 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 ''false,'' the property values of the draft version are used for semantic queries instead of the values for the stable version.


===Property QM/Document_state ===
When switching between the approved page and the draft page, the document state can be displayed on the respective page view (stable vs. unstable page view). To do this, the following tag can be included in a page or template:<syntaxhighlight lang="text">
<documentstate page="{{FULLPAGENAME}}" revision="{{REVISIONID}}" />
</syntaxhighlight>
==Quality management overview==
==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.
The Special page ''Special:Quality_management_overview'' allows all users  with ''reviewer'' permissions 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.
[[File:QM overview page.png|center|thumb|650x650px|Special page "Quality management overview"]]


==Approving a page when the title area is hidden==
If the title area on a page is hidden using the <code>HIDETITLE__</code> toggle, the page can be proved from the page tools:


# '''Switch''' to the draft version  from the  ''All Actions...'' link in page tools (this step is not necessary if the page is in the initial draft).
# '''Approve''' the page by clicking Approve page in the page tools.<br />
{{Box Links-en
{{Box Links-en
|Topic1=[[Manual:Quality_management|Quality management tools]]
|Topic1=[[Manual:Extension/Workflows|Approving pages via workflows]]
|Topic2=[[Reference:FlaggedRevs]]
|Topic3=[[Manual:Extension/BlueSpiceBookshelf|Books]]
|Topic3=[[Reference:BlueSpiceFlaggedRevsConnector]]|Topic4=[[Manual:Semantic MediaWiki]]}}
|Topic2=[[Manual:Extension/PDFCreator|PDF export]]
}}
{{translation}}
{{translation}}
[[Category:Qualität]]
 
<references />
<references />
[[Category:Quality]]

Latest revision as of 06:33, 14 May 2025

The ContentStabilization extension activates an approval mechanism for namespaces. New versions of a page are initially marked as drafts. Users with approval rights can then review and approve the page.

Activating page approval

Drafts are activated via the namespace manager. 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 of a namespace. The namespace dialog opens. Select approval and click Done or Save (depending on the version).

Namespace settings screen
Activated Approval feature 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.

First draft indicator in the title area
First draft


By 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 with a skin setting for BlueSpiceDiscovery in the Configuration manager.

First drafts

When a new page is created and saved for the first time, its status is first draft until the page gets approved. By default, first drafts are visible to all users with read permissions. However, this can be restricted to individual user groups in the settings of the Configuration manager.

Drafts

If a page is edited and saved multiple times in draft mode, each edit is listed in the version history. The Status column shows which revision is a draft and which is approved. Additionally, approved versions are highlighted in color.

5 page revision entries, 3 of which are approved versions
Version history with highlighted approvals

Approving 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.

approval feature in the title area
Approval from the title area

The new approval status is then shown in the title area.

Approval status indication
Approved page status


Configuration

The approval mechanism is managed in the Configuration manager

Quality assurance

  • Include handling: If resources are embedded in a page and these resource namespace itself has approval enabled, the following settings can be selected:
Behavior
Versions that were current at the time of release Creates an implicit draft when the resource changes after page approval. The resource will be approved together with the next page approval.
Approved versions of included pages Only applies if the resource itself can be approved. The latest approved version is displayed on the approved wiki page.
Current versions of included pages Always shows the most current version of a resource. An implicit draft is not generated.
  • Show not approved pages for following groups: If the user group has been removed from the configuration, users in this group cannot see draft versions. This also applies if they are added as reviewers in a namespace. In this case, only users with the sysop and reviewer permissions can access drafts, unless other groups are specified. These system groups can then only access drafts via the page's version history. All groups that can see page drafts anywhere in the wiki must be explicitly specified here. This setting applies to the entire wiki and cannot be restricted to namespaces.
  • Allow viewing of first draft version for users who can normally not see drafts: If this setting is enabled, all users with read permissions can see the first draft. If disabled, only groups from the setting "The following groups can see draft versions" can see first drafts.
  • Update semantic properties from approved versions only: The attribute value of the page is set from the stable version of the page and not from the draft version.

Search and navigation

  • Index only approved versions: Page names and contents of draft pages are not taken into account by the search. If this checkbox is activated, the search index has to be recreated.

Export

  • Show stabilization information in PDF export:
    Prints the timestamp for the last approved version below the page headings in the PDF (date of approval and date of last edit before approval).
    FlaggedRevs info under the heading

Changes to embedded resources

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 considered. Their approval is determined by the settings in the Configuration manager.

Important!If the approval mechanism is activated in a resource namespace (e.g. Template, File) in retrospect, all existing pages in the resource namespace 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.

Approvals via server script.
Setting Behaviour of the approved content page -

No resource approval mechanism

Namespace settings dialog
Resource without approval feature
 Behaviour of the approved content page -

Approval mechanism via resource namespace

Namespace manager settings
Resource with approval feature
Versions that were current at the time of approval

(Default)

Resource display:
  • The embedded version of the resource at the time of page approval is displayed on the approved version of the page.
  • An implicit draft is generated.
    screenshot of the approved page with the frozen resource
    Approved page version with the version of the resource that was embedded at the time of page approval

Ressource approval:

  • The resource is updated the next time the page is approved. If the resource is embedded on multiple pages in the wiki, each page must be approved separately.
Page draft with preview of changed resource and resource change banner
Page draft due to change of embedded resource
 Resource display:
  • The embedded version of the resource at the time of page approval is displayed on the approved version of the page.
  • An implicit draft is generated.
    screenshot of the approved page with the frozen resource
    Approved page version with the version of the resource that was valid at the time of page approval

Ressource approval:

  • The approval status of the ressource has no effect on the page.
  • The resource is updated the next time the page is approved. If the resource is embedded on multiple pages in the wiki, each page must be approved separately.
    Page draft with preview of changed resource and resource change banner
    Page draft due to change of embedded resource
Approved versions of included pages Resource display:
  • This setting has no effect since the resource itself has no approval mechanism.
  • The latest version of the resource is always displayed.
  • An implicit draft is not generated.
Approved page with approved status
Approved page with the latest version of the resource
 Resource display:
  • The approved version of the resource is shown.
    Approved page with currently approved version of the resource.
    The currently approved version of the resource is shown.

Resource approval:

  • This is done exclusively via the resource itself.
  • The page does not indicate whether a draft version of the resource exists.
Current versions of included pages Resource display:
  • The latest version of the resource is always displayed.
  • An implicit draft is not generated.
Approved page with approved status
Approved page with the current version of the resource
Resource approval:
  • The resource itself is neither necessary nor possible.
 Resource display:
  • The latest version of the resource is always displayed.
  • An implicit draft is not generated.
Approved page with approved status
Approved page with the current version of the resource
Resource approval:
  • The approval status of the resource has no effect on the page.

Read-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.

Warning!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.

After removing the group user, the desired group(s ), e.g. the group editor, can be added to the configuration and saved.

Note: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.


In order for administrators to see the status directly on the page, they must be added to a group listed here in the configuration.

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 for users who can normally not see drafts 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:
    Error message in the PDF
    Permissions error PDF export

Effects on Semantic MediaWiki properties

If a namespace has Semantic MediaWiki activated, the following approval states are available as properties:

Document state Available properties
First draft Current values
Approved Values of the approved (stable) version
Draft Values of the approved (stable) version (default setting)
The value for this setting can be set to false in the Configuration manager of the wiki. If set to false, the property values of the draft version are used for semantic queries instead of the values for the stable version.
There is no document state for implicit drafts. The state is shown as "approved".


Property QM/Document_state

When switching between the approved page and the draft page, the document state can be displayed on the respective page view (stable vs. unstable page view). To do this, the following tag can be included in a page or template:

<documentstate page="{{FULLPAGENAME}}" revision="{{REVISIONID}}" />

Quality management overview

The Special page Special:Quality_management_overview allows all users with reviewer permissions 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.

Special page "Quality management overview"

Approving a page when the title area is hidden

If the title area on a page is hidden using the HIDETITLE__ toggle, the page can be proved from the page tools:

  1. Switch to the draft version from the All Actions... link in page tools (this step is not necessary if the page is in the initial draft).
  2. Approve the page by clicking Approve page in the page tools.

Related info



Technical Reference: ContentStabilization



To submit feedback about this documentation, visit our community forum.

Retrieved from "https://en.wiki5.bluespice.com/w/index.php?title=Manual:Extension/ContentStabilization&oldid=11511"