Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
m →On the Template/doc page: Made sections and added a note for preloading |
m →On the Template/doc page: Making BASEPAGENAME call work incase template version not exist |
||
| (2 intermediate revisions by the same user not shown) | |||
| 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: | {{SPW|name={{subst:msg: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 == | ||
| Line 55: | Line 56: | ||
:*[[Template:Documentation/preload-sandbox]] | :*[[Template:Documentation/preload-sandbox]] | ||
:*[[Template:Documentation/preload-testcases]] | :*[[Template:Documentation/preload-testcases]] | ||
:*Site-wide CSS: | :*[[Template:T]] + [[Template:T/doc]] | ||
<pre>.template-documentation .color1, | :*[[Template:Tocright]] + [[Template:Tocright/doc]] | ||
:*[[Template:SPW]] + [[Template:SPW/doc]] | |||
:*[[Template:Underconstruction]] | |||
<dl> | |||
<dt>Site-wide CSS:</dt> | |||
<dd><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 62: | Line 68: | ||
background-color:#36C; | background-color:#36C; | ||
color:white; | color:white; | ||
}</pre> | }</pre></dd> | ||
</dl> | |||
<includeonly> | <includeonly> | ||
[[Category:General wiki templates]] | [[Category:General wiki templates]] | ||
Latest revision as of 10:58, 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:msg: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
- Site-wide CSS:
.template-documentation .color1, #bodyContent .template-documentation .color1 a, #bodyContent .template-documentation .color1 a.external { background-color:#36C; color:white; }