Extension:FlaggedRevs/en

To learn how to use Flagged Revisions, read the help page on FlaggedRevs.

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. These revisions will remain the same even if included templates are changed or images are overwritten This allows for MediaWiki to act more like a Content Management System (CMS).

Setup
The examples in the installation instruction are written for modern Unix-like operating systems (especially Linux and Mac OS X) and assume that MediaWiki is installed in the  directory. If you are working on a different family of operating systems, you will need to use commands and file paths appropriate to the operating system.

Follow these steps to install FlaggedRevs:


 * 1) Ensure that you are running MediaWiki version 1.17 or greater. If not, you will need to upgrade before you can install FlaggedRevs.
 * 2) Download FlaggedRevs. Choose a version of FlaggedRevs that matches the version of MediaWiki that you are using. For example: If you are running MediaWiki 1.17, download FlaggedRevs 1.17.
 * 3) Extract the downloaded file to the   directory of your MediaWiki installation. For example:
 *  
 * 1) Ensure that image hashes are up-to-date by running the populateImageSha1.php maintenance script. For example:
 * 2) Make sure that the   directory is readable by the web server (so that the web server can serve the FlaggedRevs CSS, images and JavaScript.) For example: Assuming that the web server user does not own the   directory, run:
 * 3) Enable collection of article review statistics.
 * 4) Disable on-demand statistic generation. Set   in . This will prevent statistics from being generated when articles are accessed (which can lead to poor performance when many articles without current statistics are accessed concurrently).
 * 5) Set up scheduled statistics generation. Create a cron job to run   at a regular interval. Run   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   as user   every hour:
 * 6) Enable FlaggedRevs by adding the following line to :
 * 7) Update MediaWiki's database schemas by running  . This must be done after the above step is saved or you will recieve a database error when accessing any page.
 * 8) Promote users to be 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.
 * 1) Enable FlaggedRevs by adding the following line to :
 * 2) Update MediaWiki's database schemas by running  . This must be done after the above step is saved or you will recieve a database error when accessing any page.
 * 3) Promote users to be 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.
 * 1) Promote users to be 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.

User rights and user groups
By default, nobody can review anything, so the first step is to set up user rights.

User rights
FlaggedRevs creates the following new user rights:
 * – user can review revisions
 * – user can review revisions and can set all tags to all levels
 * – any new revisions made by the user are automatically marked as sighted
 * – autoreview of the rollbacks made by the user.
 * – user can view Special:UnreviewedPages
 * – user can changes the settings of stable revisions of any page
 * – user can move pages with stable revisions

User groups
FlaggedRevs creates the following new user groups:


 * – receive, plus the standard Mediawiki user rights
 * – receive, plus the standard Mediawiki user rights
 * – receive

How to assign user rights
User rights can be assigned in two ways:

Assign these user rights to existing user groups in :
 * Assigning rights to user groups

Manually add user accounts to the appropriate groups via Special:UserRights.
 * Assigning rights to specific users
 * 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.


 * – Sets what namespaces may be subject to the review process. This is an array of integers. Look at the beginning of includes/defines.php to see what integer the default namespaces map to and use the defined constants for readability.
 * – Sets the tags and their three settings: 'levels', 'quality', and 'pristine'
 * Definition
 * is an associative array with keys corresponding to each tag name and values that are arrays of the three settings 'levels', 'quality', and 'pristine':
 * 'levels' controls the number of review levels,
 * 'quality' decides what level the tag must be for a revision to be 'quality'
 * 'pristine' decides what level the tag must be for a revision to be 'pristine'
 * Labeling
 * Each tag can be labeled editing the page MediaWiki:revreview-.
 * Each tag level can be labeled editing the page MediaWiki:revreview--.
 * Example
 * Suppose one wants to have "accuracy", "depth", and "tone" tags, with 3 levels each.
 * The admins also want revisions with at least "accuracy" and "depth" of the 2nd levels to count as "quality". The following settings will do that:
 * By default, the tags are labeled as they are set in the $wgFlaggedRevsTags array. In this example this means the tags appear exactly as 'accuracy', 'depth' and 'tone'.
 * To show tags for example as their capitalized name, the admins have to edit these pages with the shown content:
 * {|class="wikitable"
 * {|class="wikitable"

!tag !labeling page !content
 * accuracy
 * MediaWiki:revreview-accuracy
 * Accuracy
 * depth
 * MediaWiki:revreview-depth
 * Depth
 * tone
 * MediaWiki:revreview-tone
 * Tone
 * }
 * MediaWiki:revreview-tone
 * Tone
 * }


 * To label the tag levels, the admins have to create these pages with the shown content:


 * {|class="wikitable"

!tag !level !labeling page !content
 * rowspan=3|accuracy
 * 0
 * MediaWiki:revreview-accuracy-0
 * Low
 * 1
 * MediaWiki:revreview-accuracy-1
 * Medium
 * 2
 * MediaWiki:revreview-accuracy-2
 * High
 * rowspan=3|depth
 * 0
 * MediaWiki:revreview-depth-0
 * Superficial
 * 1
 * MediaWiki:revreview-depth-1
 * Sufficient
 * 2
 * MediaWiki:revreview-depth-2
 * Detailed
 * rowspan=3|tone
 * 0
 * MediaWiki:revreview-tone-0
 * Weak
 * 1
 * MediaWiki:revreview-tone-1
 * Good
 * 2
 * MediaWiki:revreview-tone-2
 * Excellent
 * }
 * 1
 * MediaWiki:revreview-tone-1
 * Good
 * 2
 * MediaWiki:revreview-tone-2
 * Excellent
 * }
 * Excellent
 * }


 * The resulting setup will be:


 * {|class="wikitable"

!tag names !colspan=3|level names
 * Accuracy
 * Low
 * Medium
 * High
 * Depth
 * Superficial
 * Sufficient
 * Detailed
 * Tone
 * Weak
 * Good
 * Excellent
 * }
 * Good
 * Excellent
 * }


 * – 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.
 * – 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
 * – Array of string titles. These titles are pages that are exempt from FlaggedRevs. They are unreviewable and have no flagging UI. Replace ' ' with '_' in titles (e.g. "Main page" -> "Main_page").
 * – Array of string titles. These titles are pages that are exempt from FlaggedRevs. They are unreviewable and have no flagging UI. Replace ' ' with '_' in titles (e.g. "Main page" -> "Main_page").

User interface

 * – When enabled, a simpler, icon based UI is used. Does not affect the tags shown in edit mode.
 * – 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

 * – Makes users in these groups see the current/draft revision by default.
 * – 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.
 * – If  is 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
 * Changes in templates and images 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  and   as   or
 * Changes in templates and images 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  and   as   or

Automatic user promotion

 * – 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:

Advanced
See FlaggedRevs.config.php for a complete list of configuration options (with some explanatory comments). Be sure to change only localsettings.php to set configuration options rather than editing this file.

To have a wiki where non-users can only see the stable version of articles, see /Restricting unapproved revisions.

Use

 * See also: 

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.

A user cannot review a page he cannot edit. They cannot lower the level of a revision from a level they cannot set. Blocked users cannot do anything.



At Special:StableVersions, you can list out all of the reviewed revisions for a certain page or view reviewed revisions.



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.

A list of reviewed pages at the main review levels can be found at Special:ReviewedPages.



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.

Also, a new page, Special:QualityOversight shows only flaggings log entries related to quality revisions. This is useful if the main log is too flooded with page "sightings".

API
FlaggedRevs adds API modules for reviewing revisions and configuring "stabilization" of pages, a module for retrieving flag configuration, and three list modules corresponding to the special pages for reviewed pages, unreviewed pages and "old" reviewed pages.

action = review
Reviews a page.


 * Parameters
 * : The revision ID for which to set the flags
 * : An edit token retrieved through prop=info
 * : Comment for the review (optional)
 * : Set the flag named "accuracy" to the specified value; (replace "accuracy" with the flag name to set another flag)


 * Example

action = stabilize
Changes page stabilization settings.


 * Parameters
 * : Title of page to be stabilized
 * : Reason for stabilization
 * : (Deprecated?) Stabilization expiry. Default: infinite
 * : Whether to auto-review the page
 * : Whether to watch the page
 * : An edit token retrieved through prop=info
 * For protection-like configurations :
 * : The right users must have in order for their edits to not require review.
 * Otherwise :
 * : Default revision to show (latest | stable)
 * : Which stable revision should be shown (pristine | quality | latest). Default: quality
 * : Restriction level for the 'autoreview' right (sysop | none). Default: none


 * Example

action = flagconfig
Shows information about review flag configuration.

The following parameters are returned for each tag:
 * : the name of the flag
 * : the number of possible levels the flag has (not counting the "unreviewed" level)
 * : level the flag must be for the revision to be considered "quality"
 * : level the flag must be for the revision to be considered "pristine"

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

list = reviewedpages
Lists pages that have been reviewed.


 * Parameters
 * : Start listing at this page id.
 * : Stop listing at this page id.
 * : In which direction to list.
 * : The namespaces to enumerate.
 * : How to filter for redirects
 * : How to filter by quality (0=sighted,1=quality)
 * : How many total pages to return.


 * Example

list = unreviewedpages
Lists pages which have never been reviewed.


 * Parameters
 * : Start listing at this page title.
 * : Stop listing at this page title.
 * : The namespaces to enumerate.
 * : How to filter for redirects
 * : How to filter by quality (0=sighted,1=quality)
 * : How many total pages to return.


 * Example

list = oldreviewedpages
Lists pages that have at some point been reviewed, but for which the most recent revision is not reviewed.


 * Parameters
 * : Start listing from this timestamp
 * : Stop listing at this timestamp.
 * : In which direction to list.
 * : The namespaces to enumerate.
 * : How to filter for redirects
 * : How many total pages to return.


 * Example

Limitations

 * Transclusions across wikis are not stabilized
 * External images (aside from Commons) are not stabilized
 * Metatemplates that conditionally include other templates may have the condition change between the time a reviewer loaded a page and when they reviewed it. Therefore, there would be no pointers to the revision id for this different template to load from, making it blue linked. You will be notified if this happens during review.

Uninstalling

 * 1) Remove the include line from
 * 2) Drop the tables in .
 * 3) Drop the columns ,  , and  , and the index   from the   table (if they exist; only older versions of FlaggedRevs used these)
 * 4) Run   from the command line to flush out the stable version links
 * 5) Run   from the command line if you use

Testing platforms

 * 
 * 
 * 

Licensing
© GPL, Aaron Schulz, Joerg Baach, 2007