Template:Documentation/doc: Difference between revisions
Jump to navigation
Jump to search
Content added Content deleted
sims>A morris m (8 revisions: Importing from Wikia Templates) |
sims>Roguebfl No edit summary |
||
| 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}} |
|||
;Description |
;Description |
||
:This template is used to insert |
:This template is used to insert documentation on template pages. |
||
;Syntax |
;Syntax |
||
:Type <code> |
:Type <code><noinclude>{{t|documentation}}</noinclude></code> at the end of the template page. |
||
==General usage== |
==General usage== |
||
| Line 10: | Line 20: | ||
{{documentation}}</noinclude> |
{{documentation}}</noinclude> |
||
</pre> |
</pre> |
||
Note that, depending on the template, you may need to add a clear or complete a table/div just before <code><nowiki>{{documentation}}</nowiki></code> is inserted (within the noinclude tags). |
|||
The line break is also useful as it helps prevent the documentation template "running into" previous code. |
|||
===On the Template/doc page=== |
===On the Template/doc page=== |
||
:''See also [[Template:Documentation/preload]]'' |
|||
<pre> |
<pre> |
||
;Description |
;Description |
||
| Line 22: | Line 29: | ||
:Type <code>{{t|templatename}}</code> somewhere. |
:Type <code>{{t|templatename}}</code> somewhere. |
||
;Sample output |
;Sample output |
||
:<code><nowiki>{{templatename|foo}} |
:<code><nowiki>{{templatename|foo}}</nowiki></code> gives... |
||
:{{templatename|foo}} |
:{{templatename|foo}} |
||
| Line 30: | Line 37: | ||
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. |
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 |
Note that the above example also uses {{t|T}}. |
||
<includeonly> |
|||
[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude> |
|||
[[Category:Template documentation|{{PAGENAME}}]]</noinclude> |
|||
Revision as of 20:26, 23 August 2010
- Please copy {{SPW}} from w:c:templates:Template:SPW to Template:SPW!
- Please copy {{SPW}}'s documentation from w:c:templates:Template:SPW/doc to Template:SPW/doc!
- 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<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>
On the Template/doc page
- See also Template:Documentation/preload
;Description
:This template is used to do something.
;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|{{PAGENAME}}]]</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}}.