Difference between revisions of "Template:Documentation/doc"
From Project: Gorgon Wiki
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation/doc) |
m (updating to latest version on http://templates.wikia.com/wiki/Template:Documentation/doc) |
||
| Line 23: | Line 23: | ||
===On the Template/doc page=== | ===On the Template/doc page=== | ||
| − | |||
| − | |||
| − | |||
| − | |||
<pre> | <pre> | ||
{{SPW|name={{subst:BASEPAGENAME}}}} | {{SPW|name={{subst:BASEPAGENAME}}}} | ||
| Line 49: | Line 45: | ||
Note that the above example also uses {{t|T}}. | Note that the above example also uses {{t|T}}. | ||
| + | == Dependencies == | ||
| + | :*[[Template:Documentation/preload]] | ||
| + | :*[[Template:Documentation/preload-sandbox]] | ||
| + | :*[[Template:Documentation/preload-testcases]] | ||
| + | :*Site-wide CSS:<div style="margin:0 4em;"> | ||
| + | <syntaxhighlight lang="css">.template-documentation .color1, | ||
| + | #bodyContent .template-documentation .color1 a, | ||
| + | #bodyContent .template-documentation .color1 a.external | ||
| + | { | ||
| + | background-color:#36C; | ||
| + | color:white; | ||
| + | }</syntaxhighlight> | ||
| + | </div> | ||
| + | :*[[Template:T]] + [[Template:T/doc]] | ||
| + | :*[[Template:Tocright]] + [[Template:Tocright/doc]] | ||
| + | :*[[Template:SPW]] + [[Template:SPW/doc]] | ||
<includeonly> | <includeonly> | ||
[[Category:General wiki templates]] | [[Category:General wiki templates]] | ||
Revision as of 08:14, 10 April 2016
 | This template was copied from Template:Documentation on Wikia Templates. That wiki should periodically be checked for a new version of this template. |
- 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/preload
- Template:Documentation/preload-sandbox
- Template:Documentation/preload-testcases
- Site-wide CSS:
<syntaxhighlight lang="css">.template-documentation .color1,
- bodyContent .template-documentation .color1 a,
- bodyContent .template-documentation .color1 a.external
{
background-color:#36C; color:white;
}</syntaxhighlight>
