Help:Templates/Template doc page pattern

From MeritBadgeDotOrg

(Difference between revisions)
Jump to: navigation, search
m (How to do it: big)
(How to do it: del ref to add interwikis)
Line 28: Line 28:
<includeonly></nowiki><br/><nowiki>
<includeonly></nowiki><br/><nowiki>
<!-- ADD CATEGORIES BELOW THIS LINE --></nowiki><br/><nowiki>
<!-- ADD CATEGORIES BELOW THIS LINE --></nowiki><br/><nowiki>
-
</nowiki><br/><nowiki>
 
-
<!-- ADD INTERWIKIS BELOW THIS LINE --></nowiki><br/><nowiki>
 
</nowiki><br/><nowiki>
</nowiki><br/><nowiki>
</includeonly></nowiki><br/><nowiki>
</includeonly></nowiki><br/><nowiki>

Revision as of 06:30, September 11, 2007

Shortcut:
DOC

< Help:Templates

The template doc page pattern is a method to securely split template documentation off from template code in a separate page. It enables full protection of template code while retaining the documentation part unprotected, so that everyone can still edit the documentation.

Contents

What does it solve?

Wikipedians generally like to have a usage description of the template right at the template page (example: Template:Cite_news). This can be achieved by writing some descriptive text into the template wiki-source inside <noinclude>...</noinclude>. However, this has some drawbacks:

  • The text inside <noinclude>...</noinclude> does add to the pre-expand include size, which is limited (see Template limits).
  • Some templates are fully protected, because they are transcluded into a lot of pages. Editing the documentation is awkward in this case, because non-sysops must make a request to edit a protected page and a sysop has to do the edit.
  • There is an upper limit to both the pre-included and post-expanded sizes of a page. Worse, the more a template is included, its pre-expanded size gets multiplied by however many bytes its size needs. So there are conflicting needs. (see Template limits).

This How to page sets forth a strategy 'and technique' that satisfies both the human needs to refresh their memory, (or most commonly, learn from the first exposure! The 'needs' for documentation, especially for the newer editors still on the many steep wiki learning curves.) and has the added benefit of building pages faster and unloading the servers processing loads. (We all do love to wait for that page to load, soooo much!)

In summation, the dual solution is to place the documentation and usage notes in a documentation template instead of the tool or utility template (which if worded carefully, can usually cover several related tools or utility type templates) that is walled behind a <noinclude>...</noinclude> block that is very short... so easy on the processor and, thus, we get to have our documentation cake and eat it too — faster!

The solution also has two apppreciable spin-off benefits:

  1. It minimizes server loading again for widely used templates which occurs when they are updated in the least way, such as when someone adds a foreign language interwiki link.
  2. Key protected templates that are fully matured can be edited for documentation adds, clarity, categories, etc. without bothering the main utility.

How to do it

For a template with the name Template:X, create a subpage with the name Template:X/doc and copy/paste the following wikicode for a start into that page:

<includeonly>{{template doc page transcluded}}</includeonly><noinclude>{{template doc page viewed directly}}</noinclude>
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->

<includeonly>
<!-- ADD CATEGORIES BELOW THIS LINE -->

</includeonly>

Insert the documentation, categories and interwikis as indicated by the respective comment lines (see above).

In the page for template X, append after the template code:

[--template code--]<noinclude>
{{{{FULLPAGENAME}}/doc}}
<!-- Add cats and interwikis to the /doc subpage, not here! -->
</noinclude>

Attention: Make sure the opening <noinclude> begins on the same line as the last character of the template code (or text), not on a new line. Otherwise, an additional newline will be inserted into pages transcluding X (which is almost never wanted).

The template itself can now be fully protected, while its documentation page at 'X/doc' can remain fully unprotected so that everyone can edit the documentation. However, note that cascade-protecting the template also protects the doc page.

Also, ensure that the categories added are similar to:

[[Category:Name|{{PAGENAME}}]]

and not simply:

[[Category:Name]]

The name of the template needs to be identified in the category, otherwise the name of the documentation page will appear in the category.

Benefits

  • Edits to the X/doc page only propagate to the template display page itself, not to transclusions of X. Pages transcluding X are therefore not dependent on the doc page, so edits to the doc page don't inflate the job queue for heavy use templates.
  • Edits to the documentation can't do any harm to the template itself and to transcluding pages. Vandalism to the doc page doesn't propagate into pages transcluding X.
  • Everyone can edit the template documentation, even if the template itself is fully protected. Categories and interwikis can be easily added to the X/doc subpage.

References

  • Tim Starling wrote: "If the documentation is large or frequently changed, I'd recommend that you move it to a subpage. Then you can transclude it into both the <noinclude> section and the talk page." [1]

Examples

See also

Personal tools
language