Nelson6e65 (talk | contribs) (Rename param: "Translate" --> Translatable) |
|||
| (20 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
< | <includeonly><div style="padding-bottom:3px;margin-bottom:1ex"> | ||
{{: | <span style="font-weight:bold;font-size:150%">[[File:50px-Template-info.png]] Template documentation</span> | ||
<span class="plainlinks"><sup>[ [{{canonicalurl:{{FULLPAGENAME}}/doc|action=edit}} Edit] ]</sup></span> | |||
{{#ifeq: {{lc:{{{Translatable| no }}} }} | yes | {{Documentation/i18n}} }} | |||
</div> | |||
===Description===__NOEDITSECTION__ | |||
{{{Description|Documentation for the [[{{#titleparts:{{FULLPAGENAME}}|1}}|{{#titleparts:{{PAGENAME}}|1}}]] template.}}} | |||
===Usage===__NOEDITSECTION__ | |||
{{{Usage|Copy the following code into your page:}}} | |||
<dl style="display:inline-block; padding-left:.75em; margin-left:0;"> | <dl style="display:inline-block; padding-left:.75em; margin-left:0;"> | ||
<nowiki>{{</nowiki>{{{Code}}} <nowiki>}}</nowiki> | <nowiki>{{</nowiki>{{{Code}}}<nowiki>}}</nowiki> | ||
</dl> | </dl> | ||
{{#if:{{{Params|}}} | |||
<noinclude> | |===Parameters===__NOEDITSECTION__ | ||
List of parameters used by this template: | |||
{{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 --> | |||
[[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> | ||
Latest revision as of 13:25, 25 October 2015
Template documentation
[ Edit ]
Description
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>
