Template:Script directionality/doc

Usage
The template looks for a text-direction image that matches the directionality provided in the template call. It also provides standard abbreviations or descriptions for the given directionality.



Values for Direction field
Direction and the named fields traditional, historic, or modern, should be one of the following values:

* Codes marked with an asterisk have alternate codes, displayed in the last column.


 * Note that many of the alternate codes resolve to the most common writing directions, and may not be universally applicable (eg, not all vertical writing systems are written Top to Bottom, in lines from Right to Left).

Values for DirText and LabelText fields
DirText and LabelText can take one of the standard values or user-defined text:


 * Note that only the Full and Expanded styles fully differentiate all writing directions.

Size field
The size of the graphic can be controlled using the size field. Unlike direction and text, the size field must be explicitly called with "size=". Since the icons are square, the image size can be set to a one-dimensional pixel value that corresponds to both the width and height. The size parameter does not effect the "?" of undefined text directions, except size=0 (see below). The default value is size=20px, for use in running text.

Example: produces

The size field can also be set to "0" (zero) or "0px" in order to render only the directional text. This will also blank the "?" of an undefined text direction.

Example: produces

Historic, Traditional, and Modern fields
The fields historic, traditional, and modern can be used to generate multiple labeled directionalities in addition to a single unlabeled one. Historic, traditional, and modern take the same values as the direction field, above. A blank direction field should be included if the Values for DirText field and Values for LabelText field, above are used, as the first unlabeled field will not be interpreted as those fields. Unless the historic, traditional, and modern fields are defined, the third unlabeled field will not be interpreted.

Example: produces

Templates and files used
The workhorse of this template is a dependent file, /core, and most alterations to the function of the template need to be made there.
 * Images: