Template:Documentation: Difference between revisions
m (Text replacement - "Peacekeepers of the Vast/Peacekeepers of the Vast/" to "Peacekeepers of the Vast/") Tag: Manual revert |
m (Text replacement - "Peacekeepers of the Vast/Category:" to "Category:Peacekeepers of the Vast-") |
||
| Line 2: | Line 2: | ||
#ifexist: {{FULLPAGENAME}}/doc | #ifexist: {{FULLPAGENAME}}/doc | ||
| {{tocright}}{{{{PAGENAME}}/doc}} | | {{tocright}}{{{{PAGENAME}}/doc}} | ||
| :<strong class="error">This template currently doesn't have any documentation!</strong> Help out by [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} writing some]. [[Peacekeepers of the Vast | | :<strong class="error">This template currently doesn't have any documentation!</strong> Help out by [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} writing some]. [[Category:Peacekeepers of the Vast-Templates without documentation]] | ||
}} | }} | ||
</div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;"><span class="plainlinks">Visit [[Peacekeepers of the Vast/{{FULLPAGENAME}}/doc]] to [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit] this text! ([[Peacekeepers of the Vast/Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[Peacekeepers of the Vast/Help:Purge|why?]])</span></div></div><noinclude></div> | </div><br style="clear:both;"/><div style="background:#ddd; color:#111; padding:0.5em; margin:0em; font-size:85%; text-align:right;"><span class="plainlinks">Visit [[Peacekeepers of the Vast/{{FULLPAGENAME}}/doc]] to [{{fullurl:{{FULLPAGENAME}}/doc|action=edit}} edit] this text! ([[Peacekeepers of the Vast/Template:Documentation|How does this work]]?) ([{{fullurl:{{FULLPAGENAME}}|action=purge}} Refresh] this text - [[Peacekeepers of the Vast/Help:Purge|why?]])</span></div></div><noinclude></div> | ||
{{documentation}}[[Peacekeepers of the Vast | {{documentation}}[[Category:Peacekeepers of the Vast-Template documentation| ]][[Category:Peacekeepers of the Vast-Template-related templates|{{PAGENAME}}]]</noinclude> | ||
Revision as of 22:42, 12 December 2023
Description
This template is used to insert descriptions on template pages.
Syntax
Add <noinclude>Template:T</noinclude> at the end of the template page.
Usage
On the Template page
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}
Any categories for the template itself</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}} is inserted (within the noinclude tags).
A line break right before {{documentation}} can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page
Normally, you will want to write something like the following on the documentation page:
==Description==
This template is used to do something.
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
==Samples==
<code><nowiki>{{templatename|input}}</nowiki></code>
results in...
{{templatename|input}}
<noinclude>[[Category:Peacekeepers of the Vast-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 other sections.
Note that the above example also uses the Peacekeepers of the Vast/Template:T and Peacekeepers of the Vast/Template:T/piece templates.
Credits
This template's code was taken from [2]