lib/examples/Modules/Braille.lyx

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