9 Manual:Extension/FlaggedRevs and Manual:Extension/BlueSpicePageTemplates: Difference between pages

(Difference between pages)
VisualWikitext
No edit summary
 
No edit summary
 
Line 1: Line 1:
<bookshelf src="Book:User manual" />
<bookshelf src="Book:Admin manual" />
{{DISPLAYTITLE:Page approvals (Acceptance)}}
{{DISPLAYTITLE:Page templates}}
<section begin="training-intro" />


'''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.
A page template applies a predefined content structure and layout to new pages. That way, certain page types can be applied during page creation to produce consistent sets of related pages.
==Activating the acceptance feature==
<section eind="training-intro" />
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.
==When to use page templates==
The dialog window opens after clicking the edit icon (wrench) in the ''Actions'' column. Select ''Approval'' and click ''Done''.<br />
<section begin="training-intro" />
[[File:Manual:approval-namespace.png|center|thumb|450x450px|Activate the Approval feature|link=Special:FilePath/Manual:approval-namespace.png]]


===Existing pages===
Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, or short manuals.<section end="training-intro" />
After activating ''Approvals'' for a namespace, all pages in the namespace are set into ''first draft'' mode.
[[File:Manual:flaggedrevs-firstdraft.png|alt=Frist draft|center|thumb|Frist draft]]
 
Each page in the namespace now displays the acceptance status in the title area.


===New pages===
When a page is created with a page template, the page becomes "detached" from the original page template. This means that subsequent changes to the template will not affect pages that have originally been created with that page template. This distinguishes page templates from regular [[Manual:Templates|templates]].
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]]


===Characteristics of a page template===
<section begin="training" />


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.
*can be created by administrators
*can only be used for new pages
*based on templates in the ''Template'' namespaces
*can be limited to certain namespaces
*substitution of variables is possible
*can integrate with the extension ''Page Forms''
<section end="training" />


==Accepting a page==
== Standard page templates ==
Users with ''review'' rights can accept a draft page any time they save a page (''Accept this unreviewed page''):<br />
{{BSVersion|bsvFrom=4.2|bsvTo=|bsvFeature=}}
[[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]]
Page templates that are installed by default can be deleted from the page template manager (1).
[[Datei:Handbuch:seitenvorlagen_löschen.png|link=https://de.wiki.bluespice.com/wiki/Datei:Handbuch:seitenvorlagen_l%C3%B6schen.png|alt=Seitenvorlagen löschen|center|thumb|750x750px|Delete (1) or edit the content of (2) page templates]]
Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the column ''Vemplate'' (2).


=== List of standard templates ===
{| class="wikitable" style="width:100%;"
!Page template
!Edition
!Description
|-
|Decision Matrix
|pro
|<span style="color: rgb(32, 33, 36)">Make an informed decision by comparing your options</span>
|-
|Event
|pro
|<span style="color: rgb(32, 33, 36)">Plan an event from beginning to end</span>
|-
|Guideline
|pro
|Create a code of conduct or other guideline
|-
|How-to Article
|free, pro
|Step-by-step instructions for completing a task
|-
|Management Meeting Minutes
|pro
|Create minutes for a regular management meeting
|-
|Meeting Agenda
|free
|Create a generic meeting agenda with minutes
|-
|Request for Comments
|pro
|Ask for feedback about an important decision that needs to be made
|-
|Status Report
|pro
|Stakeholder über den derzeitigen Stand eines Projekts informieren
|-
|To-do List
|free, pro
|Track and update your to-dos
|}


If the page is not accepted at this point, it can be accepted independently from the editing process.
==Creating a page template==
Administrators can create new page templates, as well as edit and remove existing ones in the ''Page templates'' manager, located under ''Global actions''.


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:
<br />
<br />
[[File:Manual:flaggedrevs-acceptdraft.png|center|277x277px|thumb|Accepting a draft from the title section|link=Special:FilePath/Manual:flaggedrevs-acceptdraft.png]]


When accepting the page, the reviewer can leave a comment. This comment will then be shown in the version history of the page.
[[File:PageTemplates1a.png|Page template manager|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates1a.png|center|650x650px|alt=Page template manager|thumb]]{{Messagebox|boxtype=note|icon=|Note text=Every page template depends on an actual page in the namespace Template. This template must exist before creating a page template.|bgcolor=}}
A new page template can be created by clicking the "Plus" button above the template list.


The page status now shows the page version as accepted.
===Template fields===
[[File:Manual:flagged-revs-accepted.png|link=https://bs4-en.wiki.bluespice.com/wiki/File:Manual:flagged-revs-accepted.png|alt=Accepted page|center|thumb|300x300px|Accepted page]]
When creating or editing a page template, the following information needs to be provided before the page template can be saved:


==Setting read permissions for drafts==
*'''Name''' - the name of the page template
By default, all users can see the drafts of a page, even readers.  
*'''Description''' - a short description of the page template
*'''Namespace''' - a list of the namespace where the template is active. If the template should be available on all pages, select ''(all)'' from the list.
*'''Template''' - page in the ''Template'' namespace from which to pull the content.


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:PageTemplates2.png|link=https://en.wiki.bluespice.com/wiki/File:PageTemplates2.png|alt=Creating a page template|center|450x450px|Creating a page template|thumb]]
<br />
<br />
[[File:Manual:flaggedrevs-config.png|center|650x650px|link=Special:FilePath/Manual:flaggedrevs-config.png]]
 
<br />{{Messagebox|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.}}
==Using page templates==
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:
A list of available templates appears when a user creates a new page. It is usually shown below the "Empty page" default template. Selecting one of these page templates will create the new page that is pre-filled with the content from the actual template page.
 
There are two important settings:
 
*'''Assigning namespaces (in the page templates administration):''' Page templates can be linked to specific namespaces. If a namespace is not added here, the template will not be displayed in that namespace.
*'''Namespace manager:''' The PageTemplates option for a namespace must be activated in the Namespace manager so that the associated templates are automatically displayed when a new page is created in that namespace (e.g., if the "+" button is used to create the page).
 
<br />
<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/Workflows|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.
[[File:Manual:PageTemplates3a.png|link=link=https://en.wiki.bluespice.com/wiki/File:PageTemplates3a.png|alt=|center|thumb|414x414px|Selecting a page template]]
{{Messagebox|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==
A list of available templates to choose from is displayed below the default "Blank Page" template when a user creates a new page.  
<span style="color: rgb(37, 37, 37)">If a page uses templates or contains other files such as images and embedded PDFs and these files have been modified since the page was approved, those changes must also be approved. The wiki can be set up in two different ways to achieve this approval:</span>


# '''The embedded resource is located in a namespace without approval feature:''' If the embedded resource is in a namespace without its own approval function, the resource version at the time of the page approval is displayed. The draft version of the page shows the most recent version of the embedded resource. To approve the resource change, the page istself must be approved again. The approval has to be done on all pages that have this resource embedded.  <br />[[Manual:Extension/FlaggedRevs/Server script|Information about automatic mass approval via server script.]]
You can also [[Manual:Extension/BlueSpicePageTemplates/Customizing|customize the look-and-feel of this page]].  
# '''The embedded resource is located in a namespace with approval feature:''' The pages that include the changed resource do not give any indication that the resource has been changed. Which version of the included resource is displayed depends on the configuration of the wiki:


{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
==Configuration==
! style="width:220px;" |Setting
!Description
|-
| style="width:220px;" |FR_INCLUDES_STABLE
(default)
|Always shows the approved (stable) version of a resource, even if it was approved after the page that includes the resource was approved (this works only if the resource is located in a namespace with active approval feature).
|-
| style="width:220px;" | FR_INCLUDES_CURRENT
| Always shows the latest version of the included resource (this works only if the resource is located in a namespace with active approval feature).
|}
==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==
In the [[Manual:Extension/BlueSpiceConfigManager#BlueSpicePageTemplates|Config manager]], you can change the following settings:
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.
{{#dpl:|title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpicePageTemplates}}
{{Box Links-en|Topic1=[[Reference:BlueSpicePageTemplates]]}}


[[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}}]]
[[en:{{FULLPAGENAME}}]]
[[de:Handbuch:Erweiterung/FlaggedRevs]]
[[de:Handbuch:Erweiterung/BlueSpicePageTemplates]]
__FORCETOC__
 
[[Category:Quality]]
[[Category:Organization]]
<references />

Revision as of 16:35, 27 July 2022

A page template applies a predefined content structure and layout to new pages. That way, certain page types can be applied during page creation to produce consistent sets of related pages.

When to use page templates

Page templates are useful for frequently used content formats such as meeting minutes, reference pages, product descriptions, or short manuals.

When a page is created with a page template, the page becomes "detached" from the original page template. This means that subsequent changes to the template will not affect pages that have originally been created with that page template. This distinguishes page templates from regular templates.

Characteristics of a page template

  • can be created by administrators
  • can only be used for new pages
  • based on templates in the Template namespaces
  • can be limited to certain namespaces
  • substitution of variables is possible
  • can integrate with the extension Page Forms

Standard page templates

is available from BlueSpice 4.2.

Page templates that are installed by default can be deleted from the page template manager (1). link=https://de.wiki.bluespice.com/wiki/Datei:Handbuch:seitenvorlagen_l%C3%B6schen.png|alt=Seitenvorlagen löschen|center|thumb|750x750px|Delete (1) or edit the content of (2) page templates Alternatively, the templates can be adapted directly in the template namespace. To do this, click on the template link in the column Vemplate (2).

List of standard templates

Page template Edition Description
Decision Matrix pro Make an informed decision by comparing your options
Event pro Plan an event from beginning to end
Guideline pro Create a code of conduct or other guideline
How-to Article free, pro Step-by-step instructions for completing a task
Management Meeting Minutes pro Create minutes for a regular management meeting
Meeting Agenda free Create a generic meeting agenda with minutes
Request for Comments pro Ask for feedback about an important decision that needs to be made
Status Report pro Stakeholder über den derzeitigen Stand eines Projekts informieren
To-do List free, pro Track and update your to-dos

Creating a page template

Administrators can create new page templates, as well as edit and remove existing ones in the Page templates manager, located under Global actions.


Page template manager
Page template manager
Note:Every page template depends on an actual page in the namespace Template. This template must exist before creating a page template.

A new page template can be created by clicking the "Plus" button above the template list.

Template fields

When creating or editing a page template, the following information needs to be provided before the page template can be saved:

  • Name - the name of the page template
  • Description - a short description of the page template
  • Namespace - a list of the namespace where the template is active. If the template should be available on all pages, select (all) from the list.
  • Template - page in the Template namespace from which to pull the content.


Creating a page template
Creating a page template


Using page templates

A list of available templates appears when a user creates a new page. It is usually shown below the "Empty page" default template. Selecting one of these page templates will create the new page that is pre-filled with the content from the actual template page.

There are two important settings:

  • Assigning namespaces (in the page templates administration): Page templates can be linked to specific namespaces. If a namespace is not added here, the template will not be displayed in that namespace.
  • Namespace manager: The PageTemplates option for a namespace must be activated in the Namespace manager so that the associated templates are automatically displayed when a new page is created in that namespace (e.g., if the "+" button is used to create the page).


Selecting a page template


A list of available templates to choose from is displayed below the default "Blank Page" template when a user creates a new page.

You can also customize the look-and-feel of this page.

Configuration

In the Config manager, you can change the following settings:

  • Force target namespace: The page is always created in the target namespace that is associated with the template, even if the user provided a different namespace prefix. In the screenshot below, the user wants to create the page "NewPage" and then selects a template for the QM namespace. The page is, therefore, created as "QM:NewPage" if this setting is activated.
    force the namespace of the template
    force the namespace of the template
  • Hide default templates: Hides the default Empty page template.
  • Hide template if the page is not to be created in the target namespace: Depending on the namespace prefix of the page to be created, templates that are associated with other namespaces will not be shown to the user for selection.

Related info


Technical Reference: FlaggedRevs


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

Retrieved from "https://en.wiki.bluespice.com/w/index.php?title=Manual:Extension/FlaggedRevs&oldid=4053"

Discussions