[liblouis-liblouisxml] Draft documentation for liblouisutdml mode configuration setting

From: "John J. Boyer" <john.boyer@xxxxxxxxxxxxxxxxx>
To: liblouis-liblouisxml@xxxxxxxxxxxxx
Date: Thu, 26 Apr 2012 15:19:58 -0500

The draft is pasted below. It will be put in texinfo format when it is 
finalized. Meanwhile it may be useful, since this is a new configuration 
settint.

--------------------

The Mode Configuration Setting 

Mode bits can be specified either in the mode parameter of function 
calls or by using the mode configuration setting. They are of course 
referenced by name. In the mode parameter the bits are ored together. In 
the configurationn setting they are separated by commas.  This list must 
not contain spaces. In function calls the names are case-sensitive. In 
the configurationsetting they are not. Both liblouis and liblouisutdml 
bits may be specified. They are.

liblouis modes 

noContractions: (not working) Do not use any contractions, even though a 
table containing contractions is being used.

compbrlAtCursor Translate the whitespace-delimited string where the 
cursor is in computer braille.

dotsIO During translation, produce output as dot patterns. During 
back-translation accept input as dot patterns. 

comp8Dots: Unimplemented. May be replaced.

pass1Only Run only the main translation pass, even though correct, 
pass2, pass3 and pass4 opcodes may be specified.

compbrlLeftCursor Translate only the material between whitespace and 
the cursor in bomputer braille.

otherTrans Use a different translator. Its API is mapped to the 
liblouis API.

ucBrl During translation produce output as Unicode dot patterns. During 
back-translation accept input as Unicode dot patterns. dotsIO must 
also be specified.

liblouisutdml modes:

doInit Initialize both the liblouis and liblouisutdml libraries. This 
mode should be used only when the built-in initialization is not 
sufficient.

htmlDoc Specifies that documents should be processed as plain html, not 
xml or xhtml.

The following modes apply when the formatFor setting has one of the 
values utd, brf, pef, volumes or transinxml.

notUC Produce text within <brl> tags in character form rather than as 
Unicode Braille.

notSync Do not produce the index attribute of the <brl> tag, which is 
used for synchronizing print and braille. This can save a lot of space 
in the output file. Synchronization is often not needed.

utdInput The input file contains UTDML. This is useful when the file 
was produced by a previous run of liblouisutdml, edited, and then 
submitted for re-translation.

convertOnly Used when the input file is the result of a previous run of 
liblouisutdml with formatFor set to utd. Do not parse or translate. Run 
one of the conversions, brf, pef,transinxml or volumes.

-- 
John J. Boyer; President, Chief Software Developer
Abilitiessoft, Inc.
http://www.abilitiessoft.com
Madison, Wisconsin USA
Developing software for people with disabilities

For a description of the software, to download it and links to
project pages go to http://www.abilitiessoft.com

[liblouis-liblouisxml] Draft documentation for liblouisutdml mode configuration setting

Other related posts: