Template:Documentation/doc: Difference between revisions
sims>Roguebfl No edit summary |
m (12 revisions imported: Import from https://sims.wikia.com) |
||
(7 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{#ifexist: Template:Documentation/preload | <!-- nothing; preload already copied --> | :<strong class="error">Please copy <nowiki>{{Documentation}}</nowiki>'s preload template from [[w:c:templates:Template:Documentation/preload]] to [[Template:Documentation/preload]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:T | <!-- nothing; T already copied/exists --> | :<strong class="error">Please copy <nowiki>{{T}}</nowiki> from [[w:c:templates:Template:T]] to [[Template:T]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:T/doc | <!-- nothing; T's documentation already copied/exists --> | :<strong class="error">Please copy <nowiki>{{T}}</nowiki>'s documentation from [[w:c:templates:Template:T/doc]] to [[Template:T/doc]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:Tocright | <!-- nothing; Tocright already copied/exists --> | :<strong class="error">Please copy <nowiki>{{Tocright}}</nowiki> from [[w:c:templates:Template:Tocright]] to [[Template:Tocright]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:Tocright/doc | <!-- nothing; Tocright's documentation already copied/exists --> | :<strong class="error">Please copy <nowiki>{{Tocright}}</nowiki>'s documentation from [[w:c:templates:Template:Tocright/doc]] to [[Template:Tocright/doc]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:SPW | <!-- nothing; SPW already copied --> | :<strong class="error">Please copy <nowiki>{{SPW}}</nowiki> from [[w:c:templates:Template:SPW]] to [[Template:SPW]]!</strong>}}<!-- |
|||
-->{{#ifexist: Template:SPW/doc | <!-- nothing; SPW's documentation already copied --> | :<strong class="error">Please copy <nowiki>{{SPW}}</nowiki>'s documentation from [[w:c:templates:Template:SPW/doc]] to [[Template:SPW/doc]]!</strong> |
|||
⚫ | |||
}}<!-- you can remove this line and everything above it if you don't see any big bold red text --> |
|||
⚫ | |||
{{SPW|is newer|name=Documentation}} |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
==Usage== |
|||
==General usage== |
|||
===On the Template page=== |
===On the Template page=== |
||
This is the normal format when used: |
|||
<pre> |
<pre> |
||
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> |
|||
{{documentation}} |
{{documentation}} |
||
Any categories for the template itself</noinclude> |
|||
</pre> |
</pre> |
||
''If your template is not a completed div or table, you may need to close the tags just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags).'' |
|||
''A line break right before <code><nowiki>{{documentation}}</nowiki></code> can also be useful as it helps prevent the documentation template "running into" previous code.'' |
|||
===On the Template/doc page=== |
===On the Template/doc page=== |
||
Normally, you will want to write something like the following on the documentation page: |
|||
:''See also [[Template:Documentation/preload]]'' |
|||
<pre> |
<pre> |
||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
;Sample output |
|||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
⚫ | |||
==Samples== |
|||
⚫ | |||
results in... |
|||
⚫ | |||
⚫ | |||
</pre> |
</pre> |
||
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or |
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections. |
||
⚫ | |||
{{Important note|When beginning a /doc page with a heading, remember to add a line break between the start of the page and the first heading. Failing to do otherwise may break the heading, resulting in the raw wikitext of the heading being displayed.}} |
|||
==Credits== |
|||
This template's code was taken from [[wikia:w:c:k6ka:Template:Documentation|Template:Documentation]] on K6ka's Wiki on Wikia. |
|||
⚫ | |||
⚫ | |||
<includeonly> |
|||
[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude> |
|||
⚫ |
Latest revision as of 20:56, 5 March 2019
Description[edit source]
This template is used to insert descriptions on template pages.
Syntax[edit source]
Add <noinclude>{{documentation}}</noinclude>
at the end of the template page.
Usage[edit source]
On the Template page[edit source]
This is the normal format when used:
TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude> {{documentation}} Any categories for the template itself</noinclude>
If your template is not a completed div or table, you may need to close the tags just before {{documentation}}
is inserted (within the noinclude tags).
A line break right before {{documentation}}
can also be useful as it helps prevent the documentation template "running into" previous code.
On the Template/doc page[edit source]
Normally, you will want to write something like the following on the documentation page:
==Description== This template is used to do something. ==Syntax== Type <code>{{t|templatename}}</code> somewhere. ==Samples== <code><nowiki>{{templatename|input}}</nowiki></code> results in... {{templatename|input}} <noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other sections.
Note that the above example also uses the Template:T and Template:T/piece templates.
Credits[edit source]
This template's code was taken from Template:Documentation on K6ka's Wiki on Wikia.