Template:Script directionality/doc: Difference between revisions

Revision as of 22:26, 17 August 2011

Latest revision as of 01:46, 6 March 2025

(35 intermediate revisions by 7 users not shown)

Line 1:

{{Documentation subpage}}

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

* <nowikicode>{{TextDirtlx|directionScript directionality|DirText<!--nocat{{=}}|-->direction|historic{{=}}direction|traditional{{=}}direction|modern{{=}}direction|DirText|LableText|size{{=}}?px}}</nowikicode>

<!--===ValuesAutomatic forscript Directiondirection categories and ''nocat'' field===

'''Direction''',The ortemplate automatically assigns script direction categories based on the namedinput fieldsto the ''direction'', ''traditional''''', '''''historic''''', orand '''''modern'' fields. This can be overridden by setting ''nocat=yes','. shouldAny beinput besides ''yes'' onewill ofretain the followingautomatic values:categorization.-->

===Values for direction field===

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

{| class="wikitable"

!colspan="2"|Text directions !!colspan="5"|Input codes (case insensitive) and associated graphic

|-

| '''DirectionWord:''' || style="text-align:right;" | '''Line:''' || style="text-align:center;" | Down || alignstyle="text-align:center;" | Up || alignstyle="text-align:center;" | Left || alignstyle="text-align:center;" | Right || alignstyle="text-align:center;" | Alternate codes (matches '''*''' code)

|-

|colspan="2"| Right-to-left || '''''RL-TB'' *''' {{TextDirScript directionality|RTL|none}} || '''''RL-BT''''' {{TextDirScript directionality|RL-BT|none}}|| alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | '''''RTL''''', '''''R2L''''', '''''right-to-left''''', or '''''leftwards'''''

|-

|colspan="2"| Left-to-right || '''''LR-TB'' *''' {{TextDirScript directionality|LTR|none}} || '''''LR-BT''''' {{TextDirScript directionality|LR-BT|none}}|| alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | '''''LTR''''', '''''L2R''''', '''''left-to-right''''', or '''''rightwards'''''

|-

|colspan="2"| Top-to-bottom || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || '''''TB-RL'' *''' {{TextDirScript directionality|TB-RL|none}} || '''''TB-LR''''' {{TextDirScript directionality|TB-LR|none}} || alignstyle="text-align:center;" | '''''Vertical'''''

|-

|colspan="2"| Bottom-to-top || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || '''''BT-RL''''' {{TextDirScript directionality|BT-RL|none}} || '''''BT-LR''''' {{TextDirScript directionality|BT-LR|none}} || alignstyle="text-align:center;" |

|-

|colspan="2"| Boustrophedon (RL,LR) || '''''RLR-TB'' *''' {{TextDirScript directionality|RLR-TB|none}} || '''''RLR-BT''''' {{TextDirScript directionality|RLR-BT|none}}|| alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | '''''Boustrophedon'''''

|-

|colspan="2"| Boustrophedon (LR,RL) || '''''LRL-TB''''' {{TextDirScript directionality|LRL-TB|none}} || '''''LRL-BT''''' {{TextDirScript directionality|LRL-BT|none}}|| alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" |

|-

|colspan="2"| Vertical boustrophedon (TB,BT) || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || '''''TBT-RL''''' {{TextDirScript directionality|TBT-RL|none}}|| '''''TBT-LR''''' {{TextDirScript directionality|TBT-LR|none}} || alignstyle="text-align:center;" |

|-

|colspan="2"| Vertical boustrophedon (BT,TB) || alignstyle="text-align:center;" | &ndash; || alignstyle="text-align:center;" | &ndash; || '''''BTB-RL''''' {{TextDirScript directionality|BTB-RL|none}}|| '''''BTB-LR''''' {{TextDirScript directionality|BTB-LR|none}} || alignstyle="text-align:center;" |

|-

|colspan="2"| Variable direction || '''''H-TB''''' {{TextDirScript directionality|H-TB|none}} || '''''H-BT''''' {{TextDirScript directionality|H-BT|none}}|| '''''V-RL''''' {{TextDirScript directionality|V-RL|none}}|| '''''V-LR''''' {{TextDirScript directionality|V-LR|none}} || alignstyle="text-align:center;" |

|-

!colspan="2"| !! colspan="45"| Swirls

|-

|colspan="2"| || colspan="2" align=center| Outwards || colspan="2" align=center| Inwards || alignstyle="text-align:center;" | Alternate codes (matches '''*''' code)

|-

|colspan="2"| Clockwise || colspan="2" align=center| '''''Ck-Out'' *''' {{TextDirScript directionality|Ck-Out|none}} || colspan="2" align=center| '''''Ck-In'' *''' {{TextDirScript directionality|Ck-In|none}} || alignstyle="text-align:center;" | '''''CW-Out''''', and '''''CW-In'''''

|-

|colspan="2"| Withershins || colspan="2" align=center| '''''WS-Out'' *''' {{TextDirScript directionality|WS-Out|none}} || colspan="2" align=center| '''''WS-In'' *''' {{TextDirScript directionality|WS-In|none}} || alignstyle="text-align:center;" | '''''AC-Out''''' or '''''CC-Out''''', and '''''AC-In''''' or '''''CC-In'''''

|-

!colspan="2"| !! colspan="5" align=center | Other codes and display

|-

|colspan="2"| Other || colspan="5"| Up-Right-Down: '''''BTRB''''' {{TextDirScript directionality|BTRB|none}}

|-

|colspan="2"| Unsupported (ex. "Wave") || colspan="5"| {{TextDirScript directionality|Wave|}}

|}

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

* Note that many of the alternate codes resolve to athe defaultmost common writing directiondirections, thatand may not be universally applicable (eg,e.g. not all vertical writing systems are written Top to Bottom, in lines from Right to Left).

===Values for DirText and LabelText fields===

Line 55 ⟶ 60:

{| class="wikitable"

!Style!!direction!!DirText produces!!<nowiki>TextDirScript directionality|historic=LTR</nowiki>!!LabelText produces!!<nowiki>TextDirScript directionality|traditional=LTR</nowiki>!!LabelText produces!!<nowiki>TextDirScript directionality|modern=LTR</nowiki>!!LabelText produces

|-

|Full||<nowiki>{{TextDirtlx|Script directionality|LTR|full}}</nowiki>||{{TextDirScript directionality|LTR|full}}

|<code><nowiki>LTR||none|full</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|full}}

|<code><nowiki>LTR||none|full</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|full}}

|<code><nowiki>LTR||none|full</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|full}}

|-

|Expanded||<nowiki>{{TextDirtlx|Script directionality|LTR|exp}}</nowiki>||{{TextDirScript directionality|LTR|exp}}

|<code><nowiki>LTR||none|exp</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|exp}}

|<code><nowiki>LTR||none|exp</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|exp}}

|<code><nowiki>LTR||none|exp</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|exp}}

|-

|''Short''||<nowiki>{{TextDirtlx|Script directionality|LTR|short}}</nowiki>||{{TextDirScript directionality|LTR|short}}

|<code><nowiki>LTR||none|short</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|short}}

|<code><nowiki>LTR||none|short</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|short}}

|<code><nowiki>LTR||none|short</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|short}}

|-

|''In-Line''||<nowiki>{{TextDirtlx|Script directionality|LTR|words}}</nowiki>||{{TextDirScript directionality|LTR|words}}

|<code><nowiki>LTR||none|words</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|words}}

|<code><nowiki>LTR||none|words</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|words}}

|<code><nowiki>LTR||none|words</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|words}}

|-

|''Default''||<nowiki>{{TextDirtlx|Script directionality|LTR|}}</nowiki>||{{TextDirScript directionality|LTR|}}

|<code><nowiki>LTR||none|</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|}}

|<code><nowiki>LTR||none|</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|}}

|<code><nowiki>LTR||none|</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|}}

|-

|Custom||<nowiki>{{TextDirtlx|Script directionality|LTR|Your text}}</nowiki>||{{TextDirScript directionality|LTR|Your text}}

|<code><nowiki>LTR||none|Your text</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|Your text}}

|<code><nowiki>LTR||none|Your text</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|Your text}}

|<code><nowiki>LTR||none|Your text</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|Your text}}

|-

|Blank||<nowiki>{{TextDirtlx|Script directionality|LTR|none}}</nowiki>||{{TextDirScript directionality|LTR|none}}

|<code><nowiki>LTR||none|none</nowiki></code>||{{TextDirScript directionality|historic=LTR||none|none}}

|<code><nowiki>LTR||none|none</nowiki></code>||{{TextDirScript directionality|traditional=LTR||none|none}}

|<code><nowiki>LTR||none|none</nowiki></code>||{{TextDirScript directionality|modern=LTR||none|none}}

|-

|'''Multiples'''||colspan=8|<nowiki>{{TextDirtlx|Script directionality|RLR-TB|historic{{=}}LTR|modern{{=}}TB-LR|traditional{{=}}Ck-Out|words|words}}</nowiki> produces {{TextDirScript directionality|RLR-TB|historic=LTR|modern=TB-LR|traditional=Ck-Out|words|words}}

|}

* Note that only the Short, In-Line,Full and DefaultExpanded styles mayfully under-differentiate the possibleall writing directions.

===Size field===

Line 101 ⟶ 106:

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: <nowiki>{{TextDirtlx|Script directionality||RLR-TB|full|size=50px}}</nowiki> produces {{TextDirScript directionality|RLR-TB|full|size=50px}}

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: <nowiki>{{TextDirtlx|Script directionality||RTL|full|size=0}}</nowiki> produces {{TextDirScript directionality|RTL|full|size=0}}

===Historic, Traditional, and Modern fields===

Line 111 ⟶ 116:

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 [[#Values for Direction field|direction field, above]]. A blank direction field should be included if the [[#Values for DirText and LabelText fields|Values for DirText field]] and [[#Values for DirText and LabelText fields|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:<br /><code><nowiki>{{TextDirScript directionality|||traditional=BT-LR|modern=LR-TB|exp}}</nowiki></code><br />
:produces<br />
{{TextDirScript directionality||traditional=BT-LR|modern=LR-TB|exp}}

==Templates and files used==

The workhorse of this template is a dependent file, [[template:TextDirScript directionality/maincore|/maincore]], and most alterations to the function of the template need to be made there.

;Images:

<div class="skin-invert-image">

[[File:text_direction_WitherOut.svg|30px]]

[[File:text_direction_RorLdown.svg|30px]]

[[File:text_direction_RorLup.svg|30px]]

[[File:text_direction_UorDleft.svg|30px]]

[[File:text_direction_UorDright.svg|30px]]

[[File:text_direction_WitherIn.svg|30px]]

[[File:text_direction_BUleft.svg|30px]]

[[File:text_direction_BUright.svg|30px]]

[[File:text_direction_BousBleft.svg|30px]]

[[File:text_direction_BousBright.svg|30px]]

[[File:text_direction_BousLdown.svg|30px]]

[[File:text_direction_BousLup.svg|30px]]

[[File:text_direction_BousRdown.svg|30px]]

[[File:text_direction_BousRup.svg|30px]]

[[File:text_direction_BousTleft.svg|30px]]

[[File:text_direction_BousTright.svg|30px]]

[[File:text_direction_ClockIn.svg|30px]]

[[File:text_direction_ClockOut.svg|30px]]

[[File:text_direction_LTRdown.svg|30px]]

[[File:text_direction_LTRup.svg|30px]]

[[File:text_direction_RTLdown.svg|30px]]

[[File:text_direction_RTLup.svg|30px]]

[[File:text_direction_TDleft.svg|30px]]

[[File:text_direction_TDright.svg|30px]]

[[File:text_direction_URD.svg|30px]]

</div>

{{TemplateData}}

==See also==

:[[:c:Category:Script directionality]] -- has all these images

<includeonly>{{Sandbox other||

==Dependent files==

<!-- Categories below this line -->

The workhorse of this template is a dependent file, [[template:TextDir/main|/main]], and most alterations to the function of the template need to be made there.

[[Category:Direction-related icon templates]]

}}</includeonly>