Template:Documentation/doc: Difference between revisions

From Heartbound Wiki
m (Djinnet moved page Documentation/doc to Template:Documentation/doc without leaving a redirect: Trying to fix the template error)
m (Updated the general wiki category to the base template category)
 
Line 33: Line 33:
Note that the above example also uses {{t|T}}.
Note that the above example also uses {{t|T}}.


<includeonly>[[Category:General wiki templates]]</includeonly>
<includeonly>[[Category:Templates]]</includeonly>
<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:39, 11 October 2024

Description
This template is used to insert documentation on template pages.
Syntax
Type <noinclude>{{documentation}}</noinclude> at the end of the template page.

General usage

On the Template page

<includeonly>
Template code
</includeonly><noinclude>{{documentation}}</noinclude>

On the Template/doc page

;Description
:This template is used to do something.
;Dependencies:
:* Uses (some CSS, JS, file, or other template).
;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]]
</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 {{T}}.