lib/examples/Modules/Braille.lyx

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