Prab: Created page with "{{Short description|Documentation subpage for the W8MD Documentation template}} {{DISPLAYTITLE:Template:Documentation/doc}} '''Template:Documentation''' is a helper template used on W8MD.com to display documentation for templates from a separate documentation subpage, usually named `/doc`. This template helps keep active template code separate from instructions, examples, parameter descriptions, and categories. It is especially useful for frequently used W8M..."

2026-07-06T03:04:21Z

Created page with "{{Short description|Documentation subpage for the W8MD Documentation template}} {{DISPLAYTITLE:Template:Documentation/doc}} '''Template:Documentation''' is a helper template used on W8MD.com to display documentation for templates from a separate documentation subpage, usually named <code>/doc</code>. This template helps keep active template code separate from instructions, examples, parameter descriptions, and categories. It is especially useful for frequently used W8M..."

New page

{{Short description|Documentation subpage for the W8MD Documentation template}}
{{DISPLAYTITLE:Template:Documentation/doc}}

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

This template helps keep active template code separate from instructions, examples, parameter descriptions, and categories. It is especially useful for frequently used W8MD templates such as infoboxes, citation templates, navigation templates, medical topic templates, and service-area templates.

== Purpose ==
The purpose of this template is to:

* Display template documentation in a clean documentation box.
* Keep template code separate from explanatory text.
* Allow examples and parameter notes to be edited without changing active template code.
* Encourage consistent W8MD template documentation.
* Place template categories on the documentation subpage instead of the main template page.
* Reduce the risk of accidental damage to working templates.

== Basic usage ==
Place this at the bottom of a template page:

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

A typical W8MD template page should use this structure:

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

The documentation should then be placed on the matching documentation subpage:

<pre>
Template:Example/doc
</pre>

== Custom documentation page ==
By default, <code>{{Documentation}}</code> displays documentation from the current template's <code>/doc</code> subpage.

A custom documentation page can also be specified:

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

This may be useful when several related templates share the same documentation.

== Recommended documentation page format ==
A good W8MD template documentation page should usually include:

<pre>
{{Short description|Brief description of what the template does}}
{{DISPLAYTITLE:Template:Example/doc}}

'''Template:Example''' is used to...

== Usage ==
<pre>
{{Example
| name =
| image =
| caption =
}}
</pre>

== Parameters ==
{| class="wikitable"
! Parameter
! Description
! Required?
|-
| name
| Name displayed by the template
| Optional
|-
| image
| Image filename without File: prefix
| Optional
|}

== Examples ==
<pre>
{{Example
| name = Sample page
| image = Example.jpg
| caption = Example image
}}
</pre>

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

<includeonly>
[[Category:Template documentation]]
[[Category:W8MD templates]]
</includeonly>
</pre>

== Parameters ==
{| class="wikitable"
! Parameter
! Description
! Required?
! Example
|-
| <code>1</code>
| Optional custom documentation page to transclude instead of the default <code>/doc</code> page
| No
| <code>Template:Infobox public health/doc</code>
|}

== Examples ==
=== Standard example ===
Use on a template page:

<pre>
<includeonly>
{{#invoke:Infobox|infobox
| above = {{{name|{{PAGENAME}}}}}
| label1 = Field
| data1 = {{{field|}}}
}}
</includeonly><noinclude>
{{Documentation}}
</noinclude>
</pre>

This will display documentation from:

<pre>
Template:Template name/doc
</pre>

=== Custom documentation example ===
Use a custom documentation page:

<pre>
<noinclude>
{{Documentation|Template:Shared infobox documentation}}
</noinclude>
</pre>

== Where to place categories ==
Template categories should normally be placed on the <code>/doc</code> page, not directly on the main template page.

Use this format on the documentation subpage:

<pre>
<includeonly>
[[Category:W8MD templates]]
[[Category:Template documentation]]
</includeonly>
</pre>

This prevents categories from being accidentally transcluded onto pages that use the template.

== Where to place interwiki links ==
If interwiki links are used, they should usually be placed on the documentation subpage rather than inside the active template code.

== W8MD best practices ==
For W8MD.com, documentation pages should be written clearly enough for editors, physicians, content writers, and technical maintainers to understand.

Recommended W8MD documentation practices:

* Begin with <code><nowiki>{{Short description|...}}</nowiki></code>.
* Use <code><nowiki>{{DISPLAYTITLE:...}}</nowiki></code> when helpful.
* Clearly explain what the template does.
* Include a copy-and-paste usage example.
* Document each parameter in a table.
* Mark parameters as required or optional.
* Include at least one working example.
* Add related templates under <code>== See also ==</code>.
* Place categories inside <code><nowiki><includeonly>...</includeonly></nowiki></code>.
* Avoid placing active template categories on the main template page.
* Avoid long prose inside the main template code.
* Keep examples medically accurate when documenting medical templates.

== Suggested sections for W8MD template documentation ==
Most W8MD template documentation pages should use some or all of these sections:

<pre>
== Usage ==
== Parameters ==
== Examples ==
== TemplateData ==
== Tracking categories ==
== See also ==
</pre>

== TemplateData ==
If VisualEditor or TemplateWizard is enabled on W8MD.com, a <code>TemplateData</code> block may be added to documentation pages.

Example:

<pre>
<templatedata>
{
"description": "Displays documentation for a template from its /doc subpage.",
"params": {
"1": {
"label": "Documentation page",
"description": "Optional custom documentation page to transclude.",
"type": "wiki-page-name",
"required": false
}
}
}
</templatedata>
</pre>

== Troubleshooting ==
{| class="wikitable"
! Problem
! Possible cause
! Fix
|-
| Documentation does not appear
| The <code>/doc</code> page does not exist
| Create the documentation subpage, such as <code>Template:Example/doc</code>
|-
| Categories appear on article pages
| Categories were placed directly inside the template
| Move categories to the <code>/doc</code> page inside <code><nowiki><includeonly>...</includeonly></nowiki></code>
|-
| Example code is being executed
| Code examples were not wrapped in <code><nowiki><pre></nowiki></code> or <code><nowiki><nowiki></nowiki></code>
| Wrap examples in <code><nowiki><pre>...</pre></nowiki></code>
|-
| Template output looks broken
| Active template code may be mixed with documentation prose
| Keep active code inside <code><nowiki><includeonly></nowiki></code> and documentation inside <code><nowiki><noinclude></nowiki></code>
|-
| Documentation page creates unwanted blank space
| Extra line breaks around includeonly/noinclude tags
| Place tags tightly around template code
|}

== Related W8MD templates ==
* [[Template:Infobox public health]]
* [[Template:Infobox medical condition]]
* [[Template:Infobox medical intervention]]
* [[Template:Cite web]]
* [[Template:Cite journal]]
* [[Template:Short description]]
* [[Template:W8MD]]
* [[Template:GLP-1]]

== Technical notes ==
This template assumes that W8MD.com has ParserFunctions enabled if the main <code>Template:Documentation</code> uses <code><nowiki>{{#ifexist:}}</nowiki></code>.

The main template normally checks whether a documentation subpage exists. If it exists, the documentation is displayed. If it does not exist, the template displays a prompt to create one.

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

<templatedata>
{
"description": "Displays documentation for W8MD templates from a /doc subpage.",
"params": {
"1": {
"label": "Documentation page",
"description": "Optional custom documentation page to transclude instead of the default /doc page.",
"type": "wiki-page-name",
"required": false,
"example": "Template:Infobox public health/doc"
}
}
}
</templatedata>

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

Template:Documentation/doc - Revision history