Extension:SelectCategory

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

Release status:Extension status stable

SelectCategory 0.2.png
ImplementationTemplate:Extension#type Page action
DescriptionTemplate:Extension#description Allows the user to select from existing categories when editing a page.
Author(s)Template:Extension#username
Latest versionTemplate:Extension#version 0.9.0 (2017-10-30)
MediaWikiTemplate:Extension#mediawiki 1.23+
PHPTemplate:Extension#php 5.4+
LicenseTemplate:Extension#license GNU General Public License 2.0 or later
Download
README
CHANGELOG
ParametersTemplate:Extension#parameters
  • $wgSelectCategoryNamespaces
  • $wgSelectCategoryRoot
  • $wgSelectCategoryEnableSubpages
Hooks usedTemplate:Extension#hook
EditPage::showEditForm:initialManual:Hooks/EditPage::showEditForm:initial
EditPage::attemptSaveManual:Hooks/EditPage::attemptSave
UploadForm:BeforeProcessingManual:Hooks/UploadForm:BeforeProcessing
OutputPageParserOutputManual:Hooks/OutputPageParserOutput

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

Check usage and version matrix.

IssuesPhabricator

Open tasks · Report a bug

The SelectCategory extension provides three functions:

  • It shows a list of all categories (unless a custom root category is configured) in their hierarchical structure on the edit page.
  • It strips all categories linked within a page upon editing and selects them in the category list list.
  • It adds selected categories from the list to the text body of the page on saving.

Download[edit]

The extension can be retrieved directly from Git [?]:

  • Browse code
  • Some extensions have tags for stable releases.
  • Each branch is associated with a past MediaWiki release. There is also a "master" branch containing the latest alpha version (might require an alpha version of MediaWiki).

Extract the snapshot and place it in the extensions/SelectCategory/ directory of your MediaWiki installation.

If you are familiar with git and have shell access to your server, you can also obtain the extension as follows:

cd extensions/
git clone https://gerrit.wikimedia.org/r/p/mediawiki/extensions/SelectCategory.git

Installation[edit]

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

Configuration[edit]

$wgSelectCategoryNamespaces

Defines in which namespaces the Extension should be active.

All namespaces are already predefined in the array. Set a specific namespace to true to enable or to false to disable the extension.

Active per default are: Media, Main, Project, Image, Help, Category.

$wgSelectCategoryNamespaces[NS_PROJECT] = false;
$wgSelectCategoryNamespaces[NS_CATEGORY] = false;

or

$wgSelectCategoryNamespaces     = array(
        NS_MEDIA                => true,
        NS_MAIN                 => true,
        NS_TALK                 => false,
        NS_USER                 => false,
        NS_USER_TALK            => false,
        NS_PROJECT              => true,
        NS_PROJECT_TALK         => false,
        NS_IMAGE                => true,
        NS_IMAGE_TALK           => false,
        NS_MEDIAWIKI            => false,
        NS_MEDIAWIKI_TALK       => false,
        NS_TEMPLATE             => false,
        NS_TEMPLATE_TALK        => false,
        NS_HELP                 => true,
        NS_HELP_TALK            => false,
        NS_CATEGORY             => true,
        NS_CATEGORY_TALK        => false,
        100                     => true,  // customized namespace, e.g. ''Portal'', c.f. [[Manual:Using custom namespaces]]
        101                     => false  // customized namespace, e.g. ''Portal talk'', c.f. [[Manual:Using custom namespaces]]
);
$wgSelectCategoryRoot

Set a specific root category depending the namespace. Only categories within this root will be displayed when editing a page in a certain namespace.

Useful on big wiki sites to keep the database load down.

If not set (default) the extension searches for all root categories and displays them including all children.

$wgSelectCategoryRoot = array(
       NS_MEDIA                => false,
       NS_MAIN                 => "My Article Root Category",
       NS_TALK                 => false,
       NS_USER                 => false,
       NS_USER_TALK            => false,
       NS_PROJECT              => false,
       NS_PROJECT_TALK         => false,
       NS_IMAGE                => "My Image Root Category",
       NS_IMAGE_TALK           => false,
       NS_MEDIAWIKI            => false,
       NS_MEDIAWIKI_TALK       => false,
       NS_TEMPLATE             => false,
       NS_TEMPLATE_TALK        => false,
       NS_HELP                 => false,
       NS_HELP_TALK            => false,
       NS_CATEGORY             => false,
       NS_CATEGORY_TALK        => false
);
$wgSelectCategoryEnableSubpages

Defines if the extension should be active when editing subpages.

$wgSelectCategoryEnableSubpages = false;

Style[edit]

To customize the design of the select box use the CSS id "SelectCategoryBox" and attach your own settings to [[MediaWiki:Monobook.css]] or your users [[User:USERNAME/Monobook.css]].

Bugs & Feature Requests[edit]

Please file bugs and feature requests in the bug tracker on phabricator.wikimedia.org. You might just use this direct link that has these two settings pre-defined: