Difference between revisions of "Template:Biochem reaction arrow alt text/doc"
Jump to navigation
Jump to search
imported>GKFX (Create docs) |
imported>GKFX (→Usage: Correct and condense templatedata.) |
||
| Line 10: | Line 10: | ||
== Usage == | == Usage == | ||
| − | + | {{Format TemplateData|JSON= | |
{ | { | ||
"params": { | "params": { | ||
| Line 22: | Line 22: | ||
"2": { | "2": { | ||
"label": "Top left substrate/product", | "label": "Top left substrate/product", | ||
| − | "description": "Any content will cause an arrow from the top left to be described. | + | "description": "Any content will cause an arrow from the top left to be described." |
| − | |||
}, | }, | ||
"3": { | "3": { | ||
"label": "Top right substrate/product", | "label": "Top right substrate/product", | ||
| − | "description": "Any content will cause an arrow from the top | + | "description": "Any content will cause an arrow from the top right to be described." |
| − | |||
}, | }, | ||
"4": { | "4": { | ||
"label": "Bottom right substrate/product", | "label": "Bottom right substrate/product", | ||
| − | "description": "Any content will cause an arrow from the | + | "description": "Any content will cause an arrow from the bottom right to be described." |
| − | |||
}, | }, | ||
"5": { | "5": { | ||
"label": "Bottom left substrate/product", | "label": "Bottom left substrate/product", | ||
| − | "description": "Any content will cause an arrow from the | + | "description": "Any content will cause an arrow from the bottom left to be described." |
| − | |||
}, | }, | ||
"6": { | "6": { | ||
| Line 49: | Line 45: | ||
"description": "This template creates suitable alt text for the Biochem reaction arrow Y XXXX horiz/vert med.svg series of images. Designed for use in templates; consider writing alt text by hand in an article." | "description": "This template creates suitable alt text for the Biochem reaction arrow Y XXXX horiz/vert med.svg series of images. Designed for use in templates; consider writing alt text by hand in an article." | ||
} | } | ||
| − | + | }} | |
<includeonly>{{sandbox other|| | <includeonly>{{sandbox other|| | ||
Latest revision as of 17:29, 19 February 2018
| 40px | This is a documentation subpage for Template:Biochem reaction arrow alt text. It contains usage information, categories and other content that is not part of the original template page. |
This template creates suitable alt text for the Biochem reaction arrow Y XXXX horiz/vert med.svg series of images. It takes parameters in the same order as the images, so the alt text for
- [[File:Biochem reaction arrow forward YYNN horiz med.svg]]
is
- {{Biochem reaction arrow alt text|forward|subst|prod|||horiz}}
Note that subst and prod can be any values here, so if you get passed a substate on an optional parameter p, you can pass {{{p|}}} directly to this template, and the arrow will only be mentioned if the parameter is passed and non-blank. The result for this example is
- Rightward reaction arrow with minor substrate(s) from top left and minor product(s) to top right
Usage
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 Biochem reaction arrow alt text
This template creates suitable alt text for the Biochem reaction arrow Y XXXX horiz/vert med.svg series of images. Designed for use in templates; consider writing alt text by hand in an article.
| Parameter | Description | Type | Status | |
|---|---|---|---|---|
| Direction | 1 | Either forward, reverse, or reversible
| String | required |
| Top left substrate/product | 2 | Any content will cause an arrow from the top left to be described. | Unknown | optional |
| Top right substrate/product | 3 | Any content will cause an arrow from the top right to be described. | Unknown | optional |
| Bottom right substrate/product | 4 | Any content will cause an arrow from the bottom right to be described. | Unknown | optional |
| Bottom left substrate/product | 5 | Any content will cause an arrow from the bottom left to be described. | Unknown | optional |
| Orientation | 6 | Either horiz or vert.
| String | optional |