Difference between revisions of "Template:Documentation/doc"

From Project: Gorgon Wiki
Jump to: navigation, search
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation/doc)
m (Dependencies: Syntaxhighlight extension not installed, bugs output !)
Line 49: Line 49:
 
:*[[Template:Documentation/preload-sandbox]]
 
:*[[Template:Documentation/preload-sandbox]]
 
:*[[Template:Documentation/preload-testcases]]
 
:*[[Template:Documentation/preload-testcases]]
:*Site-wide CSS:<div style="margin:0 4em;">
+
:*Site-wide CSS:
<syntaxhighlight lang="css">.template-documentation .color1,
+
<pre>.template-documentation .color1,
 
#bodyContent .template-documentation .color1 a,
 
#bodyContent .template-documentation .color1 a,
 
#bodyContent .template-documentation .color1 a.external
 
#bodyContent .template-documentation .color1 a.external
Line 56: Line 56:
 
     background-color:#36C;
 
     background-color:#36C;
 
     color:white;
 
     color:white;
}</syntaxhighlight>
+
}</pre>
</div>
 
 
:*[[Template:T]] + [[Template:T/doc]]
 
:*[[Template:T]] + [[Template:T/doc]]
 
:*[[Template:Tocright]] + [[Template:Tocright/doc]]
 
:*[[Template:Tocright]] + [[Template:Tocright/doc]]

Revision as of 07:25, 10 April 2016

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

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

On the Template/doc page

{{SPW|name={{subst:BASEPAGENAME}}}}
;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}}.

Dependencies

.template-documentation .color1,
#bodyContent .template-documentation .color1 a,
#bodyContent .template-documentation .color1 a.external
{
    background-color:#36C;
    color:white;
}

zh:Template:Documentation/doc