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


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

{|

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