lib/examples/Braille.lyx

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