Difference between revisions of "Template:Documentation/doc"
From Project: Gorgon Wiki
m (→On the Template/doc page: Made sections and added a note for preloading) |
m (→On the Template/doc page: update info) |
||
| Line 27: | Line 27: | ||
|border=blue | |border=blue | ||
|type=Preloading | |type=Preloading | ||
| − | |info=Not needed when using the <i>preload functionality</i> provided by the <b>create</b> link when using the {{t|Documentation}} template. | + | |info=Not needed when using the <i>preload functionality</i> provided by the <b>create</b> link when using the {{t|Documentation}} template.<br/> |
| + | The preload version will be more enhanced and is <b><u>recommended</u></b>.<br/> | ||
| + | To make use of the <i>preload functionality</i> click the <b>create</b> link provided when using the {{t|Documentation}} template.<br/> | ||
| + | <b>Don't</b> forget to save the generated doc page without alterations first before making any changes to it ! | ||
}} | }} | ||
<pre> | <pre> | ||
{{SPW|name={{subst:Template:BASEPAGENAME}}}} | {{SPW|name={{subst:Template:BASEPAGENAME}}}} | ||
| + | <includeonly><!-- Any categories for the template itself --> | ||
| + | </includeonly><noinclude> | ||
| + | [[Category:Template documentation]] | ||
| + | </noinclude> | ||
==Description== | ==Description== | ||
:This template is used to do something. | :This template is used to do something. | ||
| Line 40: | Line 47: | ||
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | :<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | ||
:{{templatename|foo}} | :{{templatename|foo}} | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
</pre> | </pre> | ||
| − | + | *Use any or all of the above description/syntax/sample output sections. | |
| − | 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. | + | *:You may also want to add "see also" or further usage information sections. |
| − | + | *Note that the above example also uses {{t|T}}. | |
| − | Note that the above example also uses {{t|T}}. | ||
== Dependencies == | == Dependencies == | ||
Revision as of 06:34, 1 May 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
<noinclude>{{Underconstruction}}
</noinclude><!-- Template code --><noinclude>
{{documentation}}
</noinclude>
On the Template/doc page
|
Preloading
Not needed when using the preload functionality provided by the create link when using the {{Documentation}} template. |
{{SPW|name={{subst:Template:BASEPAGENAME}}}}
<includeonly><!-- Any categories for the template itself -->
</includeonly><noinclude>
[[Category:Template documentation]]
</noinclude>
==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}}
- 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;
}
