View source for Template:Braille cell/doc

{{Documentation subpage}}
{{Uses TemplateStyles|Template:Braille cell/styles.css|noprotcat=yes}}
<!-- Categories and interwikis go at the bottom of this page. -->

* Basic usage, inline: {{tlx|Braille cell|<nowiki>A|B|C</nowiki>}} &rarr; {{Braille cell|A|B|C}}
* Images: {{tlx|Braille cell|<nowiki>A|B|C|type=image|size=15px</nowiki>}} &rarr; {{Braille cell|A|B|C|type=image|size=15px}}
* All parameters:
:{{tlx|Braille cell|<nowiki>code1|code2|code3|...|lang=|type=|size=|caption=|background=</nowiki>}}
By default the braille language is ''English braille'' (grade 2), and any abstract form ("dots-136").
* [[WP:Substitution|Substituted]]: {{tlsx|Braille cell|code1}}

==Usage overview==
'''code1, 2, 3, ...'''. Letter definitions to be translated to a braille cell (case insensitive, A=a). Only the first unnamed parameter is evaluated when this template is substituted, and only [[#Braille cell definitions (dot numbering)|dot patterns]] in numeric order are valid input.

'''[[#lang|lang]]''' for the ''braille language''. Four braille languages are recognised: [[Grade 2 braille|English (grade 2)]], [[French Braille|French]], [[Japanese braille|Japanese]] and [[Korean braille|Korean]] braille. English (grade 2) braille is default so doesn't have to be entered, the other languages should be defined (e.g. {{code|1=<nowiki>lang=Japanese</nowiki>}}).

[[Template:Braille cell/types|'''type''']]. Type of braille cell to be shown: 6-dot cell image, 8-dot cell image, in-line text character {{code|1=6, 6dot, 8, 8dot, image, text}}. The default is text (inline font character). For Japanese and Korean braille script, entering {{code|1=<nowiki>type=Korean</nowiki>}} produces illustrative colored braille cells (see [[Korean braille]]). These two types are default for their languages.

'''[[#size|size]]'''. Width size of the image (in {{code|1=px}}) of font-size of the inline text (like %, em, px). Add the unit to the number (e.g. {{code|1=<nowiki>size=20px</nowiki>}} for 6dot/8dot images, and {{code|1=10px, 2em, 150%}} for fontsize).

'''[[#caption|caption]]'''. A descriptive caption (mouse hover text) for a braille character is added. It can be shortened to the simple definition ({{code|1=caption=}} (&lt;blank>), and be hidden ({{code|1=caption=no}}).

'''[[#background|background]]''' or '''bg'''. Sets the background color. For {{code|1=type=text}} only. Default is {{code|1=#f4f4f4}}. Examples:
* {{tlx|Braille cell|<nowiki>K|L|M|type=text</nowiki>}} &rarr; {{Braille cell|K|L|M|type=text}}
* {{tlx|Braille cell|<nowiki>K|L|M|type=text|background=yellow</nowiki>}} &rarr; {{Braille cell|K|L|M|type=text|background=yellow}}
* {{tlx|Braille cell|<nowiki>K|L|M|type=text|background=transparent</nowiki>}} &rarr; {{Braille cell|K|L|M|type=text|background=transparent}}

==Input values==
Possible input: plain text and various braille cell definitions (see below). Up to 20 cells can be indicated in a single call to the template, each dot pattern separated with a pipe character "|". Skipping a code is read as a blank cell (e.g. {{code|1=<nowiki>{{braille cell|A||b|o|o|k</nowiki>}} introduces a blank cell after "A").
All defined input values will output a single [[Braille]] cell.

Acceptable input values to produce braille cells are of the following types:

===Letters===
''Simple English letters'' - capital or lower case: "A", "c", "X", "W", "z", etc. Valid for 6-dot, 8-dot, text, and Japanese type cells.

''Accented French letters'' - capital or lower case: "È", "Ö", "å", etc.

''Double letters and words'' - capital or lower case: "st", "SH", "for", "Th", "ing", etc.

''Japanese letters'' - [[Katakana]], [[hiragana]], and Japanese diacritics (e.g. "dakuten", "chōon", "-Y-", etc.) are valid input for 6-dot, 8-dot, text, and Japanese cell types, with [[Romaji]] valid for Japanese cells only.

''Korean letters'' - The {{tla|Unicode chart Hangul Jamo|positional Hangul jamo}} are valid input for 6-dot, 8-dot, text, and Korean cell types, with Revised Romanization (X- for initial, -X for final consonants) valid for Korean cells only.

===Other characters===
''Numbers'' - prefixed with a number sign: "#0" (="J"), "#7" (="G"), etc.

''Punctuation'' - signs or names: "exclamation", ".", "openquote", "bracket", etc.

''Other symbols'' - "null" or "blank", "accent" or "`", "contraction" or "contr2", "capital", "decimal", "contr3" or "space" (dots 4+5), "correction", "cursive" or "contr1", "number" or "#".

'''Notes''' - For the question mark "?" in French, use {{code|1=lang=French}}. Otherwise it will produce (default) the English braille. The French "space" is the third English Braille contraction prefix, while English Braille space is "blank" or "null", and French "cursive" is the first English Braille contractions prefix.

=== Braille cell definitions (dot numbering) ===
[[File:Braille8dotCellNumbering.svg|thumb|right|60px|8-dot [[Braille]] cell dot numbers. Dots 7 and 8 are not found on a 6-dot Braille cell.]]
Four options can be used in this Braille cell template to produce a cell, and all are case-insensitive (A=a).
* {{tlx|braille cell|type=text|1234|1423|⠏|U+280F||u+280f}} &rarr; {{braille cell|type=text|1234|1423|⠏|U+280F|u+280f}}
Note that this cell definition is unrelated to any language (no "A" assigned).

A braille cell is defined by '''naming the raised dots'''. In 6-dot notation there are 64 combinations, in 8-dot notation this number is 256 (including all 6-dot cells). Such a definition is ''independent'' of the braille language (there is no connection with a letter ''A''; this is for the Braille language to add).

Using the cell numbering shown here, one can simply mention the raised dots: say dots-1234 for {{braille cell|type=text|1234}}. The numeric order can be in raising numeric order ("123456"), or in row-by-row order ("142536"), so the same cell is uniquely identified by {{code|1=1234}} or by {{code|1423}}. A dot pattern in rising numeric order is the only valid input when [[WP:Substitution|substituting]] this template.

Another identification is the Unicode character, ⠏, that is {{unichar|280F|Braille pattern dots-1234|html=|note=block: [[Braille Patterns (Unicode)|Braille Patterns]]}}. The block has a mapping from raised dots to character id in the range U+28xx.

Inversely, a cell can be defined by its Unicode character id: U+280F defines cell with raised dots-1234.
{{clear}}

=== Braille cell definitions for 1829 Braille cells ===

[[File:1829 Braille cell numbering.svg|thumb|100px|Numbering scheme for 1829 (horizontal bars) braille cells.]]
*{{tlx|braille cell|1234|A23|size{{=}}20|type{{=}}image}} &rarr; {{braille cell|1234|A23|size=20|type=image}}

The 1829 Braille standard established the option of a bar across a row in addition to any combination of the two dots. In 1829 notation, there are 125 combinations, including all 64 valid regular 6-dot cell configurations.

Using the cell numbering shown here, one can simply define the raised rows: A, B, C, AB, AC, BC, or ABC, followed by the raised dots in rows not occupied by a bar ("0" for no dots). The order of the bars and numbers can be in rising order ("ABC123456"), with letters (bars) before numbers (dots), or in row-by-row order ("A14B25C36"), so the same cell is uniquely identified by {{code|1=AC25}} or by {{code|1=A25C}}.

The 1829 Braille standard is not compatible with the Unicode Braille specification, and neither a text character, nor a Unicode code point will output an 1829 Braille cell.

===Special options ===
Two input codes are available to produce special, non-braille output.

====Cell numbering overview====
{{code|1=dot numbers}} returns the overview of dot numbers 1&ndash;8. It can only be {{code|1=type=image}}:
* {{tlx|braille cell|<nowiki>dot numbers|type=image|size=40px</nowiki>}} &rarr; {{braille cell|dot numbers|type=image|size=40px}}

====Whitespace====
{{code|1=null}} or {{code|1=whitespace}} produces a true space, not the blank braille cell:
* {{tlx|braille cell|<nowiki>type=text|H|e|l|l|o|NULL|w|o|r|l|d</nowiki>}} &rarr; {{braille cell|type=text|H|e|l|l|o|NULL|w|o|r|l|d}}

==lang==
* {{code|1=<nowiki>lang=</nowiki>}} English, French, Japanese, Korean braille. English and generic is default.

===Japanese and Korean braille===
Japanese braille and Korean braille have setting options from an earlier version of this template. They can be declared using {{code|1=type<nowiki>=Japanese</nowiki>}}. Doing so returns colored braillecells for clarification.
{| class=wikitable
|-
! {{code|1=<nowiki>lang=</nowiki>}} || {{code|1=<nowiki>type=</nowiki>}} || shows || note
|-
| <not used> || <not used> || English, 6dot b/w || default
|-
| <not used> || 6dot || 6dot b/w || unchanged
|-
| <not used> || Korean || 6dot colored Korean || unchanged (''deprecated''; use {{code|1=<nowiki>lang=Korean</nowiki>}} instead)
|-
| <not used> || Japanese || 6dot colored Japanese || unchanged (''deprecated''; use {{code|1=<nowiki>lang=Japanese</nowiki>}} instead)
|-
| <not used> || 8dot || 8dot b/w || unchanged
|-
| text || character (is always 8dot) || unchanged
|-
| Japanese || 6dot || '''6dot b/w''' || new option
|-
| Korean || 6dot || '''6dot b/w''' || new option
|-
| Japanese || 8dot || 8dot b/w || new option 
|-
| Korean || 8dot || 8dot b/w || new option 

|}
In general, the language should be entered {{code|1=lang<nowiki>=Japanese</nowiki>}}. The parameter {{code|1=type}} then is available as default (colored cells) or enforcing 6dot black/white cells for Japanese or Korean.

==type==
* {{code|1=<nowiki>type=6dot, 8dot, image, text</nowiki>}}. Default: text (as a character from the font). When dot 7 or 8 is used, always the 8-dot image is shown, any 6-dot setting is overruled.

==size==
* When text, {{code|1=<nowiki>size=150% or 3em or 40px</nowiki>}} (Default: 100%, so regular font size).
* When image, in px: {{code|1=<nowiki>size=20px</nowiki>}}

==background==
Can be set for text output (not for image output).
* {{tlx|Braille cell|<nowiki>K|L|M</nowiki>}} &rarr; {{Braille cell|K|L|M}}
* {{tlx|Braille cell|<nowiki>K|L|M|background=yellow</nowiki>}} &rarr; {{Braille cell|K|L|M|background=yellow}}
* {{tlx|Braille cell|<nowiki>K|L|M|bg=yellow</nowiki>}} &rarr; {{Braille cell|K|L|M|bg=yellow}} (shortcut)
* {{tlx|Braille cell|<nowiki>K|L|M|background=transparent</nowiki>}} &rarr; {{Braille cell|K|L|M|background=transparent}}

==caption==
The cell has a caption (mouse hover text), based on the input. When the template is substituted, no caption is generated.

==Possible errors==
Possible errors that are caught:
* Input is not recognised as a braille code:
:{{tlx|Braille cell|xyz}} &rarr; {{Braille cell|xyz}}

* Too many characters are requested:
:{{tlx|Braille cell|<nowiki>a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|type=text</nowiki>}} &rarr; {{Braille cell|a|b|c|d|e|f|g|h|i|j|k|l|m|n|o|p|q|r|s|t|u|v|w|x|y|z|type=text}}

Article pages with a red error message also are listed in [[:Category:Unsupported braille input]].

* Numbers and dot number: Input '''"#2"''' is for the cell meaning decimal number two, input '''"2"''' produces the ''dot number 2'' cell:
:{{tlx|Braille cell|#2|2|type=6dot|size=20px}} &rarr; {{Braille cell|#2|2|type=6dot|size=20px}}.
This mistake is not caught or noted. The intention of the editor (input is dot-number or decimal number) cannot be deduced.

==Examples==
*6-dot cell, basic letter input: 
:{{tlx|Braille cell|<nowiki>X</nowiki>}} &rarr; {{Braille cell|X}}

*Japanese multi-cell: 
:{{tlx|Braille cell|<nowiki>y dakuten|か|chōon|type=kana</nowiki>}} &rarr; {{Braille cell|y dakuten|か|chōon|type=kana}}

*Korean multi-cell:
:{{tlx|Braille cell|<nowiki>h-|ᅡ|ᆫ|type=hangul</nowiki>}} &rarr; {{Braille cell|h-|ᅡ|ᆫ|type=hangul}}

*8-dot cell, basic letter input: 
:{{tlx|Braille cell|<nowiki>type=8|X</nowiki>}} &rarr; {{Braille cell|type=8|X}}

*Unicode text character, large size, basic letter input: 
:{{tlx|Braille cell|<nowiki>type=Unicode|size=300%|X</nowiki>}} &rarr; {{Braille cell|type=Unicode|size=300%|X}}

*6-dot cell, small size, title text: 
:{{tlx|Braille cell|<nowiki>size=25|X|text=a small braille X</nowiki>}} &rarr; {{Braille cell|size=25|X|text=a small braille X}}

*6-dot, dot order input: 
:{{tlx|Braille cell|<nowiki>12536</nowiki>}} &rarr; {{Braille cell|12536}}

*bottom dots, numeric order input: 
:{{tlx|Braille cell|<nowiki>type=8|2478</nowiki>}} -=&rarr; {{Braille cell|type=8|2478}}

*Same input, but substituted (note that only the first unnamed parameter is evaluated): 
:{{tlsx|Braille cell|<nowiki>type=8|2478</nowiki>}} &rarr; ⣊

==Overview==
* {{tlx|Braille cell/types}}
* {{tlx|Braille cell/overview Japanese and Korean braille}}

==Technical details==
The parameter name "dot-id" is used to define a braille cell. It is the numbering of the ''raised dots'', like {{code|1=136}} for {{braille cell|type=t|136}}. The sequence is climbing: 12345678, as is used in the Unicode character name: "Braille pattern dots-136".
*{{tl|Braille cell}}: separates numbered parameters into individual calls to /main.
*{{tl|Braille cell/main}}: calls /main2. Converts a single input code plus named parameters into appropriate braille cell id ("dot-id") and input code. Contains the list with non-English code translations (other languages).
*{{tl|Braille cell/main2}}: Calls /core. Prepares input texts and codes, using the now determined cell id. Checks for and shows error message.
*{{tl|Braille cell/core}}: Produces the actual cell output (text or image) using the settings.
*{{tl|Braille cell/styles.css}}: Injects proper spacing between two cells.
* {{tl|braille cell/main2singlecell}}
* {{tl|braille cell/lang2lang-id}}

Input is evaluated and processed using these lists:
* {{tl|Braille cell/english&cell2dot-id}}: analyse input code against default list (English and generic)
* {{tl|Braille cell/dot-id2character}}: cell id into text character (Unicode)
* {{tl|Braille cell/dot-id2article}}: cell id into Wikipedia article name
* {{tl|Braille cell/dot-id2unicode-id}}: cell id into textual Unicode definition, pattern U+28xx
* {{tl|Braille cell/dot-id2filename}}: cell id into a specific filename (6dot, Japanese, Korean)
* {{tl|Braille cell/dot-id2filename-8dot}}: cell id into a default 8-dot filename

Error tracking category:
* [[:Category:Unsupported braille input]]: tracks transclusions with invalid input.
* [//en.wikipedia.org/w/index.php?title=Special%3APrefixIndex&prefix=Braille+cell&namespace=10 T:braille/subs]
* '''[[Template:braille cell]] - [[template:braille cell/sandbox|sbx]]'''
** [[:Category:Unsupported braille input]]
** [[Template talk:braille cell]]

==Other related==

* [[Commons: Category: Braille letters (6 dots)]]
* [[Commons: Category: Braille letters (8 dots)]]
* [[:File:Pictograms-nps-accessibility-braille.svg]]
* [[:File:Braille8dotCellNumbering.svg]]

{{Braille}}<includeonly>
<!-- Categories and interwikis go here: -->

</includeonly>