Template:Biochem reaction arrow alt text/doc

From blackwiki
< Template:Biochem reaction arrow alt text
Revision as of 11:32, 17 September 2017 by imported>GKFX (Create docs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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 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.

Template parameters

ParameterDescriptionTypeStatus
Direction1

Either forward, reverse, or reversible

Auto value
forward
Stringrequired
Top left substrate/product2

Any content will cause an arrow from the top left to be described.

Auto value
Unknownoptional
Top right substrate/product3

Any content will cause an arrow from the top left to be described.

Auto value
Unknownoptional
Bottom right substrate/product4

Any content will cause an arrow from the top left to be described.

Auto value
Unknownoptional
Bottom left substrate/product5

Any content will cause an arrow from the top left to be described.

Auto value
Unknownoptional
Orientation6

Either horiz or vert.

Default
Horizontal orientation
Stringoptional