Difference between revisions of "Template:Extension/doc"
Jump to navigation
Jump to search
Undo revision 675650 by 66.162.247.250 (talk)
(Undo revision 652190 by Jasper Deng (talk)) |
>Kghbln (Undo revision 675650 by 66.162.247.250 (talk)) |
||
| Line 1: | Line 1: | ||
<noinclude>{{Documentation subpage}} | |||
{{timw|Extension}} | |||
</noinclude> | |||
<!----> | <!----> | ||
| Line 5: | Line 7: | ||
== Usage == | == Usage == | ||
{| width="100%" | {| width="100%" | ||
|- | |- | ||
| Line 12: | Line 14: | ||
|- valign="top" | |- valign="top" | ||
| align="left" | | | align="left" | | ||
<span id="CutAndPaste">Copy and paste:</span> | |||
<pre>{{Extension|templatemode = | |||
|name = | |name = | ||
|status = | |status = | ||
| Line 44: | Line 47: | ||
For help with parameter values, see [[#Content parameters|below]]. | For help with parameter values, see [[#Content parameters|below]]. | ||
| align="right"|{{Extension|templatemode=nocats | |||
|name = {{{name}}} | |||
|status = {{{status}}} | |||
|type1 = {{{type1}}} | |||
|type2 = {{{type2}}} | |type2 = {{{type2}}} | ||
|hook1 = hook1 | |hook1 = hook1 | ||
| Line 229: | Line 235: | ||
|} | |} | ||
== Using the infobox == | |||
=== Existing extension pages === | |||
If you want to add the infobox to an existing page, copy and paste the code at the [[#CutAndPaste|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. | |||
{{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 === | === Fixing documentation === | ||
| Line 239: | Line 256: | ||
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]]. | 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 === | ||
To improve the create extension button behavior: | To improve the create extension button behavior: | ||
| Line 246: | Line 264: | ||
=== Infobox parameters === | === 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 [[Template:Extension/Doc#Content parameters|content parameter documentation]] and link its label to that documentation. | |||
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]]:''' 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/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 <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. | |||
== Test case == | |||
See if the following pages are still ok, after edited this template. | |||
* [[Extension:Description]] | |||
* [[Template:Extension]] | |||
* [[User:Ans/{{FULLPAGENAME}}#{{FULLPAGENAME}}]] | |||