← Back to branch summary

~ubuntu-branches/debian/jessie/liblouis/jessie

« back to all changes in this revision

Viewing changes to doc/liblouis.info

  • Committer: Bazaar Package Importer
  • Author(s): Samuel Thibault
  • Date: 2010-01-12 23:48:47 UTC
  • mto: (1.1.4 upstream) (5.2.1 experimental)
  • mto: This revision was merged to the branch mainline in revision 8.
  • Revision ID: james.westby@ubuntu.com-20100112234847-ph9xdk3lrjdox6ks
Import upstream version 1.8.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/liblouis.info
1
 
This is liblouis.info, produced by makeinfo version 4.8 from
2
 
liblouis.texi.
3
 
 
4
1
INFO-DIR-SECTION Misc
5
2
START-INFO-DIR-ENTRY
 
3
This is ../../doc/liblouis.info, produced by makeinfo version 4.11 from ../../doc/liblouis.texi.
 
4
 
6
5
* Liblouis: (liblouis). A braille translator and back-translator
7
6
END-INFO-DIR-ENTRY
8
7
 
9
 
   This manual is for liblouis (version 1.7.0, 20 August 2009), a
 
8
   This manual is for liblouis (version 1.8.0, 18 November 2009), a
10
9
Braille Translation and Back-Translation Library derived from the Linux
11
10
screenreader BRLTTY.
12
11
 
37
36
Liblouis User's and Programmer's Manual
38
37
***************************************
39
38
 
40
 
This manual is for liblouis (version 1.7.0, 20 August 2009), a Braille
41
 
Translation and Back-Translation Library derived from the Linux
 
39
This manual is for liblouis (version 1.8.0, 18 November 2009), a
 
40
Braille Translation and Back-Translation Library derived from the Linux
42
41
screenreader BRLTTY.
43
42
 
44
43
Copyright (C) 1999-2006 by the BRLTTY Team.
80
79
* lou_debug::
81
80
* lou_checktable::
82
81
* lou_allround::
83
 
* lou_translate -f | -b tablename::
 
82
* lou_translate (program)::
 
83
* lou_checkhyphens::
84
84
 
85
85
How to Write Translation Tables
86
86
 
141
141
<john.boyer@abilitiessoft.com>.
142
142
 
143
143
   Persons who wish to program with liblouis but will not be writing
144
 
translation tables may want to skip ahead to *Note Programming with
 
144
translation tables may want to skip ahead to *note Programming with
145
145
liblouis::.
146
146
 
147
147
 
150
150
2 Test Programs
151
151
***************
152
152
 
153
 
Four test programs are provided as part of the liblouis package. They
 
153
Five test programs are provided as part of the liblouis package. They
154
154
are intended for testing liblouis and for debugging tables. None of
155
155
them is suitable for braille transcription. An application that can be
156
156
used for transcription is `xml2brl', which is part of the liblouisxml
158
158
test programs can be studied to learn how to use the liblouis library
159
159
and they can be used to perform the following functions.
160
160
 
 
161
   All of these programs recognize the `--help' and `--version' options.
 
162
 
 
163
`--help'
 
164
`-h'
 
165
     Print a usage message listing all available options, then exit
 
166
     successfully.
 
167
 
 
168
`--version'
 
169
`-v'
 
170
     Print the version number, then exit successfully.
 
171
 
 
172
 
161
173
* Menu:
162
174
 
163
175
* lou_debug::
164
176
* lou_checktable::
165
177
* lou_allround::
166
 
* lou_translate -f | -b tablename::
 
178
* lou_translate (program)::
 
179
* lou_checkhyphens::
167
180
 
168
181
 
169
182
File: liblouis.info,  Node: lou_debug,  Next: lou_checktable,  Prev: Test Programs,  Up: Test Programs
174
187
The lou_debug tool is intended for debugging liblouis translation
175
188
tables. The command line for lou_debug is:
176
189
 
177
 
   `lou_debug table-name'
 
190
     lou_debug [OPTIONS] TABLE[,TABLE,...]
 
191
 
 
192
   The command line options that are accepted by lou_debug are described
 
193
in *note common options::.
178
194
 
179
195
   The table (or comma-separated list of tables) is compiled. If no
180
196
errors are found a brief command summary is printed, then the prompt
269
285
2.2 lou_checktable
270
286
==================
271
287
 
272
 
To use this program type `lou_checktable' followed by a space and the
273
 
name of a table. If the table contains errors, appropriate messages
274
 
will be displayed. If there are no errors the message `no errors
275
 
found.' will be shown.
 
288
To use this program type the following:
 
289
 
 
290
     lou_checktable [OPTIONS] TABLE
 
291
 
 
292
   The command line options that are accepted by lou_checktable are
 
293
described in *note common options::.
 
294
 
 
295
   If the table contains errors, appropriate messages will be displayed.
 
296
If there are no errors the message `no errors found.' will be shown.
276
297
 
277
298
 
278
 
File: liblouis.info,  Node: lou_allround,  Next: lou_translate -f | -b tablename,  Prev: lou_checktable,  Up: Test Programs
 
299
File: liblouis.info,  Node: lou_allround,  Next: lou_translate (program),  Prev: lou_checktable,  Up: Test Programs
279
300
 
280
301
2.3 lou_allround
281
302
================
282
303
 
283
304
This program tests every capability of the liblouis library. It is
284
 
completely interactive. To start it, type `lou_allround' and then
285
 
<RET>. You will see a few lines telling you how to use the program.
286
 
Pressing one of the letters in parentheses and then enter will take you
287
 
to a message asking for more information or for the answer to a yes/no
 
305
completely interactive. Invoke it as follows:
 
306
 
 
307
     lou_allround [OPTIONS]
 
308
 
 
309
   The command line options that are accepted by lou_debug are described
 
310
in *note common options::.
 
311
 
 
312
   You will see a few lines telling you how to use the program. Pressing
 
313
one of the letters in parentheses and then enter will take you to a
 
314
message asking for more information or for the answer to a yes/no
288
315
question. Typing the letter `r' and then <RET> will take you to a
289
316
screen where you can enter a line to be processed by the library and
290
317
then view the results.
291
318
 
292
319
 
293
 
File: liblouis.info,  Node: lou_translate -f | -b tablename,  Prev: lou_allround,  Up: Test Programs
 
320
File: liblouis.info,  Node: lou_translate (program),  Next: lou_checkhyphens,  Prev: lou_allround,  Up: Test Programs
294
321
 
295
 
2.4 lou_translate -f | -b tablename
296
 
===================================
 
322
2.4 lou_translate
 
323
=================
297
324
 
298
325
This program translates whatever is on the standard input unit and
299
326
prints it on the standard output unit. It is intended for large-scale
300
 
testing of the accuracy of translation and back-translation. The first
301
 
argument must be `-f' for forward translation or `-b' for backward
302
 
translation. To use it to translate or back-translate a file use a line
303
 
like
304
 
 
305
 
   `./lou_translate -f en-us-g2.ctb <liblouis.txt >testtrans'
 
327
testing of the accuracy of translation and back-translation. The
 
328
command line for lou_translate is:
 
329
 
 
330
     lou_translate [OPTION] TABLE
 
331
 
 
332
   Aside from the standard options (*note common options::) this program
 
333
also accepts the following options:
 
334
 
 
335
`--forward'
 
336
`-f'
 
337
     Do a forward translation.
 
338
 
 
339
`--backward'
 
340
`-b'
 
341
     Do a backward translation.
 
342
 
 
343
 
 
344
   To use it to translate or back-translate a file use a line like
 
345
 
 
346
     lou_translate --forward en-us-g2.ctb <liblouis.txt >testtrans
 
347
 
 
348
 
 
349
File: liblouis.info,  Node: lou_checkhyphens,  Prev: lou_translate (program),  Up: Test Programs
 
350
 
 
351
2.5 lou_checkhyphens
 
352
====================
 
353
 
 
354
This program checks the accuracy of hyphenation in Braille translation
 
355
for both translated and untranslated words. It is completely
 
356
interactive. Invoke it as follows:
 
357
 
 
358
     lou_checkhyphens [OPTIONS]
 
359
 
 
360
   The command line options that are accepted by lou_checkhyphens are
 
361
described in *note common options::.
 
362
 
 
363
   You will see a few lines telling you how to use the program.
306
364
 
307
365
 
308
366
File: liblouis.info,  Node: How to Write Translation Tables,  Next: Notes on Back-Translation,  Prev: Test Programs,  Up: Top
970
1028
     These two opcodes are synonyms. If the characters are found within
971
1029
     a block of text surrounded by whitespace the entire block is
972
1030
     translated according to the default braille representations
973
 
     defined by the *Note Character-Definition Opcodes::, if 8-dot
 
1031
     defined by the *note Character-Definition Opcodes::, if 8-dot
974
1032
     computer braille is enabled or according to the dot patterns given
975
1033
     in the `comp6' opcode (*note comp6: comp6 opcode.), if 6-dot
976
1034
     computer braille is enabled. For example:
1510
1568
 
1511
1569
     The display opcode is optional. It is used when the embosser or
1512
1570
     display has a different mapping of characters to dot patterns than
1513
 
     that given in *Note Character-Definition Opcodes::. If used,
 
1571
     that given in *note Character-Definition Opcodes::. If used,
1514
1572
     display entries must proceed character-definition entries.
1515
1573
 
1516
1574
`multind dots opcode opcode ...'
1535
1593
***************************
1536
1594
 
1537
1595
Back-translation is carried out by the function
1538
 
`lou_backTranslateString'. Its calling sequence is described in *Note
 
1596
`lou_backTranslateString'. Its calling sequence is described in *note
1539
1597
Programming with liblouis::. Tables containing no `context' opcode
1540
1598
(*note context: context opcode.), `correct' opcode (*note correct:
1541
1599
correct opcode.) or multipass opcodes can be used for both forward and
1613
1671
`louis.h', used only internally. The latter includes `liblouis.h'.
1614
1672
 
1615
1673
   Persons who wish to use liblouis from Python may want to skip ahead
1616
 
to *Note Python bindings::.
 
1674
to *note Python bindings::.
1617
1675
 
1618
1676
   `compileTranslationTable.c' keeps track of all translation tables
1619
1677
which an application has used. It is called by the translation,
1759
1817
filename. The first table is then compiled. The pathname is then added
1760
1818
to the name of the second table, which is compiled, and so on. The
1761
1819
tables in a list are all compiled into the same internal table. The
1762
 
list is then regarded as the name of this table. As explained in *Note
 
1820
list is then regarded as the name of this table. As explained in *note
1763
1821
How to Write Translation Tables::, each table is a file which may be
1764
1822
plain text, big-endian Unicode or little-endian Unicode. A table (or
1765
1823
list of tables) is compiled into an internal representation the first
2175
2233
* Menu:
2176
2234
 
2177
2235
* lou_allround:                          lou_allround.          (line 6)
 
2236
* lou_checkhyphens:                      lou_checkhyphens.      (line 6)
2178
2237
* lou_checktable:                        lou_checktable.        (line 6)
2179
2238
* lou_debug:                             lou_debug.             (line 6)
2180
 
* lou_translate:                         lou_translate -f | -b tablename.
 
2239
* lou_translate:                         lou_translate (program).
2181
2240
                                                                (line 6)
2182
2241
 
2183
2242
 
2184
2243
 
2185
2244
Tag Table:
2186
 
Node: Top1371
2187
 
Node: Introduction3710
2188
 
Node: Test Programs4864
2189
 
Node: lou_debug5588
2190
 
Node: lou_checktable9711
2191
 
Node: lou_allround10082
2192
 
Node: lou_translate -f | -b tablename10747
2193
 
Node: How to Write Translation Tables11340
2194
 
Node: Hyphenation Tables17237
2195
 
Node: Character-Definition Opcodes17950
2196
 
Ref: space opcode19992
2197
 
Ref: punctuation opcode20188
2198
 
Ref: digit opcode20466
2199
 
Ref: uplow opcode20633
2200
 
Ref: grouping opcode21580
2201
 
Ref: letter opcode22348
2202
 
Ref: lowercase opcode22565
2203
 
Ref: uppercase opcode22780
2204
 
Ref: litdigit opcode23145
2205
 
Ref: sign opcode23336
2206
 
Ref: math opcode23681
2207
 
Node: Braille Indicator Opcodes23931
2208
 
Ref: capsign opcode24404
2209
 
Ref: begcaps opcode24558
2210
 
Ref: endcaps opcode24677
2211
 
Ref: letsign opcode24809
2212
 
Ref: noletsign opcode25075
2213
 
Ref: noletsignbefore opcode25549
2214
 
Ref: noletsignafter opcode25931
2215
 
Ref: numsign opcode26308
2216
 
Node: Emphasis Opcodes26593
2217
 
Ref: firstwordital opcode28599
2218
 
Ref: lastworditalbefore opcode28904
2219
 
Ref: italsign opcode28904
2220
 
Ref: lastworditalafter opcode29328
2221
 
Ref: firstletterital opcode29645
2222
 
Ref: begital opcode29645
2223
 
Ref: lastletterital opcode29862
2224
 
Ref: endital opcode29862
2225
 
Ref: singleletterital opcode30076
2226
 
Ref: lenitalphrase opcode30196
2227
 
Ref: firstwordbold opcode30852
2228
 
Ref: lastwordboldbefore opcode31013
2229
 
Ref: boldsign opcode31013
2230
 
Ref: lastwordboldafter opcode31430
2231
 
Ref: firstletterbold opcode31627
2232
 
Ref: begbold opcode31627
2233
 
Ref: lastletterbold opcode31844
2234
 
Ref: endbold opcode31844
2235
 
Ref: singleletterbold opcode32058
2236
 
Ref: lenboldphrase opcode32179
2237
 
Ref: firstwordunder opcode32788
2238
 
Ref: lastwordunderbefore opcode32911
2239
 
Ref: undersign opcode32911
2240
 
Ref: lastwordunderafter opcode33211
2241
 
Ref: firstletterunder opcode33336
2242
 
Ref: begunder opcode33336
2243
 
Ref: lastletterunder opcode33560
2244
 
Ref: endunder opcode33560
2245
 
Ref: singleletterunder opcode33781
2246
 
Ref: lenunderphrase opcode33902
2247
 
Ref: begcomp opcode34526
2248
 
Ref: endcomp opcode34877
2249
 
Node: Special Symbol Opcodes35228
2250
 
Ref: decpoint opcode35534
2251
 
Ref: hyphen opcode35727
2252
 
Node: Special Processing Opcodes35935
2253
 
Ref: capsnocont opcode36212
2254
 
Node: Translation Opcodes36394
2255
 
Ref: noback opcode38147
2256
 
Ref: nofor opcode38404
2257
 
Ref: compbrl opcode38622
2258
 
Ref: literal opcode38622
2259
 
Ref: comp6 opcode39178
2260
 
Ref: nocont opcode39699
2261
 
Ref: replace opcode40034
2262
 
Ref: always opcode40557
2263
 
Ref: repeated opcode40862
2264
 
Ref: repword opcode41214
2265
 
Ref: largesign opcode41604
2266
 
Ref: word opcode42207
2267
 
Ref: syllable opcode42363
2268
 
Ref: nocross opcode42955
2269
 
Ref: joinword opcode43489
2270
 
Ref: lowword opcode43979
2271
 
Ref: contraction opcode44351
2272
 
Ref: sufword opcode45167
2273
 
Ref: prfword opcode45305
2274
 
Ref: begword opcode45437
2275
 
Ref: begmidword opcode45558
2276
 
Ref: midword opcode45706
2277
 
Ref: midendword opcode45824
2278
 
Ref: endword opcode45966
2279
 
Ref: partword opcode46081
2280
 
Ref: exactdots opcode46266
2281
 
Ref: prepunc opcode46853
2282
 
Ref: postpunc opcode46994
2283
 
Ref: begnum opcode47130
2284
 
Ref: midnum opcode47342
2285
 
Ref: endnum opcode47597
2286
 
Ref: joinnum opcode47832
2287
 
Node: Character-Class Opcodes47984
2288
 
Ref: class opcode49199
2289
 
Ref: after opcode49384
2290
 
Ref: before opcode49712
2291
 
Node: Swap Opcodes50042
2292
 
Ref: swapcd opcode50803
2293
 
Ref: swapdd opcode50956
2294
 
Ref: swapcc opcode51337
2295
 
Node: The Context and Multipass Opcodes51622
2296
 
Ref: context opcode51852
2297
 
Node: The correct Opcode58724
2298
 
Ref: correct opcode58933
2299
 
Node: Miscellaneous Opcodes60088
2300
 
Ref: include opcode60261
2301
 
Ref: locale opcode60692
2302
 
Ref: display opcode60795
2303
 
Ref: multind opcode61560
2304
 
Node: Notes on Back-Translation62394
2305
 
Node: Programming with liblouis63198
2306
 
Node: License63684
2307
 
Node: Overview64721
2308
 
Node: Data structure of liblouis tables67371
2309
 
Node: lou_version70666
2310
 
Node: lou_translateString71043
2311
 
Ref: translation-tables71885
2312
 
Node: lou_translate74827
2313
 
Node: lou_backTranslateString76339
2314
 
Node: lou_backTranslate77285
2315
 
Node: lou_hyphenate77845
2316
 
Node: lou_logFile79367
2317
 
Node: lou_logPrint79869
2318
 
Node: lou_getTable80279
2319
 
Node: lou_readCharFromFile80935
2320
 
Node: lou_free81659
2321
 
Node: Python bindings82157
2322
 
Node: Opcode Index82527
2323
 
Node: Function Index92342
2324
 
Node: Program Index93363
 
2245
Node: Top1394
 
2246
Node: Introduction3748
 
2247
Node: Test Programs4902
 
2248
Ref: common options5530
 
2249
Node: lou_debug5889
 
2250
Node: lou_checktable10130
 
2251
Node: lou_allround10601
 
2252
Node: lou_translate (program)11365
 
2253
Node: lou_checkhyphens12143
 
2254
Node: How to Write Translation Tables12660
 
2255
Node: Hyphenation Tables18557
 
2256
Node: Character-Definition Opcodes19270
 
2257
Ref: space opcode21312
 
2258
Ref: punctuation opcode21508
 
2259
Ref: digit opcode21786
 
2260
Ref: uplow opcode21953
 
2261
Ref: grouping opcode22900
 
2262
Ref: letter opcode23668
 
2263
Ref: lowercase opcode23885
 
2264
Ref: uppercase opcode24100
 
2265
Ref: litdigit opcode24465
 
2266
Ref: sign opcode24656
 
2267
Ref: math opcode25001
 
2268
Node: Braille Indicator Opcodes25251
 
2269
Ref: capsign opcode25724
 
2270
Ref: begcaps opcode25878
 
2271
Ref: endcaps opcode25997
 
2272
Ref: letsign opcode26129
 
2273
Ref: noletsign opcode26395
 
2274
Ref: noletsignbefore opcode26869
 
2275
Ref: noletsignafter opcode27251
 
2276
Ref: numsign opcode27628
 
2277
Node: Emphasis Opcodes27913
 
2278
Ref: firstwordital opcode29919
 
2279
Ref: lastworditalbefore opcode30224
 
2280
Ref: italsign opcode30224
 
2281
Ref: lastworditalafter opcode30648
 
2282
Ref: firstletterital opcode30965
 
2283
Ref: begital opcode30965
 
2284
Ref: lastletterital opcode31182
 
2285
Ref: endital opcode31182
 
2286
Ref: singleletterital opcode31396
 
2287
Ref: lenitalphrase opcode31516
 
2288
Ref: firstwordbold opcode32172
 
2289
Ref: lastwordboldbefore opcode32333
 
2290
Ref: boldsign opcode32333
 
2291
Ref: lastwordboldafter opcode32750
 
2292
Ref: firstletterbold opcode32947
 
2293
Ref: begbold opcode32947
 
2294
Ref: lastletterbold opcode33164
 
2295
Ref: endbold opcode33164
 
2296
Ref: singleletterbold opcode33378
 
2297
Ref: lenboldphrase opcode33499
 
2298
Ref: firstwordunder opcode34108
 
2299
Ref: lastwordunderbefore opcode34231
 
2300
Ref: undersign opcode34231
 
2301
Ref: lastwordunderafter opcode34531
 
2302
Ref: firstletterunder opcode34656
 
2303
Ref: begunder opcode34656
 
2304
Ref: lastletterunder opcode34880
 
2305
Ref: endunder opcode34880
 
2306
Ref: singleletterunder opcode35101
 
2307
Ref: lenunderphrase opcode35222
 
2308
Ref: begcomp opcode35846
 
2309
Ref: endcomp opcode36197
 
2310
Node: Special Symbol Opcodes36548
 
2311
Ref: decpoint opcode36854
 
2312
Ref: hyphen opcode37047
 
2313
Node: Special Processing Opcodes37255
 
2314
Ref: capsnocont opcode37532
 
2315
Node: Translation Opcodes37714
 
2316
Ref: noback opcode39467
 
2317
Ref: nofor opcode39724
 
2318
Ref: compbrl opcode39942
 
2319
Ref: literal opcode39942
 
2320
Ref: comp6 opcode40498
 
2321
Ref: nocont opcode41019
 
2322
Ref: replace opcode41354
 
2323
Ref: always opcode41877
 
2324
Ref: repeated opcode42182
 
2325
Ref: repword opcode42534
 
2326
Ref: largesign opcode42924
 
2327
Ref: word opcode43527
 
2328
Ref: syllable opcode43683
 
2329
Ref: nocross opcode44275
 
2330
Ref: joinword opcode44809
 
2331
Ref: lowword opcode45299
 
2332
Ref: contraction opcode45671
 
2333
Ref: sufword opcode46487
 
2334
Ref: prfword opcode46625
 
2335
Ref: begword opcode46757
 
2336
Ref: begmidword opcode46878
 
2337
Ref: midword opcode47026
 
2338
Ref: midendword opcode47144
 
2339
Ref: endword opcode47286
 
2340
Ref: partword opcode47401
 
2341
Ref: exactdots opcode47586
 
2342
Ref: prepunc opcode48173
 
2343
Ref: postpunc opcode48314
 
2344
Ref: begnum opcode48450
 
2345
Ref: midnum opcode48662
 
2346
Ref: endnum opcode48917
 
2347
Ref: joinnum opcode49152
 
2348
Node: Character-Class Opcodes49304
 
2349
Ref: class opcode50519
 
2350
Ref: after opcode50704
 
2351
Ref: before opcode51032
 
2352
Node: Swap Opcodes51362
 
2353
Ref: swapcd opcode52123
 
2354
Ref: swapdd opcode52276
 
2355
Ref: swapcc opcode52657
 
2356
Node: The Context and Multipass Opcodes52942
 
2357
Ref: context opcode53172
 
2358
Node: The correct Opcode60044
 
2359
Ref: correct opcode60253
 
2360
Node: Miscellaneous Opcodes61408
 
2361
Ref: include opcode61581
 
2362
Ref: locale opcode62012
 
2363
Ref: display opcode62115
 
2364
Ref: multind opcode62880
 
2365
Node: Notes on Back-Translation63714
 
2366
Node: Programming with liblouis64518
 
2367
Node: License65004
 
2368
Node: Overview66041
 
2369
Node: Data structure of liblouis tables68691
 
2370
Node: lou_version71986
 
2371
Node: lou_translateString72363
 
2372
Ref: translation-tables73205
 
2373
Node: lou_translate76147
 
2374
Node: lou_backTranslateString77659
 
2375
Node: lou_backTranslate78605
 
2376
Node: lou_hyphenate79165
 
2377
Node: lou_logFile80687
 
2378
Node: lou_logPrint81189
 
2379
Node: lou_getTable81599
 
2380
Node: lou_readCharFromFile82255
 
2381
Node: lou_free82979
 
2382
Node: Python bindings83477
 
2383
Node: Opcode Index83847
 
2384
Node: Function Index93662
 
2385
Node: Program Index94683
2325
2386
 
2326
2387
End Tag Table