Difference between revisions of "Template:Extension/doc"

Jump to navigation Jump to search
2,685 bytes added ,  09:46, 16 September 2007
>Egfrank~mediawikiwiki
(→‎Usage: added hooks to sample)
>Egfrank~mediawikiwiki
Line 163: Line 163:
=== Create a new extension article ===
=== 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.
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.


{{Extension/CreateExtensionInputBox}}
{{Extension/CreateExtensionInputBox}}
== 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 forms.  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.
* '''[[Extension:MyExtension]]:''' - defines a placeholder in case a user accidentally hits the create button without changing the extension name.
=== Infobox parameters ===
To change/correct/add to the implementation type parameters:
* Check the [[Template_talk:Extension|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 <code>templatemode=nocats</code>.  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 changes to 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 <code>templatemode=nocats</code>.  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.

Navigation menu