3,311
edits
Template:Documentation/doc: Difference between revisions
m
12 revisions imported: Import from https://sims.wikia.com
sims>A morris m (8 revisions: Importing from Wikia Templates) |
m (12 revisions imported: Import from https://sims.wikia.com) |
||
| (8 intermediate revisions by 4 users not shown) | |||
Line 1:
;Description▼
:This template is used to insert descriptions on template pages.▼
;Syntax▼
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.▼
==
▲
==Usage==
===On the Template page===
This is the normal format when used:
<pre>
{{documentation}}
Any categories for the template itself</noinclude>
</pre>
===On the Template/doc page===
Normally, you will want to write something like the following on the documentation page:
<pre>
:This template is used to do something.▼
;Syntax▼
:Type <code>{{t|templatename}}</code> somewhere.▼
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives...▼
:{{templatename|foo}}▼
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>▼
==Samples==
results in...
▲
</pre>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or
Note that the above example also uses the [[Template:T]] and [[Template:T/piece]] templates.
{{Important note|When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.}}
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>▼
==Credits==
This template's code was taken from [[wikia:w:c:k6ka:Template:Documentation|Template:Documentation]] on K6ka's Wiki on Wikia.
▲
| |||