lib/examples/Braille.lyx

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