From The Mana World
Nelson6e65 (talk | contribs) m (fix: missing </includeonly> (oops)) |
Nelson6e65 (talk | contribs) m (fix?: wrapping template) |
||
Line 13: | Line 13: | ||
|===Parameters=== | |===Parameters=== | ||
List of parameters used by this template: | List of parameters used by this template: | ||
{{Parameters container|{{{Params}}} }} | {{Parameters container | ||
|{{{Params}}} | |||
}} | |||
}} | }} | ||
</includeonly><noinclude>{{:Template:{{PAGENAME}}/doc}} <!-- this is to include documentation in this page, without transcluding it in the page where template is used --> | </includeonly><noinclude>{{:Template:{{PAGENAME}}/doc}} <!-- this is to include documentation in this page, without transcluding it in the page where template is used --> | ||
[[Category:General Template]] <!-- this is to categorize the template. It will not be transcluded in the page where template is used --> | [[Category:General Template]] <!-- this is to categorize the template. It will not be transcluded in the page where template is used --> | ||
</noinclude> | </noinclude> |
Revision as of 11:13, 19 October 2015
Use this template in order to create documentation for any template.
Usage
Copy the following code into your template doc page and fill the values:
-
{{Documentation
|Description =
|Usage =
|Code = TemplateName {{!}}arg1=arg1value {{!}}arg2=
|Params = {{Parameter|arg1|Arg1 description}}
{{Parameter|arg2|Arg2 description|Default = "Default value of arg2"}}
|Translatable= No
}}
Parameters
List of parameters used by this template:
Description :
|
Optional. Description about what does the template and when to use it. If empty, it will be used a generic text with the template link (generated dynamically).
Default value: |
Usage :
|
Optional. Instructions about how and where to use the template.
Default value: |
Code :
|
Required. Template sample code, starting with its NAME.
If the template uses args, add default values separated with " |
Params :
|
Optional. Parameters description list. The {{Parameter}} template must to be used in order to describe each parameter.
Default value: |
Translatable :
|
Optional. Mark documentation as translatable. Displays a menu containing shortcuts links to translated documentation (similar to {{I18n}} ) if is set to "Yes" (case insensitive). Any other value, will be ignored.
Default value: |
Remember, also, categorize it under Category:Template documentation by adding this at the end:
-
<noinclude>[[Category:Template documentation]]</noinclude>