Template:Extension

{{Documentation|content= {{intricate template}}

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 {{ll|Category:All extensions}}, along with the appropriate {{ll|Category:Extensions by status|status}} and {{ll|Category:Extensions by implementation type|implementation type}} categories.

Content parameters
This section describes parameters that govern infobox content.

For help with templatemode and other control parameters, please see 2>#Control parameters|Control parameters. 
 *  - custom, e.g.  
 *  -, e.g. <tvar|xmp4> </>
 * <tvar|variable></> - custom, e.g. <tvar|xmp5> </>
 * <tvar|xtdsyntax></> - Extensions that add non-standard wiki syntax (i.e. not, , or ).


 * <tvar|access></> - catchall for, 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:
 * <tvar|useractivity></> - extensions that monitor user activity (logins, logouts, new user creation, etc.)
 * <tvar|useridentity></> - extensions that create and delete users, and/or verify the identity of a user
 * <tvar|userrights></> - 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 skip>#rights</>|rights parameter)


 * <tvar|interface></> - catchall for uncategorized user interface extensions.
 * <tvar|media></> - extensions that permit the embedding of multimedia content on wiki pages by registering a file extension with <tvar|wgMediaHandlers></>.
 * <tvar|mywiki></> - extensions that provide infrastructure so that users may personalize their MediaWiki experience and/or assist in the management of that infrastructure
 * <tvar|notify></> - extensions that email users, broadcast messages and provide other forms of community notification
 * <tvar|catpageaction></> - extensions that enhance or modify <tvar|pageaction></>s. 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 <tvar|userrights>user rights</>) or logs (use <tvar|useractivity>user activity</>).
 * <tvar|search></> - extensions that search through and select articles for users.
 * <tvar|skin></> - extensions adding CSS or JavaScript, or implementing hook functions to change the look and feel of MediaWiki via the skins framework.
 * <tvar|catajax></> - extensions that use Ajax programming techniques.
 * <tvar|special></> - extensions that subclass the <tvar|specialpage></> class, use one of its hooks, or patch one or more functions in <tvar|filephp></>. See <tvar|manual></> for more information.


 * other
 * <tvar|api></> - extensions that add a new API module or extend a core API module.
 * <tvar|hook></> - Hook extension - defines a new hook - see hook1, etc. below if you want to define hooks used by your extension
 * <tvar|database></> - adds tables and/or fields to the database backing a MediaWiki installation
 * <tvar|dataextraction></> - Data extraction
 * <tvar|filerepo></> - extension that adds new file repository types as file backend
 * <tvar|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 <tvar|typemissingcat>Category:Extensions with invalid or missing type</>.

Note: Many extensions have more than one type, if this applies to yours, replace <tvar|type> </> with <tvar|value> </>. You may define up to six types for an extension. hook1 hook2 hook3 hook4 ... hook90  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 <tvar|manual></> for values (but omit introductory '/').

For custom hooks defined by extensions:
 * use <tvar|form>extensionName/hookName</>. For a partial list of custom hooks, see <tvar|exthooks>Extension hook registry</>.

For multiple hooks, assign the first hook to hook1, the second to hook2 and so on. newhook1 newhook2 newhook3 newhook4 ... newhook90 name of each hook provided by the extension

You might also want to add the hooks to <tvar|exthooks>Extension hook registry</>. 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 <tvar|1> </>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 <tvar|1> </>s. imagesize  facultative, size of the image (default size is 220px) version  last version update  date of the last update <span id="compatibility_policy">compatibility policy   (accepted values are <tvar|2>master</> and <tvar|3>rel</>). mediawiki  required version of MediaWiki php  required version of PHP needs-updatephp <tvar|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. <tvar|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 <tvar|target> </> and inserted <tvar|code> </> into "LocalSettings.php", run from the command line:

cd path/to/wiki_install_directory cd maintenance php update.php

composer  If applicable the name of the "vendor" as well as the "package" should be entered in the format <tvar|format> </>, e.g. <tvar|xmp> </> 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, "<tvar|table1>table1 = cu_changes</>" at <tvar|url1></> will link to <tvar|url2></>. Don't list core tables such as <tvar|page></> or <tvar|revision></>; only list tables that are added by extensions. license  license governing use of this extension, as one of the codes found in <tvar|url>https://spdx.org/licenses/</>, e.g. <tvar|later2> </>, <tvar|only2> </> or <tvar|later3> </>, etc. download  link to the download : <tvar|url>Git</>, <tvar|wikimediadownload>WikimediaDownload</> with <tvar|server>server=svn</> in case it was not migrated from <tvar|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. <tvar|code> </> (it must remain valid when bot-copied elsewhere) readme  external link to the <tvar|readme>readme</> file, e.g. <tvar|url>https://phabricator.wikimedia.org/r/browse/mediawiki/extensions/Flow;master;README</> changelog  external link to the changelog file, e.g. <tvar|url>Extension:LDAP Authentication/Changelog</> parameters  available parameters for LocalSettings.php tags  any tags your extension uses (e.g. <tvar|tags>&lt;tag1&gt;, &lt;tag2&gt;</>). rights   rights added by the extension. Not to be confused with the license! Rights are such as <tvar|makebot>'</> or <tvar|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 <tvar|testext>Template:Extension Testing</>). It's encouraged to add any client-side compatibility information here too, especially when diverging from. translate Optional parameter to link the exact page where ( with which) the extension will be translatable on <tvar|translatewiki>translatewiki.net</> if enabled. If the default link is incorrect, manually set it to: bugzilla  Bugzilla MediaWiki extension component name phabricator  Phabricator project name CheckUsageNameOverride  override the page name used for the check usage link.
 * <tvar|lowercase>ext-LOWERCASE</>(<tvar|nospaces>NOSPACES</>(Label as defined in <tvar|file></>)), aka
 * the parameter you get in the URL after
 * typing the name of the extension in the search/filter box at <tvar|tranlwikispectransl>translatewiki:Special:Translate</> or
 * searching for its name in <tvar|transwikilangstat>languagestats</> after clicking "expand all".

Control parameters
</> because this isn't an actual extension page and we don't want to add this page to any categories on account of it.
 * <tvar|nousage>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 '<tvar|templatemode>templatemode=nocats</>'

If this is left blank, this template will add the host page to <tvar|allextcat>Category:All extensions</> and to one or more additional categories, depending on the values assigned to the anchor>#Content parameters</>|Content parameters.

Existing extension pages
If you want to add the infobox to an existing page, copy and paste the code at the 1>#CutAndPaste</>|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.

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:

The Create extension button
To improve the create extension button behavior:


 * <tvar|extsample></>: The boilerplate extension that is preloaded into newly-created pages.
 * <tvar|extinpbox></>: An input box that can be inserted wherever you want users to easily create extensions. For documentation on the <tvar|tagvalue> </> tag, please see <tvar|url></>.

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 and link its label to that documentation.

To change/correct/add to the implementation type parameters:
 * Check the url>Template_talk:Extension</>|talk page - there have been some extensive discussions about this field.
 * <tvar|typeswitch></>: Stores the possible values for the type field. Multiple values are implemented by calling this template with <tvar|foreach>Template:Foreach</>.
 * <tvar|typeswitchnocats></>: Does not need to be modified when adding a new type. Used instead of <tvar|typeswitch></> when this template is used in <tvar|nocats> </>. Templates used with <tvar|foreach>Template:Foreach</> can only take one parameter so we need to wrap the call to <tvar|tpeswitch></> with another template that sets the mode.

To change the behavior of the hook parameters:


 * <tvar|hookinuse>Template:Extension/HookInUse</>: Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with <tvar|foreach>Template:Foreach</>.
 * <tvar|hookinusenocats>Template:Extension/HookInUseNoCats</>: Used instead of <tvar|hookinuse>Template:Extension/HookInUse</> when this template is used in <tvar|nocats> </>. Templates used with <tvar|feach>Template:Foreach</> can only take one parameter so we need to wrap the call to <tvar|hookuse>Template:Extension/HookInUse</> with another template that sets the mode.

Test case
See if the following pages are still ok, after edited this template.
 * Extension:Description2
 * Template:Extension

}} Maintenance: vulnerabilities, archived