Template:Extension/doc

Purpose

This template should be added to the main page of all extensions documented on this wiki (and only the main page). It will add a useful infobox using the information supplied (see below) and will automatically add the extension to Category:All extensions, plus the appropriate status and implementation type categories.

Usage

Cut and paste: {{Extension|templatemode = |name = |status = |type1 = |type2 = |hook1 = |hook2 = |username = |author = |description = |image = |version = |update = |mediawiki = |license = |download = |readme = |changelog = |parameters = |rights = |example = }} For help with parameter values, see below.

MediaWiki extensions manual {{{name}}} Release status: unknown Implementation Description {{{description}}} Author(s) SomeAuthor (SomeUsertalk) Latest version  ({{{update}}}) MediaWiki Database changes License Download {{{download}}} {{{readme}}} {{{changelog}}} Example {{{example}}} Parameters {{{parameters}}} Added rights {{{rights}}} Translate the Extension/doc extension if it is available at translatewiki.net

Content parameters

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

Content parameters 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) 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 categorised 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: link - customized link markup, e.g. [[...]] parser function - custom parameterized template markup, e.g. {{#name: ... }} tag - custom XML tag markup, e.g. <tagname>...</tagname> variable - custom unparameterized template markup, e.g. {{NAME}} extended syntax - Extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables). access - catchall for Template:SeeManual, 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, apis, 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 Template:SeeManual. 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 Template:SeeManuals. 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. special - extensions that subclass the Template:SeeManual, use one of its hooks, or patch one or more functions in Template:SeeSourceCode. See Manual:Special pages for more information. hook - Hook extension - defines a new hook - see hook1, etc below if you want to define hooks used by your extension pfunc - same as parser function We are in the process of revising the values of this page. Types below this point are likely to be deprecated or redefined. We apologize for the inconvenience. See Template_talk:Extension#Type taxonomy for more information. database - adds tables and/or fields to the database backing a MediaWiki installation db - same as database data extraction - Data extraction 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 hook5 hook6 hook7 hook8 hook9 hook10 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: use extensionName/hookName. For a partial list of custom hooks, see Extension hook registry. 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. 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 (of base 270px) version last version update date of the last update mediawiki required version of MediaWiki license license(s) governing use of this extension, e.g. GPL download link to the download : SVN or other readme link to the readme file : README or other changelog link to the changelog file : CHANGELOG or other parameters available parameters for LocalSettings.php 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! example example, website or screenshot of working extension Control parameters Control parameters templatemode Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats - suppresses categorization. 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. 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 Template:SeeSection. 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. <translate> A developer sharing their code in the MediaWiki code repository should expect:</translate> <translate> Feedback / Criticism / Code reviews</translate> <translate> Review and comments by other developers on things like [<tvar 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: Template:Extension/Sample: The boiler plate extension that is preloaded into newly created pages. Template:Extension/CreateExtensionInputBox: An input box that can be inserted wherever you want users to easily create extensions. For documentation on the <inputbox> tag, please see Extension:Inputbox. Extension:MyExtension: - defines a placeholder in case a user accidentally hits the create button without changing the extension name. 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: Check the talk page - there have been some extensive discussions about this field. Template:Extension/TypeSwitch: Stores the possible values for the type field. Multiple values are implemented by calling this template with Template:Foreach. Template:Extension/TypeSwitchNoCats: Used instead of Template:Extension/TypeSwitch when this template is used in templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/TypeSwitch with another template that sets the mode. Template:Extension/Doc: Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy. To change the behavior of the hook parameters: Template:Extension/HookInUse: Adds links and categories for a hook in use. Multiple hooks in use are implemented by calling this template with Template:Foreach. Template:Extension/HookInUseNoCats: Used instead of Template:Extension/HookInUse when this template is used in templatemode=nocats. Templates used with Template:Foreach can only take one parameter so we need to wrap the call to Template:Extension/HookInUse with another template that sets the mode.