Template:Doc/doc: Difference between revisions
From Vintage Story Wiki
(basics) |
(better copy-paste) |
||
Line 19: | Line 19: | ||
:This template is used to do something. | :This template is used to do something. | ||
;Syntax | ;Syntax | ||
:Type <code></code> somewhere. | :Type <code><nowiki></nowiki></code> somewhere. | ||
;Sample output | ;Sample output | ||
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | :<code><nowiki>{{templatename|foo}}</nowiki></code> gives... |
Latest revision as of 17:18, 8 July 2022
- Description
- This template is used to insert descriptions on template pages.
- Syntax
- Type
<noinclude>{{Doc}}</noinclude>
at the end of the template page.
General usage
On the Template page
<includeonly>Template code and Any categories to be inserted into articles by the template</includeonly><noinclude> {{doc}}</noinclude>
The line break is also useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
;Description :This template is used to do something. ;Syntax :Type <code><nowiki></nowiki></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.