Template:Extension/doc

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


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

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.

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 boilerplate 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   tag, please see Extension:InputBox.

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: Does not need to be modified when adding a new type. Used instead of Template:Extension/TypeSwitch when this template is used in  .  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 .  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.

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

TemplateData
{	"description": "An infobox for a MediaWiki extension.", "params": { "status": { "description": "Current release status. One of: unstable, experimental, beta, stable, unmaintained, unknown.", "default": "unknown", "label": "Status", "type": "string" },		"name": { "description": "name of the extension", "label": "Name", "type": "string" },		"license": { "description": "Extension's license.", "label": "License", "type": "string" },		"templatemode": { "description": "Controls auto-categorization of host page. Normally left blank. Alternate values are: nocats, nousage.", "label": "Template Mode", "deprecated": true },		"image": { "description": "Screenshot or logo of extension. It should be provided without namespace and without s.", "label": "Screenshot or logo" },		"imagesize": { "description": "Size of the image in pixels", "type": "number", "default": "350" },		"type": { "description": "Implementation type. See detailed doc.", "label": "Primary type" },		"type1": { "description": "Implementation type. See detailed doc.", "label": "Secondary type" },		"type2": { "description": "Implementation type. See detailed doc.", "label": "Tertiary type" },		"type3": { "description": "Implementation type. See detailed doc.", "label": "Quaternary type" },		"type4": { "description": "Implementation type. See detailed doc.", "label": "Quinary type" },		"type5": { "description": "Implementation type. See detailed doc.", "label": "Senary type" },		"type6": { "description": "Implementation type. See detailed doc.", "label": "Senary type" },		"description": { "description": "Short description." },		"author": { "description": "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": { "description": "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." },		"maintainer": { "description": "The extension maintainer's name, if different from the author. If it's a username, user & talk page link will be added automatically." },		"version": { "aliases": [ "latest release version", "latest_release_version" ]		},		"update": { "description": "Date of the last release", "aliases": [ "latest release date" ],			"label": "Latest release date", "type": "date" },		"update preview": { "label": "Update preview" },		"mediawiki": { "description": "Required version of MediaWiki" },		"php": { "description": "Required version of PHP" },		"needs-updatephp": { "description": "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." },		"composer": { "description": "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." },		"phabricator": { "description": "Phabricator project name", "example": "MediaWiki-extensions-Babel", "type": "string", "suggested": true, "label": "Phabricator tag" },		"table1": { "description": "Name of a non-core table used by the extension." },		"table2": { "description": "Name of a non-core table used by the extension." },		"table3": { "description": "Name of a non-core table used by the extension." },		"table4": { "description": "Name of a non-core table used by the extension." },		"table5": { "description": "Name of a non-core table used by the extension." },		"table6": { "description": "Name of a non-core table used by the extension." },		"table7": { "description": "Name of a non-core table used by the extension." },		"table8": { "description": "Name of a non-core table used by the extension." },		"table9": { "description": "Name of a non-core table used by the extension." },		"table10": { "description": "Name of a non-core table used by the extension." },		"download": { "description": "Link to the download", "label": "Download", "type": "url" },		"readme": { "description": "External link to the readme file", "label": "ReadMe link", "type": "url" },		"changelog": { "description": "external link to the changelog file" },		"example": { "description": "example, website or screenshot of working extension", "label": "Usage example" },		"namespace": { "description": "namespace in which this extension is used" },		"parameters": { "description": "available parameters for LocalSettings.php" },		"tags": { "description": "any tags your extension uses" },		"rights": { "description": "Rights added by the extension. Not to be confused with the license!" },		"hook1": { "description": "Name of a hook used by the extension." },		"hook2": { "description": "Name of a hook used by the extension." },		"hook3": { "description": "Name of a hook used by the extension." },		"hook4": { "description": "Name of a hook used by the extension." },		"hook5": { "description": "Name of a hook used by the extension." },		"hook6": { "description": "Name of a hook used by the extension." },		"hook7": { "description": "Name of a hook used by the extension." },		"hook8": { "description": "Name of a hook used by the extension." },		"hook9": { "description": "Name of a hook used by the extension." },		"hook10": { "description": "Name of a hook used by the extension." },		"hook11": { "description": "Name of a hook used by the extension." },		"hook12": { "description": "Name of a hook used by the extension." },		"hook13": { "description": "Name of a hook used by the extension." },		"hook14": { "description": "Name of a hook used by the extension." },		"hook15": { "description": "Name of a hook used by the extension." },		"hook16": { "description": "Name of a hook used by the extension." },		"hook17": { "description": "Name of a hook used by the extension." },		"hook18": { "description": "Name of a hook used by the extension." },		"hook19": { "description": "Name of a hook used by the extension." },		"hook20": { "description": "Name of a hook used by the extension." },		"hook21": { "description": "Name of a hook used by the extension." },		"hook22": { "description": "Name of a hook used by the extension." },		"hook23": { "description": "Name of a hook used by the extension." },		"hook24": { "description": "Name of a hook used by the extension." },		"hook25": { "description": "Name of a hook used by the extension." },		"hook26": { "description": "Name of a hook used by the extension." },		"hook27": { "description": "Name of a hook used by the extension." },		"hook28": { "description": "Name of a hook used by the extension." },		"hook29": { "description": "Name of a hook used by the extension." },		"hook30": { "description": "Name of a hook used by the extension." },		"hook31": { "description": "Name of a hook used by the extension." },		"hook32": { "description": "Name of a hook used by the extension." },		"hook33": { "description": "Name of a hook used by the extension." },		"hook34": { "description": "Name of a hook used by the extension." },		"hook35": { "description": "Name of a hook used by the extension." },		"hook36": { "description": "Name of a hook used by the extension." },		"hook37": { "description": "Name of a hook used by the extension." },		"hook38": { "description": "Name of a hook used by the extension." },		"hook39": { "description": "Name of a hook used by the extension." },		"hook40": { "description": "Name of a hook used by the extension." },		"hook41": { "description": "Name of a hook used by the extension." },		"hook42": { "description": "Name of a hook used by the extension." },		"hook43": { "description": "Name of a hook used by the extension." },		"hook44": { "description": "Name of a hook used by the extension." },		"hook45": { "description": "Name of a hook used by the extension." },		"hook46": { "description": "Name of a hook used by the extension." },		"hook47": { "description": "Name of a hook used by the extension." },		"hook48": { "description": "Name of a hook used by the extension." },		"newhook1": { "description": "Name of a hook provided by the extension." },		"newhook2": { "description": "Name of a hook provided by the extension." },		"newhook3": { "description": "Name of a hook provided by the extension." },		"newhook4": { "description": "Name of a hook provided by the extension." },		"newhook5": { "description": "Name of a hook provided by the extension." },		"newhook6": { "description": "Name of a hook provided by the extension." },		"newhook7": { "description": "Name of a hook provided by the extension." },		"newhook8": { "description": "Name of a hook provided by the extension." },		"newhook9": { "description": "Name of a hook provided by the extension." },		"newhook10": { "description": "Name of a hook provided by the extension." },		"newhook11": { "description": "Name of a hook provided by the extension." },		"newhook12": { "description": "Name of a hook provided by the extension." },		"newhook13": { "description": "Name of a hook provided by the extension." },		"newhook14": { "description": "Name of a hook provided by the extension." },		"newhook15": { "description": "Name of a hook provided by the extension." },		"newhook16": { "description": "Name of a hook provided by the extension." },		"newhook17": { "description": "Name of a hook provided by the extension." },		"newhook18": { "description": "Name of a hook provided by the extension." },		"newhook19": { "description": "Name of a hook provided by the extension." },		"newhook20": { "description": "Name of a hook provided by the extension." },		"newhook21": { "description": "Name of a hook provided by the extension." },		"newhook22": { "description": "Name of a hook provided by the extension." },		"newhook23": { "description": "Name of a hook provided by the extension." },		"newhook24": { "description": "Name of a hook provided by the extension." },		"newhook25": { "description": "Name of a hook provided by the extension." },		"newhook26": { "description": "Name of a hook provided by the extension." },		"newhook27": { "description": "Name of a hook provided by the extension." },		"newhook28": { "description": "Name of a hook provided by the extension." },		"newhook29": { "description": "Name of a hook provided by the extension." },		"newhook30": { "description": "Name of a hook provided by the extension." },		"newhook31": { "description": "Name of a hook provided by the extension." },		"newhook32": { "description": "Name of a hook provided by the extension." },		"newhook33": { "description": "Name of a hook provided by the extension." },		"newhook34": { "description": "Name of a hook provided by the extension." },		"newhook35": { "description": "Name of a hook provided by the extension." },		"newhook36": { "description": "Name of a hook provided by the extension." },		"newhook37": { "description": "Name of a hook provided by the extension." },		"newhook38": { "description": "Name of a hook provided by the extension." },		"newhook39": { "description": "Name of a hook provided by the extension." },		"newhook40": { "description": "Name of a hook provided by the extension." },		"newhook41": { "description": "Name of a hook provided by the extension." },		"newhook42": { "description": "Name of a hook provided by the extension." },		"newhook43": { "description": "Name of a hook provided by the extension." },		"newhook44": { "description": "Name of a hook provided by the extension." },		"newhook45": { "description": "Name of a hook provided by the extension." },		"newhook46": { "description": "Name of a hook provided by the extension." },		"newhook47": { "description": "Name of a hook provided by the extension." },		"newhook48": { "description": "Name of a hook provided by the extension." },		"compatibility": { "description": "Compatibility chart, e.g. Template:Extension Testing.", "label": "Compatibility chart" },		"translate": { "description": "Optional parameter to link the exact page where (message group id with which) the extension will be translatable on translatewiki.net if enabled." },		"bugzilla": { "description": "Bugzilla MediaWiki extension component name", "deprecated": true, "label": "Bugzilla component" },		"vagrant-role": { "label": "Vagrant role", "description": "A MediaWiki-Vagrant role that lets you use this extension, if present", "type": "string" },		"nousage": { "label": "Hide Wikiapiary usage link", "type": "boolean" },		"CheckUsageNameOverride": { "label": "Wikiapiary name", "description": "Extension name to use for Wikiapiary, if different" },		"compatibility policy": { "description": "For older versions of MediaWiki, should one use the extension's master brunch or the REL1_XX branch corresponding to the MediaWiki version? Allowed values: master, rel", "type": "string", "suggested": true },		"latest preview version": { "aliases": [ "latest peview version", "version preview" ],			"label": "Latest preview version" }	},	"format": "\n\n", "paramOrder": [ "name", "status", "type", "type1", "type2", "type3", "type4", "type5", "hook1", "hook2", "hook3", "hook4", "hook5", "hook6", "hook7", "hook8", "hook9", "hook10", "hook11", "hook12", "hook13", "hook14", "hook15", "hook16", "hook17", "hook18", "hook19", "hook20", "hook21", "hook22", "hook23", "hook24", "hook25", "hook26", "hook27", "hook28", "hook29", "hook30", "hook31", "hook32", "hook33", "hook34", "hook35", "hook36", "hook37", "hook38", "hook39", "hook40", "hook41", "hook42", "hook43", "hook44", "hook45", "hook46", "hook47", "hook48", "newhook1", "newhook2", "newhook3", "newhook4", "newhook5", "newhook6", "newhook7", "newhook8", "newhook9", "newhook10", "newhook11", "newhook12", "newhook13", "newhook14", "newhook15", "newhook16", "newhook17", "newhook18", "newhook19", "newhook20", "newhook21", "newhook22", "newhook23", "newhook24", "newhook25", "newhook26", "newhook27", "newhook28", "newhook29", "newhook30", "newhook31", "newhook32", "newhook33", "newhook34", "newhook35", "newhook36", "newhook37", "newhook38", "newhook39", "newhook40", "newhook41", "newhook42", "newhook43", "newhook44", "newhook45", "newhook46", "newhook47", "newhook48", "type6", "username", "author", "maintainer", "description", "image", "imagesize", "version", "update", "latest preview version", "update preview", "compatibility policy", "mediawiki", "php", "needs-updatephp", "composer", "table1", "table2", "table3", "table4", "table5", "table6", "table7", "table8", "table9", "table10", "license", "download", "readme", "changelog", "example", "namespace", "parameters", "tags", "rights", "compatibility", "bugzilla", "phabricator", "vagrant-role", "translate", "CheckUsageNameOverride", "nousage", "templatemode" ] }