lib/examples/Braille.lyx

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