[brailleblaster] Description of configuration files

From: "John J. Boyer" <john.boyer@xxxxxxxxxxxxxxxxx>
To: brailleblaster@xxxxxxxxxxxxx
Date: Fri, 5 Oct 2012 23:32:56 -0500
Here is a description of BrailleBlaster configuration files. They 
specify how BrailleBlaster shall operate. The one which the user has 
selected is referenced in the userSetings.properties file. Selection, 
creation and editing are done via a dialogue. Note that BrailleBlaster 
configuration files are completely separate from liblouisutdml 
configuration files. They are stored in the configurations directory 
within the programData directory. Below is a sample file. Nore lines 
will be added as development proceeds. Explanations follow the sample.

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

hyphenate=no
pageNumberAt=top
topMargin=0.5
leftMargin=1
rightMargin=0.5
bottomMargin=0.5
paperHeight=11
paperWidth=8.5
xmlheader="<?xml=version='1.0'=encoding='UTF-8'=standalone='yes'?>
semanticFiles=*
internetAccessRequired=no
newEntries=yes
filename include
debug=no
styles=para,heading1,heading2,list

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

The first line specifies whether hyphenation should be used when a 
document is displayed onscreen.

The second line specifies where the page number should be placed. 

Then come six lines specifying margins and paper size. These are used 
principally for making hard copies. 

the xmlheader line specifies the header that should be used at the 
beginning of new files.

semanticFiles is a comma-separated list of the semantic files to be 
used. Here the value is an asterisk, which means to use the file which 
is named for the root element of the document. This is actually the 
default, so this line is not strictly necessary.

InternetAccessRequired specifies whether the Internet will be needed for 
processing a document, e.g., for getting a DTD.

newEntries specifies whether a record should be kept of the markup in a 
document which has not been assigned to a semantic action or style. This 
is useful when processing a new flavor of xml for which a 
semantic-action file does not exist. It applies to all documents. 
Semantic-action files can also have a newEntries line. It applies to 
that type of document only.

The include line, with a preceding filename, specifies that another 
configuration file is to be read at the point where it is encountered.

debug specifies whether extra testing should be done, experimental 
features used, and extra logging done.

The styles line gives a comma-separated list of styles that will be used 
in displaying and editing a document. These styles are in the styles 
directory.

The order of entries in a configuration file is generally not important. 
However, an include line does cause the referenced file to be read at 
the point where it is encountered.

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

Other related posts:
