Difference between revisions of "Template:Documentation/doc"
(As far as I can tell there are no preloads required or broken templates, so I am removing the top section. It did say I could do it, after all!) |
(updating with useful and accurate info) |
||
| Line 1: | Line 1: | ||
;Description | ;Description | ||
:This template is used to insert documentation on template pages. | :This template is used to insert documentation on template pages. | ||
| − | ;Syntax | + | ;Syntax and Parameters |
| − | :Type <code> | + | :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== | ==General usage== | ||
===On the Template page=== | ===On the Template page=== | ||
| + | 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: | ||
<pre> | <pre> | ||
| − | + | <includeonly> TEMPLATE CODE HERE | |
| − | {{documentation}}</noinclude> | + | Any categories to be inserted into articles by the template</includeonly><noinclude> |
| + | {{documentation|{{subst:FULLPAGENAME}}/doc}}</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. | ||
===On the Template/doc page=== | ===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> | ||
| Line 23: | Line 28: | ||
<includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | <includeonly>Any categories for the template itself</includeonly><noinclude>[[Category:Template documentation|{{PAGENAME}}]]</noinclude> | ||
| − | </pre> | + | </pre> <!-- why should the tags be the same as the main template page? - Telinchei, 2015 --> |
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}}. | + | 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== | ||
Revision as of 07:35, 2 September 2015
- Description
- This template is used to insert documentation on template pages.
- Syntax and Parameters
- Type
<noinclude>{{t|documentation|<var>{{FULLPAGENAME}}/doc</var>}}</noinclude>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
On the Template page
You should attach <noinclude>{{t|documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude> to the end of the template page, so it looks like the below:
<includeonly> TEMPLATE CODE HERE
Any categories to be inserted into articles by the template</includeonly><noinclude>
{{documentation|{{subst:FULLPAGENAME}}/doc}}</noinclude>
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.
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
;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}} 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.
 | This template was copied from Template:Documentation on Wikia Templates. That wiki should periodically be checked for a new version of this template. |
