~ubuntu-branches/debian/jessie/liblouis/jessie : revision 1.2.2

3

<title>Liblouis User's and Programmer's Manual</title>

4

5

6

6

7

8

9

<!--

10

This manual is for liblouis (version 1.7.0, 20 August 2009),

10

This manual is for liblouis (version 1.8.0, 18 November 2009),

11

a Braille Translation and Back-Translation Library derived from the

12

Linux screenreader BRLTTY.

13

59

<li><a href="#lou_005fdebug">2.1 lou_debug</a>

60

<li><a href="#lou_005fchecktable">2.2 lou_checktable</a>

61

<li><a href="#lou_005fallround">2.3 lou_allround</a>

62

<li><a href="#lou_005ftranslate-_002df-_007c-_002db-tablename">2.4 lou_translate -f | -b tablename</a>

62

<li><a href="#lou_005ftranslate-_0028program_0029">2.4 lou_translate</a>

63

<li><a href="#lou_005fcheckhyphens">2.5 lou_checkhyphens</a>

63

64

</li></ul>

64

65

<li><a name="toc_How-to-Write-Translation-Tables" href="#How-to-Write-Translation-Tables">3 How to Write Translation Tables</a>

65

66

<ul>

107

108

109

<h2 class="unnumbered">Liblouis User's and Programmer's Manual</h2>

109

110

This manual is for liblouis (version 1.7.0, 20 August 2009),

111

This manual is for liblouis (version 1.8.0, 18 November 2009),

111

112

a Braille Translation and Back-Translation Library derived from the

112

113

Linux screenreader <acronym>BRLTTY</acronym>.

113

114

166

167

168

<h2 class="chapter">2 Test Programs</h2>

168

169

Four test programs are provided as part of the liblouis package. They

170

Five test programs are provided as part of the liblouis package. They

170

171

are intended for testing liblouis and for debugging tables. None of

171

172

them is suitable for braille transcription. An application that can be

172

173

used for transcription is <samp>xml2brl</samp>, which is part of the

174

175

test programs can be studied to learn how to use the liblouis library

175

176

and they can be used to perform the following functions.

176

177

178

<a name="common-options"></a>All of these programs recognize the <samp>--help</samp> and

179

<samp>--version</samp> options.

180

181

<dl>

182

<dt><samp>--help</samp><dt><samp>-h</samp><dd>Print a usage message listing all available options, then exit

183

successfully.

184

185

<dt><samp>--version</samp><dt><samp>-v</samp><dd>Print the version number, then exit successfully.

186

187

</dl>

188

177

189

178

190

179

191

183

195

The lou_debug tool is intended for debugging liblouis translation

184

196

tables. The command line for lou_debug is:

185

197

186

<kbd>lou_debug table-name</kbd>

198

<pre class="example"> lou_debug [OPTIONS] TABLE[,TABLE,...]

199

</pre>

200

The command line options that are accepted by lou_debug are described

201

in <a href="#common-options">common options</a>.

187

202

188

203

The table (or comma-separated list of tables) is compiled. If no

189

204

errors are found a brief command summary is printed, then the prompt

190

`<samp>Command:</samp>'. You can then input one of the command letters and get

205

‘<samp>Command:</samp>’. You can then input one of the command letters and get

191

206

output, as described below.

192

207

193

208

Most of the commands print information in the various arrays of

194

209

<code>TranslationTableHeader</code>. Since these arrays are pointers to

195

210

chains of hashed items, the commands first print the hash number, then

196

211

the first item, then the next item chained to it, and so on. After

197

each item there is a prompt indicated by `<samp>=></samp>'. You can then press

212

each item there is a prompt indicated by ‘<samp>=></samp>’. You can then press

198

213

enter (<kbd><RET></kbd>) to see the next item in the chain or the first

199

214

item in the next chain. Or you can press <kbd>h</kbd> (for next-(h)ash) to

200

215

skip to the next hash chain. You can also press <kbd>e</kbd> to exit the

201

command and go back to the `<samp>command:</samp>' prompt.

216

command and go back to the ‘<samp>command:</samp>’ prompt.

202

217

203

218

<dl>

204

219

<dt><kbd>h</kbd><dd>Brings up a screen of somewhat more extensive help.

205

220

206

221

<dt><kbd>f</kbd><dd>Display the first forward-translation rule in the first non-empty hash

207

222

bucket. The number of the bucket is displayed at the beginning of the

208

chain. Each rule is identified by the word `<samp>Rule:</samp>'. The fields

223

chain. Each rule is identified by the word ‘<samp>Rule:</samp>’. The fields

209

224

are displayed by phrases consisting of the name of the field, an equal

210

225

sign, and its value. The before and after fields are displayed only if

211

226

they are nonzero. Special opcodes such as the <code>correct</code> opcode (see <a href="#correct-opcode">correct</a>) and

212

227

the multipass opcodes are shown with the code that instructs the

213

228

virtual machine that interprets them. If you want to see only the

214

229

rules for a particular character string you can type <kbd>p</kbd> at the

215

`<samp>command:</samp>' prompt. This will take you to the `<samp>particular:</samp>'

230

‘<samp>command:</samp>’ prompt. This will take you to the ‘<samp>particular:</samp>’

216

231

prompt, where you can press <kbd>f</kbd> and then type in the string. The

217

232

whole hash chain containing the string will be displayed.

218

233

238

253

a 6-dot code. Note that the character-definition opcodes should use

239

254

8-dot computer braille.

240

255

241

<dt><kbd>p</kbd><dd>Bring up a secondary (`<samp>particular:</samp>') prompt from which you can

256

<dt><kbd>p</kbd><dd>Bring up a secondary (‘<samp>particular:</samp>’) prompt from which you can

242

257

examine particular character strings, dot patterns, etc. The commands

243

258

(given in its own command summary) are very similar to those of the

244

main `<samp>command:</samp>' prompt, but you can type a character string or

259

main ‘<samp>command:</samp>’ prompt, but you can type a character string or

245

260

dot pattern. They include <kbd>h</kbd>, <kbd>f</kbd>, <kbd>b</kbd>, <kbd>c</kbd>, <kbd>d</kbd>,

246

261

<kbd>C</kbd>, <kbd>D</kbd>, <kbd>z</kbd> and <kbd>x</kbd> (to exit this prompt), but not

247

262

<kbd>p</kbd>, <kbd>i</kbd> and <kbd>m</kbd>.

268

283

<h3 class="section">2.2 lou_checktable</h3>

269

284

270

285

271

To use this program type <kbd>lou_checktable</kbd> followed by a space and

272

the name of a table. If the table contains errors, appropriate

273

messages will be displayed. If there are no errors the message

274

`<samp>no errors found.</samp>' will be shown.

286

To use this program type the following:

287

288

<pre class="example"> lou_checktable [OPTIONS] TABLE

289

</pre>

290

The command line options that are accepted by lou_checktable are

291

described in <a href="#common-options">common options</a>.

292

293

If the table contains errors, appropriate messages will be displayed.

294

If there are no errors the message ‘<samp>no errors found.</samp>’ will be

295

shown.

275

296

276

297

277

298

280

301

281

302

282

303

This program tests every capability of the liblouis library. It is

283

completely interactive. To start it, type <kbd>lou_allround</kbd> and then

284

<RET>. You will see a few lines telling you how to use the

285

program. Pressing one of the letters in parentheses and then enter

286

will take you to a message asking for more information or for the

287

answer to a yes/no question. Typing the letter `<samp>r</samp>' and then

288

<RET> will take you to a screen where you can enter a line to be

289

processed by the library and then view the results.

290

291

292

293

294

<h3 class="section">2.4 lou_translate -f | -b tablename</h3>

304

completely interactive. Invoke it as follows:

305

306

<pre class="example"> lou_allround [OPTIONS]

307

</pre>

308

The command line options that are accepted by lou_debug are described

309

in <a href="#common-options">common options</a>.

310

311

You will see a few lines telling you how to use the program. Pressing

312

one of the letters in parentheses and then enter will take you to a

313

message asking for more information or for the answer to a yes/no

314

question. Typing the letter ‘<samp>r</samp>’ and then <RET> will take you

315

to a screen where you can enter a line to be processed by the library

316

and then view the results.

317

318

319

320

321

<h3 class="section">2.4 lou_translate</h3>

295

322

296

323

297

324

This program translates whatever is on the standard input unit and

298

325

prints it on the standard output unit. It is intended for large-scale

299

testing of the accuracy of translation and back-translation. The first

300

argument must be <samp>-f</samp> for forward translation or <samp>-b</samp> for

301

backward translation. To use it to translate or back-translate a file

302

use a line like

303

304

<kbd>./lou_translate -f en-us-g2.ctb <liblouis.txt >testtrans</kbd>

326

testing of the accuracy of translation and back-translation. The

327

command line for lou_translate is:

328

329

<pre class="example"> lou_translate [OPTION] TABLE

330

</pre>

331

Aside from the standard options (see <a href="#common-options">common options</a>) this program

332

also accepts the following options:

333

334

<dl>

335

<dt><samp>--forward</samp><dt><samp>-f</samp><dd>Do a forward translation.

336

337

<dt><samp>--backward</samp><dt><samp>-b</samp><dd>Do a backward translation.

338

339

</dl>

340

341

To use it to translate or back-translate a file use a line like

342

343

<pre class="example"> lou_translate --forward en-us-g2.ctb <liblouis.txt >testtrans

344

</pre>

345

346

347

348

<h3 class="section">2.5 lou_checkhyphens</h3>

349

350

351

This program checks the accuracy of hyphenation in Braille translation

352

for both translated and untranslated words. It is completely

353

interactive. Invoke it as follows:

354

355

<pre class="example"> lou_checkhyphens [OPTIONS]

356

</pre>

357

The command line options that are accepted by lou_checkhyphens are

358

described in <a href="#common-options">common options</a>.

359

360

You will see a few lines telling you how to use the program.

305

361

306

362

307

363

331

387

files or 16-bit little-endian Unicode files. Blank lines are ignored.

332

388

Any leading and trailing white-space (any number of blanks and/or tabs)

333

389

is ignored. Lines which begin with a number sign or hatch mark

334

(`<samp>#</samp>') are ignored, i.e. they are comments. If the number sign is

390

(‘<samp>#</samp>’) are ignored, i.e. they are comments. If the number sign is

335

391

not the first non-blank character in the line, it is treated as an

336

392

ordinary character. If the first non-blank character is less-than

337

(`<samp><</samp>') the line is also treated as a comment. This makes it possible

393

(‘<samp><</samp>’) the line is also treated as a comment. This makes it possible

338

394

to mark up tables as xhtml documents. Lines which are not blank or

339

395

comments define table entries. The general format of a table entry is:

340

396

347

403

certain number of operands. Any text on the line after the last

348

404

operand is ignored, and may be a comment. A few opcodes accept a

349

405

variable number of operands. In this case a number sign begins a

350

comment unless it is preceded by a backslash (`<samp>\</samp>'). See <a href="#Opcode-Index">Opcode Index</a>, for a list of opcodes, with a link to each one.

406

comment unless it is preceded by a backslash (‘<samp>\</samp>’). See <a href="#Opcode-Index">Opcode Index</a>, for a list of opcodes, with a link to each one.

351

407

352

408

Here are some examples of table entries.

353

409

388

444

through 8, must be specified with their standard numbers. liblouis

389

445

recognizes "virtual dots," which are used for special purposes, such

390

446

as distinguishing accent marks. There are seven virtual dots. They are

391

specified by the number 9 and the letters `<samp>a</samp>' through `<samp>f</samp>'.

447

specified by the number 9 and the letters ‘<samp>a</samp>’ through ‘<samp>f</samp>’.

392

448

For a multi-cell dot pattern, the cell specifications must be

393

separated from one another by a dash (`<samp>-</samp>'). For example, the

394

contraction for the English word `<samp>lord</samp>' (the letter `<samp>l</samp>'

449

separated from one another by a dash (‘<samp>-</samp>’). For example, the

450

contraction for the English word ‘<samp>lord</samp>’ (the letter ‘<samp>l</samp>’

395

451

preceded by dot 5) would be specified as 5-123. A space may be

396

452

specified with the special dot number 0.

397

453

467

523

the character is treated as a space.

468

524

469

525

470

471

472

<dt><code>space character dots</code><dd>

526

527

<dl><a name="space-opcode"></a><dt><code>space character dots</code><dd>

473

528

Defines a character as a space and also defines the dot pattern as

474

529

such. for example:

475

530

476

531

<pre class="example"> space \s 0 \s is the escape sequence for blank; 0 means no dots.

477

</pre>

478

479

<dt><code>punctuation character dots</code><dd>

532

</pre>

533

<a name="index-punctuation-7"></a><a name="punctuation-opcode"></a> <dt><code>punctuation character dots</code><dd>

480

534

Associates a punctuation mark in the particular language with a

481

535

braille representation and defines the character and dot pattern as

482

536

punctuation. For example:

483

537

484

538

<pre class="example"> punctuation . 46 dot pattern for period in NAB computer braille

485

</pre>

486

487

<dt><code>digit character dots</code><dd>

539

</pre>

540

<a name="index-digit-8"></a><a name="digit-opcode"></a> <dt><code>digit character dots</code><dd>

488

541

Associates a digit with a dot pattern and defines the character as a

489

542

digit. For example:

490

543

491

544

<pre class="example"> digit 0 356 NAB computer braille

492

</pre>

493

494

<dt><code>uplow characters dots [,dots]</code><dd>

545

</pre>

546

<a name="index-uplow-9"></a><a name="uplow-opcode"></a> <dt><code>uplow characters dots [,dots]</code><dd>

495

547

The characters operand must be a pair of letters, of which the first

496

548

is uppercase and the second lowercase. The first dots suboperand

497

549

indicates the dot pattern for the upper-case letter. It may have more

506

558

distinction is important in the forward translator. for example:

507

559

508

560

<pre class="example"> uplow Aa 17,1

509

</pre>

510

511

<dt><code>grouping name characters dots ,dots</code><dd>

561

</pre>

562

<a name="index-grouping-10"></a><a name="grouping-opcode"></a> <dt><code>grouping name characters dots ,dots</code><dd>

512

563

This opcode is used to indicate pairs of grouping symbols used in

513

564

processing mathematical expressions. These symbols are usually generated

514

565

by the MathML interpreter in liblouisxml. They are used in multipass

521

572

522

573

<pre class="example"> grouping mrow \x0001\x0002 1e,2e

523

574

grouping mfrac \x0003\x0004 3e,4e

524

</pre>

525

526

<dt><code>letter character dots</code><dd>

575

</pre>

576

<a name="index-letter-11"></a><a name="letter-opcode"></a> <dt><code>letter character dots</code><dd>

527

577

Associates a letter in the language with a braille representation and

528

578

defines the character as a letter. This is intended for letters which

529

579

are neither uppercase nor lowercase.

530

580

531

532

<dt><code>lowercase character dots</code><dd>

581

<a name="index-lowercase-12"></a><a name="lowercase-opcode"></a> <dt><code>lowercase character dots</code><dd>

533

582

Associates a character with a dot pattern and defines the character as

534

583

a lowercase letter. Both the character and the dot pattern have the

535

584

attributes lowercase and letter.

536

585

537

538

<dt><code>uppercase character dots</code><dd>

586

<a name="index-uppercase-13"></a><a name="uppercase-opcode"></a> <dt><code>uppercase character dots</code><dd>

539

587

Associates a character with a dot pattern and defines the character as

540

588

an uppercase letter. Both the character and the dot pattern have the

541

589

attributes uppercase and letter. <code>lowercase</code> and <code>uppercase</code>

542

590

should be used when a letter has only one case. Otherwise use the

543

591

<code>uplow</code> opcode (see <a href="#uplow-opcode">uplow</a>).

544

592

545

546

<dt><code>litdigit digit dots</code><dd>

593

<a name="index-litdigit-14"></a><a name="litdigit-opcode"></a> <dt><code>litdigit digit dots</code><dd>

547

594

Associates a digit with the dot pattern which should be used to

548

595

represent it in literary texts. For example:

549

596

550

597

<pre class="example"> litdigit 0 245

551

598

litdigit 1 1

552

</pre>

553

554

<dt><code>sign character dots</code><dd>

599

</pre>

600

<a name="index-sign-15"></a><a name="sign-opcode"></a> <dt><code>sign character dots</code><dd>

555

601

Associates a character with a dot pattern and defines both as a sign.

556

This opcode should be used for things like at sign (`<samp>@</samp>'),

557

percent (`<samp>%</samp>'), dollar sign (`<samp>$</samp>'), etc. Do not use it to

602

This opcode should be used for things like at sign (‘<samp>@</samp>’),

603

percent (‘<samp>%</samp>’), dollar sign (‘<samp>$</samp>’), etc. Do not use it to

558

604

define ordinary punctuation such as period and comma. For example:

559

605

560

606

<pre class="example"> sign % 4-25-1234 literary percent sign

561

</pre>

562

563

<dt><code>math character dots</code><dd>

607

</pre>

608

<a name="index-math-16"></a><a name="math-opcode"></a> <dt><code>math character dots</code><dd>

564

609

Associates a character and a dot pattern and defines them as a

565

mathematical symbol. It should be used for less than (`<samp><</samp>'),

566

greater than(`<samp>></samp>'), equals(`<samp>=</samp>'), plus(`<samp>+</samp>'), etc. For

610

mathematical symbol. It should be used for less than (‘<samp><</samp>’),

611

greater than(‘<samp>></samp>’), equals(‘<samp>=</samp>’), plus(‘<samp>+</samp>’), etc. For

567

612

example:

568

613

569

614

<pre class="example"> math + 346 plus

570

</pre>

615

</pre>

571

616

</dl>

572

617

573

618

580

625

by a dot pattern, which may be one or more cells.

581

626

582

627

583

584

585

<dt><code>capsign dots</code><dd>

628

629

<dl><a name="capsign-opcode"></a><dt><code>capsign dots</code><dd>

586

630

The dot pattern which indicates capitalization of a single letter. In

587

631

English, this is dot 6. For example:

588

632

589

633

<pre class="example"> capsign 6

590

</pre>

591

592

<dt><code>begcaps dots</code><dd>

634

</pre>

635

<a name="index-begcaps-18"></a><a name="begcaps-opcode"></a> <dt><code>begcaps dots</code><dd>

593

636

The dot pattern which begins a block of capital letters. For example:

594

637

595

638

<pre class="example"> begcaps 6-6

596

</pre>

597

598

<dt><code>endcaps dots</code><dd>

639

</pre>

640

<a name="index-endcaps-19"></a><a name="endcaps-opcode"></a> <dt><code>endcaps dots</code><dd>

599

641

The dot pattern which ends a block of capital letters within a word.

600

642

For example:

601

643

602

644

<pre class="example"> endcaps 6-3

603

</pre>

604

605

<dt><code>letsign dots</code><dd>

645

</pre>

646

<a name="index-letsign-20"></a><a name="letsign-opcode"></a> <dt><code>letsign dots</code><dd>

606

647

This indicator is needed in Grade 2 to show that a single letter is

607

648

not a contraction. It is also used when an abbreviation happens to be

608

649

a sequence of letters that is the same as a contraction. For example:

609

650

610

651

<pre class="example"> letsign 56

611

</pre>

612

613

<dt><code>noletsign letters</code><dd>

652

</pre>

653

<a name="index-noletsign-21"></a><a name="noletsign-opcode"></a> <dt><code>noletsign letters</code><dd>

614

654

615

655

The letters in the operand will not be proceeded by a letter sign.

616

656

More than one <code>noletsign</code> opcode can be used. This is equivalent

617

657

to a single entry containing all the letters. In addition, if a single

618

letter, such as `<samp>a</samp>' in English, is defined as a <code>word</code>

658

letter, such as ‘<samp>a</samp>’ in English, is defined as a <code>word</code>

619

659

(see <a href="#word-opcode">word</a>) or <code>largesign</code>

620

660

(see <a href="#largesign-opcode">largesign</a>), it will be

621

661

treated as though it had also been specified in a <code>noletsign</code>

622

662

entry.

623

663

624

625

<dt><code>noletsignbefore characters</code><dd>

664

<a name="index-noletsignbefore-22"></a><a name="noletsignbefore-opcode"></a> <dt><code>noletsignbefore characters</code><dd>

626

665

If any of the characters proceeds a single letter without a space a

627

666

letter sign is not used. By default the characters apostrophe

628

(`<samp>'</samp>') and period (`<samp>.</samp>') have this property. Use of a

667

(‘<samp>'</samp>’) and period (‘<samp>.</samp>’) have this property. Use of a

629

668

<code>noletsignbefore</code> entry cancels the defaults. If more than one

630

669

<code>noletsignbefore</code> entry is used, the characters in all entries

631

670

are combined.

632

671

633

634

<dt><code>noletsignafter characters</code><dd>

672

<a name="index-noletsignafter-23"></a><a name="noletsignafter-opcode"></a> <dt><code>noletsignafter characters</code><dd>

635

673

If any of the characters follows a single letter without a space a

636

674

letter sign is not used. By default the characters apostrophe

637

(`<samp>'</samp>') and period (`<samp>.</samp>') have this property. Use of a

675

(‘<samp>'</samp>’) and period (‘<samp>.</samp>’) have this property. Use of a

638

676

<code>noletsignafter</code> entry cancels the defaults. If more than one

639

677

<code>noletsignafter</code> entry is used the characters in all entries are

640

678

combined.

641

679

642

643

<dt><code>numsign dots</code><dd>

680

<a name="index-numsign-24"></a><a name="numsign-opcode"></a> <dt><code>numsign dots</code><dd>

644

681

The translator inserts this indicator before numbers made up of digits

645

682

defined with the <code>litdigit</code> opcode (see <a href="#litdigit-opcode">litdigit</a>) to show that they are a number

646

683

and not letters or some other symbols. For example:

647

684

648

685

<pre class="example"> numsign 3456

649

</pre>

686

</pre>

650

687

</dl>

651

688

652

689

686

723

Here are the various emphasis opcodes.

687

724

688

725

689

690

691

<dt><code>firstwordital dots</code><dd>

726

727

<dl><a name="firstwordital-opcode"></a><dt><code>firstwordital dots</code><dd>

692

728

This is the braille indicator to be placed before the first word of an

693

729

italicized phrase that is longer than the value given in the

694

730

<code>lenitalphrase</code> opcode (see <a href="#lenitalphrase-opcode">lenitalphrase</a>). For example:

695

731

696

732

<pre class="example"> firstwordital 46-46 English indicator

697

</pre>

698

699

700

<dt><code>lastworditalbefore dots</code><dt><code>italsign dots</code><dd>

733

</pre>

734

<a name="index-lastworditalbefore-26"></a><a name="index-italsign-27"></a><a name="lastworditalbefore-opcode"></a><a name="italsign-opcode"></a> <dt><code>lastworditalbefore dots</code><dt><code>italsign dots</code><dd>

701

735

These two opcodes are synonyms. This is the braille indicator to be

702

736

placed before the last word of an italicized phrase. In addition, if

703

737

<code>firstwordital</code> is not used, this braille indicator is doubled

705

739

and <code>lastworditalafter</code> in the same table. For example:

706

740

707

741

<pre class="example"> lastworditalbefore 4-6

708

</pre>

709

710

<dt><code>lastworditalafter dots</code><dd>

742

</pre>

743

<a name="index-lastworditalafter-28"></a><a name="lastworditalafter-opcode"></a> <dt><code>lastworditalafter dots</code><dd>

711

744

This is the braille indicator to be placed after the last word of an

712

745

italicized phrase. Do not use <code>lastworditalbefore</code> and

713

746

<code>lastworditalafter</code> in the same table. See also the

714

747

<code>lenitalphrase</code> opcode (see <a href="#lenitalphrase-opcode">lenitalphrase</a>) for more information.

715

748

716

717

718

<dt><code>firstletterital dots</code><dt><code>begital dots</code><dd>

749

<a name="index-firstletterital-29"></a><a name="index-begital-30"></a><a name="firstletterital-opcode"></a><a name="begital-opcode"></a> <dt><code>firstletterital dots</code><dt><code>begital dots</code><dd>

719

750

These two opcodes are synonyms. This is the braille indicator to be

720

751

placed before the first letter (or character) if italicization begins

721

752

in the middle of a word.

722

753

723

724

725

<dt><code>lastletterital dots</code><dt><code>endital dots</code><dd>

754

<a name="index-lastletterital-31"></a><a name="index-endital-32"></a><a name="lastletterital-opcode"></a><a name="endital-opcode"></a> <dt><code>lastletterital dots</code><dt><code>endital dots</code><dd>

726

755

These two opcodes are synonyms. This is the braille indicator to be

727

756

placed after the last letter (or character) when italicization ends in

728

757

the middle of a word.

729

758

730

731

<dt><code>singleletterital dots</code><dd>

759

<a name="index-singleletterital-33"></a><a name="singleletterital-opcode"></a> <dt><code>singleletterital dots</code><dd>

732

760

This braille indicator is used if only a single letter (or character)

733

761

is italicized.

734

762

735

736

<dt><code>lenitalphrase number</code><dd>

763

<a name="index-lenitalphrase-34"></a><a name="lenitalphrase-opcode"></a> <dt><code>lenitalphrase number</code><dd>

737

764

If <code>lastworditalbefore</code> is used, an italicized phrase is checked

738

765

to see how many words it contains. If this number is less than or

739

766

equal to the number given in the <code>lenitalphrase</code> opcode, the

745

772

<code>lastworditalbefore</code> entry. For example:

746

773

747

774

<pre class="example"> lenitalphrase 4

748

</pre>

749

750

<dt><code>firstwordbold dots</code><dd>

775

</pre>

776

<a name="index-firstwordbold-35"></a><a name="firstwordbold-opcode"></a> <dt><code>firstwordbold dots</code><dd>

751

777

This is the braille indicator to be placed before the first word of a

752

778

bold phrase. For example:

753

779

754

780

<pre class="example"> firstwordbold 456-456

755

</pre>

756

757

758

<dt><code>lastwordboldbefore dots</code><dt><code>boldsign dots</code><dd>

781

</pre>

782

<a name="index-lastwordboldbefore-36"></a><a name="index-boldsign-37"></a><a name="lastwordboldbefore-opcode"></a><a name="boldsign-opcode"></a> <dt><code>lastwordboldbefore dots</code><dt><code>boldsign dots</code><dd>

759

783

These two opcodes are synonyms. This is the braille indicator to be

760

784

placed before the last word of a bold phrase. In addition, if

761

785

<code>firstwordbold</code> is not used, this braille indicator is doubled

763

787

and <code>lastwordboldafter</code> in the same table. For example:

764

788

765

789

<pre class="example"> lastwordboldbefore 456

766

</pre>

767

768

<dt><code>lastwordboldafter dots</code><dd>

790

</pre>

791

<a name="index-lastwordboldafter-38"></a><a name="lastwordboldafter-opcode"></a> <dt><code>lastwordboldafter dots</code><dd>

769

792

This is the braille indicator to be placed after the last word of a

770

793

bold phrase. Do not use <code>lastwordboldbefore</code> and

771

794

<code>lastwordboldafter</code> in the same table.

772

795

773

774

775

<dt><code>firstletterbold dots</code><dt><code>begbold dots</code><dd>

796

<a name="index-firstletterbold-39"></a><a name="index-begbold-40"></a><a name="firstletterbold-opcode"></a><a name="begbold-opcode"></a> <dt><code>firstletterbold dots</code><dt><code>begbold dots</code><dd>

776

797

These two opcodes are synonyms. This is the braille indicator to be

777

798

placed before the first letter (or character) if bold emphasis begins

778

799

in the middle of a word.

779

800

780

781

782

<dt><code>lastletterbold dots</code><dt><code>endbold dots</code><dd>

801

<a name="index-lastletterbold-41"></a><a name="index-endbold-42"></a><a name="lastletterbold-opcode"></a><a name="endbold-opcode"></a> <dt><code>lastletterbold dots</code><dt><code>endbold dots</code><dd>

783

802

These two opcodes are synonyms. This is the braille indicator to be

784

803

placed after the last letter (or character) when bold emphasis ends in

785

804

the middle of a word.

786

805

787

788

<dt><code>singleletterbold dots</code><dd>

806

<a name="index-singleletterbold-43"></a><a name="singleletterbold-opcode"></a> <dt><code>singleletterbold dots</code><dd>

789

807

This braille indicator is used if only a single letter (or character)

790

808

is in boldface.

791

809

792

793

<dt><code>lenboldphrase number</code><dd>

810

<a name="index-lenboldphrase-44"></a><a name="lenboldphrase-opcode"></a> <dt><code>lenboldphrase number</code><dd>

794

811

If <code>lastwordboldbefore</code> is used, a bold phrase is checked to see

795

812

how many words it contains. If this number is less than or equal to

796

813

the number given in the <code>lenboldphrase</code> opcode, the

801

818

used its indicator is made up by doubling the dot pattern given in the

802

819

<code>lastwordboldbefore</code> entry.

803

820

804

805

<dt><code>firstwordunder dots</code><dd>

821

<a name="index-firstwordunder-45"></a><a name="firstwordunder-opcode"></a> <dt><code>firstwordunder dots</code><dd>

806

822

This is the braille indicator to be placed before the first word of an

807

823

underlined phrase.

808

824

809

810

811

<dt><code>lastwordunderbefore dots</code><dt><code>undersign dots</code><dd>

825

<a name="index-lastwordunderbefore-46"></a><a name="index-undersign-47"></a><a name="lastwordunderbefore-opcode"></a><a name="undersign-opcode"></a> <dt><code>lastwordunderbefore dots</code><dt><code>undersign dots</code><dd>

812

826

These two opcodes are synonyms. This is the braille indicator to be

813

827

placed before the last word of an underlined phrase. In addition, if

814

828

<code>firstwordunder</code> is not used, this braille indicator is doubled

815

829

and placed before the first word.

816

830

817

818

<dt><code>lastwordunderafter dots</code><dd>

831

<a name="index-lastwordunderafter-48"></a><a name="lastwordunderafter-opcode"></a> <dt><code>lastwordunderafter dots</code><dd>

819

832

This is the braille indicator to be placed after the last word of an

820

833

underlined phrase.

821

834

822

823

824

<dt><code>firstletterunder dots</code><dt><code>begunder dots</code><dd>

835

<a name="index-firstletterunder-49"></a><a name="index-begunder-50"></a><a name="firstletterunder-opcode"></a><a name="begunder-opcode"></a> <dt><code>firstletterunder dots</code><dt><code>begunder dots</code><dd>

825

836

These two opcodes are synonyms. This is the braille indicator to be

826

837

placed before the first letter (or character) if underline emphasis

827

838

begins in the middle of a word.

828

839

829

830

831

<dt><code>lastletterunder dots</code><dt><code>endunder dots</code><dd>

840

<a name="index-lastletterunder-51"></a><a name="index-endunder-52"></a><a name="lastletterunder-opcode"></a><a name="endunder-opcode"></a> <dt><code>lastletterunder dots</code><dt><code>endunder dots</code><dd>

832

841

These two opcodes are synonyms. This is the braille indicator to be

833

842

placed after the last letter (or character) when underline emphasis

834

843

ends in the middle of a word.

835

844

836

837

<dt><code>singleletterunder dots</code><dd>

845

<a name="index-singleletterunder-53"></a><a name="singleletterunder-opcode"></a> <dt><code>singleletterunder dots</code><dd>

838

846

This braille indicator is used if only a single letter (or character)

839

847

is underlined.

840

848

841

842

<dt><code>lenunderphrase number</code><dd>

849

<a name="index-lenunderphrase-54"></a><a name="lenunderphrase-opcode"></a> <dt><code>lenunderphrase number</code><dd>

843

850

If <code>lastwordunderbefore</code> is used, an underlined phrase is checked

844

851

to see how many words it contains. If this number is less than or

845

852

equal to the number given in the <code>lenunderphrase</code> opcode, the

850

857

not used its indicator is made up by doubling the dot pattern given in

851

858

the <code>lastwordunderbefore</code> entry.

852

859

853

854

<dt><code>begcomp dots</code><dd>

860

<a name="index-begcomp-55"></a><a name="begcomp-opcode"></a> <dt><code>begcomp dots</code><dd>

855

861

This braille indicator is placed before a sequence of characters

856

862

translated in computer braille, whether this sequence is indicated in

857

863

the <code>typeform</code> parameter (see <a href="#Programming-with-liblouis">Programming with liblouis</a>) or

858

864

inferred because it contains a subsequence specified by the

859

865

<code>compbrl</code> opcode (see <a href="#compbrl-opcode">compbrl</a>).

860

866

861

862

<dt><code>endcomp dots</code><dd>

867

<a name="index-endcomp-56"></a><a name="endcomp-opcode"></a> <dt><code>endcomp dots</code><dd>

863

868

This braille indicator is placed after a sequence of characters

864

869

translated in computer braille, whether this sequence is indicated in

865

870

the <code>typeform</code> parameter (see <a href="#Programming-with-liblouis">Programming with liblouis</a>) or

876

881

require special treatment.

877

882

878

883

879

880

881

<dt><code>decpoint character dots</code><dd>

884

885

<dl><a name="decpoint-opcode"></a><dt><code>decpoint character dots</code><dd>

882

886

This opcode defines the decimal point. The character operand must have

883

887

only one character. For example, in <samp>en-us-g1.ctb</samp> we have:

884

888

885

889

<pre class="example"> decpoint . 46

886

</pre>

887

888

<dt><code>hyphen character dots</code><dd>

890

</pre>

891

<a name="index-hyphen-58"></a><a name="hyphen-opcode"></a> <dt><code>hyphen character dots</code><dd>

889

892

This opcode defines the hyphen, that is, the character used in

890

893

compound words such as have-nots. The back-translator uses it to

891

894

determine the end of individual words.

899

902

These opcodes cause special processing to be carried out.

900

903

901

904

902

903

904

<dt><code>capsnocont</code><dd>

905

906

<dl><a name="capsnocont-opcode"></a><dt><code>capsnocont</code><dd>

905

907

This opcode has no operands. If it is specified words or parts of

906

908

words in all caps are not contracted. This is needed for languages

907

909

such as Norwegian.

931

933

The characters operand is a sequence or string of characters preceded

932

934

and followed by whitespace. Each character can be entered in the

933

935

normal way, or it can be defined as a four-digit hexadecimal number

934

preceded by `<samp>\x</samp>'.

936

preceded by ‘<samp>\x</samp>’.

935

937

936

938

The dots operand defines the braille representation for the characters

937

operand. It may also be specified as an equals sign (`<samp>=</samp>'). This

939

operand. It may also be specified as an equals sign (‘<samp>=</samp>’). This

938

940

means that the the default representation for each character

939

941

(see <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a>) within the sequence is to be

940

942

used.

941

943

942

In what follows the word `<samp>characters</samp>' means a sequence of one or

944

In what follows the word ‘<samp>characters</samp>’ means a sequence of one or

943

945

more consecutive letters between spaces and/or punctuation marks.

944

946

945

947

946

947

948

<dt><code>noback opcode ...</code><dd>

948

949

<dl><a name="noback-opcode"></a><dt><code>noback opcode ...</code><dd>

949

950

This is an opcode prefix, that is to say, it modifies the operation of

950

951

the opcode that follows it on the same line. noback specifies that no

951

952

back-translation is to be done using this line.

952

953

954

<pre class="example"> noback always ;\s; 0

954

</pre>

955

956

<dt><code>nofor opcode ...</code><dd>

955

</pre>

956

<a name="index-nofor-61"></a><a name="nofor-opcode"></a> <dt><code>nofor opcode ...</code><dd>

957

This is an opcode prefix which modifies the opration of the opcode

958

following it on the same line. nofor specifies that forward translation

959

is not to use the information on this line.

960

961

962

963

<dt><code>compbrl characters</code><dt><code>literal characters</code><dd>

961

<a name="index-compbrl-62"></a><a name="index-literal-63"></a><a name="compbrl-opcode"></a><a name="literal-opcode"></a> <dt><code>compbrl characters</code><dt><code>literal characters</code><dd>

964

962

These two opcodes are synonyms. If the characters are found within a

965

963

block of text surrounded by whitespace the entire block is translated

966

964

according to the default braille representations defined by the

969

967

<code>comp6</code> opcode (see <a href="#comp6-opcode">comp6</a>), if 6-dot computer braille is enabled. For example:

970

968

971

969

<pre class="example"> compbrl www translate URLs in computer braille

972

</pre>

973

974

<dt><code>comp6 character dots</code><dd>

970

</pre>

971

<a name="index-comp6-64"></a><a name="comp6-opcode"></a> <dt><code>comp6 character dots</code><dd>

975

972

This opcode specifies the translation of characters in 6-dot computer

976

973

braille. It is necessary because the translation of a single character

977

974

may require more than one cell. The first operand must be a character

980

977

of a misnomer, since any dots, not just dots 1 through 6, can be

981

978

specified. This even includes virtual dots.

982

979

983

984

<dt><code>nocont characters</code><dd>

980

<a name="index-nocont-65"></a><a name="nocont-opcode"></a> <dt><code>nocont characters</code><dd>

985

981

Like <code>compbrl</code>, except that the string is uncontracted.

986

982

<code>prepunc</code> opcode (see <a href="#prepunc-opcode">prepunc</a>) and <code>postpunc</code> opcode (see <a href="#postpunc-opcode">postpunc</a>) rules are applied,

987

983

however. This is useful for specifying that foreign words should not

988

984

be contracted in an entire document.

989

985

990

991

<dt><code>replace characters {characters}</code><dd>

986

<a name="index-replace-66"></a><a name="replace-opcode"></a> <dt><code>replace characters {characters}</code><dd>

992

987

Replace the first set of characters, no matter where they appear, with

993

988

the second. Note that the second operand is NOT a dot pattern.

994

989

It is also optional. If it is omitted the character(s) in the first

997

992

translation indirectly. Therefore, it is preferable to use

998

993

<code>correct</code> opcode (see <a href="#correct-opcode">correct</a>).

999

994

1000

1001

<dt><code>always characters dots</code><dd>

995

<a name="index-always-67"></a><a name="always-opcode"></a> <dt><code>always characters dots</code><dd>

1002

996

Replace the characters with the dot pattern no matter where they

1003

997

appear. Do NOT use an entry such as <code>always a 1</code>. Use the

1004

998

<code>uplow</code>, <code>letter</code>, etc. character definition opcodes

1005

999

instead. For example:

1006

1000

1007

1001

<pre class="example"> always world 456-2456 unconditional translation

1008

</pre>

1009

1010

<dt><code>repeated characters dots</code><dd>

1002

</pre>

1003

<a name="index-repeated-68"></a><a name="repeated-opcode"></a> <dt><code>repeated characters dots</code><dd>

1011

1004

Replace the characters with the dot pattern no matter where they

1012

1005

appear. Ignore any consecutive repetitions of the same character

1013

1006

sequence. This is useful for shortening long strings of spaces or

1014

1007

hyphens or periods. For example:

1015

1008

1016

1009

<pre class="example"> repeated --- 36-36-36 shorten separator lines made with hyphens

1017

</pre>

1018

1019

<dt><code>repword characters dots</code><dd>

1010

</pre>

1011

<a name="index-repword-69"></a><a name="repword-opcode"></a> <dt><code>repword characters dots</code><dd>

1020

1012

When characters are encountered check to see if the word before this

1021

1013

string matches the word after it. If so, replace characters with dots

1022

1014

and eliminate the second word and any word following another occurence

1024

1016

braille. In this case the rule is:

1025

1017

1026

1018

<pre class="example"> repword - 123456

1027

</pre>

1028

1029

<dt><code>largesign characters dots</code><dd>

1019

</pre>

1020

<a name="index-largesign-70"></a><a name="largesign-opcode"></a> <dt><code>largesign characters dots</code><dd>

1030

1021

Replace the characters with the dot pattern no matter where they

1031

1022

appear. In addition, if two words defined as large signs follow each

1032

1023

other, remove the space between them. For example, in

1033

<samp>en-us-g2.ctb</samp> the words `<samp>and</samp>' and `<samp>the</samp>' are both

1034

defined as large signs. Thus, in the phrase `<samp>the cat and the dog</samp>'

1035

the space would be deleted between `<samp>and</samp>' and `<samp>the</samp>', with the

1036

result `<samp>the cat andthe dog</samp>'. Of course, `<samp>and</samp>' and `<samp>the</samp>'

1024

<samp>en-us-g2.ctb</samp> the words ‘<samp>and</samp>’ and ‘<samp>the</samp>’ are both

1025

defined as large signs. Thus, in the phrase ‘<samp>the cat and the dog</samp>’

1026

the space would be deleted between ‘<samp>and</samp>’ and ‘<samp>the</samp>’, with the

1027

result ‘<samp>the cat andthe dog</samp>’. Of course, ‘<samp>and</samp>’ and ‘<samp>the</samp>’

1037

1028

would be properly contracted. The term <code>largesign</code> is a bit of

1038

1029

braille jargon that pleases braille experts.

1039

1030

1040

1041

<dt><code>word characters dots</code><dd>

1031

<a name="index-word-71"></a><a name="word-opcode"></a> <dt><code>word characters dots</code><dd>

1042

1032

Replace the characters with the dot pattern if they are a word, that

1043

1033

is, are surrounded by whitespace and/or punctuation.

1044

1034

1045

1046

<dt><code>syllable characters dots</code><dd>

1035

<a name="index-syllable-72"></a><a name="syllable-opcode"></a> <dt><code>syllable characters dots</code><dd>

1047

1036

As its name indicates, this opcode defines a "syllable" which must be

1048

1037

represented by exactly the dot patterns given. Contractions may not

1049

1038

cross the boundaries of this "syllable" either from left or right. The

1053

1042

within the sequence is to be used (see <a href="#Translation-Opcodes">Translation Opcodes</a>):

1054

1043

1055

1044

<pre class="example"> syllable horse = sawhorse, horseradish

1056

</pre>

1057

1058

<dt><code>nocross characters dots</code><dd>

1045

</pre>

1046

<a name="index-nocross-73"></a><a name="nocross-opcode"></a> <dt><code>nocross characters dots</code><dd>

1059

1047

Replace the characters with the dot pattern if the characters are all

1060

1048

in one syllable (do not cross a syllable boundary). For this opcode to

1061

1049

work, a hyphenation table must be included. If this is not done,

1062

1050

<code>nocross</code> behaves like the <code>always</code> opcode (see <a href="#always-opcode">always</a>). For example, if

1063

1051

the English Grade 2 table is being used and the appropriate

1064

1052

hyphenation table has been included <code>nocross sh 146</code> will cause

1065

the `<samp>sh</samp>' in `<samp>monkshood</samp>' not to be contracted.

1053

the ‘<samp>sh</samp>’ in ‘<samp>monkshood</samp>’ not to be contracted.

1066

1054

1067

1068

<dt><code>joinword characters dots</code><dd>

1055

<a name="index-joinword-74"></a><a name="joinword-opcode"></a> <dt><code>joinword characters dots</code><dd>

1069

1056

Replace the characters with the dot pattern if they are a word which

1070

1057

is followed by whitespace and a letter. In addition remove the

1071

1058

whitespace. For example, <samp>en-us-g2.ctb</samp> has <code>joinword to

1072

235</code>. This means that if the word `<samp>to</samp>' is followed by another

1059

235</code>. This means that if the word ‘<samp>to</samp>’ is followed by another

1073

1060

word the contraction is to be used and the space is to be omitted. If

1074

1061

these conditions are not met, the word is translated according to any

1075

1062

other opcodes that may apply to it.

1076

1063

1077

1078

<dt><code>lowword characters dots</code><dd>

1064

<a name="index-lowword-75"></a><a name="lowword-opcode"></a> <dt><code>lowword characters dots</code><dd>

1079

1065

Replace the characters with the dot pattern if they are a word

1080

1066

preceded and followed by whitespace. No punctuation either before or

1081

1067

after the word is allowed. The term <code>lowword</code> derives from the

1083

1069

of the cell. For example:

1084

1070

1085

1071

<pre class="example"> lowword were 2356

1086

</pre>

1087

1088

<dt><code>contraction characters</code><dd>

1072

</pre>

1073

<a name="index-contraction-76"></a><a name="contraction-opcode"></a> <dt><code>contraction characters</code><dd>

1089

1074

If you look at <samp>en-us-g2.ctb</samp> you will see that some words are

1090

1075

actually contracted into some of their own letters. A famous example

1091

among braille transcribers is `<samp>also</samp>', which is contracted as

1092

`<samp>al</samp>'. But this is also the name of a person. To take another

1093

example, `<samp>altogether</samp>' is contracted as `<samp>alt</samp>', but this is

1076

among braille transcribers is ‘<samp>also</samp>’, which is contracted as

1077

‘<samp>al</samp>’. But this is also the name of a person. To take another

1078

example, ‘<samp>altogether</samp>’ is contracted as ‘<samp>alt</samp>’, but this is

1094

1079

the abbreviation for the alternate key on a computer keyboard.

1095

Similarly `<samp>could</samp>' is contracted into `<samp>cd</samp>', but this is the

1080

Similarly ‘<samp>could</samp>’ is contracted into ‘<samp>cd</samp>’, but this is the

1096

1081

abbreviation for compact disk. To prevent confusion in such cases, the

1097

1082

letter sign (see <code>letsign</code> opcode (see <a href="#letsign-opcode">letsign</a>)) is placed before such letter

1098

1083

combinations when they actually are abbreviations, not contractions.

1099

1084

The <code>contraction</code> opcode tells the translator to do this.

1100

1085

1101

1102

<dt><code>sufword characters dots</code><dd>

1086

<a name="index-sufword-77"></a><a name="sufword-opcode"></a> <dt><code>sufword characters dots</code><dd>

1103

1087

Replace the characters with the dot pattern if they are either a word

1104

1088

or at the beginning of a word.

1105

1089

1106

1107

<dt><code>prfword characters dots</code><dd>

1090

<a name="index-prfword-78"></a><a name="prfword-opcode"></a> <dt><code>prfword characters dots</code><dd>

1108

1091

Replace the characters with the dot pattern if they are either a word

1109

1092

or at the end of a word.

1110

1093

1111

1112

<dt><code>begword characters dots</code><dd>

1094

<a name="index-begword-79"></a><a name="begword-opcode"></a> <dt><code>begword characters dots</code><dd>

1113

1095

Replace the characters with the dot pattern if they are at the

1114

1096

beginning of a word.

1115

1097

1116

1117

<dt><code>begmidword characters dots</code><dd>

1098

<a name="index-begmidword-80"></a><a name="begmidword-opcode"></a> <dt><code>begmidword characters dots</code><dd>

1118

1099

Replace the characters with the dot pattern if they are either at the

1119

1100

beginning or in the middle of a word.

1120

1101

1121

1122

<dt><code>midword characters dots</code><dd>

1102

<a name="index-midword-81"></a><a name="midword-opcode"></a> <dt><code>midword characters dots</code><dd>

1123

1103

Replace the characters with the dot pattern if they are in the middle

1124

1104

of a word.

1125

1105

1126

1127

<dt><code>midendword characters dots</code><dd>

1106

<a name="index-midendword-82"></a><a name="midendword-opcode"></a> <dt><code>midendword characters dots</code><dd>

1128

1107

Replace the characters with the dot pattern if they are either in the

1129

1108

middle or at the end of a word.

1130

1109

1131

1132

<dt><code>endword characters dots</code><dd>

1110

<a name="index-endword-83"></a><a name="endword-opcode"></a> <dt><code>endword characters dots</code><dd>

1133

1111

Replace the characters with the dot pattern if they are at the end of

1134

1112

a word.

1135

1113

1136

1137

<dt><code>partword characters dots</code><dd>

1114

<a name="index-partword-84"></a><a name="partword-opcode"></a> <dt><code>partword characters dots</code><dd>

1138

1115

Replace the characters with the dot pattern if the characters are

1139

1116

anywhere in a word, that is, if they are proceeded or followed by a

1140

1117

letter.

1141

1118

1142

1143

<dt><code>exactdots @dots</code><dd>

1144

Note that the operand must begin with an at sign (`<samp>@</samp>'). The dot

1119

<a name="index-exactdots-85"></a><a name="exactdots-opcode"></a> <dt><code>exactdots @dots</code><dd>

1120

Note that the operand must begin with an at sign (‘<samp>@</samp>’). The dot

1145

1121

pattern following it is evaluated for validity. If it is valid,

1146

1122

whenever an at sign followed by this dot pattern appears in the source

1147

1123

document it is replaced by the characters corresponding to the dot

1150

1126

mathematical codes. For example:

1151

1127

1152

1128

<pre class="example"> exactdots @4-46-12356

1153

</pre>

1129

</pre>

1154

1130

will produce the characters with these dot patterns in the output.

1155

1131

1156

1157

<dt><code>prepunc characters dots</code><dd>

1132

<a name="index-prepunc-86"></a><a name="prepunc-opcode"></a> <dt><code>prepunc characters dots</code><dd>

1158

1133

Replace the characters with the dot pattern if they are part of

1159

1134

punctuation at the beginning of a word.

1160

1135

1161

1162

<dt><code>postpunc characters dots</code><dd>

1136

<a name="index-postpunc-87"></a><a name="postpunc-opcode"></a> <dt><code>postpunc characters dots</code><dd>

1163

1137

Replace the characters with the dot pattern if they are part of

1164

1138

punctuation at the end of a word.

1165

1139

1166

1167

<dt><code>begnum characters dots</code><dd>

1140

<a name="index-begnum-88"></a><a name="begnum-opcode"></a> <dt><code>begnum characters dots</code><dd>

1168

1141

Replace the characters with the dot pattern if they are at the

1169

1142

beginning of a number, that is, before all its digits. For example, in

1170

1143

<samp>en-us-g1.ctb</samp> we have <code>begnum # 4</code>.

1171

1144

1172

1173

<dt><code>midnum characters dots</code><dd>

1145

<a name="index-midnum-89"></a><a name="midnum-opcode"></a> <dt><code>midnum characters dots</code><dd>

1174

1146

Replace the characters with the dot pattern if they are in the middle

1175

1147

of a number. For example, <samp>en-us-g1.ctb</samp> has <code>midnum . 46</code>.

1176

1148

This is because the decimal point has a different dot pattern than the

1177

1149

period.

1178

1150

1179

1180

<dt><code>endnum characters dots</code><dd>

1151

<a name="index-endnum-90"></a><a name="endnum-opcode"></a> <dt><code>endnum characters dots</code><dd>

1181

1152

Replace the characters with the dot pattern if they are at the end of

1182

1153

a number. For example <samp>en-us-g1.ctb</samp> has <code>endnum th 1456</code>.

1183

This handles things like `<samp>4th</samp>'. A letter sign is NOT

1154

This handles things like ‘<samp>4th</samp>’. A letter sign is NOT

1184

1155

inserted.

1185

1156

1186

1187

<dt><code>joinnum characters dots</code><dd>

1157

<a name="index-joinnum-91"></a><a name="joinnum-opcode"></a> <dt><code>joinnum characters dots</code><dd>

1188

1158

Replace the characters with the dot pattern. In addition, if

1189

1159

whitespace and a number follows omit the whitespace.

1190

1160

1212

1182

<dt><code>lowercase</code><dd>Lowercase alphabetic characters

1213

1183

<dt><code>uppercase</code><dd>Uppercase alphabetic characters

1214

1184

<dt><code>punctuation</code><dd>Punctuation marks

1215

<dt><code>sign</code><dd>Signs such as percent (`<samp>%</samp>')

1185

<dt><code>sign</code><dd>Signs such as percent (‘<samp>%</samp>’)

1216

1186

<dt><code>math</code><dd>Mathematical symbols

1217

1187

<dt><code>litdigit</code><dd>Literary digit

1218

1188

<dt><code>undefined</code><dd>Not properly defined

1223

1193

For examples see <samp>fr-abrege.ctb</samp>.

1224

1194

1225

1195

1226

1227

1228

<dt><code>class name characters</code><dd>

1196

1197

<dl><a name="class-opcode"></a><dt><code>class name characters</code><dd>

1229

1198

Define a new character class. The characters operand must be specified

1230

1199

as a string. A character class may not be used until it has been

1231

1200

defined.

1232

1201

1233

1234

<dt><code>after class opcode ...</code><dd>

1202

<a name="index-after-93"></a><a name="after-opcode"></a> <dt><code>after class opcode ...</code><dd>

1235

1203

The specified opcode is further constrained in that the matched

1236

1204

character sequence must be immediately preceded by a character

1237

1205

belonging to the specified class. If this opcode is used more than

1238

1206

once on the same line then the union of the characters in all the

1239

1207

classes is used.

1240

1208

1241

1242

<dt><code>before class opcode ...</code><dd>

1209

<a name="index-before-94"></a><a name="before-opcode"></a> <dt><code>before class opcode ...</code><dd>

1243

1210

The specified opcode is further constrained in that the matched

1244

1211

character sequence must be immediately followed by a character

1245

1212

belonging to the specified class. If this opcode is used more than

1262

1229

are separated by commas and may contain more than one cell.

1263

1230

1264

1231

1265

1266

1267

<dt><code>swapcd name characters dots, dots, dots, ...</code><dd>

1232

1233

<dl><a name="swapcd-opcode"></a><dt><code>swapcd name characters dots, dots, dots, ...</code><dd>

1268

1234

See above paragraph for explanation. For example:

1269

1235

1270

1236

<pre class="example"> swapcd dropped 0123456789 356,2,23,...

1271

</pre>

1272

1273

<dt><code>swapdd name dots, dots, dots ... dotpattern1, dotpattern2, dotpattern3, ...</code><dd>

1237

</pre>

1238

<a name="index-swapdd-96"></a><a name="swapdd-opcode"></a> <dt><code>swapdd name dots, dots, dots ... dotpattern1, dotpattern2, dotpattern3, ...</code><dd>

1274

1239

The <code>swapdd</code> opcode defines substitutions for the multipass

1275

1240

opcodes. In the second operand the dot patterns must be single cells,

1276

1241

but in the third operand multi-cell dot patterns are allowed. This is

1277

1242

because multi-cell patterns in the second operand would lead to

1278

1243

ambiguities.

1279

1244

1280

1281

<dt><code>swapcc name characters characters</code><dd>

1245

<a name="index-swapcc-97"></a><a name="swapcc-opcode"></a> <dt><code>swapcc name characters characters</code><dd>

1282

1246

The <code>swapcc</code> opcode swaps characters in its second operand for

1283

1247

characters in the corresponding places in its third operand. It is

1284

1248

intended for use with <code>correct</code> opcodes and can solve problems

1291

1255

<h3 class="section">3.10 The Context and Multipass Opcodes</h3>

1292

1256

1293

1257

<dl>

1294

1295

<a name="index-context-97"></a><a name="index-pass2-98"></a><a name="index-pass3-99"></a><a name="index-pass4-100"></a><dt><code>context test action</code><dt><code>pass2 test action</code><dt><code>pass3 test action</code><dt><code>pass4 test action</code><dd>

1258

<a name="context-opcode"></a><a name="index-context-98"></a><a name="index-pass2-99"></a><a name="index-pass3-100"></a><a name="index-pass4-101"></a><dt><code>context test action</code><dt><code>pass2 test action</code><dt><code>pass3 test action</code><dt><code>pass4 test action</code><dd>

1296

1259

The <code>context</code> and multipass opcodes (<code>pass2</code>, <code>pass3</code>

1297

1260

and <code>pass4</code>) provide translation capabilities beyond those of the

1298

1261

basic translation opcodes (see <a href="#Translation-Opcodes">Translation Opcodes</a>) discussed

1305

1268

format of all these opcodes is:

1306

1269

1307

1270

<pre class="example"> opcode test action

1308

</pre>

1271

</pre>

1309

1272

The <code>test</code> and <code>action</code> operands have suboperands. Each

1310

1273

suboperand begins with a non-alphanumeric character and ends when

1311

1274

another non-alphanumeric character is encountered. The suboperands and

1315

1278

<dt><kbd>" (double quote)</kbd><dd>a string of characters. This string must be terminated by another

1316

1279

double quote. It may contain any characters. If a double quote is

1317

1280

needed within the string, it must be preceded by a backslash

1318

(`<samp>\</samp>'). If a space is needed, it must be represented by the escape

1281

(‘<samp>\</samp>’). If a space is needed, it must be represented by the escape

1319

1282

sequence \s. This suboperand is valid only in the test part of the

1320

1283

<code>context</code> opcode.

1321

1284

1323

1286

This suboperand is not valid in the test part of the context and

1324

1287

correct opcodes.

1325

1288

1326

<dt><kbd>$ (dollar sign)</kbd><dd>a string of attributes, such as `<samp>d</samp>' for digit, `<samp>l</samp>' for

1289

<dt><kbd>$ (dollar sign)</kbd><dd>a string of attributes, such as ‘<samp>d</samp>’ for digit, ‘<samp>l</samp>’ for

1327

1290

letter, etc. More than one attribute can be given. If you wish to

1328

check characters with any attribute, use the letter `<samp>a</samp>'. Input

1291

check characters with any attribute, use the letter ‘<samp>a</samp>’. Input

1329

1292

characters are checked to see if they have at least one of the

1330

1293

attributes. The attribute string can be followed by numbers specifying

1331

1294

how many characters are to be checked. If no numbers are given, 1 is

1417

1380

<h3 class="section">3.11 The correct Opcode</h3>

1418

1381

1419

1382

1420

1421

1422

<dt><code>correct test action</code><dd>

1383

1384

<dl><a name="correct-opcode"></a><dt><code>correct test action</code><dd>

1423

1385

Because some input (such as that from an OCR program) may contain

1424

1386

systematic errors, it is sometimes advantageous to use a

1425

1387

pre-translation pass to remove them. The errors and their corrections

1437

1399

correct "*" ? Get rid of stray asterisks

1438

1400

correct "|" ? ditto for vertical bars

1439

1401

correct "\s?" "?" drop space before question mark

1440

</pre>

1402

</pre>

1441

1403

Note that if the <code>correct</code> opcode is used and the

1442

1404

<code>pass1Only</code> mode bit (see <a href="#lou_005ftranslateString">lou_translateString</a>) is not set

1443

1405

input and output positions may be incorrect.

1449

1411

<h3 class="section">3.12 Miscellaneous Opcodes</h3>

1450

1412

1451

1413

1452

1453

1454

<dt><code>include filename</code><dd>

1414

1415

<dl><a name="include-opcode"></a><dt><code>include filename</code><dd>

1455

1416

Read the file indicated by <code>filename</code> and incorporate or include

1456

1417

its entries into the table. Included files can include other files,

1457

1418

which can include other files, etc. For an example, see what files are

1459

1420

<samp>en-us-g2.ctb</samp>. If the included file is not in the same directory

1460

1421

as the main table, use a full pathname for filename.

1461

1422

1462

1463

<dt><code>locale characters</code><dd>

1423

<a name="index-locale-104"></a><a name="locale-opcode"></a> <dt><code>locale characters</code><dd>

1464

1424

Not implemented, but recognized and ignored for backward

1465

1425

compatibility.

1466

1426

1467

1468

<dt><code>display character dots</code><dd>

1427

<a name="index-display-105"></a><a name="display-opcode"></a> <dt><code>display character dots</code><dd>

1469

1428

Associates dot patterns with the characters which will be sent to a

1470

1429

braille embosser, display or screen font. The character must be in the

1471

1430

range 0-255 and the dots must specify a single cell. Here are some

1473

1432

1474

1433

<pre class="example"> display a 1 When the character a is sent to the embosser or display,

1475

1434

it # will produce a dot 1.

1476

</pre>

1435

</pre>

1477

1436

<pre class="example"> display L 123 When the character L is sent to the display or embosser

1478

1437

# produces dots 1-2-3.

1479

</pre>

1438

</pre>

1480

1439

The display opcode is optional. It is used when the embosser or

1481

1440

display has a different mapping of characters to dot patterns than

1482

1441

that given in <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a>. If used, display

1483

1442

entries must proceed character-definition entries.

1484

1443

1485

1486

<dt><code>multind dots opcode opcode ...</code><dd>

1444

<a name="index-multind-106"></a><a name="multind-opcode"></a> <dt><code>multind dots opcode opcode ...</code><dd>

1487

1445

the multind opcode tells the back-translator that a sequence of

1488

1446

braille cells represents more than one braille indicator. For example,

1489

1447

in <samp>en-us-g1.ctb</samp> we have <code>multind 56-6 letsign capsign</code>.

1605

1563

1606

1564

The data structure <code>TranslationTableHeader</code> is defined by a

1607

1565

<code>typedef</code> statement in <samp>louis.h</samp>. To find the beginning,

1608

search for the word `<samp>header</samp>'. As its name implies, this is

1566

search for the word ‘<samp>header</samp>’. As its name implies, this is

1609

1567

actually the table header. Data are placed in the <code>ruleArea</code>

1610

1568

array, which is the last item defined in this structure. This array is

1611

1569

declared with a length of 1 and is expanded as needed. The table

1650

1608

1651

1609

Next is an array of size 256 which maps characters in this range to

1652

1610

dot patterns which may consist of multiple cells. It is used, for

1653

example, to map `<samp>{</samp>' to dots 456-246. These mappings are created

1611

example, to map ‘<samp>{</samp>’ to dots 456-246. These mappings are created

1654

1612

1655

1613

1656

1614

by the <code>compdots</code>

1674

1632

1675

1633

<h3 class="section">5.4 lou_version</h3>

1676

1634

1677

1635

1678

1636

<pre class="example"> char *lou_version ()

1679

1637

</pre>

1680

1638

This function returns a pointer to a character string containing the

1686

1644

1687

1645

<h3 class="section">5.5 lou_translateString</h3>

1688

1646

1689

1647

1690

1648

<pre class="example"> int lou_translateString (

1691

1649

const char *const trantab,

1692

1650

const widechar *const inbuf,

1705

1663

is indicated by the character-definition and display opcodes in the

1706

1664

translation table.

1707

1665

1708

1709

The <code>trantab</code> parameter points to a list of translation tables

1666

<a name="translation_002dtables"></a>The <code>trantab</code> parameter points to a list of translation tables

1710

1667

separated by commas. If only one table is given, no comma should be

1711

1668

used after it. It is these tables which control just how the

1712

1669

translation is made, whether in Grade 2, Grade 1, or something else.

1764

1721

1765

1722

<h3 class="section">5.6 lou_translate</h3>

1766

1723

1767

1724

1768

1725

<pre class="example"> int lou_translate (

1769

1726

const char *const trantab,

1770

1727

const widechar * const inbuf,

1801

1758

1802

1759

<h3 class="section">5.7 lou_backTranslateString</h3>

1803

1760

1804

1761

1805

1762

<pre class="example"> int lou_backTranslateString (

1806

1763

const char *const trantab,

1807

1764

const widechar *const inbuf,

1827

1784

1828

1785

<h3 class="section">5.8 lou_backTranslate</h3>

1829

1786

1830

1787

1831

1788

<pre class="example"> int lou_backTranslate (

1832

1789

const char *const trantab,

1833

1790

const widechar *const inbufx,

1848

1805

1849

1806

<h3 class="section">5.9 lou_hyphenate</h3>

1850

1807

1851

1808

1852

1809

<pre class="example"> int lou_hyphenate (

1853

1810

const char *const trantab,

1854

1811

const widechar * const inbuf,

1882

1839

1883

1840

<h3 class="section">5.10 lou_logFile</h3>

1884

1841

1885

1842

1886

1843

<pre class="example"> void lou_logFile (char *fileName);

1887

1844

</pre>

1888

1845

This function is used when it is not convenient either to let messages

1896

1853

1897

1854

<h3 class="section">5.11 lou_logPrint</h3>

1898

1855

1899

1856

1900

1857

<pre class="example"> void lou_logPrint (char *format, ...);

1901

1858

</pre>

1902

1859

This function is called like <code>fprint</code>. It can be used by other

1909

1866

1910

1867

<h3 class="section">5.12 lou_getTable</h3>

1911

1868

1912

1869

1913

1870

<pre class="example"> void *lou_getTable (char *tablelist);

1914

1871

</pre>

1915

1872

<code>tablelist</code> is a list of names of table files separated by

1925

1882

1926

1883

<h3 class="section">5.13 lou_readCharFromFile</h3>

1927

1884

1928

1885

1929

1886

<pre class="example"> int lou_readCharFromFile (const char *fileName, int *mode);

1930

1887

</pre>

1931

1888

This function is provided for situations where it is necessary to read

1942

1899

1943

1900

1944

1901

1945

1902

1946

1903

<pre class="example"> void lou_free ();

1947

1904

</pre>

1948

1905

This function should be called at the end of the application to free

1965

1922

<h2 class="unnumbered">Opcode Index</h2>

1966

1923

1967

1924

1968

<li><a href="#index-after-92">after</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1969

<li><a href="#index-always-66">always</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1970

<li><a href="#index-before-93">before</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1971

<li><a href="#index-begbold-39">begbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1972

<li><a href="#index-begcaps-17">begcaps</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1973

<li><a href="#index-begcomp-54">begcomp</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1974

<li><a href="#index-begital-29">begital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1975

<li><a href="#index-begmidword-79">begmidword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1976

<li><a href="#index-begnum-87">begnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1977

<li><a href="#index-begunder-49">begunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1978

<li><a href="#index-begword-78">begword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1979

<li><a href="#index-boldsign-36">boldsign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1980

<li><a href="#index-capsign-16">capsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1981

<li><a href="#index-capsnocont-58">capsnocont</a>: <a href="#Special-Processing-Opcodes">Special Processing Opcodes</a></li>

1982

<li><a href="#index-class-91">class</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1983

<li><a href="#index-comp6-63">comp6</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1984

<li><a href="#index-compbrl-61">compbrl</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1985

<li><a href="#index-context-97">context</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

1986

<li><a href="#index-contraction-75">contraction</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1987

<li><a href="#index-correct-101">correct</a>: <a href="#The-correct-Opcode">The correct Opcode</a></li>

1988

<li><a href="#index-decpoint-56">decpoint</a>: <a href="#Special-Symbol-Opcodes">Special Symbol Opcodes</a></li>

1989

<li><a href="#index-digit-7">digit</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1990

<li><a href="#index-display-104">display</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

1991

<li><a href="#index-endbold-41">endbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1992

<li><a href="#index-endcaps-18">endcaps</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1993

<li><a href="#index-endcomp-55">endcomp</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1994

<li><a href="#index-endital-31">endital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1995

<li><a href="#index-endnum-89">endnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1996

<li><a href="#index-endunder-51">endunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1997

<li><a href="#index-endword-82">endword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1998

<li><a href="#index-exactdots-84">exactdots</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1999

<li><a href="#index-firstletterbold-38">firstletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2000

<li><a href="#index-firstletterital-28">firstletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2001

<li><a href="#index-firstletterunder-48">firstletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2002

<li><a href="#index-firstwordbold-34">firstwordbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2003

<li><a href="#index-firstwordital-24">firstwordital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2004

<li><a href="#index-firstwordunder-44">firstwordunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2005

<li><a href="#index-grouping-9">grouping</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2006

<li><a href="#index-hyphen-57">hyphen</a>: <a href="#Special-Symbol-Opcodes">Special Symbol Opcodes</a></li>

2007

<li><a href="#index-include-102">include</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

2008

<li><a href="#index-italsign-26">italsign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2009

<li><a href="#index-joinnum-90">joinnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2010

<li><a href="#index-joinword-73">joinword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2011

<li><a href="#index-largesign-69">largesign</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2012

<li><a href="#index-lastletterbold-40">lastletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2013

<li><a href="#index-lastletterital-30">lastletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2014

<li><a href="#index-lastletterunder-50">lastletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2015

<li><a href="#index-lastwordboldafter-37">lastwordboldafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2016

<li><a href="#index-lastwordboldbefore-35">lastwordboldbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2017

<li><a href="#index-lastworditalafter-27">lastworditalafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2018

<li><a href="#index-lastworditalbefore-25">lastworditalbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2019

<li><a href="#index-lastwordunderafter-47">lastwordunderafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2020

<li><a href="#index-lastwordunderbefore-45">lastwordunderbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2021

<li><a href="#index-lenboldphrase-43">lenboldphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2022

<li><a href="#index-lenitalphrase-33">lenitalphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2023

<li><a href="#index-lenunderphrase-53">lenunderphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2024

<li><a href="#index-letsign-19">letsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2025

<li><a href="#index-letter-10">letter</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2026

<li><a href="#index-litdigit-13">litdigit</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2027

<li><a href="#index-literal-62">literal</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2028

<li><a href="#index-locale-103">locale</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

2029

<li><a href="#index-lowercase-11">lowercase</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2030

<li><a href="#index-lowword-74">lowword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2031

<li><a href="#index-math-15">math</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2032

<li><a href="#index-midendword-81">midendword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2033

<li><a href="#index-midnum-88">midnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2034

<li><a href="#index-midword-80">midword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2035

<li><a href="#index-multind-105">multind</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

2036

<li><a href="#index-noback-59">noback</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2037

<li><a href="#index-nocont-64">nocont</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2038

<li><a href="#index-nocross-72">nocross</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2039

<li><a href="#index-nofor-60">nofor</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2040

<li><a href="#index-noletsign-20">noletsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2041

<li><a href="#index-noletsignafter-22">noletsignafter</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2042

<li><a href="#index-noletsignbefore-21">noletsignbefore</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2043

<li><a href="#index-numsign-23">numsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2044

<li><a href="#index-partword-83">partword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2045

<li><a href="#index-pass2-98">pass2</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2046

<li><a href="#index-pass3-99">pass3</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2047

<li><a href="#index-pass4-100">pass4</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2048

<li><a href="#index-postpunc-86">postpunc</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2049

<li><a href="#index-prepunc-85">prepunc</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2050

<li><a href="#index-prfword-77">prfword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2051

<li><a href="#index-punctuation-6">punctuation</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2052

<li><a href="#index-repeated-67">repeated</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2053

<li><a href="#index-replace-65">replace</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2054

<li><a href="#index-repword-68">repword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2055

<li><a href="#index-sign-14">sign</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2056

<li><a href="#index-singleletterbold-42">singleletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2057

<li><a href="#index-singleletterital-32">singleletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2058

<li><a href="#index-singleletterunder-52">singleletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2059

<li><a href="#index-space-5">space</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2060

<li><a href="#index-sufword-76">sufword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2061

<li><a href="#index-swapcc-96">swapcc</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2062

<li><a href="#index-swapcd-94">swapcd</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2063

<li><a href="#index-swapdd-95">swapdd</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2064

<li><a href="#index-syllable-71">syllable</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2065

<li><a href="#index-undersign-46">undersign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2066

<li><a href="#index-uplow-8">uplow</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2067

<li><a href="#index-uppercase-12">uppercase</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2068

<li><a href="#index-word-70">word</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1925

<li><a href="#index-after-93">after</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1926

<li><a href="#index-always-67">always</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1927

<li><a href="#index-before-94">before</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1928

<li><a href="#index-begbold-40">begbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1929

<li><a href="#index-begcaps-18">begcaps</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1930

<li><a href="#index-begcomp-55">begcomp</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1931

<li><a href="#index-begital-30">begital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1932

<li><a href="#index-begmidword-80">begmidword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1933

<li><a href="#index-begnum-88">begnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1934

<li><a href="#index-begunder-50">begunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1935

<li><a href="#index-begword-79">begword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1936

<li><a href="#index-boldsign-37">boldsign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1937

<li><a href="#index-capsign-17">capsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1938

<li><a href="#index-capsnocont-59">capsnocont</a>: <a href="#Special-Processing-Opcodes">Special Processing Opcodes</a></li>

1939

<li><a href="#index-class-92">class</a>: <a href="#Character_002dClass-Opcodes">Character-Class Opcodes</a></li>

1940

<li><a href="#index-comp6-64">comp6</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1941

<li><a href="#index-compbrl-62">compbrl</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1942

<li><a href="#index-context-98">context</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

1943

<li><a href="#index-contraction-76">contraction</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1944

<li><a href="#index-correct-102">correct</a>: <a href="#The-correct-Opcode">The correct Opcode</a></li>

1945

<li><a href="#index-decpoint-57">decpoint</a>: <a href="#Special-Symbol-Opcodes">Special Symbol Opcodes</a></li>

1946

<li><a href="#index-digit-8">digit</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1947

<li><a href="#index-display-105">display</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

1948

<li><a href="#index-endbold-42">endbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1949

<li><a href="#index-endcaps-19">endcaps</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1950

<li><a href="#index-endcomp-56">endcomp</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1951

<li><a href="#index-endital-32">endital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1952

<li><a href="#index-endnum-90">endnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1953

<li><a href="#index-endunder-52">endunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1954

<li><a href="#index-endword-83">endword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1955

<li><a href="#index-exactdots-85">exactdots</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1956

<li><a href="#index-firstletterbold-39">firstletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1957

<li><a href="#index-firstletterital-29">firstletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1958

<li><a href="#index-firstletterunder-49">firstletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1959

<li><a href="#index-firstwordbold-35">firstwordbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1960

<li><a href="#index-firstwordital-25">firstwordital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1961

<li><a href="#index-firstwordunder-45">firstwordunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1962

<li><a href="#index-grouping-10">grouping</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1963

<li><a href="#index-hyphen-58">hyphen</a>: <a href="#Special-Symbol-Opcodes">Special Symbol Opcodes</a></li>

1964

<li><a href="#index-include-103">include</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

1965

<li><a href="#index-italsign-27">italsign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1966

<li><a href="#index-joinnum-91">joinnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1967

<li><a href="#index-joinword-74">joinword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1968

<li><a href="#index-largesign-70">largesign</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1969

<li><a href="#index-lastletterbold-41">lastletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1970

<li><a href="#index-lastletterital-31">lastletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1971

<li><a href="#index-lastletterunder-51">lastletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1972

<li><a href="#index-lastwordboldafter-38">lastwordboldafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1973

<li><a href="#index-lastwordboldbefore-36">lastwordboldbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1974

<li><a href="#index-lastworditalafter-28">lastworditalafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1975

<li><a href="#index-lastworditalbefore-26">lastworditalbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1976

<li><a href="#index-lastwordunderafter-48">lastwordunderafter</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1977

<li><a href="#index-lastwordunderbefore-46">lastwordunderbefore</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1978

<li><a href="#index-lenboldphrase-44">lenboldphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1979

<li><a href="#index-lenitalphrase-34">lenitalphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1980

<li><a href="#index-lenunderphrase-54">lenunderphrase</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

1981

<li><a href="#index-letsign-20">letsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1982

<li><a href="#index-letter-11">letter</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1983

<li><a href="#index-litdigit-14">litdigit</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1984

<li><a href="#index-literal-63">literal</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1985

<li><a href="#index-locale-104">locale</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

1986

<li><a href="#index-lowercase-12">lowercase</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1987

<li><a href="#index-lowword-75">lowword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1988

<li><a href="#index-math-16">math</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

1989

<li><a href="#index-midendword-82">midendword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1990

<li><a href="#index-midnum-89">midnum</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1991

<li><a href="#index-midword-81">midword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1992

<li><a href="#index-multind-106">multind</a>: <a href="#Miscellaneous-Opcodes">Miscellaneous Opcodes</a></li>

1993

<li><a href="#index-noback-60">noback</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1994

<li><a href="#index-nocont-65">nocont</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1995

<li><a href="#index-nocross-73">nocross</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1996

<li><a href="#index-nofor-61">nofor</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

1997

<li><a href="#index-noletsign-21">noletsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1998

<li><a href="#index-noletsignafter-23">noletsignafter</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

1999

<li><a href="#index-noletsignbefore-22">noletsignbefore</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2000

<li><a href="#index-numsign-24">numsign</a>: <a href="#Braille-Indicator-Opcodes">Braille Indicator Opcodes</a></li>

2001

<li><a href="#index-partword-84">partword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2002

<li><a href="#index-pass2-99">pass2</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2003

<li><a href="#index-pass3-100">pass3</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2004

<li><a href="#index-pass4-101">pass4</a>: <a href="#The-Context-and-Multipass-Opcodes">The Context and Multipass Opcodes</a></li>

2005

<li><a href="#index-postpunc-87">postpunc</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2006

<li><a href="#index-prepunc-86">prepunc</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2007

<li><a href="#index-prfword-78">prfword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2008

<li><a href="#index-punctuation-7">punctuation</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2009

<li><a href="#index-repeated-68">repeated</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2010

<li><a href="#index-replace-66">replace</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2011

<li><a href="#index-repword-69">repword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2012

<li><a href="#index-sign-15">sign</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2013

<li><a href="#index-singleletterbold-43">singleletterbold</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2014

<li><a href="#index-singleletterital-33">singleletterital</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2015

<li><a href="#index-singleletterunder-53">singleletterunder</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2016

<li><a href="#index-space-6">space</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2017

<li><a href="#index-sufword-77">sufword</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2018

<li><a href="#index-swapcc-97">swapcc</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2019

<li><a href="#index-swapcd-95">swapcd</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2020

<li><a href="#index-swapdd-96">swapdd</a>: <a href="#Swap-Opcodes">Swap Opcodes</a></li>

2021

<li><a href="#index-syllable-72">syllable</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2022

<li><a href="#index-undersign-47">undersign</a>: <a href="#Emphasis-Opcodes">Emphasis Opcodes</a></li>

2023

<li><a href="#index-uplow-9">uplow</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2024

<li><a href="#index-uppercase-13">uppercase</a>: <a href="#Character_002dDefinition-Opcodes">Character-Definition Opcodes</a></li>

2025

<li><a href="#index-word-71">word</a>: <a href="#Translation-Opcodes">Translation Opcodes</a></li>

2069

2026

</ul><a name="Function-Index"></a>

2070

2027

2071

2028

<h2 class="unnumbered">Function Index</h2>

2073

2030

2074

2031

2075

2032

2076

<li><a href="#index-lou_005fbackTranslate-110"><code>lou_backTranslate</code></a>: <a href="#lou_005fbackTranslate">lou_backTranslate</a></li>

2077

<li><a href="#index-lou_005fbackTranslateString-109"><code>lou_backTranslateString</code></a>: <a href="#lou_005fbackTranslateString">lou_backTranslateString</a></li>

2078

2079

<li><a href="#index-lou_005fgetTable-114"><code>lou_getTable</code></a>: <a href="#lou_005fgetTable">lou_getTable</a></li>

2080

<li><a href="#index-lou_005fhyphenate-111"><code>lou_hyphenate</code></a>: <a href="#lou_005fhyphenate">lou_hyphenate</a></li>

2081

<li><a href="#index-lou_005flogFile-112"><code>lou_logFile</code></a>: <a href="#lou_005flogFile">lou_logFile</a></li>

2082

<li><a href="#index-lou_005flogPrint-113"><code>lou_logPrint</code></a>: <a href="#lou_005flogPrint">lou_logPrint</a></li>

2083

<li><a href="#index-lou_005freadCharFromFile-115"><code>lou_readCharFromFile</code></a>: <a href="#lou_005freadCharFromFile">lou_readCharFromFile</a></li>

2084

<li><a href="#index-lou_005ftranslate-108"><code>lou_translate</code></a>: <a href="#lou_005ftranslate">lou_translate</a></li>

2085

<li><a href="#index-lou_005ftranslateString-107"><code>lou_translateString</code></a>: <a href="#lou_005ftranslateString">lou_translateString</a></li>

2086

<li><a href="#index-lou_005fversion-106"><code>lou_version</code></a>: <a href="#lou_005fversion">lou_version</a></li>

2033

<li><a href="#index-lou_005fbackTranslate-111"><code>lou_backTranslate</code></a>: <a href="#lou_005fbackTranslate">lou_backTranslate</a></li>

2034

<li><a href="#index-lou_005fbackTranslateString-110"><code>lou_backTranslateString</code></a>: <a href="#lou_005fbackTranslateString">lou_backTranslateString</a></li>

2035

2036

<li><a href="#index-lou_005fgetTable-115"><code>lou_getTable</code></a>: <a href="#lou_005fgetTable">lou_getTable</a></li>

2037

<li><a href="#index-lou_005fhyphenate-112"><code>lou_hyphenate</code></a>: <a href="#lou_005fhyphenate">lou_hyphenate</a></li>

2038

<li><a href="#index-lou_005flogFile-113"><code>lou_logFile</code></a>: <a href="#lou_005flogFile">lou_logFile</a></li>

2039

<li><a href="#index-lou_005flogPrint-114"><code>lou_logPrint</code></a>: <a href="#lou_005flogPrint">lou_logPrint</a></li>

2040

<li><a href="#index-lou_005freadCharFromFile-116"><code>lou_readCharFromFile</code></a>: <a href="#lou_005freadCharFromFile">lou_readCharFromFile</a></li>

2041

<li><a href="#index-lou_005ftranslate-109"><code>lou_translate</code></a>: <a href="#lou_005ftranslate">lou_translate</a></li>

2042

<li><a href="#index-lou_005ftranslateString-108"><code>lou_translateString</code></a>: <a href="#lou_005ftranslateString">lou_translateString</a></li>

2043

<li><a href="#index-lou_005fversion-107"><code>lou_version</code></a>: <a href="#lou_005fversion">lou_version</a></li>

2087

2044

</ul><a name="Program-Index"></a>

2088

2045

2089

2046

<h2 class="unnumbered">Program Index</h2>

2092

2049

2093

2050

2094

2051

<li><a href="#index-lou_005fallround-3"><code>lou_allround</code></a>: <a href="#lou_005fallround">lou_allround</a></li>

2052

<li><a href="#index-lou_005fcheckhyphens-5"><code>lou_checkhyphens</code></a>: <a href="#lou_005fcheckhyphens">lou_checkhyphens</a></li>

2095

2053

<li><a href="#index-lou_005fchecktable-2"><code>lou_checktable</code></a>: <a href="#lou_005fchecktable">lou_checktable</a></li>

2096

2054

<li><a href="#index-lou_005fdebug-1"><code>lou_debug</code></a>: <a href="#lou_005fdebug">lou_debug</a></li>

2097

<li><a href="#index-lou_005ftranslate-4"><code>lou_translate</code></a>: <a href="#lou_005ftranslate-_002df-_007c-_002db-tablename">lou_translate -f | -b tablename</a></li>

2055

<li><a href="#index-lou_005ftranslate-4"><code>lou_translate</code></a>: <a href="#lou_005ftranslate-_0028program_0029">lou_translate (program)</a></li>

2098

2056

</ul></body></html>

2099

2057