Extension:EditSubpages

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
EditSubpages

Release status:Extension status stable

ImplementationTemplate:Extension#type User rights
DescriptionTemplate:Extension#description Allows sysops to unlock pages for anonymous editing
Author(s)Template:Extension#username Ryan Schmidt and Prod
Latest versionTemplate:Extension#version 3.4
MediaWikiTemplate:Extension#mediawiki 1.19+
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license GPL
Download
ParametersTemplate:Extension#parameters

$wgEditSubpagesDefaultFlags

Hooks usedTemplate:Extension#hook
userCanManual:Hooks/userCan

Translate the EditSubpages extension if it is available at translatewiki.net

Check usage and version matrix.

The EditSubpages extension restricts anonymous users from editing most pages. Sysops (or whatever group has the 'editinterface' permission) can add pages to "MediaWiki:Unlockedpages" to allow anonymous editing.

Usage[edit]

Add pages to be unlocked to MediaWiki:Unlockedpages in a bulleted list (they may be links). Any line that isn't part of a bulleted list is treated as a comment. Example:

* Unlocked page 1
# Comment. Note that declaring the namespace matters
* Help:Unlocked page 2
* Talk:Unlocked page 3
 This is a comment too :). Unlike page 1, which has both the
 subject and talk page unlocked, page 3 only has an unlocked
 talk page.
* Unlocked page 4/subpage
# this will only unlock subpages of this subpage, so page 4 itself
# uneditable by anons.

This will allow anonymous users (or any user lacking the 'edit' permission) to edit that page and all subpages of it (e.g. Unlocked page 1, Unlocked page 1/Subpage, etc.), as well as their respective talk pages. If you declare a talk page, it will not make the respective subject page editable. To prevent talk pages from being edited but allow the subject pages to be, simply protect the talk page.

This will also allow the anonymous users to create new pages that are sub-pages of the unlocked page.

Extended Syntax[edit]

The extended syntax (also known as flags), allows you to control exactly how each unlocked page works. The way of utilizing this is as follows:

* Unlocked page|flags|alternate text (optional, useful if you are using links)
# ex:
* [[Somepage/sub/subpage|+b-t|unlocks base pages but does not unlock talk pages]]
* HELLO|+in-c
# The above unlocks HELLO, Hello, Help:Hello, User:HEllO, etc., but does not allow creation of new pages
List of flags (* = enabled by default)
Flag Description Flag Description
+s* Unlocks subpages of the page -s Does not unlock subpages of the page
+b Unlocks basepages of the page -b* Does not unlock basepages of the page
+u Apply these restrictions to both users and anons -u* Only apply these restrictions to anons
+c* Allow creation of new pages -c Do not allow creation of new pages
+t* Unlock the talk page as well -t Do not unlock the talk page as well
+e* Allow editing of unlocked pages -e do not allow editing of unlocked pages
+i Case insensitive -i* case sensitive
+n Namespace inspecific -n* Namespace specific
+r Treated as a regex fragment -r* Treated as a string
+w Allow wildcards * and ? -w* Does not allow wildcards
+w does not work with +r set.
* means "0 or more characters", ? means "0 or 1 characters"
Character classes are denoted with square brackets, such as [ae] to match a or e
Negate a character class with !, e.g. [!ae] to match everything except a or e
Literal *, ?, [, and ] must be escaped with \ (like \* and \?. \\ produces a literal backslash)

Caveats[edit]

  • This extension goes down the list in order and stops when it reaches the first match. As such, it is impossible to have multiple conditions for a single page/group of pages.
  • The +r flag has an implicit ^ and $ before and after the fragment, respectively. This means if you want it only to match part of a title, you will need to use ".*title.*" and not just "title." (Former parses to /^.*title.*$/, latter to /^title$/)
  • The extension's require_once either needs to be after you configure $wgGroupPermissions on your LocalSettings.php file, or you need to make sure that '*' is allowed to 'edit', 'createpage', and 'createtalk', or the extension will not work as expected.
  • The +u flag applies to all logged-in users, no matter what groups they are in (aka sysops are not exempt). As such, it is possible to lock yourself out of the list of unlocked pages until you disable the extension.

Installation[edit]

  • Download and place the file(s) in a directory called EditSubpages in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/EditSubpages/EditSubpages.php";
    
  • Configure at your convenience
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration[edit]

As of version 3.1, it is possible to modify what the default flags are via $wgEditSubpagesDefaultFlags. This can either be a string in the format +blah-blah, like MediaWiki:Unlockedpages, or in an array format where flags are the keys and the value is true if it should be set by default, and false if it should be unset by default.

Changelog[edit]

Version 3.4
Fix fatal error in certain page/flag combinations. Expand functionality of the wildcard flag (+w) to include character classes and negated character classes.
Version 3.3
Move to new JSON i18n format. Now requires PHP 5.3+.
Version 3.2
Fix EditSubpages so that it actually successfully unlocks pages.
Version 3.1
Made flags parsing more flexible, so you can have stuff like "-blah" or "+a+s+d+f", fixed error when trying to view special pages on certain versions of MediaWiki. Added $wgEditSubpagesDefaultFlags variable.
Version 3.0
Added flags feature for finer control over the behavior of unlocked pages.
Version 2.2
Fixed bug that did not allow anonymous users to save unlocked pages.
Version 2.1
Fixed author field in the extension credits.
Version 2.0
Switched to using userCan hook. Fixed namespace issue. Fixed incompatibility with Extension:ConfirmAccount. Now works for versions of MediaWiki 1.6.0+. This will probably be the final release of this extension unless more major bugs are discovered.
Version 1.2.2
Fixed major bug that did not unlock Talk pages when they were explicitly declared. If you have any earlier version, please upgrade to this version for correct functionality!
Version 1.2.1
Fixed major bug that prevented any pages from being unlocked. If you have version 1.2, upgrade to this version!
Version 1.2
Used strpos instead of regex for faster processing and less memory usage. Bugfixes. Moved into Subversion
Version 1.1
Added ability to use comments and talk pages are now unlocked as well.
Version 1.0
Initial creation