Prab at 02:50, 6 July 2026

2026-07-06T02:50:34Z

← Older revision		Revision as of 02:50, 6 July 2026
Line 38:		Line 38:
	<!-- Add categories to the /doc subpage, not here -->		<!-- Add categories to the /doc subpage, not here -->
	</noinclude>		</noinclude>
	~~```~~

	~~For best results, also create `Template:Documentation/doc`:~~

	~~```mediawiki~~
	{{Short description\|Documentation helper template for displaying template documentation subpages}}		{{Short description\|Documentation helper template for displaying template documentation subpages}}
	{{DISPLAYTITLE:Template:Documentation}}		{{DISPLAYTITLE:Template:Documentation}}

Prab: Created page with "{{#ifexist:{{{1|{{FULLPAGENAME}}/doc}}} |

Template documentation [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit..."

2026-07-06T02:48:43Z

Created page with "<includeonly>{{#ifexist:{{{1|{{FULLPAGENAME}}/doc}}} | <div class="template-documentation" style="clear:both;margin:1em 0 0 0;border:1px solid #a2a9b1;background:#f8f9fa;color:#202122;padding:0;"> <div style="background:#eaecf0;border-bottom:1px solid #a2a9b1;padding:0.45em 0.75em;font-weight:bold;font-size:110%;"> Template documentation <span style="float:right;font-size:85%;font-weight:normal;"> [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit..."

New page

<includeonly>{{#ifexist:{{{1|{{FULLPAGENAME}}/doc}}}
| <div class="template-documentation" style="clear:both;margin:1em 0 0 0;border:1px solid #a2a9b1;background:#f8f9fa;color:#202122;padding:0;">
<div style="background:#eaecf0;border-bottom:1px solid #a2a9b1;padding:0.45em 0.75em;font-weight:bold;font-size:110%;">
Template documentation
<span style="float:right;font-size:85%;font-weight:normal;">
[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit]
[{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=history}} history]
[{{fullurl:{{FULLPAGENAME}}|action=purge}} purge]
</span>
</div>
<div style="padding:0.9em 1em;background:#ffffff;">
{{ {{{1|{{FULLPAGENAME}}/doc}}} }}
</div>
<div style="border-top:1px solid #c8ccd1;background:#f8f9fa;padding:0.45em 0.75em;font-size:90%;">
This documentation is transcluded from [[{{{1|{{FULLPAGENAME}}/doc}}}]].
Editors can improve the documentation, examples, categories, and usage notes on the documentation subpage.
</div>
</div>
| <div class="template-documentation" style="clear:both;margin:1em 0 0 0;border:1px solid #a2a9b1;background:#f8f9fa;color:#202122;padding:0;">
<div style="background:#eaecf0;border-bottom:1px solid #a2a9b1;padding:0.45em 0.75em;font-weight:bold;font-size:110%;">
Template documentation
</div>
<div style="padding:0.9em 1em;background:#ffffff;">
'''No documentation subpage exists yet.'''

You can create documentation for this template at [[{{{1|{{FULLPAGENAME}}/doc}}}]].

Suggested documentation sections:
* <code><nowiki>== Usage ==</nowiki></code>
* <code><nowiki>== Parameters ==</nowiki></code>
* <code><nowiki>== Examples ==</nowiki></code>
* <code><nowiki>== See also ==</nowiki></code>
* <code><nowiki><includeonly>[[Category:Templates]]</includeonly></nowiki></code>
</div>
</div>
}}</includeonly><noinclude>
{{Documentation/doc}}

</noinclude>
```

For best results, also create `Template:Documentation/doc`:

```mediawiki
{{Short description|Documentation helper template for displaying template documentation subpages}}
{{DISPLAYTITLE:Template:Documentation}}

'''Template:Documentation''' is a helper template used on template pages to display documentation from a separate documentation subpage, usually named <code>/doc</code>.

This follows the common MediaWiki pattern of keeping template code separate from explanatory documentation. MediaWiki templates are transcluded using double braces, and documentation subpages make it easier to protect or maintain template code while still allowing usage notes, examples, and categories to be edited separately.

== Usage ==
Place this at the bottom of a template page, outside the active template code:

<pre>
<noinclude>
{{Documentation}}
</noinclude>
</pre>

A typical template page should look like this:

<pre>
<includeonly>
Template code goes here.
</includeonly><noinclude>
{{Documentation}}
</noinclude>
</pre>

== Custom documentation page ==
By default, this template transcludes documentation from:

<pre>
{{FULLPAGENAME}}/doc
</pre>

You can also specify a custom documentation page:

<pre>
{{Documentation|Template:Example/doc}}
</pre>

== Recommended /doc page structure ==
A good documentation subpage usually includes:

<pre>
== Usage ==
== Parameters ==
== Examples ==
== See also ==
<includeonly>
[[Category:Templates]]
</includeonly>
</pre>

== Why use documentation subpages? ==
Documentation subpages are useful because they:

* Keep template code clean and easier to maintain.
* Allow categories to be placed on the documentation page instead of inside active template code.
* Allow usage examples and parameter explanations without affecting template output.
* Make protected templates easier to document.
* Reduce accidental edits to working template code.

== Notes ==
* Add template categories to the <code>/doc</code> page, not the main template page.
* Place categories inside <code><nowiki><includeonly>...</includeonly></nowiki></code> on the documentation page.
* Use <code><nowiki><noinclude>{{Documentation}}</noinclude></nowiki></code> at the bottom of templates.
* Use <code><nowiki><nowiki>...</nowiki></nowiki></code> or <code><nowiki><pre>...</pre></nowiki></code> when showing template code examples.

== See also ==
* [[Template:Infobox public health]]
* [[Template:Cite web]]
* [[Template:Cite journal]]
* [[Help:Template]]
* [[Help:Transclusion]]

<includeonly>
[[Category:Template documentation]]
[[Category:Documentation templates]]
[[Category:WikiMD templates]]
</includeonly>

Template:Documentation - Revision history

Prab at 02:50, 6 July 2026

Prab: Created page with "{{#ifexist:{{{1|{{FULLPAGENAME}}/doc}}} | Template documentation [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit..."

Prab: Created page with "{{#ifexist:{{{1|{{FULLPAGENAME}}/doc}}} |

Template documentation [{{fullurl:{{{1|{{FULLPAGENAME}}/doc}}}|action=edit}} edit..."