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 type categories.

Example

MediaWiki extensions manual

Extension Release status: unknown
Implementation
Description	{{{description}}}
Author(s)	Sombebody (unknowntalk)
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

Usage

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 type of extension Can contain any value, but the following special values ensure proper categorisation: category - Category 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 extended syntax - Extensions that add non-standard wiki syntax (i.e. not tags, parser functions, or variables). form - Form hook - Hook extension - defines a new hook - see hook1, etc below if you want to define hooks used by your extension interface - User interface extension (e.g. javascript code) link - Link markup extensions list - List media - Media namespace - Namespace parser - Parser extension (uncategorized) parser function - Parser function pfunc - same as parser function special - Special page table - Table tag - Tag extension variable - defines wiki variables 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 - please see Manual:Hooks and Extension hook registry for a list of valid values. 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). 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. image screenshot (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 description short description 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 Using the infobox Existing extension pages If you want to add the infobox to an existing page, copy and paste the following code and add it to the top: {{Extension |name = |status = |type = |author = |username = |image = |version = |update = |mediawiki = |download = |readme = |changelog = |description = |parameters = |rights = |example = }} 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.