Template:Documentation/doc: Difference between revisions

Latest revision as of 11:04, 1 August 2015

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[edit source]

On the Template page[edit source]

Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation}}</noinclude>

On the Template/doc page[edit source]

See also Template:Documentation/preload

{{SPW|name={{subst:BASEPAGENAME}}}}
;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]]</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}}.

@@ Line 1: / Line 1: @@
-==Description==
+{{#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>}}<!--
-This template is used to insert descriptions on template pages.
+-->{{#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>
-==Syntax==
+}}<!-- you can remove this line and everything above it if you don't see any big bold red text -->
-Add <code><nowiki><noinclude></nowiki>{{t|documentation}}<nowiki></noinclude></nowiki></code> at the end of the template page.
+{{SPW|is newer|name=Documentation}}
+;Description
-==Usage==
+:This template is used to insert documentation on template pages.
+;Syntax
+:Type <code>&lt;noinclude>{{t|documentation}}&lt;/noinclude></code> at the end of the template page.
+==General usage==
 ===On the Template page===
-This is the normal format when used:
 <pre>
-TEMPLATE CODE<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
+Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
 {{documentation}}</noinclude>
 </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===
-Normally, you will want to write something like the following on the documentation page:
+:''See also [[Template:Documentation/preload]]''
 <pre>
-==Description==
+{{SPW|name={{subst:BASEPAGENAME}}}}
-This template is used to do something.
+;Description
+:This template is used to do something.
-==Syntax==
+;Syntax
-Type <code>{{t|templatename}}</code> somewhere.
+:Type <code>{{t|templatename}}</code> somewhere.
+;Sample output
+:<code>&lt;nowiki>{{templatename|foo}}</nowiki></code> gives...
+:{{templatename|foo}}
-==Samples==
+<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation]]</noinclude>
-<code>&lt;nowiki>{{templatename|input}}&lt;/nowiki></code>
-results in...
-{{templatename|input}}
-<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
 </pre>
-Use any or all of the above description/syntax/sample output sections. You may also want to add "see also" or other 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 the [[Template:T]] and [[Template:T/piece]] templates.
-<includeonly>[[Category:General wiki templates|{{PAGENAME}}]]</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+Note that the above example also uses {{t|T}}.<includeonly>
+[[Category:General wiki templates]]
+</includeonly><noinclude>
+[[Category:Template documentation]]
+</noinclude>

Template:Documentation/doc: Difference between revisions

Latest revision as of 11:04, 1 August 2015

General usage[edit source]

On the Template page[edit source]

On the Template/doc page[edit source]

Navigation menu

Search