MY EYES! Some of the CSS needs repairing. That'll be done soon. I promise.

Screamer Wiki was down for who honestly knows the reason why. Maybe it was a DoS attack? Maybe it was our old VPS throttling us? Who knows. We have moved servers and are now on the latest LTS version of MediaWiki.

Account creation will be disabled for now.

Template:Documentation/doc: Difference between revisions

From Screamer Wiki
Jump to navigation Jump to search
← Older edit
Visual
imported>Default
m Protected "Template:Documentation/doc" (‎[edit=sysop] (indefinite) ‎[move=sysop] (indefinite))
imported>Screamer Nerd
m 1 revision
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
==Description==
'''To use this template, type {{t|documentation}} on the template page.'''
This template is used to insert descriptions on template pages.


==Syntax==
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly>
Add <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>
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
</pre>
 
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).''
 
''A line break right before <code><nowiki>{{documentation}}</nowiki></code> 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:
 
<pre>
==Description==
This template is used to do something.
 
==Syntax==
Type <code>{{t|templatename}}</code> somewhere.
 
==Samples==
<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
 
results in...
 
{{templatename|input}}
 
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
</pre>
 
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 [[Template:T]] and [[Template:T/piece]] templates.
 
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>

Latest revision as of 01:27, 5 August 2015

To use this template, type {{documentation}} on the template page.


Retrieved from "https://screamer.wiki/index.php?title=Template:Documentation/doc&oldid=53271"