Template:Script directionality/doc
![]() | This is a documentation subpage for Template:Script directionality. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
[edit]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.
{{Script directionality|direction|historic=direction|traditional=direction|modern=direction|DirText|LableText|size=?px}}
Values for Direction field
[edit]Direction and the named fields traditional, historic, or modern, should be one of the following values:
Text Directions | Input codes (case insensitive) and associated graphic | |||||
---|---|---|---|---|---|---|
Word: | Line: | Down | Up | Left | Right | Alternate codes (matches * code) |
Right-to-left | RL-TB * ![]() |
RL-BT ![]() |
– | – | RTL, R2L, right-to-left, or leftwards | |
Left-to-right | LR-TB * ![]() |
LR-BT ![]() |
– | – | LTR, L2R, left-to-right, or rightwards | |
Top-to-bottom | – | – | TB-RL * ![]() |
TB-LR ![]() |
Vertical | |
Bottom-to-top | – | – | BT-RL ![]() |
BT-LR ![]() |
||
Boustrophedon (RL,LR) | RLR-TB * ![]() |
RLR-BT ![]() |
– | – | Boustrophedon | |
Boustrophedon (LR,RL) | LRL-TB ![]() |
LRL-BT ![]() |
– | – | ||
Vertical boustrophedon (TB,BT) | – | – | TBT-RL ![]() |
TBT-LR ![]() |
||
Vertical boustrophedon (BT,TB) | – | – | BTB-RL ![]() |
BTB-LR ![]() |
||
Variable direction | H-TB ![]() |
H-BT ![]() |
V-RL ![]() |
V-LR ![]() |
||
Swirls | ||||||
Outwards | Inwards | Alternate codes (matches * code) | ||||
Clockwise | Ck-Out * ![]() |
Ck-In * ![]() |
CW-Out, and CW-In | |||
Withershins | WS-Out * ![]() |
WS-In * ![]() |
AC-Out or CC-Out, and AC-In or CC-In | |||
Other codes and display | ||||||
Other | Up-Right-Down: BTRB ![]() | |||||
Unsupported (ex. "Wave") | ? Wave |
* 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
[edit]DirText and LabelText can take one of the standard values or user-defined text:
Style | direction | DirText produces | Script directionality|historic=LTR | LabelText produces | Script directionality|traditional=LTR | LabelText produces | Script directionality|modern=LTR | LabelText produces |
---|---|---|---|---|---|---|---|---|
Full | {{Script directionality|LTR|full}} |
![]() |
||none|full |
Historic:![]() |
||none|full |
Traditional:![]() |
||none|full |
Modern:![]() |
Expanded | {{Script directionality|LTR|exp}} |
![]() |
||none|exp |
Historic:![]() |
||none|exp |
Traditional:![]() |
||none|exp |
Modern:![]() |
Short | {{Script directionality|LTR|short}} |
![]() |
||none|short |
(Hist)-![]() |
||none|short |
(Trad)-![]() |
||none|short |
(Mod)-![]() |
In-Line | {{Script directionality|LTR|words}} |
![]() |
||none|words |
historically,![]() |
||none|words |
traditionally,![]() |
||none|words |
modern,![]() |
Default | {{Script directionality|LTR}} |
![]() |
||none| |
Hist:![]() |
||none| |
Trad:![]() |
||none| |
Mod:![]() |
Custom | {{Script directionality|LTR|Your text}} |
![]() |
||none|Your text |
Your text![]() |
||none|Your text |
Your text![]() |
||none|Your text |
Your text![]() |
Blank | {{Script directionality|LTR|none}} |
![]() |
||none|none |
![]() |
||none|none |
![]() |
||none|none |
![]() |
Multiples | {{Script directionality|RLR-TB|historic=LTR|modern=TB-LR|traditional=Ck-Out|words|words}} produces ![]() ![]() ![]() ![]() |
- Note that only the Full and Expanded styles fully differentiate all writing directions.
Size field
[edit]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: {{Script directionality|RLR-TB|full}}
produces Boustrophedon (right-left, left-right), down the page
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: {{Script directionality|RTL|full}}
produces Right-to-Left, down the page
Historic, Traditional, and Modern fields
[edit]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: {{Script directionality|exp}}
produces Trad: Bottom-Up (right), Mod:
Left-to-Right (down)
Templates and files used
[edit]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
view] [edit] [history] [purge]
[TemplateData for Script directionality
Template for displaying graphic and description of script directionality
Parameter | Description | Type | Status | |
---|---|---|---|---|
Direction | 1 | Main script directionality
| String | required |
historic | historic | Historic script directionality
| String | optional |
traditional | traditional | Traditional script directionality
| String | optional |
modern | modern | Modern script directionality
| String | optional |
Dir-Text | 2 | Text direction description
| String | optional |
Label Text | 3 | Text directionality label
| String | optional |
Size | size | Image size
| String | optional |
See also
[edit]- c:Category:Script directionality -- has all these images