Template:Documentation/doc: Difference between revisions

(5 intermediate revisions by 4 users not shown)

Line 1:

;Description

:This template is used to insert documentation on template pages.

; Description

~~;Syntax~~

: This template is used to insert documentation on template pages.

~~:Type <code><noinclude>{{t|documentation}}</noinclude></code> at the end of the template page~~.

==General usage==

; Dependencies

===On the Template page===

:; Uses

:: {{T|Documentation/preload}} when no actual documentation is added yet.

; Syntax

: Type <code><nowiki><noinclude>{{Documentation</noinclude></nowiki></code> at the end of the template page.

== General usage ==

=== On the Template page ===

You should attach <code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code> to the end of the template page, so it looks like the below:

<pre>

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

TEMPLATE CODE HERE

Template code

<includeonly> Any categories to be inserted into articles by the template</includeonly><noinclude>

{{documentation}}</noinclude>

</pre>

===On the Template/doc page===

This will add the documentation template to the template-page, ''but not to pages where the template is used'' due to the inclusion tags.

=== On the Template/doc page ===

You should fill this out with information on how to use the template. Unused items should be removed.

:''See also [[Template:Documentation/preload]]''

<pre>

;Description

; Description

:~~This~~ template is used ~~to do something~~.

: A short description of the purpose of the template.

;Syntax

:~~Type <code>~~{{t|~~templatename~~}}~~</code> somewhere~~.

; Dependencies

;Sample ~~output~~

:; Uses

:<code><nowiki>{{templatename~~|foo~~}}</nowiki></code> gives...

:: Resource used by this template (Use linking or {{T}} where possible)

:{{templatename~~|foo~~}}

:: Resource used by this template

:: Repeat as needed ...

:; Used by

:: Template that uses this template (Preferably by using {{T|Templatename}} ))

:: Repeat as needed ...

; Syntax

: {{T|Templatename|param|...}}

:; Parameters

::; param

::: Param description

::; param

::: Param description

OR

::; param : Param description

Repeat as needed ...

; Sample

: <code><nowiki>{{templatename}}</nowiki></code> gives...

: {{templatename}}

<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation~~|{{PAGENAME}}~~]]</noinclude>

<includeonly>[[Category:Any categories for the template itself]]</includeonly><noinclude>

[[Category:Template documentation]]</noinclude>

</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}}.

Note that the above example also uses {{T|T}} to display the formatting of the template code, without actually calling the template for transclusion (as normally happens with the squiggly brackets).

==Rationale==

== Rationale ==

This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links. According to [http://www.mediawiki.org/wiki/Template:Documentation/doc#Rationale MediaWiki] it also helps reduce server resource demand by circumventing certain technical limitations of templates. Unfortunately they don't say what those limitations are, exactly. - 2012, [[User:Quinn fellthorn]]

: [[User:Telinchei]] would suggest to the those relate to server resources, when deciding what to transclude (finding noinclude tags) from the template page.

Line 37:

Line 72:

[[Category:~~General wiki~~ templates~~|{{PAGENAME}}~~]]

[[Category:Maintenance templates]]

</includeonly>

[[Category:Template documentation~~|{{PAGENAME}}~~]]

[[Category:Template documentation]]

</noinclude>

@@ Line 1: / Line 1: @@
-;Description
+{{Tocright}}
-:This template is used to insert documentation on template pages.
+; Description
-;Syntax
+: This template is used to insert documentation on template pages.
-:Type <code>&lt;noinclude>{{t|documentation}}&lt;/noinclude></code> at the end of the template page.
-==General usage==
+; Dependencies
-===On the Template page===
+:; Uses
+:: {{T|Documentation/preload}} when no actual documentation is added yet.
+; Syntax
+: Type <code><nowiki><noinclude>{{Documentation</noinclude></nowiki></code> at the end of the template page.
+== General usage ==
+=== On the Template page ===
+You should attach <code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code> to the end of the template page, so it looks like the below:
 <pre>
-Template code<includeonly>Any categories to be inserted into articles by the template</includeonly><noinclude>
+TEMPLATE CODE HERE
+Template code
+<includeonly> Any categories to be inserted into articles by the template</includeonly><noinclude>
 {{documentation}}</noinclude>
 </pre>
-===On the Template/doc page===
+This will add the documentation template to the template-page, ''but not to pages where the template is used'' due to the inclusion tags.
+=== On the Template/doc page ===
+You should fill this out with information on how to use the template. Unused items should be removed.
 :''See also [[Template:Documentation/preload]]''
 <pre>
-;Description
+; Description
-:This template is used to do something.
+: A short description of the purpose of the template.
-;Syntax
-:Type <code>{{t|templatename}}</code> somewhere.
+; Dependencies
-;Sample output
+:; Uses
-:<code>&lt;nowiki>{{templatename|foo}}</nowiki></code> gives...
+:: Resource used by this template (Use linking or {{T}} where possible)
-:{{templatename|foo}}
+:: Resource used by this template
+:: Repeat as needed ...
+:; Used by
+:: Template that uses this template (Preferably by using {{T|Templatename}} ))
+:: Repeat as needed ...
+; Syntax
+: {{T|Templatename|param|...}}
+:; Parameters
+::; param
+::: Param description
+::; param
+::: Param description
+OR
+::; param : Param description
+::; param : Param description
+Repeat as needed ...
+; Sample
+: <code>&lt;nowiki>{{templatename}}</nowiki></code> gives...
+: {{templatename}}
-<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude>
+<includeonly>[[Category:Any categories for the template itself]]</includeonly><noinclude>
+[[Category:Template documentation]]</noinclude>
 </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}}.
+Note that the above example also uses {{T|T}} to display the formatting of the template code, without actually calling the template for transclusion (as normally happens with the squiggly brackets).
-==Rationale==
+== Rationale ==
 This template allows any page to use any documentation page, and makes it possible to protect templates while allowing anyone to edit the template's documentation, categories, and interwiki links.  According to [http://www.mediawiki.org/wiki/Template:Documentation/doc#Rationale MediaWiki] it also helps reduce server resource demand by circumventing certain technical limitations of templates.  Unfortunately they don't say what those limitations are, exactly. - 2012, [[User:Quinn fellthorn]]
 : [[User:Telinchei]] would suggest to the those relate to server resources, when deciding what to transclude (finding noinclude tags) from the template page.
@@ Line 37: / Line 72: @@
 <includeonly>
-[[Category:General wiki templates|{{PAGENAME}}]]
+[[Category:Maintenance templates]]
 </includeonly>
 <noinclude>
-[[Category:Template documentation|{{PAGENAME}}]]
+[[Category:Template documentation]]
 </noinclude>