Difference between revisions of "Template:Documentation/doc"

From EVE University Wiki
Jump to: navigation, search
(Recategorising)
m (Fix typo.)
 
(3 intermediate revisions by 2 users not shown)
Line 1: Line 1:
−
;Description
+
{{Tocright}}
−
:This template is used to insert documentation on template pages.
+
; Description
−
;Syntax and Parameters
+
: This template is used to insert documentation on template pages.
−
:Type <code><nowiki><noinclude>{{t|documentation|<var>{{FULLPAGENAME}}/doc</var>}}</noinclude></nowiki></code> at the end of the template page. Include the full (exact, including namespace) name of the documentation page as a parameter where posible.
 
  
−
==General usage==
+
; Dependencies
−
===On the Template page===
+
:; Uses
−
You should attach <code><nowiki><noinclude>{{t|documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude></nowiki></code> to the end of the template page, so it looks like the below:
+
:: {{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>
 
<pre>
−
<includeonly> TEMPLATE CODE HERE
+
TEMPLATE CODE HERE
−
Any categories to be inserted into articles by the template</includeonly><noinclude>
+
Template code
−
{{documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude>
+
<includeonly> Any categories to be inserted into articles by the template</includeonly><noinclude>
 +
{{documentation}}</noinclude>
 
</pre>
 
</pre>
  
−
This will fill in add the documentation template to the template-page, ''but not pages where the template is used'' due to the inclusion tags. The subst:FULLPAGENAME serves as a wikimedia "Magic Word" and will be replaced by the wikispace and page name once the edit is completed, and serves to direct the template towards the appropriate page for substitution in case the automatic code fails to work.
+
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.
  
−
===On the Template/doc page===
 
−
You should fill this out with information on how to use the template. For example,
 
 
:''See also [[Template:Documentation/preload]]''
 
:''See also [[Template:Documentation/preload]]''
 
<pre>
 
<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>
−
</pre> <!-- why should the tags be the same as the main template page? - Telinchei, 2015 -->
+
[[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.
 
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}} to display the formatting of the template code, without actually calling the template for transclusion (as normally happens with the squiggly brackets).
+
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]]
 
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.
 
: [[User:Telinchei]] would suggest to the those relate to server resources, when deciding what to transclude (finding noinclude tags) from the template page.
Line 42: Line 72:
  
 
<includeonly>
 
<includeonly>
−
[[Category:Template]]
+
[[Category:Maintenance templates]]
 
</includeonly>
 
</includeonly>
 
<noinclude>
 
<noinclude>
−
[[Category:Template documentation|{{PAGENAME}}]]
+
[[Category:Template documentation]]
 
</noinclude>
 
</noinclude>

Latest revision as of 14:48, 9 March 2023

Description
This template is used to insert documentation on template pages.
Dependencies
Uses
{{Documentation/preload}} when no actual documentation is added yet.
Syntax
Type <noinclude>{{Documentation</noinclude> at the end of the template page.

General usage

On the Template page

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

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

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
; Description
: A short description of the purpose of the template.

; Dependencies
:; Uses
:: Resource used by this template (Use linking or {{T}} where possible)
:: 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><nowiki>{{templatename}}</nowiki></code> gives...
: {{templatename}}

<includeonly>[[Category: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}} to display the formatting of the template code, without actually calling the template for transclusion (as normally happens with the squiggly brackets).

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 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.
Wiki.pngThis template was copied from Template:Documentation on Wikia Templates.
That wiki should periodically be checked for a new version of this template.
Retrieved from "https://wiki.eveuniversity.org/index.php?title=Template:Documentation/doc&oldid=201237"