Difference between revisions of "Template:Enzymatic reaction/doc"

From blackwiki
Jump to navigation Jump to search
imported>GKFX
(Start doc subpage.)
 
imported>GKFX
(Conclude documentation page.)
Line 2: Line 2:
  
 
This template is part of [[Wikipedia:Wikiproject Metabolic Pathways|Metabolic Pathways WikiProject]].
 
This template is part of [[Wikipedia:Wikiproject Metabolic Pathways|Metabolic Pathways WikiProject]].
 +
 +
{{esoteric}}
  
 
{{TemplateDataHeader}}
 
{{TemplateDataHeader}}
Line 13: Line 15:
 
"description": "The name of the substrate.",
 
"description": "The name of the substrate.",
 
"required": true,
 
"required": true,
"type": "string"
+
"type": "content"
 
},
 
},
 
"forward_enzyme": {
 
"forward_enzyme": {
Line 19: Line 21:
 
"description": "The name of the forward enzyme.",
 
"description": "The name of the forward enzyme.",
 
"required": false,
 
"required": false,
"type": "string"
+
"type": "content"
 
},
 
},
 
"product": {
 
"product": {
Line 25: Line 27:
 
"description": "The name of the product.",
 
"description": "The name of the product.",
 
"required": true,
 
"required": true,
"type": "string"
+
"type": "content"
 
},
 
},
 
"substrate_image": {
 
"substrate_image": {
Line 31: Line 33:
 
"description": "The name of an image of the structure of the substrate. Do not include \"File:\".",
 
"description": "The name of an image of the structure of the substrate. Do not include \"File:\".",
 
"required": true,
 
"required": true,
"type": "string"
+
"type": "wiki-file-name"
 
},
 
},
 
"substrate_image_size": {
 
"substrate_image_size": {
 
"label": "Substrate image size",
 
"label": "Substrate image size",
 +
"description": "Substrate image size, in pixels, in the form \"70px\".",
 
"required": false,
 
"required": false,
 
"type": "string"
 
"type": "string"
Line 42: Line 45:
 
"description": "The name of an image of the structure of the product. Do not include \"File:\".",
 
"description": "The name of an image of the structure of the product. Do not include \"File:\".",
 
"required": true,
 
"required": true,
"type": "string"
+
"type": "wiki-file-name"
 
},
 
},
 
"product_image_size": {
 
"product_image_size": {
 
"label": "Product image size",
 
"label": "Product image size",
 +
"description": "Product image size, in pixels, in the form \"70px\".",
 
"required": false,
 
"required": false,
 
"type": "string"
 
"type": "string"
 
},
 
},
"forward_enzyme": {
+
"minor_forward_substrate(s)": {
"label": "Forward enzyme",
+
"label": "Minor forward substrate(s)",
"description": "The name of the forward enzyme.",
+
"description": "The name(s) of the minor forward substrate(s). Triggers appropriate arrow; use \" \" alone for an unlabelled arrow.",
 +
"required": false,
 +
"type": "content"
 +
},
 +
"minor_forward_product(s)": {
 +
"label": "Minor forward product(s)",
 +
"description": "The name(s) of the minor forward product(s). Triggers appropriate arrow; use \" \" alone for an unlabelled arrow.",
 +
"required": false,
 +
"type": "content"
 +
},
 +
"minor_reverse_substrate(s)": {
 +
"label": "Minor reverse substrate(s)",
 +
"description": "The name(s) of the minor reverse substrate(s). Triggers appropriate arrow; use \" \" alone for an unlabelled arrow.",
 +
"required": false,
 +
"type": "content"
 +
},
 +
"minor_reverse_product(s)": {
 +
"label": "Minor reverse product(s)",
 +
"description": "The name(s) of the minor reverse product(s). Triggers appropriate arrow; use \" \" alone for an unlabelled arrow.",
 +
"required": false,
 +
"type": "content"
 +
},
 +
"reverse_enzyme": {
 +
"label": "Reverse enzyme",
 +
"description": "The name of the reverse enzyme.",
 
"required": false,
 
"required": false,
 +
"type": "content"
 +
},
 +
"reaction_direction_(forward/reversible/reverse)": {
 +
"label": "Reaction direction",
 +
"description": "The direction of the arrow: \"forward\", \"reversible\", or \"reverse\".",
 +
"required": true,
 
"type": "string"
 
"type": "string"
 
}
 
}
Line 58: Line 92:
 
}
 
}
 
</templatedata>
 
</templatedata>
 
{| border="0" bgcolor="white"
 
|-
 
| align="center" bgcolor="lightgreen" | {{{substrate}}}
 
| colspan="2" align="center" bgcolor="{{#if:{{{forward_enzyme|}}}|pink|white}}" width="75px" | {{{forward_enzyme}}}
 
| align="center" bgcolor="lightgreen" | {{{product}}}
 
|-
 
| rowspan="5" align="center" | [[image:{{{substrate_image}}}{{#if:{{{substrate_image_size|}}}|{{!}}{{{substrate_image_size}}}|}}]]
 
| colspan="2" align="center" width="75" | &nbsp;
 
| rowspan="5" align="center" | [[image:{{{product_image}}}{{#if:{{{product_image_size|}}}|{{!}}{{{product_image_size}}}|}}]]
 
|-
 
| align="center" width="38px" | {{{minor_forward_substrate(s)}}}
 
| align="center" width="38px" | {{{minor_forward_product(s)}}}
 
|-
 
| colspan="2" width="75px" align="center" | [[image:Biochem_reaction_arrow_{{#if:{{{reaction_direction_(forward/reversible/reverse)|}}}|{{#ifeq:{{{reaction_direction_(forward/reversible/reverse)}}}|forward|forward|{{{reaction_direction_(forward/reversible/reverse)}}}}}|{{{reaction_direction_(forward/reversible/reverse)}}}}}_{{#if:{{{minor_forward_substrate(s)|}}}|Y|N}}{{#if:{{{minor_forward_product(s)|}}}|Y|N}}{{#if:{{{minor_reverse_substrate(s)|}}}|Y|N}}{{#if:{{{minor_reverse_product(s)|}}}|Y|N}}_horiz_med.png|75px]]
 
|-
 
| align="center" width="38px" | {{{minor_reverse_product(s)}}}
 
| align="center" width="38px" | {{{minor_reverse_substrate(s)}}}
 
|-
 
| colspan="2" align="center" width="75" | &nbsp;
 
|-
 
| &nbsp;
 
| colspan="2" align="center" bgcolor="{{#if:{{{reverse_enzyme|}}}|pink|white}}" width="75"| {{{reverse_enzyme}}}
 
| style="text-align:right;" |
 
|}
 
 
{{esoteric}}
 

Revision as of 16:06, 19 September 2015

This template should be used on enzyme pages to show the reactions that are produced and used by the enzyme, especially when part of a major biochemical pathway such as glycolysis.

This template is part of Metabolic Pathways WikiProject.

This is the TemplateData documentation for this template used by VisualEditor and other tools; see the monthly parameter usage report for this template.

TemplateData for Enzymatic reaction

This template should be used on enzyme pages to show the reactions that are produced and used by the enzyme, especially when part of a major biochemical pathway such as glycolysis.

Template parameters

ParameterDescriptionTypeStatus
Substratesubstrate

The name of the substrate.

Contentrequired
Forward enzymeforward_enzyme

The name of the forward enzyme.

Contentoptional
Productproduct

The name of the product.

Contentrequired
Substrate imagesubstrate_image

The name of an image of the structure of the substrate. Do not include "File:".

Filerequired
Substrate image sizesubstrate_image_size

Substrate image size, in pixels, in the form "70px".

Stringoptional
Product imageproduct_image

The name of an image of the structure of the product. Do not include "File:".

Filerequired
Product image sizeproduct_image_size

Product image size, in pixels, in the form "70px".

Stringoptional
Minor forward substrate(s)minor_forward_substrate(s)

The name(s) of the minor forward substrate(s). Triggers appropriate arrow; use "&amp;nbsp;" alone for an unlabelled arrow.

Contentoptional
Minor forward product(s)minor_forward_product(s)

The name(s) of the minor forward product(s). Triggers appropriate arrow; use "&amp;nbsp;" alone for an unlabelled arrow.

Contentoptional
Minor reverse substrate(s)minor_reverse_substrate(s)

The name(s) of the minor reverse substrate(s). Triggers appropriate arrow; use "&amp;nbsp;" alone for an unlabelled arrow.

Contentoptional
Minor reverse product(s)minor_reverse_product(s)

The name(s) of the minor reverse product(s). Triggers appropriate arrow; use "&amp;nbsp;" alone for an unlabelled arrow.

Contentoptional
Reverse enzymereverse_enzyme

The name of the reverse enzyme.

Contentoptional
Reaction directionreaction_direction_(forward/reversible/reverse)

The direction of the arrow: "forward", "reversible", or "reverse".

Stringrequired