Template:Documentation: Difference between revisions
Jump to navigation
Jump to search
(Created page with "<onlyinclude><div style="position: relative" class="templatedocbox"><div style="position: absolute; top: -4em; right: 1.5em; z-index: 2; font-size: 0.85em" class="templatedoce...") |
mNo edit summary |
||
| Line 1: | Line 1: | ||
<onlyinclude><div style="position: relative" class="templatedocbox"><div style="position: absolute; top: -4em; right: 1.5em; z-index: 2; font-size: 0.85em" class="templatedoceditlink">'''[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} Edit documentation]'''</div> | <onlyinclude><div style="position: relative" class="templatedocbox"><div style="position: absolute; top: -4em; right: 1.5em; z-index: 2; font-size: 0.85em" class="templatedoceditlink">'''[{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} Edit documentation]'''</div> | ||
{{{{FULLPAGENAME}}/doc}}</div></onlyinclude> | {{{{FULLPAGENAME}}/doc}}</div></onlyinclude> | ||
Latest revision as of 11:23, 16 May 2020
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{documentation}}</noinclude>at the top of the template page.
General usage
On the Template page
<noinclude>{{documentation}}
</noinclude>Template code
<includeonly>Categories applied to pages using the template</includeonly>
The line break before <includeonly> is included here for formatting purposes, and should not appear in actual templates. Depending on the template, it may be beneficial to move the <includeonly> to immediately after </noinclude>, hiding the template from view.
On the Template/doc page
;Description
:This template is used to do something.
;Syntax
:Type <code>{{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.