|
|
| 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
| |
| :This template is used to insert documentation on template pages.
| |
| ;Syntax
| |
| :Type <code><noinclude>{{t|documentation}}</noinclude></code> at the end of the template page.
| |
|
| |
| ==General usage==
| |
| ===On the Template page===
| |
| <pre>
| |
| Template code<noinclude>
| |
| {{documentation}}
| |
| </noinclude>
| |
| </pre>
| |
|
| |
| ===On the Template/doc page===
| |
| <pre>
| |
| {{SPW|name={{subst:BASEPAGENAME}}}}
| |
| ;Description | | ;Description |
| :This template is used to do something. | | :This template is used to do something. |
| ;Dependencies: | | ;Dependencies:<!-- delete if N/A --> |
| :* Uses (some CSS, JS, file, or other template). | | :* Uses (some CSS, JS, file, or other template).<!-- delete if N/A --> |
| ;Syntax | | ;Syntax |
| :Type <code>{{t|templatename}}</code> somewhere. | | :Type {{t|{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|param1<!-- delete if N/A -->|namedparam=<!-- delete if N/A -->|style=code}} somewhere. |
| ;Sample output | | ;Sample output |
| :<code><nowiki>{{templatename|foo}}</nowiki></code> gives... | | :<code><nowiki>{{</nowiki>{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}<nowiki>|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}}</nowiki></code> gives... |
| :{{templatename|foo}} | | :{{{{<includeonly>subst:</includeonly>#titleparts:{{<includeonly>subst:</includeonly>PAGENAME}}|1}}|foo1<!-- delete if N/A -->|foo2=<!-- delete if N/A -->}} |
| | ;See also:<!-- delete if N/A --> |
| | :* [[Template:<!-- Some other template -->]]<!-- delete if N/A --> |
| | :* [[<!-- Some other related page -->]]<!-- delete if N/A --> |
|
| |
|
| <includeonly>Any categories for the template itself | | <includeonly><<noinclude/>includeonly> |
| </includeonly><noinclude> | | <!-- Categories/interwikis for the template --> |
| | <<noinclude/>/includeonly><<noinclude/>noinclude> |
| | <!-- Categories/interwikis for this documentation --> |
| [[Category:Template documentation]] | | [[Category:Template documentation]] |
| </noinclude> | | <<noinclude/>/noinclude></includeonly> |
| </pre>
| |
| | |
| 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|T}}.
| |
| | |
| == Dependencies ==
| |
| :*[[Template:Documentation/preload]]
| |
| :*[[Template:Documentation/preload-sandbox]]
| |
| :*[[Template:Documentation/preload-testcases]]
| |
| :*Site-wide CSS:
| |
| <div style="margin-left:60px;"><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>
| |
| [[Category:General wiki templates]]
| |
| | |
| [[ja:テンプレート:Documentation]]
| |
| [[zh:Template:Documentation]]
| |
| </includeonly><noinclude> | |
| [[Category:Template documentation]]
| |
| | |
| [[ja:テンプレート:Documentation/doc]]
| |
| [[zh:Template:Documentation/doc]]
| |
| </noinclude>
| |