Template:Bc subst/doc
 | This is a documentation subpage for Template:Bc subst. It may contain usage information, categories and other content that is not part of the original template page. |
Usage
 | This template should always be substituted (i.e., use {{subst:Bc subst}}). For transcluding, use {{Braille cell}} instead. |
This template is a subst:-able version of the {{braille cell}} template that returns a single plain text unicode character or 8-dot braille cell image.
{{subst:bc subst|pattern|type=image|size=}}
- pattern is the numbers of the raised dots in numeric order, e.g. 1348 for
. Default is no dots (pattern 0). - type can be set to image to return an 8-dot braille cell image. Any other input returns a unicode character.
- size can be used to specify the size of an 8-dot braill cell image. Default 12px.
Technical details
This template directly calls subpages of the {{braille cell}} template, and does not contain any data files of its own.
The braille pattern input is evaluated and processed using either:
- {{Braille cell/dot-id2character}}: braille pattern into text character (Unicode)
- {{Braille cell/dot-id2filename-8dot}}: braille pattern into a default 8-dot filename
These data files contain several one-off and error codes, and any invalid braille patterns entered may produce a non-standard result, an error, or no output at all.