Difference between revisions of "Template:Infobox drug class/doc"
imported>Boghog (→Usage: removed stray text) |
imported>DePiep (→TemplateData: +Width) |
||
| (11 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{Documentation subpage}} |
| + | <!-- Please place categories where indicated at the bottom of this page and interwikis at Wikidata (see [[</nowiki>[[Wikipedia:Wikidata]]<nowiki>]]) --> | ||
Use this template freely for any drug class article. | Use this template freely for any drug class article. | ||
| − | + | == Usage == | |
| − | The template does not at the current time include summary information about the drug class itself. Instead, it contains a consistent interface to other sources that provide information about the drug class. Don't worry about trying to fill in all the fields & | + | The template does not at the current time include summary information about the drug class itself. Instead, it contains a consistent interface to other sources that provide information about the drug class. Don't worry about trying to fill in all the fields – even if you can only get one or two, that still can be useful. |
While editing an article about a drug class, copy and paste the following text at the top of the page: | While editing an article about a drug class, copy and paste the following text at the top of the page: | ||
| Line 14: | Line 15: | ||
| Alt = {{{Alt}}} | | Alt = {{{Alt}}} | ||
| Caption = {{{Caption}}} | | Caption = {{{Caption}}} | ||
| + | | Pronounce = {{{Pronounce}}} | ||
| + | | Synonyms = {{{Synonyms}}} | ||
| + | --> | ||
<!-- Class identifiers --> | <!-- Class identifiers --> | ||
| + | <!-- | ||
| Use = {{{Use}}} | | Use = {{{Use}}} | ||
| ATC_prefix = {{{ATC_prefix}}} | | ATC_prefix = {{{ATC_prefix}}} | ||
| − | | Mode_of_action = {{{Mode_of_action}}} | + | | Mode_of_action = {{{Mode_of_action}}} |
| Mechanism_of_action = {{{Mechanism_of_action}}} | | Mechanism_of_action = {{{Mechanism_of_action}}} | ||
| Biological_target = {{{Biological_target}}} | | Biological_target = {{{Biological_target}}} | ||
| Line 27: | Line 32: | ||
| rxlist = {{{rxlist}}} | | rxlist = {{{rxlist}}} | ||
<!-- External links --> | <!-- External links --> | ||
| − | | MeshID = {{{MeshID}}} | + | | MeshID = {{{MeshID}}}--> |
}} | }} | ||
<pre style="overflow: auto"> | <pre style="overflow: auto"> | ||
{{Infobox drug class | {{Infobox drug class | ||
| − | | Name | + | | Name = <!-- omit to use page name --> |
| − | | Image | + | | Image = |
| − | | Alt | + | | Alt = |
| − | | Caption = | + | | Caption = |
| + | | Pronounce = | ||
| + | | Synonyms = | ||
<!-- Class identifiers --> | <!-- Class identifiers --> | ||
| − | | Use | + | | Use = |
| − | | ATC_prefix | + | | ATC_prefix = |
| − | | Mode_of_action = | + | | Mode_of_action = |
| Mechanism_of_action = | | Mechanism_of_action = | ||
| − | | Biological_target = | + | | Biological_target = |
| − | | Chemical_class = | + | | Chemical_class = |
<!-- Clinical data --> | <!-- Clinical data --> | ||
| − | | Drugs.com | + | | Drugs.com = <!-- {{Drugs.com|drug-class|?}} --> |
| − | | Consumer_Reports | + | | Consumer_Reports = |
| − | | medicinenet | + | | medicinenet = |
| − | | rxlist | + | | rxlist = |
<!-- External links --> | <!-- External links --> | ||
| − | | MeshID | + | | MeshID = |
}} | }} | ||
</pre> | </pre> | ||
| Line 56: | Line 63: | ||
=== Name === | === Name === | ||
| − | + | This field lists the full name of the drug class, ideally from a nomenclature authority like ATC. | |
=== Image === | === Image === | ||
| − | + | This field specifies an image file that displays the chemical structure of a representative example (e.g., the first-in-class) drug from this class. | |
| + | |||
| + | === Use === | ||
| + | |||
| + | <pre> | ||
| + | | Use = | ||
| + | | ATC_prefix = | ||
| + | | Mode_of_action = | ||
| + | | Mechanism_of_action = | ||
| + | | Biological_target = | ||
| + | | Chemical_class = | ||
| + | </pre> | ||
| + | |||
| + | * '''ATC_prefix''' If available, the [[ATC code]] prefix should be added to the drug class box. | ||
| + | * '''Mode_of_action''' The cellular [[mode of action]]. | ||
| + | * '''Mechanism_of_action''' If known, The molecular [[mechanism of action]] of the drug class. For example, a receptor [[agonist]], [[receptor antagonist|antagonist]], [[inverse agonist]], or [[selective receptor modulator|modulator]]; enzyme [[enzyme activator|activator]] or [[enzyme inhibitor|inhibitor]]; or ion channel [[channel opener|opener]] or [[channel blocker|blocker]]. | ||
| + | * '''Biological_target''' If known, the [[biological target]] of the drug class. | ||
| + | * '''Chemical_class''' If appropriate (the class is defined by a specific type of chemical structure) this should be specified in this parameter. | ||
| + | |||
| + | === Clinical data === | ||
| + | |||
| + | <pre> | ||
| + | | Drugs.com = <!-- {{Drugs.com|drug-class|?}} --> | ||
| + | | Consumer_Reports = | ||
| + | | medicinenet = | ||
| + | | rxlist = | ||
| + | </pre> | ||
| + | |||
| + | * '''Drugs.com''' – link to Drugs.com drug class | ||
| + | * '''MedlinePlus''' – MedlinePlus drug accession number | ||
| + | * '''medicinenet''' | ||
| + | * '''rxlist''' | ||
| + | |||
| + | == External links == | ||
| + | |||
| + | <pre>| MeshID =</pre> | ||
| + | |||
| + | ==TemplateData== | ||
| + | {{TemplateData header}} | ||
| + | <templatedata> | ||
| + | { | ||
| + | "params": { | ||
| + | "Name": {}, | ||
| + | "Image": {}, | ||
| + | "Alt": {}, | ||
| + | "Caption": {}, | ||
| + | "Pronounce": {}, | ||
| + | "Synonyms": {}, | ||
| + | "Use": {}, | ||
| + | "ATC_prefix": {}, | ||
| + | "Mode_of_action": {}, | ||
| + | "Mechanism_of_action": {}, | ||
| + | "Biological_target": {}, | ||
| + | "Chemical_class": {}, | ||
| + | "Drugs.com": {}, | ||
| + | "Consumer_Reports": {}, | ||
| + | "medicinenet": {}, | ||
| + | "rxlist": {}, | ||
| + | "MeshID": {}, | ||
| + | "Width": {} | ||
| + | } | ||
| + | } | ||
| + | </templatedata> | ||
| − | + | <includeonly>{{sandbox other|| | |
| − | + | <!-- Categories below this line, please; interwikis at Wikidata --> | |
| + | [[Category:Medicine infobox templates]] | ||
| + | }}</includeonly> | ||
Latest revision as of 14:35, 5 July 2020
| This is a documentation subpage for Template:Infobox drug class. It contains usage information, categories and other content that is not part of the original template page. |
Use this template freely for any drug class article.
Contents
Usage
The template does not at the current time include summary information about the drug class itself. Instead, it contains a consistent interface to other sources that provide information about the drug class. Don't worry about trying to fill in all the fields – even if you can only get one or two, that still can be useful.
While editing an article about a drug class, copy and paste the following text at the top of the page:
| {{{Name}}} | |
|---|---|
| Drug class | |
| [[File:{{{Image}}}|frameless|alt={{{Alt}}}|upright=1.25|{{{Alt}}}]] {{{Caption}}} | |
| Pronunciation | {{{Pronounce}}} |
| Synonyms | {{{Synonyms}}} --> |
| Clinical data | |
| Drugs.com | {{{Drugs.com}}} |
| Consumer Reports | Best Buy Drugs |
| WebMD | MedicineNet RxList |
| External links | |
| MeSH | > {{{MeshID}}}--> |
| [[d:Template:Wikidata |In Wikidata]] | |
{{Infobox drug class
| Name = <!-- omit to use page name -->
| Image =
| Alt =
| Caption =
| Pronounce =
| Synonyms =
<!-- Class identifiers -->
| Use =
| ATC_prefix =
| Mode_of_action =
| Mechanism_of_action =
| Biological_target =
| Chemical_class =
<!-- Clinical data -->
| Drugs.com = <!-- {{Drugs.com|drug-class|?}} -->
| Consumer_Reports =
| medicinenet =
| rxlist =
<!-- External links -->
| MeshID =
}}
Parameter explanations
Name
This field lists the full name of the drug class, ideally from a nomenclature authority like ATC.
Image
This field specifies an image file that displays the chemical structure of a representative example (e.g., the first-in-class) drug from this class.
Use
| Use = | ATC_prefix = | Mode_of_action = | Mechanism_of_action = | Biological_target = | Chemical_class =
- ATC_prefix If available, the ATC code prefix should be added to the drug class box.
- Mode_of_action The cellular mode of action.
- Mechanism_of_action If known, The molecular mechanism of action of the drug class. For example, a receptor agonist, antagonist, inverse agonist, or modulator; enzyme activator or inhibitor; or ion channel opener or blocker.
- Biological_target If known, the biological target of the drug class.
- Chemical_class If appropriate (the class is defined by a specific type of chemical structure) this should be specified in this parameter.
Clinical data
| Drugs.com = <!-- {{Drugs.com|drug-class|?}} -->
| Consumer_Reports =
| medicinenet =
| rxlist =
- Drugs.com – link to Drugs.com drug class
- MedlinePlus – MedlinePlus drug accession number
- medicinenet
- rxlist
External links
| MeshID =
TemplateData
TemplateData for Infobox drug class
No description.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Name | Name | no description | Unknown | optional |
| Image | Image | no description | Unknown | optional |
| Alt | Alt | no description | Unknown | optional |
| Caption | Caption | no description | Unknown | optional |
| Pronounce | Pronounce | no description | Unknown | optional |
| Synonyms | Synonyms | no description | Unknown | optional |
| Use | Use | no description | Unknown | optional |
| ATC_prefix | ATC_prefix | no description | Unknown | optional |
| Mode_of_action | Mode_of_action | no description | Unknown | optional |
| Mechanism_of_action | Mechanism_of_action | no description | Unknown | optional |
| Biological_target | Biological_target | no description | Unknown | optional |
| Chemical_class | Chemical_class | no description | Unknown | optional |
| Drugs.com | Drugs.com | no description | Unknown | optional |
| Consumer_Reports | Consumer_Reports | no description | Unknown | optional |
| Medicinenet | medicinenet | no description | Unknown | optional |
| Rxlist | rxlist | no description | Unknown | optional |
| MeshID | MeshID | no description | Unknown | optional |
| Width | Width | no description | Unknown | optional |