lib/examples/Braille.lyx

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