Template talk:Documentation

From Meta, a Wikimedia project coordination wiki
Jump to navigation Jump to search

template doc page viewed directly[edit]

Shouldn't the doc page still include <noinclude>{{template doc page viewed directly}}</noinclude> - this template automatically categorizes the doc page in Category:documentation subpages. --V111P 20:47, 28 June 2007 (UTC)

I've added {{documentation subpage}} to the instructions (the template you mentioned redirects to it). —{admin} Pathoschild 21:12:23, 28 June 2007 (UTC)

Removed tip on saving 10 bytes[edit]

I've removed the text below from the documentation page and added {{shortcut}} instead. 10 bytes is an insignificant difference; it would take 400 template calls to make one second of difference if Wikimedia servers parsed code at the speed of a phone dialup modem on a slow day. Since they parse code far more quickly than that, and cache the result, 10 bytes is negligible and not worth the extra documentation. Further, if you consider negligibles noteworthy, redirecting the query might add (negligible) processing time.

Pre-expand include size
Transcluding a template directly or indirectly on a page adds to the pre-expand include sizehttp://en.wikipedia.org/wiki/Wikipedia:Template limits of that page. In general, documentation of the template on the template page adds to this pre-expand include size by an amount per call of 23 bytes for the noinclude tags, plus the size of the unexpanded wikitext for the documentation. When using this Template:Documentation the latter is 17 bytes for the wikitext "{{documentation}}", so typically much less than the documentation text itself. Together the use of this template adds 40 bytes per direct or indirect inclusion.

To save 10 more bytes, due to a redirect one can also use

<noinclude>{{doc}}</noinclude>

adding only 30 bytes per inclusion.

{admin} Pathoschild 19:52:32, 04 July 2007 (UTC)

The text is more than the tip about the 10 bytes. It is about one of the main reasons of using the template.--Patrick 23:10, 4 July 2007 (UTC)
I've added a more concise and detailed explanation of the template. What say you? —{admin} Pathoschild 02:53:28, 05 July 2007 (UTC)
I tweaked the text a bit.--Patrick 07:10, 5 July 2007 (UTC)

Link[edit]

The link "{{mlww|Template_documentation}}" gives "w:Wikipedia:Template_documentationhttp://en.wikipedia.org/wiki/Wikipedia:Template_documentation" [1] and allows the backlink [2].--Patrick 23:31, 4 July 2007 (UTC)

Could you explain how this is useful? —{admin} Pathoschild 02:44:57, 05 July 2007 (UTC)
It provides a "What links here" feature for interwiki links. This allows finding related content even if there is no link (yet) in the other direction. Locating links is also useful when the target content is changed or moved; that may require changes in the links.--Patrick 07:08, 5 July 2007 (UTC)

Copy of Commons:Template:Documentation[edit]

Would there be problems if I were to copy paste the commons template here? -- とある白い猫 chi? 07:23, 21 May 2012 (UTC)

Template:Edit semi protected