Phabricator project: [[phab:tag/{{{phabricator}}}/|#{{{phabricator}}}]]

Template:Extension

From MediaWiki.org
Jump to: navigation, search
Documentation icon Template documentation[view] [edit] [history] [purge]

This template should be added to all extension pages on this wiki (but only the main page). It will add a useful infobox (see below) and will automatically add the extension to Category:All extensions, along with the appropriate status and implementation type categories.

Usage

Copy and paste:

{{ {{TNTN|Extension}} |templatemode =
|name            = 
|status          = 
|type1           = 
|type2           = 
|hook1           = 
|hook2           = 
|username        = 
|author          = 
|description     = 
|image           = 
|imagesize       = 
|version         = 
|update          = 
|version preview = 
|update preview  = 
|mediawiki       = 
|php             = 
|needs-updatephp = 
|composer        =
|table1          = 
|table2          = 
|license         = 
|download        = 
|readme          = 
|changelog       = 
|example         = 
|namespace       = 
|parameters      = 
|tags            = 
|rights          = 
|compatibility   = 
|bugzilla        = 
|phabricator =
|vagrant-role    = 
}}

For help with parameter values, see below.

MediaWiki extensions manual
Crystal Clear action run.png
{{{name}}}

Release status: unknown

Placeholder.png
Implementation {{{type1}}}, {{{type2}}}
Description {{{description}}}
Author(s) SomeAuthor (SomeUsertalk)
Latest version {{{version}}} ({{{update}}})
Latest preview version {{{version preview}}} ({{{update preview}}})
MediaWiki {{{mediawiki}}}
PHP {{{php}}}
Database changes {{{needs-updatephp}}}
Composer {{{composer}}}
Tables [[Template:Extension/{{{table1}}} table|{{{table1}}}]]
[[Template:Extension/{{{table2}}} table|{{{table2}}}]]
License {{{license}}}
Download {{{download}}}
{{{readme}}}
{{{changelog}}}
Example {{{example}}}
Namespace {{{namespace}}}
Parameters

{{{parameters}}}

Tags
{{{tags}}}
Added rights

{{{rights}}}

Hooks used
hook1

hook2

{{{compatibility}}}

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

Vagrant role
{{{vagrant-role}}}

Issues:

[[phab:tag/{{{phabricator}}}|Open tasks]] · Report a bug


Content parameters

This section describes parameters that govern infobox content. For help with templatemode and other control parameters, please see Control parameters.

Content parameters
Parameter Description
name name of the extension
status current release status

One of:

  • unstable (broken - do not use this extension)
  • experimental (early stages of development, may change drastically)
  • beta (stable but not fully tested)
  • stable (stable version)
  • unmaintained (unmaintained - previously claimed to be stable, now unmaintained)
  • unknown (default)

If the status is anything other than the above, it will be ignored and the default value of 'Unknown' will be displayed in the template instead. In cases where the value is omitted, it will be categorized as unknown. In cases where the value is invalid, it will be placed in a special category so that the error can be caught and fixed.

type1
type2
type3
type4
type5
type6
implementation type

The implementation strategy(s) employed in building this extension. This parameter is used to create categories that help programmers find examples of various MediaWiki specific implementation strategies or patterns. Although the values of this parameter sometimes coincide with the use case or purpose of an extension, that is not reason for this parameter. If the values you have chosen for this parameter do not adequately identify the purpose or possible use cases, we recommend you add additional category links as needed.


Legal values for the type1, type2, ... parameters are:

  • parser - catchall for uncategorized parser extensions. If you have written a parser extension, please use one of the following more specific types:
  • access - catchall for user access extensions, that is, extensions that create, authenticate, grant permissions, revoke permissions, or monitor the activity of users. If you have written an access extension, please use one of the following more specific types:
    • user activity - extensions that monitor user activity (logins, logouts, new user creation, etc.)
    • user identity - extensions that create and delete users, and/or verify the identity of a user
    • user rights - extensions to the rights management system, e.g. changes to the way rights are assigned, API, maintenance tools (does not include extensions that merely name the rights needed to use the features of that extension; for this purpose use the rights parameter)
  • interface - catchall for uncategorized user interface extensions.
    • media - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with $wgMediaHandlers.
    • mywiki - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
    • notify - extensions that email users, broadcast messages and provide other forms of community notification
    • page action - extensions that enhance or modify page actions. This includes anything that implements an action that reads, writes, searches for, creates, renames, deletes, redirects or discusses a page. It does not include rights (use user rights) or logs (use user activity).
    • search - extensions that search through and select articles for users.
    • skin - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
    • ajax - extensions that use Ajax programming techniques.
    • special - extensions that subclass the SpecialPage class, use one of its hooks, or patch one or more functions in SpecialPage.php. See Special:MyLanguage/Manual:Special pages for more information.
  • other
    • api - extensions that add a new API module or extend a core API module.
    • hook - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension
    • database - adds tables and/or fields to the database backing a MediaWiki installation
    • data extraction - Data extraction
    • filerepo - extension that adds new file repository types as file backend
    • example - Not a real extension, but an example of how to write one

Any other value for 'type' is invalid, and will cause the extension to be placed in Category:Extensions with invalid or missing type.

Note: Many extensions have more than one type, if this applies to yours, replace |type= with |type1=|type2=|type3=.... You may define up to six types for an extension.

hook1
hook2
hook3
hook4
...
hook30
name of each hook used by the extension

Entering values in this field is a good way to get exposure for your extension and help other developers. Each documented hook will automatically add the extension to a category listing extensions that use that hook. This category is autolinked to each hook article so that programmers can easily find examples of extensions that use a particular hook.

For built-in hooks:

  • use the hook name alone. Please see Manual:Hooks for values (but omit introductory '/').

For custom hooks defined by extensions:

For multiple hooks, assign the first hook to hook1, the second to hook2 and so on.

username The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s.
author The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present).
description short description
image screenshot or logo of extension. It should be provided without namespace and without [[]]s.
imagesize facultative, size of the image (default size is 220px)
version last version
update date of the last update
mediawiki required version of MediaWiki
php required version of PHP
needs-updatephp Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty

Extensions which conform to MediaWiki extension standards come with a schema change script which you need to start manually (once) before starting and accessing the MediaWiki through your browser, and after you copied all the extension files to $IP/extensions/ExtensionName and inserted require_once "$IP/extensions/ExtensionName"; to "LocalSettings.php":

php $IP/maintenance/update.php
$IP stands for the Installation Path (or "directory") of your MediaWiki installation, the same directory that holds LocalSettings.php, index.php etc..
composer If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive.
table1
table2
table3
table4
...
table30
name of each non-core table used by the extension

Links to a subpage of your extension page. For instance, "table1 = cu_changes" at Extension:CheckUser will link to Extension:CheckUser/cu_changes table. Don't list core tables such as page or revision; only list tables that are added by extensions.

license license(s) governing use of this extension, e.g. GPL

Possible values are (case-insensitive):

  • GPL family: "gpl", "gplv2", "gplv2 or later", "gpl v2", "gpl v2 or later", "gplv2+", "gplv3+", "gplv3", "gpl v3", "gpl v3 or later", "GPL 2.0", "gpl v2+", "gpl v3+"
  • LGPL family: "lgpl", "lgplv2", "lgplv3"
  • AGPL family: "agpl", "agplv2", "agplv3"
  • MIT family: "mit", "expat", "expat (mit)", "x11", "The MIT License", "Mit License"
  • BSD family: "bsd", "new bsd", "revised bsd", "modified bsd", "freebsd"
  • MPL family: "mpl", "mplv2", "mpl v2"
  • WTFPL family: "wtfpl", "wtfpl 2", "wtfpl 2.0"
  • Apache family: "apache", "apache license"
  • Public domain: "public domain", "none (public domain)", "none", "pd"
download link to the download : Git, {{WikimediaDownload}} with server=svn in case it was not migrated from SVN. If you put the code into page in the MediaWiki wiki, link to it using a full page name and section name, e.g. [[Extension:Example/version_1.22a#Code]] (it must remain valid when bot-copied elsewhere)
readme external link to the readme file, e.g. http://svn.wikimedia.org/svnroot/mediawiki/trunk/extensions/Sort/README
changelog external link to the changelog file, e.g. Extension:LDAP Authentication/Changelog
parameters available parameters for LocalSettings.php
tags any tags your extension uses (e.g. <tag1>, <tag2>).
rights rights added by the extension. Not to be confused with the license! Rights are such as makebot or desysop, not such as GFDL or LGPL or GPL - those are licenses!
namespace namespace in which this extension is used
example example, website or screenshot of working extension
compatibility Additional compatibility information, for instance compatibility charts (formerly using Template:Extension Testing). It's encouraged to add any client-side compatibility information here too, especially when diverging from expectations of full support for a browser.
translate Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. If the default link is incorrect, manually set it to:
  • ext-LOWERCASE(NOSPACES(Label as defined in config)), aka
  • the parameter you get in the URL after
bugzilla Bugzilla MediaWiki extension component name
phabricator Phabricator project name
CheckUsageNameOverride override the page name used for the check usage link.

Control parameters

Control parameters
Parameter Description
templatemode Controls auto-categorization of host page.

Normally left blank. Alternate values are:

  • nocats - suppresses categorization and the 'check usage' link. Use this value if you are adding this template to subpages of an extension or to how-to documentation of extensions. For example, the usage image above sets templatemode=nocats because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
  • nousage - suppresses the 'check usage' link. Link is also suppressed if the page is a subpage; it is not in the Extension: namespace; or if suppressed by 'templatemode=nocats'


If this is left blank, this template will add the host page to Category:All extensions and to one or more additional categories, depending on the values assigned to the Content parameters.

Using the infobox

Existing extension pages

If you want to add the infobox to an existing page, copy and paste the code at the top of this page.

Create a new extension article

If you want to create a new extension page, enter the name below and click the button. A new page will be created with the infobox template already in place.




MediaWiki is an open-source project and users are encouraged to make any MediaWiki extensions under an Open Source Initiative (OSI) approved GPLv2 compatible license (including MIT, BSD, PD). For extensions that have a compatible license, you can request developer access to the MediaWiki source repositories for extensions and get a new repository created for you. Alternatively, you may also post your code directly on your extension's page, although that is not the preferred method.

A developer sharing their code on the MediaWiki wiki or code repository should expect:

Feedback / Criticism / Code reviews
Review and comments by other developers on things like framework use, security, efficiency and usability.
Developer tweaking
Other developers modifying your submission to improve or clean-up your code to meet new framework classes and methods, coding conventions and translations.
Improved access for wiki sysadmins
If you do decide to put your code on the wiki, another developer may decide to move it to the MediaWiki code repository for easier maintenance. You may then request commit access to continue maintaining it.
Future versions by other developers
New branches of your code being created by other developers as new versions of MediaWiki are released.
Merger of your code into other extensions with duplicate or similar purposes — incorporating the best features from each extension.
Credit
Credit for your work being preserved in future versions — including any merged extensions.
Similarly, you should credit the developers of any extensions whose code you borrow from — especially when performing a merger.

Any developer who is uncomfortable with any of these actions occurring should not host their code directly on the MediaWiki wiki or code repository. You are still encouraged to create a summary page for your extension on the wiki to let people know about the extension, and where to download it. You may also add the {{Extension exception}} template to your extension requesting other developers refrain from modifying your code, although no guarantees can be made that an update will be made if deemed important for security or compatibility reasons. You may use the current issues noticeboard if you feel another developer has violated the spirit of these expectations in editing your extension.


Enhancing this template

If you would like to improve on this template, thanks! This is a complicated template so here is some help along the way:

Fixing documentation

If you would like to fix documentation, please be aware that documentation and code is split into two files:

  • Template:Extension/doc - stores all documentation.
  • Template:Extension - stores only the code for the template and a small amount of non-included material (category links, transcluded documentation link).


In addition, Template:Extension/Sample stores the boiler plate that is preloaded into newly created pages and contains some basic documentation on how to fill in the template parameters. It needs to be kept in sync with Template:Extension/doc.

The Create extension button

To improve the create extension button behavior:

Infobox parameters

In general:

  • To make this template easy to use, each label in the infobox is linked to documentation on the template parameter(s) it displays. If you add a parameter, please be sure to also add it to the content parameter documentation and link its label to that documentation.


To change/correct/add to the implementation type parameters:


To change the behavior of the hook parameters:

Test case

See if the following pages are still ok, after edited this template.

TemplateData

An infobox for a MediaWiki extension.

Template parameters
Parameter Description Type Default Auto value Status
Status status Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown. string unknown empty optional
Name name name of the extension string empty empty optional
License license Extension's license. string empty empty optional
Mode templatemode Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage. unknown empty empty optional
Screenshot or logo image Screenshot or logo of extension. It should be provided without namespace and without [[]]s. unknown empty empty optional
Imagesize imagesize Facultative, size of the image (default size is 220px) unknown empty empty optional
Primary type type Implementation type. See detailed doc. unknown empty empty optional
Secondary type type1 Implementation type. See detailed doc. unknown empty empty optional
Tertiary type type2 Implementation type. See detailed doc. unknown empty empty optional
Quaternary type type3 Implementation type. See detailed doc. unknown empty empty optional
Quaternary type type4 Implementation type. See detailed doc. unknown empty empty optional
Quinary type type5 Implementation type. See detailed doc. unknown empty empty optional
Senary type type6 Implementation type. See detailed doc. unknown empty empty optional
Description description Short description. unknown empty empty optional
Author author The extension author's name, if different from their MediaWiki.org username. Free text. If omitted then the 'username' field will be used (if present). unknown empty empty optional
Username username The author's username on MediaWiki.org (if they have one). May be omitted, but if present it will be used to link to the author's user & user_talk page. It should be provided without namespace and without [[]]s. unknown empty empty optional
Version versionlatest release versionlatest_release_version no description unknown empty empty optional
Update update date of the last update unknown empty empty optional
Version preview version preview version preview unknown empty empty optional
Update preview update preview version preview unknown empty empty optional
Mediawiki mediawiki Required version of MediaWiki unknown empty empty optional
Php php Required version of PHP unknown empty empty optional
Needs-updatephp needs-updatephp Yes indicates that the extension requires a database table schema change or a similar action, before the MediaWiki can run. It is a common pitfall: your MediaWiki will stall, if you forgot to run update.php - if the extension requires it. No should be set as a value since this assures that the extension does not need update.php to be run and thus avoids uncertainty. unknown empty empty optional
Composer composer If applicable the name of the "vendor" as well as the "package" should be entered in the format vendor/package, e.g. mediawiki/semantic-media-wiki to point people directly to packagist.org, which serves as the package archive. unknown empty empty optional
Table1 table1 Name of a non-core table used by the extension. unknown empty empty optional
Table2 table2 Name of a non-core table used by the extension. unknown empty empty optional
Table3 table3 Name of a non-core table used by the extension. unknown empty empty optional
Table4 table4 Name of a non-core table used by the extension. unknown empty empty optional
Table5 table5 Name of a non-core table used by the extension. unknown empty empty optional
Table6 table6 Name of a non-core table used by the extension. unknown empty empty optional
Table7 table7 Name of a non-core table used by the extension. unknown empty empty optional
Table8 table8 Name of a non-core table used by the extension. unknown empty empty optional
Table9 table9 Name of a non-core table used by the extension. unknown empty empty optional
Table10 table10 Name of a non-core table used by the extension. unknown empty empty optional
Download download Link to the download. unknown empty empty optional
Readme readme external link to the readme file unknown empty empty optional
Changelog changelog external link to the changelog file unknown empty empty optional
Example example example, website or screenshot of working extension unknown empty empty optional
Namespace namespace namespace in which this extension is used unknown empty empty optional
Parameters parameters available parameters for LocalSettings.php unknown empty empty optional
Tags tags any tags your extension uses unknown empty empty optional
Rights rights Rights added by the extension. Not to be confused with the license! unknown empty empty optional
Hook1 hook1 Name of a hook used by the extension. unknown empty empty optional
Hook2 hook2 Name of a hook used by the extension. unknown empty empty optional
Hook3 hook3 Name of a hook used by the extension. unknown empty empty optional
Hook4 hook4 Name of a hook used by the extension. unknown empty empty optional
Hook5 hook5 Name of a hook used by the extension. unknown empty empty optional
Hook6 hook6 Name of a hook used by the extension. unknown empty empty optional
Hook7 hook7 Name of a hook used by the extension. unknown empty empty optional
Hook8 hook8 Name of a hook used by the extension. unknown empty empty optional
Hook9 hook9 Name of a hook used by the extension. unknown empty empty optional
Hook10 hook10 Name of a hook used by the extension. unknown empty empty optional
Hook11 hook11 Name of a hook used by the extension. unknown empty empty optional
Hook12 hook12 Name of a hook used by the extension. unknown empty empty optional
Hook13 hook13 Name of a hook used by the extension. unknown empty empty optional
Hook14 hook14 Name of a hook used by the extension. unknown empty empty optional
Hook15 hook15 Name of a hook used by the extension. unknown empty empty optional
Hook16 hook16 Name of a hook used by the extension. unknown empty empty optional
Hook17 hook17 Name of a hook used by the extension. unknown empty empty optional
Hook18 hook18 Name of a hook used by the extension. unknown empty empty optional
Hook19 hook19 Name of a hook used by the extension. unknown empty empty optional
Hook20 hook20 Name of a hook used by the extension. unknown empty empty optional
Hook21 hook21 Name of a hook used by the extension. unknown empty empty optional
Hook22 hook22 Name of a hook used by the extension. unknown empty empty optional
Hook23 hook23 Name of a hook used by the extension. unknown empty empty optional
Hook24 hook24 Name of a hook used by the extension. unknown empty empty optional
Hook25 hook25 Name of a hook used by the extension. unknown empty empty optional
Hook26 hook26 Name of a hook used by the extension. unknown empty empty optional
Hook27 hook27 Name of a hook used by the extension. unknown empty empty optional
Hook28 hook28 Name of a hook used by the extension. unknown empty empty optional
Hook29 hook29 Name of a hook used by the extension. unknown empty empty optional
Hook30 hook30 Name of a hook used by the extension. unknown empty empty optional
Hook31 hook31 Name of a hook used by the extension. unknown empty empty optional
Hook32 hook32 Name of a hook used by the extension. unknown empty empty optional
Hook33 hook33 Name of a hook used by the extension. unknown empty empty optional
Hook34 hook34 Name of a hook used by the extension. unknown empty empty optional
Hook35 hook35 Name of a hook used by the extension. unknown empty empty optional
Hook36 hook36 Name of a hook used by the extension. unknown empty empty optional
Hook37 hook37 Name of a hook used by the extension. unknown empty empty optional
Hook38 hook38 Name of a hook used by the extension. unknown empty empty optional
Hook39 hook39 Name of a hook used by the extension. unknown empty empty optional
Hook40 hook40 Name of a hook used by the extension. unknown empty empty optional
Hook41 hook41 Name of a hook used by the extension. unknown empty empty optional
Hook42 hook42 Name of a hook used by the extension. unknown empty empty optional
Hook43 hook43 Name of a hook used by the extension. unknown empty empty optional
Hook44 hook44 Name of a hook used by the extension. unknown empty empty optional
Hook45 hook45 Name of a hook used by the extension. unknown empty empty optional
Hook46 hook46 Name of a hook used by the extension. unknown empty empty optional
Hook47 hook47 Name of a hook used by the extension. unknown empty empty optional
Hook48 hook48 Name of a hook used by the extension. unknown empty empty optional
Compatibility compatibility Compatibility chart, e.g. Template:Extension Testing. unknown empty empty optional
Translate translate Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled. unknown empty empty optional
Bugzilla bugzilla Bugzilla MediaWiki extension component name unknown empty empty optional
Vagrant role vagrant-role A MediaWiki-Vagrant role that lets you use this extension, if present string empty empty optional
Language: English  • Deutsch • Ελληνικά • español • français • Հայերեն • italiano • 日本語 • 한국어 • मराठी • Nederlands • polski • português • português do Brasil • русский • українська • Tiếng Việt • 中文 • 中文(简体)‎ • 中文(繁體)‎