lyx_mirror/lib/examples/Modules/Braille.lyx

#LyX 2.3 created this file. For more info see http://www.lyx.org/
\lyxformat 544
\begin_document
\begin_header
\save_transient_properties true
\origin /systemlyxdir/examples/Modules/
\textclass article
\begin_preamble
% color greyed-out notes blue
\renewenvironment{lyxgreyedout}
 {\textcolor{blue}\bgroup}{\egroup}
\end_preamble
\use_default_options false
\begin_modules
braille
\end_modules
\maintain_unincluded_children false
\language english
\language_package default
\inputencoding utf8
\fontencoding global
\font_roman "default" "default"
\font_sans "default" "default"
\font_typewriter "default" "default"
\font_math "auto" "auto"
\font_default_family default
\use_non_tex_fonts false
\font_sc false
\font_osf false
\font_sf_scale 100 100
\font_tt_scale 100 100
\use_microtype false
\use_dash_ligatures false
\graphics default
\default_output_format default
\output_sync 0
\bibtex_command default
\index_command default
\paperfontsize default
\spacing single
\use_hyperref true
\pdf_title "How to write Braille with LyX"
\pdf_author "Uwe Stöhr"
\pdf_bookmarks false
\pdf_bookmarksnumbered false
\pdf_bookmarksopen false
\pdf_bookmarksopenlevel 1
\pdf_breaklinks false
\pdf_pdfborder false
\pdf_colorlinks true
\pdf_backref false
\pdf_pdfusetitle false
\pdf_quoted_options "pdfstartview=XYZ"
\papersize default
\use_geometry true
\use_package amsmath 1
\use_package amssymb 1
\use_package cancel 1
\use_package esint 1
\use_package mathdots 1
\use_package mathtools 1
\use_package mhchem 1
\use_package stackrel 1
\use_package stmaryrd 1
\use_package undertilde 1
\cite_engine basic
\cite_engine_type default
\biblio_style plain
\use_bibtopic false
\use_indices false
\paperorientation portrait
\suppress_date true
\justification true
\use_refstyle 0
\use_minted 0
\index Index
\shortcut idx
\color #008000
\end_index
\leftmargin 2.5cm
\rightmargin 2.5cm
\secnumdepth 3
\tocdepth 3
\paragraph_separation skip
\defskip medskip
\is_math_indent 0
\math_numbering_side default
\quotes_style english
\dynamic_quotes 0
\papercolumns 1
\papersides 1
\paperpagestyle default
\tracking_changes false
\output_changes false
\html_math_output 0
\html_css_as_file 0
\html_be_strict false
\end_header

\begin_body

\begin_layout Title
How to write Braille with \SpecialChar LyX

\end_layout

\begin_layout Author
Uwe Stöhr
\end_layout

\begin_layout Standard
First a general note: The Braille you can create with \SpecialChar LaTeX
 is not complete!
 Braille can have 6 or 8
\begin_inset space \thinspace{}
\end_inset

dots, while \SpecialChar LaTeX
 (and therefore \SpecialChar LyX
) only supports only 6
\begin_inset space \thinspace{}
\end_inset

dot Braille without accented characters.
\end_layout

\begin_layout Standard
To write Braille with \SpecialChar LyX
, load the module 
\family sans
Braille
\family default
 in the document settings under 
\family sans
Modules
\family default
.
 Now select the environment 
\family sans
Braille
\begin_inset space ~
\end_inset

(default)
\family default
 or 
\family sans
Braille
\begin_inset space ~
\end_inset

(textsize)
\family default
 from \SpecialChar LyX
's environment selection box and write your text.
 The other Braille environments are only turn on/off some properties as
 described below; keep them empty!
\end_layout

\begin_layout Standard
Here is an example:
\begin_inset Newline newline
\end_inset


\begin_inset CommandInset line
LatexCommand rule
offset "0.5ex"
width "100line%"
height "1pt"

\end_inset


\end_layout

\begin_layout Standard
with Latin letters:
\begin_inset Newline newline
\end_inset

This is an example sentence written in Braille.
\end_layout

\begin_layout Standard
with Braille letters:
\end_layout

\begin_layout Braille (default)
This is an example sentence written in Braille.
\end_layout

\begin_layout Standard
\noindent
\begin_inset CommandInset line
LatexCommand rule
offset "0.5ex"
width "100line%"
height "1pt"

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

You can see that \SpecialChar LaTeX
 is not able to hyphenate words written in Braille; you
 have to do this manually.
\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset


\begin_inset Note Greyedout
status open

\begin_layout Plain Layout

\series bold
Note:
\series default
 Only Latin letters, numbers, punctuations, parentheses, and brackets can
 be printed in Braille.
 Special characters like 
\begin_inset Quotes eld
\end_inset

@
\begin_inset Quotes erd
\end_inset

, or 
\begin_inset Quotes eld
\end_inset

$
\begin_inset Quotes erd
\end_inset

, accented characters like umlauts, as well as line breaks are not supported.
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset


\begin_inset Note Greyedout
status open

\begin_layout Plain Layout

\series bold
Note:
\series default
 \SpecialChar LyX
's and \SpecialChar LaTeX
's proper names 
\begin_inset Quotes eld
\end_inset

\SpecialChar LaTeX

\begin_inset Quotes erd
\end_inset

, 
\begin_inset Quotes eld
\end_inset

\SpecialChar LaTeX2e

\begin_inset Quotes erd
\end_inset

, 
\begin_inset Quotes eld
\end_inset

\SpecialChar TeX

\begin_inset Quotes erd
\end_inset

, and 
\begin_inset Quotes eld
\end_inset

\SpecialChar LyX

\begin_inset Quotes erd
\end_inset

 must be inserted as \SpecialChar TeX
 code like in the following example:
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\noindent
\begin_inset CommandInset line
LatexCommand rule
offset "0.5ex"
width "100line%"
height "1pt"

\end_inset


\end_layout

\begin_layout Standard
Latin: 
\begin_inset ERT
status collapsed

\begin_layout Plain Layout

LyX
\end_layout

\end_inset

 is cool!
\begin_inset Newline newline
\end_inset

Braille:
\end_layout

\begin_layout Braille (default)
\begin_inset ERT
status collapsed

\begin_layout Plain Layout

LyX
\end_layout

\end_inset

 is cool!
\end_layout

\begin_layout Standard
\noindent
\begin_inset CommandInset line
LatexCommand rule
offset "0.5ex"
width "100line%"
height "1pt"

\end_inset


\end_layout

\begin_layout Standard
Here is an overview about the different Braille environments using the example
 text 
\begin_inset Quotes eld
\end_inset

This is Braille.
\begin_inset Quotes erd
\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset


\family sans
Braille
\begin_inset space ~
\end_inset

(default)
\family default
:
\end_layout

\begin_layout Braille (default)
This is Braille.
\end_layout

\begin_layout Standard

\family sans
Braille
\begin_inset space ~
\end_inset

(textsize)
\family default
 - size that approximately matches the document's text size:
\end_layout

\begin_layout Braille (textsize)
This is Braille.
\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset


\family sans
Braille
\begin_inset space ~
\end_inset

(dots on)
\family default
 - tiny dots can be displayed at empty positions:
\end_layout

\begin_layout Braille (dots on)

\end_layout

\begin_layout Braille (textsize)
This is Braille.
\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

Text can be printed mirror-inverted for embossing the Braille by hand with
 a needle or another suitable device:
\end_layout

\begin_layout Standard
Normal:
\end_layout

\begin_layout Braille (default)
This is Braille.
\end_layout

\begin_layout Standard

\family sans
Braille
\begin_inset space ~
\end_inset

(mirror on)
\family default
:
\end_layout

\begin_layout Braille (mirror on)

\end_layout

\begin_layout Braille (default)
This is Braille.
\end_layout

\begin_layout Braille (mirror off)

\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

Braille characters can alternatively be created by writing a number to a
 Braille box.
 A Braille box is inserted with the menu
\family sans
 Insert\SpecialChar menuseparator
Custom
\begin_inset space ~
\end_inset

insets
\family default
.
 Every number in this box turns on the corresponding Braille dot.
 For example, the number
\series bold
 6145
\series default
 results in:
\begin_inset Newline newline
\end_inset


\begin_inset Flex Braillebox
status open

\begin_layout Plain Layout
6145
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

Computer Braille that uses 8
\begin_inset space \thinspace{}
\end_inset

dots can be turned on with the command
\series bold
 
\backslash
brailleeightdotstrue
\series default
.
 But the two extra dots are only printed when using a Braille box.
 For example, the number 
\series bold
8175
\series default
 in a Braille box results in:
\begin_inset Newline newline
\end_inset


\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
brailleeightdotstrue 
\end_layout

\end_inset

 
\begin_inset Flex Braillebox
status open

\begin_layout Plain Layout
8175
\end_layout

\end_inset

 
\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
brailleeightdotsfalse 
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

The size of the default Braille font can be changed by the length 
\series bold

\backslash
brailleunit
\series default
.
 Its default value is 2.4
\begin_inset space \thinspace{}
\end_inset

mm.
 To get e.
\begin_inset space \thinspace{}
\end_inset

g.
\begin_inset space \space{}
\end_inset

double-sized Braille use this command in \SpecialChar TeX
 code in your document:
\end_layout

\begin_layout Standard

\series bold

\backslash
renewcommand{
\backslash
braillenormal}[1]
\begin_inset Newline newline
\end_inset


\begin_inset space ~
\end_inset

{
\backslash
setlength{
\backslash
brailleunit}{4.8mm}
\backslash
braille{#1}}
\end_layout

\begin_layout Standard
Double-sized Braille:
\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
renewcommand{
\backslash
braillenormal}[1]
\end_layout

\begin_layout Plain Layout

 {
\backslash
setlength{
\backslash
brailleunit}{4mm}
\backslash
braille{#1}}
\end_layout

\end_inset


\end_layout

\begin_layout Braille (default)
This is Braille.
\end_layout

\begin_layout Standard
\begin_inset ERT
status collapsed

\begin_layout Plain Layout


\backslash
renewcommand{
\backslash
braillenormal}[1]
\end_layout

\begin_layout Plain Layout

 {
\backslash
setlength{
\backslash
brailleunit}{2mm}
\backslash
braille{#1}}
\end_layout

\end_inset


\end_layout

\begin_layout Standard
\begin_inset VSpace bigskip
\end_inset

For more informations about the Braille cell dimensions have a look at
\begin_inset Newline newline
\end_inset


\begin_inset CommandInset href
LatexCommand href
name "http://www.brailleauthority.org/sizespacingofbraille/index.html"
target "http://www.brailleauthority.org/sizespacingofbraille/index.html"
literal "false"

\end_inset

.
\end_layout

\end_body
\end_document