lib/examples/Braille.lyx

   1 #LyX 1.6.2svn 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 \begin_inset Newline newline
  74 \end_inset
  75
  76
  77 \begin_inset CommandInset href
  78 LatexCommand href
  79 target "uwestoehr@web.de"
  80 type "mailto:"
  81
  82 \end_inset
  83
  84
  85 \end_layout
  86
  87 \begin_layout Standard
  88 First a general note: The Braille you can create with LaTeX is not complete!
  89  Braille can have 6 or 8
  90 \begin_inset space \thinspace{}
  91 \end_inset
  92
  93 dots, while LaTeX (and therefore LyX) only supports only 6
  94 \begin_inset space \thinspace{}
  95 \end_inset
  96
  97 dot Braille without accented characters.
  98 \end_layout
  99
 100 \begin_layout Standard
 101 To write Braille with LyX, load the module
 102 \family sans
 103 Braille
 104 \family default
 105  in the document settings under
 106 \family sans
 107 Modules
 108 \family default
 109 .
 110  Now select the environment
 111 \family sans
 112 Braille
 113 \begin_inset space ~
 114 \end_inset
 115
 116 (default)
 117 \family default
 118  or
 119 \family sans
 120 Braille
 121 \begin_inset space ~
 122 \end_inset
 123
 124 (textsize)
 125 \family default
 126  from the end of LyX's environment selection box and write your text.
 127  The other Braille environments are only turn on/off some properties as
 128  described below; keep them empty!
 129 \end_layout
 130
 131 \begin_layout Standard
 132 Here is an example:
 133 \lyxline
 134
 135 \end_layout
 136
 137 \begin_layout Standard
 138 with Latin letters:
 139 \begin_inset Newline newline
 140 \end_inset
 141
 142 This is an example sentence written in Braille.
 143 \end_layout
 144
 145 \begin_layout Standard
 146 with Braille letters:
 147 \end_layout
 148
 149 \begin_layout Braille (default)
 150 This is an example sentence written in Braille.
 151 \end_layout
 152
 153 \begin_layout Standard
 154
 155 \lyxline
 156
 157 \end_layout
 158
 159 \begin_layout Standard
 160 \begin_inset VSpace bigskip
 161 \end_inset
 162
 163 You can see that LaTeX is not able to hyphenate words written in Braille.
 164  You have to do this manually.
 165 \end_layout
 166
 167 \begin_layout Standard
 168 \begin_inset VSpace bigskip
 169 \end_inset
 170
 171
 172 \begin_inset Note Greyedout
 173 status open
 174
 175 \begin_layout Plain Layout
 176
 177 \series bold
 178 Note:
 179 \series default
 180  Only Latin letters, numbers, punctuations, parentheses, and brackets can
 181  be printed in Braille.
 182  Special characters like
 183 \begin_inset Quotes eld
 184 \end_inset
 185
 186 @
 187 \begin_inset Quotes erd
 188 \end_inset
 189
 190 , or
 191 \begin_inset Quotes eld
 192 \end_inset
 193
 194 $
 195 \begin_inset Quotes erd
 196 \end_inset
 197
 198 , accented characters like umlauts, and line breaks are not supported.
 199 \end_layout
 200
 201 \end_inset
 202
 203
 204 \end_layout
 205
 206 \begin_layout Standard
 207 \begin_inset VSpace bigskip
 208 \end_inset
 209
 210
 211 \begin_inset Note Greyedout
 212 status open
 213
 214 \begin_layout Plain Layout
 215
 216 \series bold
 217 Note:
 218 \series default
 219  LyX and LaTeX's proper names
 220 \begin_inset Quotes eld
 221 \end_inset
 222
 223 LaTeX
 224 \begin_inset Quotes erd
 225 \end_inset
 226
 227 ,
 228 \begin_inset Quotes eld
 229 \end_inset
 230
 231 LaTeX2e
 232 \begin_inset Quotes erd
 233 \end_inset
 234
 235 ,
 236 \begin_inset Quotes eld
 237 \end_inset
 238
 239 TeX
 240 \begin_inset Quotes erd
 241 \end_inset
 242
 243 , and
 244 \begin_inset Quotes eld
 245 \end_inset
 246
 247 LyX
 248 \begin_inset Quotes erd
 249 \end_inset
 250
 251  must be inserted as ERT, as in the following example:
 252 \end_layout
 253
 254 \end_inset
 255
 256
 257 \end_layout
 258
 259 \begin_layout Standard
 260
 261 \lyxline
 262
 263 \end_layout
 264
 265 \begin_layout Standard
 266 Latin:
 267 \begin_inset ERT
 268 status collapsed
 269
 270 \begin_layout Plain Layout
 271
 272 LyX
 273 \end_layout
 274
 275 \end_inset
 276
 277  is cool!
 278 \begin_inset Newline newline
 279 \end_inset
 280
 281 Braille:
 282 \end_layout
 283
 284 \begin_layout Braille (default)
 285 \begin_inset ERT
 286 status collapsed
 287
 288 \begin_layout Plain Layout
 289
 290 LyX
 291 \end_layout
 292
 293 \end_inset
 294
 295  is cool!
 296 \end_layout
 297
 298 \begin_layout Standard
 299
 300 \lyxline
 301
 302 \end_layout
 303
 304 \begin_layout Standard
 305 Here is an overview about the different Braille environments using the example
 306  text
 307 \begin_inset Quotes eld
 308 \end_inset
 309
 310 This is Braille.
 311 \begin_inset Quotes erd
 312 \end_inset
 313
 314
 315 \end_layout
 316
 317 \begin_layout Standard
 318 \begin_inset VSpace bigskip
 319 \end_inset
 320
 321 Default:
 322 \end_layout
 323
 324 \begin_layout Braille (default)
 325 This is Braille.
 326 \end_layout
 327
 328 \begin_layout Standard
 329 Size that approximately matches the document's text size:
 330 \end_layout
 331
 332 \begin_layout Braille (textsize)
 333 This is Braille.
 334 \end_layout
 335
 336 \begin_layout Standard
 337 \begin_inset VSpace bigskip
 338 \end_inset
 339
 340 Tiny dots can be displayed at empty positions:
 341 \end_layout
 342
 343 \begin_layout Braille (dots on)
 344
 345 \end_layout
 346
 347 \begin_layout Braille (textsize)
 348 This is Braille.
 349 \end_layout
 350
 351 \begin_layout Standard
 352 \begin_inset VSpace bigskip
 353 \end_inset
 354
 355 The text can be printed mirrored to be later able to for "print" Braille
 356  by hand with a needle or another suitable method:
 357 \end_layout
 358
 359 \begin_layout Standard
 360 Normal:
 361 \end_layout
 362
 363 \begin_layout Braille (default)
 364 This is Braille.
 365 \end_layout
 366
 367 \begin_layout Standard
 368 Mirrored:
 369 \end_layout
 370
 371 \begin_layout Braille (mirror on)
 372
 373 \end_layout
 374
 375 \begin_layout Braille (default)
 376 This is Braille.
 377 \end_layout
 378
 379 \begin_layout Braille (mirror off)
 380
 381 \end_layout
 382
 383 \begin_layout Standard
 384 \begin_inset VSpace bigskip
 385 \end_inset
 386
 387 Braille characters can alternatively be created by writing a number to a
 388  Braille box.
 389  A Braille box is inserted with the menu
 390 \family sans
 391  Insert\SpecialChar \menuseparator
 392 Custom
 393 \begin_inset space ~
 394 \end_inset
 395
 396 insets
 397 \family default
 398 .
 399  Every number that is in this box, turns on the corresponding Braille dot,
 400  for example the number
 401 \series bold
 402  6145
 403 \series default
 404  box leads to:
 405 \begin_inset Newline newline
 406 \end_inset
 407
 408
 409 \begin_inset Flex Braillebox
 410 status open
 411
 412 \begin_layout Plain Layout
 413 6145
 414 \end_layout
 415
 416 \end_inset
 417
 418
 419 \end_layout
 420
 421 \begin_layout Standard
 422 \begin_inset VSpace bigskip
 423 \end_inset
 424
 425 Computer Braille that uses 8
 426 \begin_inset space \thinspace{}
 427 \end_inset
 428
 429 dots can be turned on with the command
 430 \series bold
 431
 432 \backslash
 433 brailleeightdotstrue
 434 \series default
 435 .
 436  But the two extra dots are only used when using a Braille box.
 437  For example the number
 438 \series bold
 439  8175
 440 \series default
 441  in a Braille box leads to:
 442 \begin_inset Newline newline
 443 \end_inset
 444
 445
 446 \begin_inset ERT
 447 status collapsed
 448
 449 \begin_layout Plain Layout
 450
 451
 452 \backslash
 453 brailleeightdotstrue
 454 \end_layout
 455
 456 \end_inset
 457
 458
 459 \begin_inset Flex Braillebox
 460 status open
 461
 462 \begin_layout Plain Layout
 463 8175
 464 \end_layout
 465
 466 \end_inset
 467
 468
 469 \begin_inset ERT
 470 status collapsed
 471
 472 \begin_layout Plain Layout
 473
 474
 475 \backslash
 476 brailleeightdotsfalse
 477 \end_layout
 478
 479 \end_inset
 480
 481
 482 \end_layout
 483
 484 \begin_layout Standard
 485 \begin_inset VSpace bigskip
 486 \end_inset
 487
 488 The size of the default Braille font can be changed by the length
 489 \series bold
 490
 491 \backslash
 492 brailleunit
 493 \series default
 494 .
 495  Its default value is 2.4
 496 \begin_inset space \thinspace{}
 497 \end_inset
 498
 499 mm.
 500  To get e.
 501 \begin_inset space \thinspace{}
 502 \end_inset
 503
 504 g.
 505 \begin_inset space \space{}
 506 \end_inset
 507
 508 double-sized Braille where also the tiny dots have the double size, use
 509  this command in TeX code in your document:
 510 \end_layout
 511
 512 \begin_layout Standard
 513
 514 \series bold
 515
 516 \backslash
 517 renewcommand{
 518 \backslash
 519 braillenormal}[1]
 520 \begin_inset Newline newline
 521 \end_inset
 522
 523
 524 \begin_inset space ~
 525 \end_inset
 526
 527 {
 528 \backslash
 529 setlength{
 530 \backslash
 531 brailleunit}{4.8mm}
 532 \backslash
 533 braille{#1}}
 534 \end_layout
 535
 536 \begin_layout Standard
 537 Double-sized Braille:
 538 \begin_inset ERT
 539 status collapsed
 540
 541 \begin_layout Plain Layout
 542
 543
 544 \backslash
 545 renewcommand{
 546 \backslash
 547 braillenormal}[1]
 548 \end_layout
 549
 550 \begin_layout Plain Layout
 551
 552  {
 553 \backslash
 554 setlength{
 555 \backslash
 556 brailleunit}{4mm}
 557 \backslash
 558 braille{#1}}
 559 \end_layout
 560
 561 \end_inset
 562
 563
 564 \end_layout
 565
 566 \begin_layout Braille (default)
 567 This is Braille.
 568 \end_layout
 569
 570 \begin_layout Standard
 571 \begin_inset ERT
 572 status collapsed
 573
 574 \begin_layout Plain Layout
 575
 576
 577 \backslash
 578 renewcommand{
 579 \backslash
 580 braillenormal}[1]
 581 \end_layout
 582
 583 \begin_layout Plain Layout
 584
 585  {
 586 \backslash
 587 setlength{
 588 \backslash
 589 brailleunit}{2mm}
 590 \backslash
 591 braille{#1}}
 592 \end_layout
 593
 594 \end_inset
 595
 596
 597 \end_layout
 598
 599 \begin_layout Standard
 600 \begin_inset VSpace bigskip
 601 \end_inset
 602
 603 For more informations about the Braille cell dimensions have a look at
 604 \begin_inset CommandInset href
 605 LatexCommand href
 606 name "Braille cell dimensions"
 607 target "http://www.tiresias.org/research/reports/braille_cell.htm"
 608
 609 \end_inset
 610
 611 .
 612 \end_layout
 613
 614 \end_body
 615 \end_document