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