Screamer Forums and Screamer gallery have returned.

The Screamer Forums will likely remain read only unless it's known that it will be active, since forums in general are kind of dead because of Discord.

Template:Documentation/doc: Difference between revisions

From Screamer Wiki
Jump to navigation Jump to search
← Older edit
VisualWikitext
imported>Default
Removed: <includeonly>Any categories for the template itself</includeonly> - This does not work correctly. License tags are not showing up at Category:Image wiki templates
imported>Screamer Nerd
m 1 revision
 
(4 intermediate revisions by 2 users 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
:Type <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.


==General usage==
<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly>
===On the Template page===
<pre>
Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
</pre>
 
Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).
 
The line break is also useful as it helps prevent the documentation template "running into" previous code.
 
===On the Template/doc page===
<pre>
;Description
:This template is used to do something.
;Syntax
:Type <code>{{t|templatename}}</code> somewhere.
;Sample output
:<code>&lt;nowiki>{{templatename|foo}}&lt;/nowiki></code> gives...
:{{templatename|foo}}
 
<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 further usage information 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"