Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
Template:Extension/doc (view source)
Revision as of 18:44, 15 February 2014
, 18:44, 15 February 2014s|/Doc|/doc|
>Amire80 (add TemplateData) |
>SamB (s|/Doc|/doc|) |
||
| Line 267: | Line 267: | ||
=== Fixing documentation === | === Fixing documentation === | ||
If you would like to fix documentation, please be aware that documentation and code is split into two files: | If you would like to fix documentation, please be aware that documentation and code is split into two files: | ||
* '''[[Template:Extension/ | * '''[[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). | * '''[[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/ | 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 === | === The Create extension button === | ||
| Line 281: | Line 281: | ||
=== Infobox parameters === | === Infobox parameters === | ||
In general: | 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 [[Template:Extension/ | * 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 [[Template:Extension/doc#Content parameters|content parameter documentation]] and link its label to that documentation. | ||
| Line 288: | Line 288: | ||
* '''[[Template:Extension/TypeSwitch]]:''' Stores the possible values for the type field. Multiple values are implemented by calling this template with [[Template:Foreach]]. | * '''[[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 <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/TypeSwitchNoCats]]:''' Does not need to be modified when adding a new type. 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/ | * '''[[Template:Extension/doc]]:''' Documentation for this template needs to be kept in sync with any changes to the implementation type taxonomy. | ||