Template:Documentation/doc: Difference between revisions
No edit summary |
Updates |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 20: | Line 20: | ||
:This template is used to do something. | :This template is used to do something. | ||
;Syntax | ;Syntax | ||
:Type <code>{{ | :Type <code>{{tlx|templatename}}</code> somewhere. | ||
;Sample output | ;Sample output | ||
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | :<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | ||
| Line 30: | Line 30: | ||
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections. | Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections. | ||
Note that the above example also uses the [[Template: | Note that the above example also uses the [[Template:Tlx]] and [[Template:T/piece]] templates. | ||
==Categorisation== | |||
Note that any templates that call {{tlx|Documentation}} but do not have a detectable documentation subpage defined will be categorised by this template into [[:Category:Templates without a documentation subpage|Templates without a documentation subpage]]. Pages using the template in question will not be affected. | |||
==Attribution== | ==Attribution== | ||
This template was copied from [[ew:Template:Documentation]]. | This template was copied from [[ew:Template:Documentation]]. Therefore, this template and all original documentation text is licensed under the [https://creativecommons.org/licenses/by-sa/3.0/ Creative Commons CC BY-SA 3.0 license]. Any text added by AEW editors is licensed under CC BY 4.0 as per the wiki norm. | ||
==TemplateData== | |||
<templatedata> | |||
{ | |||
"params": { | |||
"1": { | |||
"label": "Documentation subpage", | |||
"description": "The template's documentation subpage. Normally, this is located on the /doc subpage of the transcluding template, but this parameter allows you to specify another.", | |||
"example": "Template:Foo/bar", | |||
"type": "wiki-page-name", | |||
"default": "{{FULLPAGENAME}}/doc" | |||
} | |||
}, | |||
"description": "Creates a preview of the documentation subpage, showcasing the documentation for the template, links to view the subpage, edit and purge it." | |||
} | |||
</templatedata> | |||
[[Category:Template documentation]] | [[Category:Template documentation]] | ||
Latest revision as of 07:59, 28 January 2022
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Place
{{Documentation}}in noinclude tags at the end of the template page.
General usage[edit source]
On the Template page[edit source]
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
Note that, depending on the template, you may need to add a clear or complete a table/div just before {{documentation}} is inserted (within the noinclude tags).
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page[edit source]
;Description
:This template is used to do something.
;Syntax
:Type <code>{{tlx|templatename}}</code> somewhere.
;Sample output
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...
:{{templatename|foo}}
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or further usage information sections.
Note that the above example also uses the Template:Tlx and Template:T/piece templates.
Categorisation[edit source]
Note that any templates that call {{Documentation}} but do not have a detectable documentation subpage defined will be categorised by this template into Templates without a documentation subpage. Pages using the template in question will not be affected.
Attribution[edit source]
This template was copied from ew:Template:Documentation. Therefore, this template and all original documentation text is licensed under the Creative Commons CC BY-SA 3.0 license. Any text added by AEW editors is licensed under CC BY 4.0 as per the wiki norm.
TemplateData[edit source]
Creates a preview of the documentation subpage, showcasing the documentation for the template, links to view the subpage, edit and purge it.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Documentation subpage | 1 | The template's documentation subpage. Normally, this is located on the /doc subpage of the transcluding template, but this parameter allows you to specify another.
| Page name | optional |