Extension:FlaggedRevs/av
 Warning: | Flagged Revisions is very clunky, complex and not recommended for production use, despite the "stable" tag. See phab:T185664. This extension has not been installed on any new WMF wikis since 2014. |
The Flagged Revisions extension allows for Editor and Reviewer users to rate revisions of articles and set those revisions as the default revision to show upon normal page view. This allows for MediaWiki to act more like a Content Management System (CMS).
Installation
- Download and move the extracted
FlaggedRevsfolder to yourextensions/directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/FlaggedRevs - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'FlaggedRevs' );
- Run the update script which will automatically create the necessary database tables that this extension needs.
- Configure as required.
Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Setup
AllowEncodedSlashes
If you are using Apache 2.3.12 or later, you should set AllowEncodedSlashes to "NoDecode".
Add the following line to your <VirtualHost> or, if you don't have one, at the end of your httpd.conf file:
AllowEncodedSlashes NoDecode
After you edited httpd.conf, Apache needs to be restarted.
Alter your .htaccess (if needed)
If you are shortening your URLs, you need to add an exception to .htaccess to allow the use of the REST API.
FlaggedRevs calls on rest.php. For example:
https://[domain]/w/rest.php/flaggedrevs/internal/review/Main_Page
If the .htaccess conditions are not properly set when the above url is called, FlaggedRevs will literally try to access an article named "W/rest.php/flaggedrevs/internal/review/Main Page".
Here is one way to add an exception to .htaccess, emphasis added:
RewriteEngine On
RewriteCond %{REQUEST_URI} !^/w/rest\.php
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-f
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_URI} !-d
RewriteRule ^(.*)$ w/index.php?title=$1 [L,QSA]
RewriteRule ^$ w/index.php [L,QSA]
Promote users to reviewers
After FlaggedRevs is first installed, no user can see the reviewer's widget. To fix this, login as a wiki bureaucrat and go to Special:UserRights, then grant review rights to one or more users. Reviewers will see the reviewer's widget on the bottom of an editable page.
Article review statistics (optional)
/var/www/mediawiki.For a scheduled collection of article review statistics, create a cron job to run extensions/FlaggedRevs/maintenance/updateStats.php at a regular interval.
Run time php updateStats.php to see how long the script takes to run and set your cron jobs interval appropriately.
For example, to create a cron job that runs updateStats.php every hour, add the following to the crontab for the user running the web server (e.g., www-data):
@hourly php /var/www/mediawiki/extensions/FlaggedRevs/maintenance/updateStats.php
Configuration
Parts of this page (those related to features removed in master version) are outdated. |
User rights and user groups
By default, nobody can review anything, so the first step is to set up user rights.
| User groups | User rights |
|---|---|
| reviewer | validate |
| review | |
| editor | |
| autoreview | |
| unreviewedpages |
User rights
FlaggedRevs creates the following new user rights:
review– user can review revisionsvalidate– user can review revisions and can set all tags to all levelsautoreview– any new revisions made by the user are automatically marked as sightedautoreviewrestore– autoreview of the rollbacks made by the user.unreviewedpages– user can view Special:UnreviewedPagesstablesettings– user can changes the settings of stable revisions of any pagemovestable– user can move pages with stable revisions
User groups
FlaggedRevs creates the following new user groups:
editor– receiveautoreview, review, unreviewedpages, plus the standard MediaWiki user rightsautoconfirmed, editsemiprotectedreviewer– receiveautoreview, review, unreviewedpages, validate, plus the standard MediaWiki user rightsautoconfirmed, editsemiprotectedautoreview– receiveautoreview
How to assign user rights
User rights can be assigned in two ways:
- Assigning rights to user groups
Assign these user rights to existing user groups in LocalSettings.php:
$wgGroupPermissions['sysop']['review'] = true; //allow administrators to review revisions
- Assigning rights to specific users
Manually add user accounts to the appropriate groups via Special:UserRights.
- By default:
- Bureaucrats can add/remove Reviewers
- Administrators can add/remove both Autoreviewers and Editors.
Basic settings
FlaggedRevs.php comes with a number of configurable variables.
These should be configured in LocalSettings.php.
$wgFlaggedRevsNamespaces– Sets what namespaces may be subject to the review process. This is an array of integers. See Manual:Namespace constants to see what integer the default namespaces map to and use the defined constants for readability.$wgFlaggedRevsTags– Sets the tags and their 'levels' setting.- Definition
$wgFlaggedRevsTagsis an associative array with keys corresponding to each tag name. The only meaningful value of the array is 'levels', which controls the number of review levels, and the array can only have one element.- Labeling
- Each tag can be labeled editing the page MediaWiki:revreview-<tag-name>.
- Each tag level can be labeled editing the page MediaWiki:revreview-<tag-name>-<level-number>.
- By default, the tag is labeled as it appears in the
$wgFlaggedRevsTagsarray. To override this, and show tags for example as their capitalized name, the admins have to edit these pages with the shown content, for example changing the content of MediaWiki:revreview-accuracy
- To label the tag levels, the admins have to create these pages with the shown content:
tag level labeling page content accuracy 0 MediaWiki:revreview-accuracy-0 не указано 1 MediaWiki:revreview-accuracy-1 Выборочно проверено 2 MediaWiki:revreview-accuracy-2 точная
- The resulting setup will be:
tag names level names Точность не указано Выборочно проверено точная
$wgFlaggedRevsOverride– Whether the stable version is the default content for pages.- Individual pages can be configured to have the stable or draft version as the default content by administrators.
$wgFlaggedRevsTagsRestrictions– An array with keys corresponding to each flag type, and values that are arrays of rights and how high users with it can rate the flags (integral tag level).- Example
$wgFlaggedRevsTagsRestrictions = [ 'accuracy' => [ 'review' => 1 ], ];
User interface
$wgSimpleFlaggedRevsUI– When enabled, a simpler, icon based UI is used. Does not affect the tags shown in edit mode.$wgFlaggedRevsLowProfile– This setting hides the review status box/bar for pages that are reviewed in their latest version. Explanatory text is also removed from some places.
Workflow
$wgFlaggedRevsAutoReview– If enabled, every edit by a user with 'autoreview' rights is automatically reviewed upon save. There is no need to hit the "submit review" button. This feature requires that the previous revision was also reviewed; otherwise, auto-review will not occur.$wgFlaggedRevsTagsAuto– IfwgFlaggedRevsAutoReviewis enabled, this settings controls how high each tag can be auto-reviewed. If allowed, tags will be auto-reviewed to the same level the previous revision tags were. This is an associative array; each key is a tag and each value is a tag level.- Example
$wgFlaggedRevsTagsAuto = [ 'accuracy' => 1 ];
- Changes in templates are auto-reviewed (per-page). This could possibly cause bad versions to be reviewed. Users should be encouraged to use preview or review the page after saving. You may want to set
$wgNamespaceProtection[NS_TEMPLATE]as[ 'editor' ]or[ 'autoconfirmed' ]
Automatic user promotion
$wgFlaggedRevsAutopromote– An array with keys for days, edits, time spacing, benchmarks, emailconfirmed, recent content page edits, total content edits, content pages edited, edit summaries used, IP uniqueness, and userpage existence as keys. The values correspond to how many days/edits are needed for a user account to be autopromoted to Editor status and whether they must be emailconfirmed and have a user page do so. The user must have at least X edits that are Y or more days apart, where X is the number of benchmarks and Y is the time spacing. Set this variable to false to disable this entirely.- If a user has their Editor rights removed, they will not automatically be re-granted (the editor status log is checked for revocations).
- Some of these counts are not retroactive, so you may notice a delay in promotions.
- Example
- For
$wgFlaggedRevsAutopromote, one might have: $wgFlaggedRevsAutopromote['days'] = 60; # days since registration $wgFlaggedRevsAutopromote['edits'] = 150; # total edit count $wgFlaggedRevsAutopromote['excludeDeleted'] = true; # exclude deleted edits from 'edits' count above? $wgFlaggedRevsAutopromote['spacing'] = 3; # spacing of edit intervals $wgFlaggedRevsAutopromote['benchmarks'] = 15; # how many edit intervals are needed? $wgFlaggedRevsAutopromote['recentContentEdits'] = 10; # $wgContentNamespaces edits in recent changes $wgFlaggedRevsAutopromote['totalContentEdits'] = 30; # $wgContentNamespaces edits $wgFlaggedRevsAutopromote['uniqueContentPages'] = 10; # $wgContentNamespaces unique pages edited $wgFlaggedRevsAutopromote['editComments'] = 5; # how many edit comments used? $wgFlaggedRevsAutopromote['email'] = true; # user must be emailconfirmed? $wgFlaggedRevsAutopromote['userpageBytes'] = 0; # if userpage is needed, what is the min size?
Advanced
$wgFlaggedRevsRestrictionLevels- Restriction levels forautoreview/reviewrights. When a level is selected for a page, an edit made by a user will not be auto-reviewed if the user lacks the specified permission. Levels are set at Special:Stabilization.$wgFlaggedRevsProtection- Set this to use FlaggedRevs only as a protection-like mechanism (Help:Pending changes), rather than the standard configuration.$wgFlaggedRevsAutoConfirm- Define when users get to have their own edits auto-reviewed. Set tofalseto disable.$wgFlaggedRevsHandleIncludes- Whether to use stable versions of templates when rendering the stable version of a page.
To have a wiki where non-users can only see the stable version of articles, see Extension:FlaggedRevs/Restricting unapproved revisions.
Use
- See also: Help:FlaggedRevs
Approving pages
Users with some level of review status will have a small rating form on page view (at the bottom of the page) and diffs (at the top of the page) that lets them review revisions. Each tag must at least meet the minimal level of approval. Users should look at the whole page, included templates and images, before reviewing. The (diff to stable) link is very useful for speeding up this process.
Users cannot review a page which they cannot edit. They cannot lower the level of a revision from a level they cannot set. Blocked users cannot do anything.
Upkeep
At Special:UnreviewedPages, there is a list of pages that have not yet been reviewed, for Editors only. A namespace must be selected and an optional category filter is also present.
At Special:OldReviewedPages, there is a list of pages that have been reviewed, but have edits pending. This is for Editors only. An optional category filter is also present.
Pages that cannot be reviewed can still be patrolled for anti-vandalism purposes by Editors to see what has been checked already.
Logging
All relevant actions are permanently logged, so everything can be tracked and overseen properly.
- A log of promotion/demotion of editors and the reasons is kept at Special:Log/userrights.
- A log of the approval/unapproval of revisions is kept at Special:Log/review.
- A log of changes to the stable versioning configuration to pages is logged at Special:Log/stable.
Notes
$wgUseRCPatrolis enabled with the extension.
Patrolling of reviewable pages is disabled, but flagged revisions are marked as patrolled in Recent Changes. This will mean that the only way to patrol a reviewable revision is to flag it. Non-reviewable pages still behave as normal (depending on site patrol settings).
- Sysops can change whether the stable version is shown by default for specific pages.
To disable this, add $wgGroupPermissions['sysop']['stablesettings'] = false; to LocalSettings.php.
- Page links, category, image, template, language, and external links are still based on the current version of pages.
- Users cannot move pages they cannot review.
This is deliberate; see task T15994. To work around this, add $wgGroupPermissions['autoconfirmed']['movestable'] = true; to LocalSettings.php
- You can demote Editors either temporarily by blocking them or permanently via Special:UserRights.
An extra demotion log item will appear for tracking purposes.
API
FlaggedRevs adds API modules for reviewing revisions and configuring "stabilization" of pages, a module for retrieving flag configuration, and two list modules corresponding to the special pages for unreviewed pages and "old" reviewed pages.
action=review
Reviews a page.
- Parameters
revid: The revision ID for which to set the flagstoken: A csrf token retrieved through action=query&meta=tokenscomment: Comment for the review (optional)flag_accuracy: Set the flag named "accuracy" to the specified value; (replace "accuracy" with the flag name to set another flag)unapprove: If set, revision will be unapproved rather than approved
- Example
| Result |
|---|
<api>
<review revid="12345" />
</api>
|
action=stabilize
Changes page stabilization settings.
- Parameters
title: Title of page to be stabilizedreason: Reason for stabilizationexpiry: Stabilization expiry. Default: infinitereview: Whether to auto-review the pagewatch: Whether to watch the pagetoken: An edit token retrieved through action=query&meta=tokens
- For protection-like configurations (
$wgFlaggedRevsProtection=true):
protectlevel: The right users must have in order for their edits to not require review.
- Otherwise (
$wgFlaggedRevsProtection=false):
default: Default revision to show (latest | stable)autoreview: Restriction level for the 'autoreview' right (sysop | none). Default: none
- Example
| Result |
|---|
<api>
<stabilize title="Foo" default="stable" autoreview="none" expiry="infinite" />
</api>
|
action=flagconfig
Shows information about review flag configuration.
The following parameters are returned for each tag:
name: the name of the flaglevels: the number of possible levels the flag has (not counting the "unreviewed" level)
The displayed name for each flag and the different level names for each flag are MediaWiki messages, so can be set and retrieved through the appropriate page; for example the name for the first level of the "accuracy" flag is located at MediaWiki:revreview-accuracy-1.
- Example
| Result |
|---|
<api>
<flagconfig>
<tag name="value" levels="3" tier1="1" />
</flagconfig>
</api>
|
list=unreviewedpages
Lists pages which have never been reviewed.
- Parameters
urstart: Start listing at this page title.urend: Stop listing at this page title.urnamespace: The namespaces to enumerate.urfilterredir: How to filter for redirectsurfilterlevel: How to filter by quality (0=sighted,1=quality)urlimit: How many total pages to return.
- Example
| Result |
|---|
<api>
<query-continue>
<unreviewedpages urstart="Arbeitgeberverband_Chemie_und_verwandte_Industrien_für_das_Land_Hessen" />
</query-continue>
<query>
<unreviewedpages>
<p pageid="4762806" ns="0" title="Aaftink" revid="65175047" />
<p pageid="4747500" ns="0" title="Abt RS6" revid="64976429" />
<p pageid="4749877" ns="0" title="Acht Vorlesungen über den Konstruktiven Realismus" revid="65089962" />
<p pageid="4758156" ns="0" title="Alkylglycerole" revid="65169004" />
<p pageid="4719044" ns="0" title="All Riot" revid="64767732" />
<p pageid="4745418" ns="0" title="Allgäu-Panorama-Marathon" revid="64974783" />
<p pageid="4729976" ns="0" title="An- und Einpressen" revid="64742640" />
<p pageid="4742559" ns="0" title="Anjara I. Bartz" revid="64925772" />
<p pageid="4740681" ns="0" title="Anthony Norris Groves" revid="65064712" />
<p pageid="4759964" ns="0" title="Antonino Asta" revid="65169073" />
</unreviewedpages>
</query>
</api>
|
list=oldreviewedpages
Lists pages that have at some point been reviewed, but for which the most recent revision is not reviewed.
- Parameters
orstart: Start listing from this timestamporend: Stop listing at this timestamp.ordir: In which direction to list.ornamespace: The namespaces to enumerate.orfilterredir: How to filter for redirectsorlimit: How many total pages to return.
- Example
| Result |
|---|
<api>
<query-continue>
<oldreviewedpages orstart="2009-09-15T20:23:05Z" />
</query-continue>
<query>
<oldreviewedpages>
<p pageid="144735" ns="0" title="Two International Finance Centre" revid="64562654" stable_revid="62769201" pending_since="2009-09-15T16:16:33Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="1629949" ns="0" title="Porta San Sebastiano" revid="64791898" stable_revid="61610797" pending_since="2009-09-15T16:19:32Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="2157354" ns="0" title="Entwicklungspolitik der Europäischen Union" revid="64640078" stable_revid="59929751" pending_since="2009-09-15T16:38:33Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="971904" ns="0" title="Federpendel" revid="65142775" stable_revid="59587441" pending_since="2009-09-15T17:37:29Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="3106812" ns="0" title="Soultzbach-les-Bains" revid="64552516" stable_revid="60455707" pending_since="2009-09-15T19:04:07Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="1223029" ns="0" title="VfR Bürstadt" revid="65150048" stable_revid="62925935" pending_since="2009-09-15T19:35:30Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="829158" ns="0" title="GSP" revid="64553869" stable_revid="62913440" pending_since="2009-09-15T19:38:46Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="3453867" ns="0" title="Agios Dimitrios" revid="65103799" stable_revid="64544222" pending_since="2009-09-15T19:47:10Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="2583263" ns="0" title="Jörg Kudlich" revid="64554475" stable_revid="62429967" pending_since="2009-09-15T20:03:24Z" flagged_level="0" flagged_level_text="stable" />
<p pageid="325478" ns="0" title="Liste deutscher Komponisten klassischer Musik" revid="65089571" stable_revid="63582610" pending_since="2009-09-15T20:21:55Z" flagged_level="0" flagged_level_text="stable" />
</oldreviewedpages>
</query>
</api>
|
prop=flagged
Use action=query&prop=flagged to get information about the flagging status of the given pages.
Limitations
- Transclusions across wikis are not stabilized
Uninstalling
- Remove the
require_onceorwfLoadExtensionline fromLocalSettings.php
- Drop the tables in
FlaggedRevs.sql
- Drop the columns
page_ext_reviewed,page_ext_quality, andpage_ext_stable, and the indexext_namespace_reviewedfrom thepagetable (if they exist; only older versions of FlaggedRevs used these)
- Run
maintenance/refreshLinks.phpfrom the command line to flush out the stable version links
- Run
maintenance/rebuildFileCache.php 0 overwritefrom the command line if you use$wgFileCache
Testing platforms
See also
- Help:Patrolled edits
- Extension:FlaggedRevs/Specifications
- Extension:Approved Revs - allows administrators to mark a specific revision of a page as "approved"
- Extension:ContentStabilization - allows users to mark pages as "approved" or "draft" and to view the most recent approved version of a page
- Extension:Moderation – edits remain private until they're approved
- Extension:Page Approvals - allows users to approve pages and automatically revokes them in case of content changes
- Flagged Revisions on Wikimedia projects
- Project:Editor – documentation about the user groups and rights created by this extension, while it was at use on mediawiki.org
External links
- Quality Assurance in an Open Project – 2008 Wikimedia blog post
- Images of Flagged Revisions – Wikimedia Commons
- About Flagged Revisions – Meta-Wiki
Licensing
© GPL, Aaron Schulz, Joerg Baach, 2007
| This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
| This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |
| Это произведение — свободное программное обеспечение; вы можете распространять и/или изменять его в соответствии с условиями GNU General Public License, опубликованной Free Software Foundation, версии 2 или более поздней. Данное произведение распространяется в надежде на то, что оно будет полезным, но без какой-либо гарантии; в том числе, без подразумеваемых гарантий товарной пригодности или пригодности для конкретных целей. Подробнее см. версию 2 и версию 3 условий GNU General Public License. |