lib/examples/Braille.lyx

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