Template:Documentation: Difference between revisions
From RoR Wiki
(Created page with "<div style="position: relative" class="templatedocbox"><div style="position: absolute; top: -4em; right: 1.5em; z-index: 2; font-size: 0.85em" class="templatedoceditlink">'''[...") |
Stah>Bsherr (consistent with new substitution template format) |
||
| Line 1: | Line 1: | ||
{{#invoke:documentation|main|_content={{ {{#invoke:documentation|contentTitle}}}}}}<noinclude> | |||
<!-- Add categories to the /doc subpage --> | |||
</noinclude> | |||
Revision as of 02:14, 29 March 2022
Template documentation- 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>{{t|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:T and Template:T/piece templates.
