Template:Infobox medical intervention

   Template documentation

   No documentation subpage exists yet.

   You can create documentation for this template at Template:Infobox medical intervention/doc.

   Suggested documentation sections:
   * == Usage ==
   * == Parameters ==
   * == Examples ==
   * == See also ==
   * <includeonly>[[Category:Templates]]</includeonly>

Documentation helper template for displaying template documentation subpages

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

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:

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

A typical template page should look like this:

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

Custom documentation page

By default, this template transcludes documentation from:

{{FULLPAGENAME}}/doc

You can also specify a custom documentation page:

{{Documentation|Template:Example/doc}}

Recommended /doc page structure

A good documentation subpage usually includes:

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

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 /doc page, not the main template page.
• Place categories inside <includeonly>...</includeonly> on the documentation page.
• Use <noinclude>{{Documentation}}</noinclude> at the bottom of templates.
• Use <nowiki>...</nowiki> or <pre>...</pre> when showing template code examples.

See also

• Template:Infobox public health
• Template:Cite web
• Template:Cite journal
• Help:Template
• Help:Transclusion

Usage

{{Infobox medical intervention
| name = Anti-obesity drugs
| image = 
| image_size = 220px
| alt = 
| caption = 
| synonyms = Weight loss medications, obesity pharmacotherapy
| specialty = [[Obesity medicine]], [[endocrinology]]
| uses = [[Obesity]], [[overweight]], [[weight management]]
| types = [[GLP-1 receptor agonist]]s, [[appetite suppressant]]s, [[fat absorption inhibitor]]s
| medication = [[Semaglutide]], [[tirzepatide]], [[phentermine]], [[orlistat]]
| mechanism = Appetite reduction, satiety enhancement, fat absorption inhibition
| benefits = Weight loss and improvement in obesity-related risk factors
| risks = Gastrointestinal symptoms, medication interactions, contraindications
| contraindications = Pregnancy, selected endocrine tumors, severe disease depending on drug
| monitoring = Weight, BMI, waist circumference, blood pressure, side effects
| provider = [[Physician]], [[obesity medicine]] specialist
| related = [[Medical weight loss]], [[diet]], [[exercise]], [[sleep apnea]]
}}

Parameters

• name - Name of the intervention.
• image - Optional image filename without the File: prefix.
• image_size - Optional image size; default is 220px.
• alt - Optional image alt text.
• caption - Optional image caption.
• synonyms - Alternative names.
• specialty - Medical specialty.
• uses - Main clinical uses.
• types - Types or classes.
• procedure - Procedure or intervention description.
• medication - Relevant medications.
• mechanism - Mechanism of action.
• benefits - Potential benefits.
• risks - Risks or adverse effects.
• contraindications - Contraindications or cautions.
• duration - Duration of treatment.
• frequency - Frequency of treatment.
• monitoring - Monitoring requirements.
• provider - Type of provider.
• related - Related topics.