lib/examples/Braille.lyx

   1 #LyX 2.3 created this file. For more info see http://www.lyx.org/
   2 \lyxformat 544
   3 \begin_document
   4 \begin_header
   5 \save_transient_properties true
   6 \origin /systemlyxdir/examples/
   7 \textclass article
   8 \begin_preamble
   9 % color greyed-out notes blue
  10 \renewenvironment{lyxgreyedout}
  11  {\textcolor{blue}\bgroup}{\egroup}
  12 \end_preamble
  13 \use_default_options false
  14 \begin_modules
  15 braille
  16 \end_modules
  17 \maintain_unincluded_children false
  18 \language english
  19 \language_package default
  20 \inputencoding utf8
  21 \fontencoding global
  22 \font_roman "default" "default"
  23 \font_sans "default" "default"
  24 \font_typewriter "default" "default"
  25 \font_math "auto" "auto"
  26 \font_default_family default
  27 \use_non_tex_fonts false
  28 \font_sc false
  29 \font_osf false
  30 \font_sf_scale 100 100
  31 \font_tt_scale 100 100
  32 \use_microtype false
  33 \use_dash_ligatures false
  34 \graphics default
  35 \default_output_format default
  36 \output_sync 0
  37 \bibtex_command default
  38 \index_command default
  39 \paperfontsize default
  40 \spacing single
  41 \use_hyperref true
  42 \pdf_title "How to write Braille with LyX"
  43 \pdf_author "Uwe Stöhr"
  44 \pdf_bookmarks false
  45 \pdf_bookmarksnumbered false
  46 \pdf_bookmarksopen false
  47 \pdf_bookmarksopenlevel 1
  48 \pdf_breaklinks false
  49 \pdf_pdfborder false
  50 \pdf_colorlinks true
  51 \pdf_backref false
  52 \pdf_pdfusetitle false
  53 \pdf_quoted_options "pdfstartview=XYZ"
  54 \papersize default
  55 \use_geometry true
  56 \use_package amsmath 1
  57 \use_package amssymb 1
  58 \use_package cancel 0
  59 \use_package esint 1
  60 \use_package mathdots 1
  61 \use_package mathtools 0
  62 \use_package mhchem 1
  63 \use_package stackrel 0
  64 \use_package stmaryrd 0
  65 \use_package undertilde 0
  66 \cite_engine basic
  67 \cite_engine_type default
  68 \biblio_style plain
  69 \use_bibtopic false
  70 \use_indices false
  71 \paperorientation portrait
  72 \suppress_date false
  73 \justification true
  74 \use_refstyle 0
  75 \index Index
  76 \shortcut idx
  77 \color #008000
  78 \end_index
  79 \leftmargin 2.5cm
  80 \rightmargin 2.5cm
  81 \secnumdepth 3
  82 \tocdepth 3
  83 \paragraph_separation skip
  84 \defskip medskip
  85 \is_math_indent 0
  86 \math_numbering_side default
  87 \quotes_style english
  88 \papercolumns 1
  89 \papersides 1
  90 \paperpagestyle default
  91 \tracking_changes false
  92 \output_changes false
  93 \html_math_output 0
  94 \html_css_as_file 0
  95 \html_be_strict false
  96 \use_minted 0
  97 \end_header
  98
  99 \begin_body
 100
 101 \begin_layout Title
 102 How to write Braille with \SpecialChar LyX
 103
 104 \end_layout
 105
 106 \begin_layout Author
 107 Uwe Stöhr
 108 \end_layout
 109
 110 \begin_layout Standard
 111 First a general note: The Braille you can create with \SpecialChar LaTeX
 112  is not complete!
 113  Braille can have 6 or 8
 114 \begin_inset space \thinspace{}
 115 \end_inset
 116
 117 dots, while \SpecialChar LaTeX
 118  (and therefore \SpecialChar LyX
 119 ) only supports only 6
 120 \begin_inset space \thinspace{}
 121 \end_inset
 122
 123 dot Braille without accented characters.
 124 \end_layout
 125
 126 \begin_layout Standard
 127 To write Braille with \SpecialChar LyX
 128 , load the module
 129 \family sans
 130 Braille
 131 \family default
 132  in the document settings under
 133 \family sans
 134 Modules
 135 \family default
 136 .
 137  Now select the environment
 138 \family sans
 139 Braille
 140 \begin_inset space ~
 141 \end_inset
 142
 143 (default)
 144 \family default
 145  or
 146 \family sans
 147 Braille
 148 \begin_inset space ~
 149 \end_inset
 150
 151 (textsize)
 152 \family default
 153  from \SpecialChar LyX
 154 's environment selection box and write your text.
 155  The other Braille environments are only turn on/off some properties as
 156  described below; keep them empty!
 157 \end_layout
 158
 159 \begin_layout Standard
 160 Here is an example:
 161 \begin_inset Newline newline
 162 \end_inset
 163
 164
 165 \begin_inset CommandInset line
 166 LatexCommand rule
 167 offset "0.5ex"
 168 width "100line%"
 169 height "1pt"
 170
 171 \end_inset
 172
 173
 174 \end_layout
 175
 176 \begin_layout Standard
 177 with Latin letters:
 178 \begin_inset Newline newline
 179 \end_inset
 180
 181 This is an example sentence written in Braille.
 182 \end_layout
 183
 184 \begin_layout Standard
 185 with Braille letters:
 186 \end_layout
 187
 188 \begin_layout Braille (default)
 189 This is an example sentence written in Braille.
 190 \end_layout
 191
 192 \begin_layout Standard
 193 \noindent
 194 \begin_inset CommandInset line
 195 LatexCommand rule
 196 offset "0.5ex"
 197 width "100line%"
 198 height "1pt"
 199
 200 \end_inset
 201
 202
 203 \end_layout
 204
 205 \begin_layout Standard
 206 \begin_inset VSpace bigskip
 207 \end_inset
 208
 209 You can see that \SpecialChar LaTeX
 210  is not able to hyphenate words written in Braille; you
 211  have to do this manually.
 212 \end_layout
 213
 214 \begin_layout Standard
 215 \begin_inset VSpace bigskip
 216 \end_inset
 217
 218
 219 \begin_inset Note Greyedout
 220 status open
 221
 222 \begin_layout Plain Layout
 223
 224 \series bold
 225 Note:
 226 \series default
 227  Only Latin letters, numbers, punctuations, parentheses, and brackets can
 228  be printed in Braille.
 229  Special characters like
 230 \begin_inset Quotes eld
 231 \end_inset
 232
 233 @
 234 \begin_inset Quotes erd
 235 \end_inset
 236
 237 , or
 238 \begin_inset Quotes eld
 239 \end_inset
 240
 241 $
 242 \begin_inset Quotes erd
 243 \end_inset
 244
 245 , accented characters like umlauts, as well as line breaks are not supported.
 246 \end_layout
 247
 248 \end_inset
 249
 250
 251 \end_layout
 252
 253 \begin_layout Standard
 254 \begin_inset VSpace bigskip
 255 \end_inset
 256
 257
 258 \begin_inset Note Greyedout
 259 status open
 260
 261 \begin_layout Plain Layout
 262
 263 \series bold
 264 Note:
 265 \series default
 266  \SpecialChar LyX
 267 's and \SpecialChar LaTeX
 268 's proper names
 269 \begin_inset Quotes eld
 270 \end_inset
 271
 272 \SpecialChar LaTeX
 273
 274 \begin_inset Quotes erd
 275 \end_inset
 276
 277 ,
 278 \begin_inset Quotes eld
 279 \end_inset
 280
 281 \SpecialChar LaTeX2e
 282
 283 \begin_inset Quotes erd
 284 \end_inset
 285
 286 ,
 287 \begin_inset Quotes eld
 288 \end_inset
 289
 290 \SpecialChar TeX
 291
 292 \begin_inset Quotes erd
 293 \end_inset
 294
 295 , and
 296 \begin_inset Quotes eld
 297 \end_inset
 298
 299 \SpecialChar LyX
 300
 301 \begin_inset Quotes erd
 302 \end_inset
 303
 304  must be inserted as \SpecialChar TeX
 305  code like in the following example:
 306 \end_layout
 307
 308 \end_inset
 309
 310
 311 \end_layout
 312
 313 \begin_layout Standard
 314 \noindent
 315 \begin_inset CommandInset line
 316 LatexCommand rule
 317 offset "0.5ex"
 318 width "100line%"
 319 height "1pt"
 320
 321 \end_inset
 322
 323
 324 \end_layout
 325
 326 \begin_layout Standard
 327 Latin:
 328 \begin_inset ERT
 329 status collapsed
 330
 331 \begin_layout Plain Layout
 332
 333 LyX
 334 \end_layout
 335
 336 \end_inset
 337
 338  is cool!
 339 \begin_inset Newline newline
 340 \end_inset
 341
 342 Braille:
 343 \end_layout
 344
 345 \begin_layout Braille (default)
 346 \begin_inset ERT
 347 status collapsed
 348
 349 \begin_layout Plain Layout
 350
 351 LyX
 352 \end_layout
 353
 354 \end_inset
 355
 356  is cool!
 357 \end_layout
 358
 359 \begin_layout Standard
 360 \noindent
 361 \begin_inset CommandInset line
 362 LatexCommand rule
 363 offset "0.5ex"
 364 width "100line%"
 365 height "1pt"
 366
 367 \end_inset
 368
 369
 370 \end_layout
 371
 372 \begin_layout Standard
 373 Here is an overview about the different Braille environments using the example
 374  text
 375 \begin_inset Quotes eld
 376 \end_inset
 377
 378 This is Braille.
 379 \begin_inset Quotes erd
 380 \end_inset
 381
 382
 383 \end_layout
 384
 385 \begin_layout Standard
 386 \begin_inset VSpace bigskip
 387 \end_inset
 388
 389
 390 \family sans
 391 Braille
 392 \begin_inset space ~
 393 \end_inset
 394
 395 (default)
 396 \family default
 397 :
 398 \end_layout
 399
 400 \begin_layout Braille (default)
 401 This is Braille.
 402 \end_layout
 403
 404 \begin_layout Standard
 405
 406 \family sans
 407 Braille
 408 \begin_inset space ~
 409 \end_inset
 410
 411 (textsize)
 412 \family default
 413  - size that approximately matches the document's text size:
 414 \end_layout
 415
 416 \begin_layout Braille (textsize)
 417 This is Braille.
 418 \end_layout
 419
 420 \begin_layout Standard
 421 \begin_inset VSpace bigskip
 422 \end_inset
 423
 424
 425 \family sans
 426 Braille
 427 \begin_inset space ~
 428 \end_inset
 429
 430 (dots on)
 431 \family default
 432  - tiny dots can be displayed at empty positions:
 433 \end_layout
 434
 435 \begin_layout Braille (dots on)
 436
 437 \end_layout
 438
 439 \begin_layout Braille (textsize)
 440 This is Braille.
 441 \end_layout
 442
 443 \begin_layout Standard
 444 \begin_inset VSpace bigskip
 445 \end_inset
 446
 447 Text can be printed mirror-inverted for embossing the Braille by hand with
 448  a needle or another suitable device:
 449 \end_layout
 450
 451 \begin_layout Standard
 452 Normal:
 453 \end_layout
 454
 455 \begin_layout Braille (default)
 456 This is Braille.
 457 \end_layout
 458
 459 \begin_layout Standard
 460
 461 \family sans
 462 Braille
 463 \begin_inset space ~
 464 \end_inset
 465
 466 (mirror on)
 467 \family default
 468 :
 469 \end_layout
 470
 471 \begin_layout Braille (mirror on)
 472
 473 \end_layout
 474
 475 \begin_layout Braille (default)
 476 This is Braille.
 477 \end_layout
 478
 479 \begin_layout Braille (mirror off)
 480
 481 \end_layout
 482
 483 \begin_layout Standard
 484 \begin_inset VSpace bigskip
 485 \end_inset
 486
 487 Braille characters can alternatively be created by writing a number to a
 488  Braille box.
 489  A Braille box is inserted with the menu
 490 \family sans
 491  Insert\SpecialChar menuseparator
 492 Custom
 493 \begin_inset space ~
 494 \end_inset
 495
 496 insets
 497 \family default
 498 .
 499  Every number in this box turns on the corresponding Braille dot.
 500  For example, the number
 501 \series bold
 502  6145
 503 \series default
 504  results in:
 505 \begin_inset Newline newline
 506 \end_inset
 507
 508
 509 \begin_inset Flex Braillebox
 510 status open
 511
 512 \begin_layout Plain Layout
 513 6145
 514 \end_layout
 515
 516 \end_inset
 517
 518
 519 \end_layout
 520
 521 \begin_layout Standard
 522 \begin_inset VSpace bigskip
 523 \end_inset
 524
 525 Computer Braille that uses 8
 526 \begin_inset space \thinspace{}
 527 \end_inset
 528
 529 dots can be turned on with the command
 530 \series bold
 531
 532 \backslash
 533 brailleeightdotstrue
 534 \series default
 535 .
 536  But the two extra dots are only printed when using a Braille box.
 537  For example, the number
 538 \series bold
 539 8175
 540 \series default
 541  in a Braille box results in:
 542 \begin_inset Newline newline
 543 \end_inset
 544
 545
 546 \begin_inset ERT
 547 status collapsed
 548
 549 \begin_layout Plain Layout
 550
 551
 552 \backslash
 553 brailleeightdotstrue
 554 \end_layout
 555
 556 \end_inset
 557
 558
 559 \begin_inset Flex Braillebox
 560 status open
 561
 562 \begin_layout Plain Layout
 563 8175
 564 \end_layout
 565
 566 \end_inset
 567
 568
 569 \begin_inset ERT
 570 status collapsed
 571
 572 \begin_layout Plain Layout
 573
 574
 575 \backslash
 576 brailleeightdotsfalse
 577 \end_layout
 578
 579 \end_inset
 580
 581
 582 \end_layout
 583
 584 \begin_layout Standard
 585 \begin_inset VSpace bigskip
 586 \end_inset
 587
 588 The size of the default Braille font can be changed by the length
 589 \series bold
 590
 591 \backslash
 592 brailleunit
 593 \series default
 594 .
 595  Its default value is 2.4
 596 \begin_inset space \thinspace{}
 597 \end_inset
 598
 599 mm.
 600  To get e.
 601 \begin_inset space \thinspace{}
 602 \end_inset
 603
 604 g.
 605 \begin_inset space \space{}
 606 \end_inset
 607
 608 double-sized Braille use this command in \SpecialChar TeX
 609  code in your document:
 610 \end_layout
 611
 612 \begin_layout Standard
 613
 614 \series bold
 615
 616 \backslash
 617 renewcommand{
 618 \backslash
 619 braillenormal}[1]
 620 \begin_inset Newline newline
 621 \end_inset
 622
 623
 624 \begin_inset space ~
 625 \end_inset
 626
 627 {
 628 \backslash
 629 setlength{
 630 \backslash
 631 brailleunit}{4.8mm}
 632 \backslash
 633 braille{#1}}
 634 \end_layout
 635
 636 \begin_layout Standard
 637 Double-sized Braille:
 638 \begin_inset ERT
 639 status collapsed
 640
 641 \begin_layout Plain Layout
 642
 643
 644 \backslash
 645 renewcommand{
 646 \backslash
 647 braillenormal}[1]
 648 \end_layout
 649
 650 \begin_layout Plain Layout
 651
 652  {
 653 \backslash
 654 setlength{
 655 \backslash
 656 brailleunit}{4mm}
 657 \backslash
 658 braille{#1}}
 659 \end_layout
 660
 661 \end_inset
 662
 663
 664 \end_layout
 665
 666 \begin_layout Braille (default)
 667 This is Braille.
 668 \end_layout
 669
 670 \begin_layout Standard
 671 \begin_inset ERT
 672 status collapsed
 673
 674 \begin_layout Plain Layout
 675
 676
 677 \backslash
 678 renewcommand{
 679 \backslash
 680 braillenormal}[1]
 681 \end_layout
 682
 683 \begin_layout Plain Layout
 684
 685  {
 686 \backslash
 687 setlength{
 688 \backslash
 689 brailleunit}{2mm}
 690 \backslash
 691 braille{#1}}
 692 \end_layout
 693
 694 \end_inset
 695
 696
 697 \end_layout
 698
 699 \begin_layout Standard
 700 \begin_inset VSpace bigskip
 701 \end_inset
 702
 703 For more informations about the Braille cell dimensions have a look at
 704 \begin_inset Newline newline
 705 \end_inset
 706
 707
 708 \begin_inset CommandInset href
 709 LatexCommand href
 710 name "http://www.tiresias.org/research/reports/braille_cell.htm"
 711 target "http://www.tiresias.org/research/reports/braille_cell.htm"
 712 literal "false"
 713
 714 \end_inset
 715
 716 .
 717 \end_layout
 718
 719 \end_body
 720 \end_document