lib/examples/Braille.lyx

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