lib/examples/Braille.lyx

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