[brailleblaster] push by john.bo...@xxxxxxxxxxxxxxxxx - Updating tutorial and programData on 2012-03-11 15:10 GMT
- From: brailleblaster@xxxxxxxxxxxxxx
- To: brailleblaster@xxxxxxxxxxxxx
- Date: Sun, 11 Mar 2012 15:11:02 +0000
Revision: 21a96a1f3223
Author: John Boyer <john.boyer@xxxxxxxxxxxxxxxxx>
Date: Sun Mar 11 08:09:03 2012
Log: Updating tutorial and programData
http://code.google.com/p/brailleblaster/source/detail?r=21a96a1f3223
Added:
/dist/programData/liblouis/tables/ta-ta-g1.ctb
Modified:
/dist/getting-started.txt
/dist/helpDocs/liblouisutdml.html
/dist/helpDocs/liblouisutdml.txt
/dist/helpDocs/tutorial.html
/dist/programData/liblouis/tables/Es-Es-G0.utb
/dist/programData/liblouis/tables/is.ctb
/dist/programData/liblouis/tables/no-no-generic.ctb
/dist/programData/liblouis/tables/no-no.ctb
/dist/programData/liblouisutdml/lbu_files/brf.cfg
/dist/programData/liblouisutdml/lbu_files/preferences.cfg
/dist/programData/liblouisutdml/lbu_files/sample-utd.cfg
/dist/programData/liblouisutdml/lbu_files/transinxml.cfg
/dist/programData/liblouisutdml/lbu_files/utd.sem
/dist/programData/liblouisutdml/lbu_files/viewxml.cfg
/dist/programData/liblouisutdml/lbu_files/viewxml.ctb
=======================================
--- /dev/null
+++ /dist/programData/liblouis/tables/ta-ta-g1.ctb Sun Mar 11 08:09:03 2012
@@ -0,0 +1,133 @@
+# Copyright (C) 2012 Braille Section Team, Anna Centenary Library, Chennai
+# Shankar <brailleacl@xxxxxxxxx>
+# Copyright (C) 2012 Mesar Hameed <mhameed@xxxxxxxxxxxxx>, DINAKAR T.D.
<td.dinkar@xxxxxxxxx>
+#
+# This file is part of liblouis.
+#
+# liblouis is free software: you can redistribute it and/or modify it
+# under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+#
+# liblouis is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with liblouis. If not, see
+# <http://www.gnu.org/licenses/>.
+
+
+include en-us-g1.ctb
+
+sign \x0b82 56 # TAMIL SIGN ANUSVARA
+sign \x0b83 6 # TAMIL SIGN VISARGA
+sign \x0b85 1 # TAMIL sign A
+sign \x0b86 345 # TAMIL sign AA
+sign \x0b87 24 # TAMIL sign I
+sign \x0b88 35 # TAMIL sign II
+sign \x0b89 136 # TAMIL sign U
+sign \x0b8a 1256 # TAMIL sign UU
+
+sign \x0b8e 26 # TAMIL sign E
+
+sign \x0b8f 15 # TAMIL sign EE
+sign \x0b90 34 # TAMIL sign AI
+
+sign \x0b92 1346 # TAMIL sign O
+
+sign \x0b93 135 # TAMIL sign OO
+sign \x0b94 246 # TAMIL sign AU
+sign \x0b95 13 # TAMIL sign KA
+sign \x0b99 346 # TAMIL sign NGA
+sign \x0b9a 14 # TAMIL sign CA
+sign \x0b9c 245 # TAMIL sign JA
+sign \x0b9e 25 # TAMIL sign NYA
+sign \x0b9f 23456 # TAMIL sign TTA
+sign \x0ba3 3456 # TAMIL sign NNA
+sign \x0ba4 2345 # TAMIL sign TA
+sign \x0ba8 1345 # TAMIL sign NA
+sign \x0ba9 56 # TAMIL sign NNNA
+sign \x0baa 1234 # TAMIL sign PA
+sign \x0bae 134 # TAMIL sign MA
+sign \x0baf 13456 # TAMIL sign YA
+sign \x0bb0 1235 # TAMIL sign RA
+
+sign \x0bb1 12456 # TAMIL sign RRA
+
+sign \x0bb2 123 # TAMIL sign LA
+
+sign \x0bb3 456 # TAMIL sign LLA
+
+sign \x0bb4 12356 # TAMIL sign LLLA
+
+sign \x0bb5 1236 # TAMIL sign VA
+sign \x0bb6 146 # TAMIL sign SHA
+sign \x0bb7 12346 # TAMIL sign SSA
+sign \x0bb8 234 # TAMIL sign SA
+sign \x0bb9 125 # TAMIL sign HA
+sign \x0bbe 345 # TAMIL VOWEL SIGN AA
+sign \x0bbf 24 # TAMIL VOWEL SIGN I
+sign \x0bc0 35 # TAMIL VOWEL SIGN II
+sign \x0bc1 136 # TAMIL VOWEL SIGN U
+sign \x0bc2 1256 # TAMIL VOWEL SIGN UU
+
+sign \x0bc6 26 # TAMIL VOWEL SIGN E
+
+sign \x0bc7 15 # TAMIL VOWEL SIGN EE
+sign \x0bc8 34 # TAMIL VOWEL SIGN AI
+
+sign \x0bca 1346 # TAMIL VOWEL SIGN O
+
+sign \x0bcb 135 # TAMIL VOWEL SIGN OO
+sign \x0bcc 246 # TAMIL VOWEL SIGN AU
+sign \x0bcd 4 # TAMIL SIGN VIRAMA
+sign \x0be6 245 # TAMIL DIGIT ZERO
+sign \x0be7 1 # TAMIL DIGIT ONE
+sign \x0be8 12 # TAMIL DIGIT TWO
+sign \x0be9 14 # TAMIL DIGIT THREE
+sign \x0bea 145 # TAMIL DIGIT FOUR
+sign \x0beb 15 # TAMIL DIGIT FIVE
+sign \x0bec 124 # TAMIL DIGIT SIX
+sign \x0bed 1245 # TAMIL DIGIT SEVEN
+sign \x0bee 125 # TAMIL DIGIT EIGHT
+sign \x0bef 24 # TAMIL DIGIT NINE
+
+sign \x2018 236 #left single quote
+sign \x2019 345 #right single quote
+sign \x201c 6-236 #left quote
+sign \x201d 356-3 #right quote
+
+#--------
+# half characters
+
+always \x0b95\x0bcd 4-13
+always \x0b99\x0bcd 4-346
+always \x0b9a\x0bcd 4-14
+always \x0b9e\x0bcd 4-25
+always \x0b9f\x0bcd 4-23456
+always \x0ba3\x0bcd 4-3456
+always \x0ba4\x0bcd 4-2345
+always \x0ba8\x0bcd 4-1345
+always \x0baa\x0bcd 4-1234
+always \x0bae\x0bcd 4-134
+always \x0baf\x0bcd 4-13456
+always \x0bb0\x0bcd 4-1235
+always \x0bb2\x0bcd 4-123
+always \x0bb5\x0bcd 4-1236
+always \x0bb4\x0bcd 4-12356
+always \x0bb3\x0bcd 4-456
+always \x0bb1\x0bcd 4-12456
+always \x0ba9\x0bcd 4-56
+always \x0b9c\x0bcd 4-245
+always \x0bb7\x0bcd 4-12346
+always \x0bb8\x0bcd 4-234
+always \x0bb9\x0bcd 4-125
+
+# words and partwords
+# sri
+word \x0bb8\x0bcd\x0bb0\x0bc0 234
+
+always \x0b95\x0bcd\x0bb7 12345 #ksh
+always \x0b95\x0bcd\x0bb7\x0bcd 4-12345 #ksh with varama
=======================================
--- /dist/getting-started.txt Sun Mar 11 04:51:16 2012
+++ /dist/getting-started.txt Sun Mar 11 08:09:03 2012
@@ -1,6 +1,6 @@
You will find the real getting-started documents in the helpDocs
-subdirectory (or folder). However, the following information may be
-useful.
+subdirectory (or folder). You will want to read the turorial first.
+However, the following information may be useful.
After you have downloaded the BrailleBlaster build for your platform and
architecture, unzip it and go to the folder (directory) which it
=======================================
--- /dist/helpDocs/liblouisutdml.html Mon Oct 3 18:58:50 2011
+++ /dist/helpDocs/liblouisutdml.html Sun Mar 11 08:09:03 2012
@@ -7,8 +7,8 @@
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/"; rel="generator-home"
title="Texinfo Homepage">
<!--
-This manual is for liblouisutdml (version 1.7.0,
-31 August 2010), an xml to Braille Translation Library.
+This manual is for liblouisutdml (version 2.2.0,
+24 February 2012), an xml to Braille Translation Library.
This file may contain code borrowed from the Linux screenreader
BRLTTY, Copyright (C) 1999-2009 by the
@@ -121,17 +121,17 @@
<li><a href="#License">8.1 License</a>
<li><a href="#Overview">8.2 Overview</a>
<li><a href="#Files-and-Paths">8.3 Files and Paths</a>
-<li><a href="#lbx_005fversion">8.4 lbx_version</a>
-<li><a href="#lbx_005finitialize">8.5 lbx_initialize</a>
-<li><a href="#lbx_005ftranslateString">8.6 lbx_translateString</a>
-<li><a href="#lbx_005ftranslateFile">8.7 lbx_translateFile</a>
-<li><a href="#lbx_005ftranslateTextFile">8.8 lbx_translateTextFile</a>
-<li><a href="#lbx_005fbackTranslateFile">8.9 lbx_backTranslateFile</a>
-<li><a href="#lbx_005ffree">8.10 lbx_free</a>
+<li><a href="#lbu_005fversion">8.4 lbu_version</a>
+<li><a href="#lbu_005finitialize">8.5 lbu_initialize</a>
+<li><a href="#lbu_005ftranslateString">8.6 lbu_translateString</a>
+<li><a href="#lbu_005ftranslateFile">8.7 lbu_translateFile</a>
+<li><a href="#lbu_005ftranslateTextFile">8.8 lbu_translateTextFile</a>
+<li><a href="#lbu_005fbackTranslateFile">8.9 lbu_backTranslateFile</a>
+<li><a href="#lbu_005ffree">8.10 lbu_free</a>
</li></ul>
<li><a name="toc_Example-files" href="#Example-files">Appendix A Example
files</a>
<ul>
-<li><a href="#canonical_002ecfg">A.1 <samp><span
class="file">canonical.cfg</span></samp></a>
+<li><a href="#liblouisutdml_002eini">A.1 <samp><span
class="file">liblouisutdml.ini</span></samp></a>
<li><a href="#default_002ecfg">A.2 <samp><span
class="file">default.cfg</span></samp></a>
<li><a href="#html_002esem">A.3 <samp><span
class="file">html.sem</span></samp></a>
<li><a href="#nemeth_002esem">A.4 <samp><span
class="file">nemeth.sem</span></samp></a>
@@ -156,8 +156,8 @@
<h2 class="unnumbered">Liblouisutdml User's and Programmer's Manual</h2>
-<p>This manual is for liblouisutdml (version 1.7.0,
-31 August 2010), an xml to Braille Translation Library.
+<p>This manual is for liblouisutdml (version 2.2.0,
+24 February 2012), an xml to Braille Translation Library.
<p>This file may contain code borrowed from the Linux screenreader
<acronym>BRLTTY</acronym>, Copyright © 1999-2009 by the
@@ -271,7 +271,7 @@
as many <samp><span class="option">-C</span></samp> options as you wish.
Any settings can be specified
except those having to do with styles. See <a
href="#Configuration-Settings-Index">Configuration Settings Index</a>, for
a list of available settings. These must be specified in
configuration files. The settings may be in any order. They override
-any settings in <samp><span class="file">canonical.cfg</span></samp> or in
the configuration file used
+any settings in <samp><span class="file">liblouisutdml.ini</span></samp>
or in the configuration file used
by <samp><span class="command">file2brl</span></samp>.
<br><dt><samp><span class="option">-b</span></samp><dt><samp><span
class="option">--backward</span></samp><dd>back-translate. The input file
must be a braille file, such as
@@ -311,6 +311,8 @@
configuration (see <a href="#formatFor-setting">formatFor setting</a>)
file setting, which enables
you to format the braille output for viewing in a browser.
+ <br><dt><samp><span
class="option">-T</span></samp><br><dt><samp><span
class="option">--text</span></samp><dd>Consider the document to be a text
file, even if it is xml or html.
+
<br><dt><samp><span class="option">infile</span></samp><dd>This is
the name of the input file containing the material to be
transcribed. The file may be either an xml file or a text file. The
<samp><span class="option">-b</span></samp>, <samp><span
class="option">-r</span></samp> and <samp><span
class="option">-p</span></samp> options discussed above
@@ -449,7 +451,7 @@
settings separated by end-of-line characters. Such strings can be
generated by the <samp><span class="option">-C</span></samp> option on the
<samp><span class="command">file2brl</span></samp> command
line, by the <code>configstring</code> and <code>configtweak</code>
semantic
-actions, or by passing a string to the <code>lbx_initialize</code>
function.
+actions, or by passing a string to the <code>lbu_initialize</code>
function.
<p>The information below applies to <samp><span
class="command">file2brl</span></samp> as much as to
liblouisutdml.
@@ -457,54 +459,61 @@
<p>Before discussing configuration files in detail it is worth noting
that the application program has access to the information in the
configuration files by calling the liblouisutdml function
-<code>lbx_initialize</code>. This function returns a pointer to a data
+<code>lbu_initialize</code>. This function returns a pointer to a data
structure containing the configuration information. The calling program
must include the header file <code>louisutdml.h</code>. You do not need to
call
-<code>lbx_initialize</code> unless you need the facilities which it
provides.
+<code>lbu_initialize</code> unless you need the facilities which it
provides.
<p>A configuration file specification may contain more than one file
name,
-separated by commas. liblouisutdml will process these files in sequence.
-The first file name may also contain a path. liblouisutdml will search for
-the files it needs first on this path. To make it search first the
-current directory precede the first file name with <code>./</code>. After
the
-path, if any, has been evaluated, but before reading any of the files,
-liblouisutdml reads in a file called <samp><span
class="file">canonical.cfg</span></samp>. This file
-specifies values for all possible settings. It is needed to complete the
-initialization of the program. You may alter the values in the
-distribution <samp><span class="file">canonical.cfg</span></samp>, but you
should not delete any
-settings. Do not specify <samp><span
class="file">canonical.cfg</span></samp> as your configuration
+separated by commas. liblouisutdml will process these files in sequence,
+merging the information they contain. The first file name may also
+contain a path. liblouisutdml will search for the files it needs first
+on this path. To make it search first the current directory precede the
+first file name with <code>./</code>. After the path, if any, has been
+evaluated, but before reading any of the files, liblouisutdml reads in a
+file called <samp><span class="file">liblouisutdml.ini</span></samp>. This
file can contain any
+configuration settings, but it usually contains only the minimum ones
+for liblouisutdml to operate properly. You may alter the values in the
+distribution <samp><span class="file">liblouisutdml.ini</span></samp>, but
you should not delete any
+settings. Do not specify <samp><span
class="file">liblouisutdml.ini</span></samp> as your configuration
file. This will lead to error messages and program termination. If a
configuration file read in later contains a particular setting name, the
value specified simply replaces the one specified in
-<samp><span class="file">canonical.cfg</span></samp>.
-
- <p>As you will see by looking at <samp><span
class="file">canonical.cfg</span></samp>, it contains four
-main sections, <code>outputFormat</code>, <code>translation</code>,
<code>xml</code> and
-<code>style</code>. In addition, a configuration file can contain an
-include entry. This causes the file named on that line to be read in
-at the point where the line occurs. The sections need not follow each
-other in any particular order, nor is the order of settings within
-each section important. The section names, except for <code>style</code>
are
-optional. In this document and in the
-<samp><span class="file">canonical.cfg</span></samp> file, where section
and setting names consist of
-more than one word, the first letter of each word following the
-initial one is capitalized. This is merely for readability. The case
-of the letters in these names is ignored by the program. Section and
+<samp><span class="file">liblouisutdml.ini</span></samp> or any previously
read configuration file.
+
+ <p>Originally, configuration files contained four main sections,
+<code>outputFormat</code>, <code>translation</code>, <code>xml</code> and
<code>style</code>.
+The section names, except for <code>style</code> are now optional. In
+addition, a configuration file can contain an include entry. This causes
+the file named on that line to be read in at the point where the line
+occurs. The sections need not follow each other in any particular order,
+nor is the order of settings within each section important. The section
+names, except for <code>style</code> are optional. In this document and in
the
+<samp><span class="file">liblouisutdml.ini</span></samp> file, where
section and setting names consist
+of more than one word, the first letter of each word following the
+initial one is capitalized. This is merely for readability. The case of
+the letters in these names is ignored by the program. Section and
setting names may not contain spaces.
+ <p>In addition to <samp><span
class="file">liblouisutdml.ini</span></samp> the distribution also
+sontains a number of configuration files. The most important of
+these is <samp><span class="file">preferences.cfg</span></samp>, which
contains all possible
+settings and a "default" value for each. You should use this file
+as a refererence. It is the file read by the <samp><span
class="command">file2brl</span></samp>
+command-line interface program if no configuration file is giben.
+
<p>Here, then, is an explanation of each section and setting in the
-<samp><span class="file">canonical.cfg</span></samp> file. When you look
at this file you will see
-that the section names start at the left margin, while the settings
-are indented one tab stop. This is done for readability. it has no
-effect on the meaning of the lines. You will also see lines beginning
-with a number sign (`<samp><span class="samp">#</span></samp>'), which are
comments. Blank lines can
-also be used anywhere in a configuration file. In general, a section
-name is a single word or combination of unspaced words. However, each
-style has a section of its own, so the word `<samp><span
class="samp">style</span></samp>' is followed
-by a space then by the name of the style. Setting lines begin with the
-name of the
-setting, followed by at least one space or tab, followed by the value
-of the setting. A few settings have two values.
+<samp><span class="file">preferences.cfg</span></samp> file. When you look
at this file you will see
+that the section names start at the left margin, while the settings are
+indented one tab stop. This is done for readability. it has no effect on
+the meaning of the lines. You will also see lines beginning with a
+number sign (`<samp><span class="samp">#</span></samp>'), which are
comments. Blank lines can also be used
+anywhere in a configuration file. In general, a section name is a single
+word or combination of unspaced words. However, each style has a section
+of its own, so the word `<samp><span class="samp">style</span></samp>' is
followed by a space then by the
+name of the style. Setting lines begin with the name of the setting,
+followed by at least one space or tab, followed by the value of the
+setting. A few settings have two values.
<p><a name="outputFormat"></a>
@@ -764,7 +773,7 @@
of those that has two values. The first is the thing to be replaced,
and the second is the replacement. As many entity lines as necessary
can be used. The information they contain is added to the information
-provided by xmlHeader. In <samp><span
class="file">canonical.cfg</span></samp> this line is commented
+provided by xmlHeader. In <samp><span
class="file">liblouisutdml.ini</span></samp> this line is commented
out, because specifying it at this point would prevent the user from
specifying his own xmlheader.
@@ -802,7 +811,7 @@
<code>contents2</code>, <code>contents3</code> and <code>contents4</code>.
The first two
are needed for basic formatting. The others are needed for the table of
contents tool. The user must define settings for these styles as for any
-others. This is done in <samp><span
class="file">canonical.cfg</span></samp>, which also contains
+others. This is done in <samp><span
class="file">liblouisutdml.ini</span></samp>, which also contains
definitions and settings for many other styles. The user can add styles
at any time in her/his own configuration files.
@@ -1687,7 +1696,7 @@
<p><a name="index-mtable-134"></a><a name="mtable-semantic"></a>
<br><dt><code>mtable elementSpecifier</code><dd>
- <p>The file <samp><span class="file">canonical.cfg</span></samp>
defines the style <code>matrix</code>. The
+ <p>The file <samp><span class="file">liblouisutdml.ini</span></samp>
defines the style <code>matrix</code>. The
semantic-action files for math codes declare <code>mtable</code> to be
<code>matrix</code>. Depending on the attributes of this element, it can be
set to other styles, such as long division. The <code>matrix</code> style
@@ -1908,7 +1917,7 @@
are <code>contents1</code>, <code>contents2</code>, <code>contents3</code>
and
<code>contents4</code>. These styles are chosen as appropriate while the
table
of contents is being made. Do not declare them in a semantic-action
-file. See the <samp><span class="file">canonical.cfg</span></samp> file
for the current default
+file. See the <samp><span class="file">liblouisutdml.ini</span></samp>
file for the current default
definitions of all these styles.
<p>The table of contents will be placed where the xml tag is that you
@@ -1965,7 +1974,7 @@
<pre class="example"> space \x001b 1b escape character
</pre>
<p>To perform the back-translation operation, <samp><span
class="command">file2brl</span></samp> uses the
-liblouisutdml function <code>lbx_backTranslateFile</code>.
+liblouisutdml function <code>lbu_backTranslateFile</code>.
<p><a name="Reformatting"></a>
@@ -2096,7 +2105,7 @@
<h3 class="section">6.7 Poetry</h3>
-<p><samp><span class="file">canonical.cfg</span></samp> defines two styles
which can be used to format
+<p><samp><span class="file">liblouisutdml.ini</span></samp> defines two
styles which can be used to format
poetry, as follows:
<pre class="example"> style stanza
@@ -2158,7 +2167,7 @@
<p>Four tables are used to translate xml documents containing a mixture
of
text and mathematics. They can be found in the subdirectory
-<samp><span class="file">lbx_files</span></samp> of the liblouisutdml
directory and in the <samp><span class="file">tables</span></samp>
+<samp><span class="file">lbu_files</span></samp> of the liblouisutdml
directory and in the <samp><span class="file">tables</span></samp>
subdirectory of the liblouis distribution. First, the semantic-action
file <samp><span class="file">ukmaths.sem</span></samp> is used to
interpret the mathematical portions
of the xml document (The text portions are interpreted by another
@@ -2446,10 +2455,10 @@
first filename in a configuration file list may have a path. Next, in
Windows liblouisutdml determines the path to itself. this is the second
path on which it will look for files. The liblouis <samp><span
class="file">tables</span></samp>
-directory and the liblouisutdml <samp><span
class="file">lbx_files</span></samp> directory are relative to
+directory and the liblouisutdml <samp><span
class="file">lbu_files</span></samp> directory are relative to
this path. In Unix systems, including the Mac,, these directories are
absolute paths determined at compile time. liblouisutdml searches first
-the <samp><span class="file">tables</span></samp> directory and then the
<samp><span class="file">lbx_files</span></samp> directory.
+the <samp><span class="file">tables</span></samp> directory and then the
<samp><span class="file">lbu_files</span></samp> directory.
Finally, it establishes the current directory as the final path to be
searched. If you wish the current directory to be the first path
searched, prefix the first configuration file name with `<samp><span
class="samp">./</span></samp>' for
@@ -2459,31 +2468,31 @@
function <code>set_paths</code>, which is called from
<code>readconfig.c</code> and
in turn calls <code>addPath</code> in the <code>paths.c</code> module.
-<p><a name="lbx_version"></a>
-<a name="lbx_005fversion"></a>
-
-<h3 class="section">8.4 lbx_version</h3>
-
-<p><a name="index-lbx_005fversion-153"></a>
-<pre class="example"> char *lbx_version (void)
+<p><a name="lbu_version"></a>
+<a name="lbu_005fversion"></a>
+
+<h3 class="section">8.4 lbu_version</h3>
+
+<p><a name="index-lbu_005fversion-153"></a>
+<pre class="example"> char *lbu_version (void)
</pre>
<p>This function returns a pointer to a character string containing the
version of liblouisutdml. Other information such as the release
date and perhaps notable changes may be added later.
-<p><a name="lbx_initialize"></a>
-<a name="lbx_005finitialize"></a>
-
-<h3 class="section">8.5 lbx_initialize</h3>
-
-<p><a name="index-lbx_005finitialize-154"></a>
-<pre class="example"> void * lbx_initialize (
+<p><a name="lbu_initialize"></a>
+<a name="lbu_005finitialize"></a>
+
+<h3 class="section">8.5 lbu_initialize</h3>
+
+<p><a name="index-lbu_005finitialize-154"></a>
+<pre class="example"> void * lbu_initialize (
const char *configFilelist,
const char *logFileName,
const char *settingsString)
</pre>
<p>This function initializes the libxml2 library, processes
-<samp><span class="file">canonical.cfg</span></samp> and configuration
settings given in
+<samp><span class="file">liblouisutdml.ini</span></samp> and configuration
settings given in
the configuration files given in <code>configFilelist</code>. This is a
list
of configuration file names separated by commas. If the first character
is a comma it is taken to be a string containing configuration settings
@@ -2498,13 +2507,13 @@
access the information in this structure you must include
<samp><span class="file">louisutdml.h</span></samp>. This function is used
by <samp><span class="command">file2brl</span></samp>.
-<p><a name="lbx_translateString"></a>
-<a name="lbx_005ftranslateString"></a>
-
-<h3 class="section">8.6 lbx_translateString</h3>
-
-<p><a name="index-lbx_005ftranslateString-155"></a>
-<pre class="example"> int lbx_translateString (
+<p><a name="lbu_translateString"></a>
+<a name="lbu_005ftranslateString"></a>
+
+<h3 class="section">8.6 lbu_translateString</h3>
+
+<p><a name="index-lbu_005ftranslateString-155"></a>
+<pre class="example"> int lbu_translateString (
const char *configfilelist,
char * inbuf,
widechar *outbuf,
@@ -2522,7 +2531,7 @@
the configuration file. If no such line is present, a default header
specifying UTF-8 encoding is used. The <code>mode</code> parameter
specifies
whether you want the library to be initialized. If it is 0 everything
-is reset, the <samp><span class="file">canonical.cfg</span></samp> file is
processed and the
+is reset, the <samp><span class="file">liblouisutdml.ini</span></samp>
file is processed and the
configuration file and/or string (see previous section) are processed.
If <code>mode</code> is 1 liblouisutdml simply prepares to handle a new
document. For more on the <code>mode</code> parameter see the next section.
@@ -2541,13 +2550,13 @@
function returns 1 if no errors were encountered and a negative number
if a complete translation could not be done.
-<p><a name="lbx_translateFile"></a>
-<a name="lbx_005ftranslateFile"></a>
-
-<h3 class="section">8.7 lbx_translateFile</h3>
-
-<p><a name="index-lbx_005ftranslateFile-156"></a>
-<pre class="example"> int lbx_translateFile (
+<p><a name="lbu_translateFile"></a>
+<a name="lbu_005ftranslateFile"></a>
+
+<h3 class="section">8.7 lbu_translateFile</h3>
+
+<p><a name="index-lbu_005ftranslateFile-156"></a>
+<pre class="example"> int lbu_translateFile (
char *configfilelist,
char *inputFileName,
char *outputFileName,
@@ -2555,7 +2564,7 @@
</pre>
<p>This function accepts a well-formed xml document in
<code>inputFilename</code> and produces a braille translation in
-<code>outputFilename</code>. As for <code>lbx_translateString</code>, the
+<code>outputFilename</code>. As for <code>lbu_translateString</code>, the
<code>mode</code> parameter specifies whether the library is to be
initialized with new configuration information or simply prepared to
handle a new document. In addition, the <code>mode</code> parameter can
@@ -2569,13 +2578,13 @@
<code>configfilelist</code>. The function returns 1 if the translation was
successful.
-<p><a name="lbx_translateTextFile"></a>
-<a name="lbx_005ftranslateTextFile"></a>
-
-<h3 class="section">8.8 lbx_translateTextFile</h3>
-
-<p><a name="index-lbx_005ftranslateTextFile-157"></a>
-<pre class="example"> int lbx_translateTextFile (
+<p><a name="lbu_translateTextFile"></a>
+<a name="lbu_005ftranslateTextFile"></a>
+
+<h3 class="section">8.8 lbu_translateTextFile</h3>
+
+<p><a name="index-lbu_005ftranslateTextFile-157"></a>
+<pre class="example"> int lbu_translateTextFile (
char *configfilelist,
char *inputFileName,
char *outputFileName,
@@ -2589,17 +2598,17 @@
blank line between paragraphs (or headers). The output file may be in
UTF-8, UTF-16, or Ascii8, as specified by the <code>outputEncoding</code>
line in the configuration file, <code>configfilelist</code>. As for
-<code>lbx_translateString</code>, the <code>mode</code> parameter specifies
+<code>lbu_translateString</code>, the <code>mode</code> parameter specifies
whether complete initialization is to be done or simply initialization
for a new document.
-<p><a name="lbx_backTranslateFile"></a>
-<a name="lbx_005fbackTranslateFile"></a>
-
-<h3 class="section">8.9 lbx_backTranslateFile</h3>
-
-<p><a name="index-lbx_005fbackTranslateFile-158"></a>
-<pre class="example"> int lbx_backTranslateFile (
+<p><a name="lbu_backTranslateFile"></a>
+<a name="lbu_005fbackTranslateFile"></a>
+
+<h3 class="section">8.9 lbu_backTranslateFile</h3>
+
+<p><a name="index-lbu_005fbackTranslateFile-158"></a>
+<pre class="example"> int lbu_backTranslateFile (
char *configfilelist,
char *inputFileName,
char *outputFileName,
@@ -2615,21 +2624,21 @@
line in the configuration file, <code>configfilelist</code>. The mode
parameter specifies whether or not the library is to be initialized
with new configuration information, as described in the section on
-<code>lbx_translateString</code> (see <a
href="#lbx_005ftranslateString">lbx_translateString</a>).
-
-<p><a name="lbx_free"></a>
-<a name="lbx_005ffree"></a>
-
-<h3 class="section">8.10 lbx_free</h3>
-
-<p><a name="index-lbx_005ffree-159"></a>
-<pre class="example"> void lbx_free (void)
+<code>lbu_translateString</code> (see <a
href="#lbu_005ftranslateString">lbu_translateString</a>).
+
+<p><a name="lbu_free"></a>
+<a name="lbu_005ffree"></a>
+
+<h3 class="section">8.10 lbu_free</h3>
+
+<p><a name="index-lbu_005ffree-159"></a>
+<pre class="example"> void lbu_free (void)
</pre>
<p>This function should be called at the end of the application to free
all memory allocated by liblouisutdml and liblouis. If you wish to
change configuration files during your application, use a <code>mode</code>
parameter of 0 on the function call using the new configuration
-information. This will call the <code>lbx_free</code> function
automatically.
+information. This will call the <code>lbu_free</code> function
automatically.
<p><a name="Example-files"></a>
@@ -2640,10 +2649,10 @@
software may change. Besides being used for reference, they can be
studied to see how things are done.
-<p><a name="canonical.cfg"></a>
-<a name="canonical_002ecfg"></a>
-
-<h3 class="section">A.1 <samp><span
class="file">canonical.cfg</span></samp></h3>
+<p><a name="liblouisutdml.ini"></a>
+<a name="liblouisutdml_002eini"></a>
+
+<h3 class="section">A.1 <samp><span
class="file">liblouisutdml.ini</span></samp></h3>
<pre class="example"> # canonical Configuration File
@@ -4212,13 +4221,13 @@
<ul class="index-fn" compact>
-<li><a
href="#index-lbx_005fbackTranslateFile-158"><code>lbx_backTranslateFile</code></a>:
<a href="#lbx_005fbackTranslateFile">lbx_backTranslateFile</a></li>
-<li><a href="#index-lbx_005ffree-159"><code>lbx_free</code></a>: <a
href="#lbx_005ffree">lbx_free</a></li>
-<li><a
href="#index-lbx_005finitialize-154"><code>lbx_initialize</code></a>: <a
href="#lbx_005finitialize">lbx_initialize</a></li>
-<li><a
href="#index-lbx_005ftranslateFile-156"><code>lbx_translateFile</code></a>:
<a href="#lbx_005ftranslateFile">lbx_translateFile</a></li>
-<li><a
href="#index-lbx_005ftranslateString-155"><code>lbx_translateString</code></a>:
<a href="#lbx_005ftranslateString">lbx_translateString</a></li>
-<li><a
href="#index-lbx_005ftranslateTextFile-157"><code>lbx_translateTextFile</code></a>:
<a href="#lbx_005ftranslateTextFile">lbx_translateTextFile</a></li>
-<li><a href="#index-lbx_005fversion-153"><code>lbx_version</code></a>: <a
href="#lbx_005fversion">lbx_version</a></li>
+<li><a
href="#index-lbu_005fbackTranslateFile-158"><code>lbu_backTranslateFile</code></a>:
<a href="#lbu_005fbackTranslateFile">lbu_backTranslateFile</a></li>
+<li><a href="#index-lbu_005ffree-159"><code>lbu_free</code></a>: <a
href="#lbu_005ffree">lbu_free</a></li>
+<li><a
href="#index-lbu_005finitialize-154"><code>lbu_initialize</code></a>: <a
href="#lbu_005finitialize">lbu_initialize</a></li>
+<li><a
href="#index-lbu_005ftranslateFile-156"><code>lbu_translateFile</code></a>:
<a href="#lbu_005ftranslateFile">lbu_translateFile</a></li>
+<li><a
href="#index-lbu_005ftranslateString-155"><code>lbu_translateString</code></a>:
<a href="#lbu_005ftranslateString">lbu_translateString</a></li>
+<li><a
href="#index-lbu_005ftranslateTextFile-157"><code>lbu_translateTextFile</code></a>:
<a href="#lbu_005ftranslateTextFile">lbu_translateTextFile</a></li>
+<li><a href="#index-lbu_005fversion-153"><code>lbu_version</code></a>: <a
href="#lbu_005fversion">lbu_version</a></li>
</ul><p><a name="Program-Index"></a>
<h2 class="unnumbered">Program Index</h2>
=======================================
--- /dist/helpDocs/liblouisutdml.txt Mon Oct 3 18:58:50 2011
+++ /dist/helpDocs/liblouisutdml.txt Sun Mar 11 08:09:03 2012
@@ -4,7 +4,7 @@
Liblouisutdml User's and Programmer's Manual
1 Introduction
2 Transcribing Documents
- 2.1 Transcribing XML files with xml2brl
+ 2.1 Transcribing XML files with file2brl
2.2 Transcribing Text Documents
2.3 Transcribing Poorly Formatted Documents
2.4 Transcribing html Documents
@@ -33,6 +33,7 @@
4.3 Pseudo-actions
4.3.1 include
4.3.2 newentries
+ 4.3.3 namespaces
4.4 Using XPath Expressions
5 Special Features
5.1 Table of contents
@@ -55,15 +56,15 @@
8.1 License
8.2 Overview
8.3 Files and Paths
- 8.4 lbx_version
- 8.5 lbx_initialize
- 8.6 lbx_translateString
- 8.7 lbx_translateFile
- 8.8 lbx_translateTextFile
- 8.9 lbx_backTranslateFile
- 8.10 lbx_free
+ 8.4 lbu_version
+ 8.5 lbu_initialize
+ 8.6 lbu_translateString
+ 8.7 lbu_translateFile
+ 8.8 lbu_translateTextFile
+ 8.9 lbu_backTranslateFile
+ 8.10 lbu_free
Appendix A Example files
- A.1 `canonical.cfg'
+ A.1 `liblouisutdml.ini'
A.2 `default.cfg'
A.3 `html.sem'
A.4 `nemeth.sem'
@@ -81,8 +82,8 @@
Liblouisutdml User's and Programmer's Manual
********************************************
-This manual is for liblouisutdml (version 1.1.0, 1 July 2010), an xml
-to Braille Translation Library.
+This manual is for liblouisutdml (version 2.1.0, 24 February 2012), an
+xml to Braille Translation Library.
This file may contain code borrowed from the Linux screenreader
BRLTTY, Copyright (C) 1999-2009 by the BRLTTY Team.
@@ -114,11 +115,11 @@
transcribed braille. This includes translation into grade two, if
desired, mathematical codes, etc. It also includes formatting according
to a style sheet which can be modified by the user. The first program
-into which liblouisutdml has been incorporated is `xml2brl'. This
+into which liblouisutdml has been incorporated is `file2brl'. This
program will translate an xml or text file into an embosser-ready
braille file. It is not necessary to know xml, because MSWord and other
word processors can export files in this format. If the word processor
-has been used correctly `xml2brl' will produce an excellent braille
+has been used correctly `file2brl' will produce an excellent braille
file.
There is a Mac GUI application incorporating liblouisutdml called
@@ -126,16 +127,16 @@
can also obtain a Windows binary on this page. At present it is
command-line. We hope to have a GUI soon.
- Users who want to generate Braille using `xml2brl' will be
-interested in *note Transcribing XML files with xml2brl::. Those who
-wish to change the output generated by liblouisutdml should read *note
+ Users who want to generate Braille using `file2brl' will be
+interested in *Note Transcribing XML files with file2brl::. Those who
+wish to change the output generated by liblouisutdml should read *Note
Customization Configuring liblouisutdml::. If you encounter a type of
xml file with which liblouisutdml is not familiar you can learn how to
-tell it how to process that file by reading *note Connecting with the
+tell it how to process that file by reading *Note Connecting with the
xml Document::. If you wish to implement a new braille mathematics code
-read *note Implementing Braille Mathematics Codes::. Finally, computer
+read *Note Implementing Braille Mathematics Codes::. Finally, computer
programmers who wish to use liblouisutdml in their software can find
-the information they need in *note Programming with liblouisutdml::.
+the information they need in *Note Programming with liblouisutdml::.
You will also find it advantageous to be acquainted with the
companion library liblouis, which is a braille translator and
@@ -144,48 +145,48 @@
2 Transcribing Documents
************************
-2.1 Transcribing XML files with xml2brl
-=======================================
+2.1 Transcribing XML files with file2brl
+========================================
At the moment, actual transcription with liblouisutdml is done with the
-command-line (or console) program `xml2brl'. The line to type is:
-
- xml2brl [OPTIONS] [-f config-file] [infile] [outfile]
+command-line (or console) program `file2brl'. The line to type is:
+
+ file2brl [OPTIONS] [-f config-file] [infile] [outfile]
The brackets indicate that something is optional. You will see that
-nothing is required except the program name itself, `xml2brl'. The
+nothing is required except the program name itself, `file2brl'. The
various optional parts control how the program will behave, as follows:
`-h'
`--help'
- This option causes `xml2brl' to print a help message describing
+ This option causes `file2brl' to print a help message describing
usage and exit.
`-v'
`--version'
- This option causes `xml2brl' to display the version information
+ This option causes `file2brl' to display the version information
and exit.
`-l'
`--log-file'
- This option will cause `xml2brl' and liblouisutdml to print error
- messages to `xml2brl.log' instead of stderr. The file will be in
+ This option will cause `file2brl' and liblouisutdml to print error
+ messages to `file2brl.log' instead of stderr. The file will be in
the current directory. This option is particularly useful if
- `xml2brl' is called by a GUI script or Web application.
+ `file2brl' is called by a GUI script or Web application.
`-f configfile'
`--config-file configfile'
- This specifies the configuration file which tells `xml2brl' how to
- do the transcription. (It may be a list of file names separated by
- commas.) This file specifies such things as the number of cells per
- line, the number of lines per page, The translation tables to be
- used, how paragraphs and headings are to be formatted, etc. If
- this part of the command line is omitted, `xml2brl' assumes that
+ This specifies the configuration file which tells `file2brl' how
+ to do the transcription. (It may be a list of file names separated
+ by commas.) This file specifies such things as the number of cells
+ per line, the number of lines per page, The translation tables to
+ be used, how paragraphs and headings are to be formatted, etc. If
+ this part of the command line is omitted, `file2brl' assumes that
the configuration file is named `default.cfg'. If the configuration
- file name contains a pathname `xml2brl' will consider this as a
+ file name contains a pathname `file2brl' will consider this as a
path on which to look for files that it needs (*note Files and
Paths::). If no pathname is given the standard paths are searched
- and finally the current directory. To make `xml2brl' search the
+ and finally the current directory. To make `file2brl' search the
current directory first, precede the file name with `./'.
`-Csetting=value'
@@ -193,10 +194,11 @@
This option enables you to specify configuration settings on the
command line instead of changing the configuration file. You can
use as many `-C' options as you wish. Any settings can be specified
- except those having to do with styles. These must be specified in
- configuration files. The settings may be in any order. They
- override any settings in `canonical.cfg' or in the configuration
- file used by `xml2brl'.
+ except those having to do with styles. *Note Configuration
+ Settings Index::, for a list of available settings. These must be
+ specified in configuration files. The settings may be in any
+ order. They override any settings in `liblouisutdml.ini' or in the
+ configuration file used by `file2brl'.
`-b'
`--backward'
@@ -230,8 +232,8 @@
as may have been obtained by extracting the text in a pdf file.
The input file may also be an xml or html file which is so poorly
formatted that better braille can be obtained by ignoring the
- formatting. `xml2brl' tries to guess paragraph breaks. The output
- is generally reasonably formatted, that is, with reasonable
+ formatting. `file2brl' tries to guess paragraph breaks. The
+ output is generally reasonably formatted, that is, with reasonable
paragraph breaks.
`-t'
@@ -245,6 +247,11 @@
file setting, which enables you to format the braille output for
viewing in a browser.
+`-T'
+
+`--text'
+ Consider the document to be a text file, even if it is xml or html.
+
`infile'
This is the name of the input file containing the material to be
transcribed. The file may be either an xml file or a text file. The
@@ -266,7 +273,7 @@
both the input and output files.
- `xml2brl' is set up so that it can be used in a "pipe". To do this,
+ `file2brl' is set up so that it can be used in a "pipe". To do this,
omit both infile and outfile. Input is then taken from the standard
input unit.
@@ -275,28 +282,28 @@
you wish input to be taken from stdin and still want to specify an
output file, use one minus sign (`-') for the input file.
- If only the program name is typed `xml2brl' assumes that the
+ If only the program name is typed `file2brl' assumes that the
configuration file is `default.cfg', input is from the standard input
unit, and output is to the standard output unit.
2.2 Transcribing Text Documents
===============================
-See the previous section on using `xml2brl'. This program recognizes
+See the previous section on using `file2brl'. This program recognizes
text files automatically and transcribes them according to the
-information in the configuration files. Paragraphs must be separated
+information in the configuration files. Paragraphs must be separated
with a blank line. If you want a blank line in the output use two blank
lines.
2.3 Transcribing Poorly Formatted Documents
===========================================
- xml2brl -p infile outfile
+ file2brl -p infile outfile
Some text documents, such as those derived from pdf files, and even
some xml and html documents, are so poorly formatted that you can get
better braille by ignoring whatever markup they contain. The `-p'
-option of `xml2brl' does this. It ignores xml or html markup and uses
+option of `file2brl' does this. It ignores xml or html markup and uses
heuristics to find the beginning of paragraphs. Its choices are
usually good. Note that it does not work with rtf files. However, if
`rtf2xml' (*note Transcribing RTF files with rtf2brl::) will convert
@@ -305,11 +312,11 @@
2.4 Transcribing html Documents
===============================
- xml2brl -t infile outfile
+ file2brl -t infile outfile
The `-t' option prevents `xml2blr' from trying to transcribe infile
as an xml document. This will produce a lot of error messages.
-`xml2brl' will then try the html parser. Note that xhtml documents are
+`file2brl' will then try the html parser. Note that xhtml documents are
actually xml.
2.5 Transcribing Microsoft Word files with msword2brl
@@ -320,8 +327,8 @@
Infile must be a Microsoft Word file. The script first calls the
`antiword' program, so you must have this installed on your machine.
`antiword' is called with `-x db', which causes the output to be in
-docbook format. This is piped to `xml2brl'. The output file from
-`xml2brl' contains much of the formatting, including emphasis, of the
+docbook format. This is piped to `file2brl'. The output file from
+`file2brl' contains much of the formatting, including emphasis, of the
word file.
2.6 Transcribing RTF files with rtf2brl
@@ -334,9 +341,9 @@
program installed on your machine. You can find it on the downloads
page of `www.abilitiessoft.com'. It was copied from its SourceForge
project. Since it is a Python program, it can be rather slow. Its output
-is piped to `xml2brl'. The output of `rtf2xml' is xml with the root
+is piped to `file2brl'. The output of `rtf2xml' is xml with the root
element `doc'. The file `doc.sem' is fairly complete, so the output of
-`xml2brl' contains much of the formatting, including emphasis, of the
+`file2brl' contains much of the formatting, including emphasis, of the
original rtf file.
2.7 Transcribing PDF files with pdf2brl
@@ -351,9 +358,9 @@
either `http://poppler.freedesktop.org' or
`http://www.foolabs.com/xpdf/download.html'. `pdftotext' is called with
the `-raw' and `-' options, which cause it to place its output on
-stdout. This is piped to `xml2brl', which is called with the `-p'
+stdout. This is piped to `file2brl', which is called with the `-p'
option, since output from `pdftotext' is likely to be poorly formatted.
-The output file from `xml2brl' is mostly in sensible paragraphs.
+The output file from `file2brl' is mostly in sensible paragraphs.
3 Customization: Configuring liblouisutdml
******************************************
@@ -372,61 +379,71 @@
Besides files, liblouisutdml can also be controlled by configuration
strings, which are character strings in memory containing configuration
settings separated by end-of-line characters. Such strings can be
-generated by the `-C' option on the `xml2brl' command line, by the
+generated by the `-C' option on the `file2brl' command line, by the
`configstring' and `configtweak' semantic actions, or by passing a
-string to the `lbx_initialize' function.
-
- The information below applies to `xml2brl' as much as to
+string to the `lbu_initialize' function.
+
+ The information below applies to `file2brl' as much as to
liblouisutdml.
Before discussing configuration files in detail it is worth noting
that the application program has access to the information in the
configuration files by calling the liblouisutdml function
-`lbx_initialize'. This function returns a pointer to a data structure
+`lbu_initialize'. This function returns a pointer to a data structure
containing the configuration information. The calling program must
include the header file `louisutdml.h'. You do not need to call
-`lbx_initialize' unless you need the facilities which it provides.
+`lbu_initialize' unless you need the facilities which it provides.
A configuration file specification may contain more than one file
name, separated by commas. liblouisutdml will process these files in
-sequence. The first file name may also contain a path. liblouisutdml
-will search for the files it needs first on this path. To make it
-search first the current directory precede the first file name with
-`./'. After the path, if any, has been evaluated, but before reading
-any of the files, liblouisutdml reads in a file called `canonical.cfg'.
-This file specifies values for all possible settings. It is needed to
-complete the initialization of the program. You may alter the values in
-the distribution `canonical.cfg', but you should not delete any
-settings. Do not specify `canonical.cfg' as your configuration file.
-This will lead to error messages and program termination. If a
+sequence, merging the information they contain. The first file name may
+also contain a path. liblouisutdml will search for the files it needs
+first on this path. To make it search first the current directory
+precede the first file name with `./'. After the path, if any, has been
+evaluated, but before reading any of the files, liblouisutdml reads in a
+file called `liblouisutdml.ini'. This file can contain any
+configuration settings, but it usually contains only the minimum ones
+for liblouisutdml to operate properly. You may alter the values in the
+distribution `liblouisutdml.ini', but you should not delete any
+settings. Do not specify `liblouisutdml.ini' as your configuration
+file. This will lead to error messages and program termination. If a
configuration file read in later contains a particular setting name, the
-value specified simply replaces the one specified in `canonical.cfg'.
-
- As you will see by looking at `canonical.cfg', it contains four main
-sections, `outputFormat', `translation', `xml' and `style'. In
-addition, a configuration file can contain an include entry. This
-causes the file named on that line to be read in at the point where the
-line occurs. The sections need not follow each other in any particular
-order, nor is the order of settings within each section important. The
-section names, except for `style' are optional. In this document and in
-the `canonical.cfg' file, where section and setting names consist of
-more than one word, the first letter of each word following the initial
-one is capitalized. This is merely for readability. The case of the
-letters in these names is ignored by the program. Section and setting
-names may not contain spaces.
+value specified simply replaces the one specified in
+`liblouisutdml.ini' or any previously read configuration file.
+
+ Originally, configuration files contained four main sections,
+`outputFormat', `translation', `xml' and `style'. The section names,
+except for `style' are now optional. In addition, a configuration file
+can contain an include entry. This causes the file named on that line
+to be read in at the point where the line occurs. The sections need not
+follow each other in any particular order, nor is the order of settings
+within each section important. The section names, except for `style'
+are optional. In this document and in the `liblouisutdml.ini' file,
+where section and setting names consist of more than one word, the
+first letter of each word following the initial one is capitalized.
+This is merely for readability. The case of the letters in these names
+is ignored by the program. Section and setting names may not contain
+spaces.
+
+ In addition to `liblouisutdml.ini' the distribution also sontains a
+number of configuration files. The most important of these is
+`preferences.cfg', which contains all possible settings and a "default"
+value for each. You should use this file as a refererence. It is the
+file read by the `file2brl' command-line interface program if no
+configuration file is giben.
Here, then, is an explanation of each section and setting in the
-`canonical.cfg' file. When you look at this file you will see that the
-section names start at the left margin, while the settings are indented
-one tab stop. This is done for readability. it has no effect on the
-meaning of the lines. You will also see lines beginning with a number
-sign (`#'), which are comments. Blank lines can also be used anywhere
-in a configuration file. In general, a section name is a single word or
-combination of unspaced words. However, each style has a section of its
-own, so the word `style' is followed by a space then by the name of the
-style. Setting lines begin with the name of the setting, followed by at
-least one space or tab, followed by the value of the setting. A few
-settings have two values.
+`preferences.cfg' file. When you look at this file you will see that
+the section names start at the left margin, while the settings are
+indented one tab stop. This is done for readability. it has no effect on
+the meaning of the lines. You will also see lines beginning with a
+number sign (`#'), which are comments. Blank lines can also be used
+anywhere in a configuration file. In general, a section name is a single
+word or combination of unspaced words. However, each style has a section
+of its own, so the word `style' is followed by a space then by the name
+of the style. Setting lines begin with the name of the setting,
+followed by at least one space or tab, followed by the value of the
+setting. A few settings have two values.
3.1 outputFormat
================
@@ -486,16 +503,69 @@
`printPageNumberAt top'
If print page numbers are given in the xml input file they will be
- placed at the top of each braille page in the right-hand corner. A
- page separator line will also be produced on the braille page where
- the print page break actually occurs. You may also specify
- `bottom' for this setting.
+ placed at the top of each braille page in the right-hand corner. If
+ `pageSeparator' is set to `yes', a page separator line will also
+ be produced on the Braille page where the print page break
+ actually occurs. You may also specify `bottom' for this setting.
`braillePageNumberAt bottom'
The braille page number will be placed in the bottom right-hand
corner of each page. If `interpoint yes' has been specified only
- odd pages will receive page numbers. If you specify `top' for this
- setting then `bottom' must be specified for `printPageNumberAt'.
+ odd pages will receive page numbers. You may also specify `top'
+ for this setting. If print page numbers and Braille page numbers
+ are both placed at the top or bottom, they are rendered next to
+ each other with a space in between.
+
+`continuePages yes'
+ Print page numbers can be prefixed with a letter (a, b, c, etc.) on
+ continued pages. The two valid values are `yes' and `no'.
+
+`pageSeparator yes'
+ A page separator line (or page break indicator), a line of unspaced
+ Braille dots 36, will be placed wherever a print page break
+ occurs. No page separator lines are placed on the first or last
+ line of a Braille page, and no page separator lines are shown when
+ the new print page coincides with a new Braille page.
+
+`pageSeparatorNumber yes'
+ Show a page number at the far right margin of a page separator
+ line. No space is left between the separator line and the first
+ symbol of the page number.
+
+`ignoreEmptyPages yes'
+ An empty page occurs when a `pagenum' tag is immediately followed
+ by another `pagenum' tag. By default, empty pages are completely
+ ignored. If you specify `no' for this setting, a sequence of
+ `pagenum' tags will lead to a _combined_ print page number: the
+ number of the first empty page is combined with that of the page on
+ which text reappears, e.g. 5-7. If lettered continuation pages are
+ required (see `continuePages'), they carry only the number of the
+ page on which text reappears.
+
+`printPageNumberRange no'
+ By default, only the page number of the _first_ print page on a
+ Braille page is shown at the top or bottom. However, if
+ `printPageNumberRange' is set to `yes', the _range_ of print pages
+ contained in the current Braille page is displayed. If the first
+ page in this range is a continued print page, it is prefixed with
+ a letter as usual (see `continuePages').
+
+`mergeUnnumberedPages yes'
+ Page breaks without a page number can simply be ignored. This
+ means that unnumbered print pages will be treated as if they were
+ a part of the preceding page. You can also specify `no' for this
+ setting.
+
+`pageNumberTopSeparateLine yes'
+ Whether or not to provide a separate line for page numbers when
+ they are placed at the top of a Braille page. The two valid values
+ are `yes' and `no'. A print page number range (see
+ `printPageNumberRange') at the top of a page is always displayed
+ on a separate line.
+
+`pageNumberBottomSeparateLine yes'
+ Whether or not to provide a separate line for page numbers when
+ they are placed at the bottom of a Braille page.
`hyphenate no'
If `yes' is specified words will be hyphenated at the ends of
@@ -621,7 +691,7 @@
one of those that has two values. The first is the thing to be
replaced, and the second is the replacement. As many entity lines
as necessary can be used. The information they contain is added to
- the information provided by xmlHeader. In `canonical.cfg' this
+ the information provided by xmlHeader. In `liblouisutdml.ini' this
line is commented out, because specifying it at this point would
prevent the user from specifying his own xmlheader.
@@ -656,7 +726,7 @@
`contents1', `contents2', `contents3' and `contents4'. The first two
are needed for basic formatting. The others are needed for the table of
contents tool. The user must define settings for these styles as for any
-others. This is done in `canonical.cfg', which also contains
+others. This is done in `liblouisutdml.ini', which also contains
definitions and settings for many other styles. The user can add styles
at any time in her/his own configuration files.
@@ -724,12 +794,12 @@
The format setting controls how the text in the style will be
formatted. Valid values are `leftJustified', `rightJustified',
`centered', `computerCoded', `alignColumnsLeft',
- `alignColumnsRight', and `contents'. The first three are
+ `alignColumnsRight', and `contents'. The first three are
self-explanatory. `computerCoded' is used for computer programs
and similar material. The next two are used for tabular material.
`alignColumnsLeft' causes the left ends of columns to be aligned.
`alignColumnsRight' causes the right ends of columns to be
- aligned. `contents' is used only in styles specifically intended
+ aligned. `contents' is used only in styles specifically intended
for tables of contents.
`newPageBefore no'
@@ -856,7 +926,7 @@
4.1 Overview
============
-When liblouisutdml (or `xml2brl') processes an xml document, it needs
+When liblouisutdml (or `file2brl') processes an xml document, it needs
to be told how to use the information in that document to produce a
properly translated and formatted braille document. These instructions
are provided by a semantic-action file, so called because it explains
@@ -1178,7 +1248,7 @@
the value of this attribute is equal to the specified value.
`contenss1 elementSpecifier'
- Note that the `contenss1', etc. semantic actions are never
+ Note that the `contenss1', etc. semantic actions are never
assigned an actual `elementSpecifier'. There used internally by
the table of contents generator. They should be assigned style
settings, however.
@@ -1359,7 +1429,7 @@
values), and ends with `</elementSpecifier>' (`/math'). This is
therefore the root element of a mathematical expression. However,
mathematical expressions are usually part of a document, so it is
- not given the semantic action document. liblouisutdml will,
+ not given the semantic action document. liblouisutdml will,
however, handle files and strings which consist of nothing but a
mathematical expression properly. The `math' semantic action
causes liblouisutdml to carry out special interpretation actions.
@@ -1419,7 +1489,7 @@
`msup elementSpecifier'
`mtable elementSpecifier'
- The file `canonical.cfg' defines the style `matrix'. The
+ The file `liblouisutdml.ini' defines the style `matrix'. The
semantic-action files for math codes declare `mtable' to be
`matrix'. Depending on the attributes of this element, it can be
set to other styles, such as long division. The `matrix' style
@@ -1481,7 +1551,9 @@
for translation according to the active table. This table must
contain an entry for translating `\_' into a letter sign or
whatever else is wanted. This string is inserted so that roman
- page numbers will be handled properly.
+ page numbers will be handled properly. Unnumbered page breaks are
+ indicated with an empty pagenum tag:
+ `<elementSpecifier></elementSpecifier>'.
`reverse elementSpecifier'
The branches of the subtree rooted at this node are reversed in
@@ -1525,7 +1597,8 @@
==================
These actions affect the processing of semantic-action files. They are
-not connected with any tag in the document.
+not connected with any tag in the document. They are executed when they
+are encountered in the processing of semantic-action files.
4.3.1 include
-------------
@@ -1534,7 +1607,7 @@
filename must be the name of a semantic action file. The file is
compiled as though it were part of the file containing the `include'
-entry.
+entry. Included files may include other files.
4.3.2 newentries
----------------
@@ -1547,6 +1620,16 @@
semantic-action file. The configuration setting `newEntries' affects
all documents.
+4.3.3 namespaces
+----------------
+
+ namespaces dtb=http://www.daisy.org/z3986/2005/dtbook/
+
+ This pseudo-action is used to declare namespaces used in XPath
+expressions. (See following section). The format is `namespaces
+prefix1=url1,prefix2=url2,...'. The list of namespaces may not contain
+blanks.
+
4.4 Using XPath Expressions
===========================
@@ -1558,7 +1641,12 @@
the syntax `&xpath(...)'. That is, the XPath expression is placed
within parentheses following `&xpath'. It may contain parentheses
itself, as long as they match. The third column may contain arguments,
-as with any line in a semantic-action file.
+as with any line in a semantic-action file. XPath expressions are not
+processed in any particular order. Care should be taken that the node
+sets which they find do not overlap. If a node is in a node set found
+by a particular XPath expression it will be given the semantic-action
+and arguments associated with that expression. This will not be changed
+subsequently.
The `&funcname(...)' notation may be used for other features, such
as XPointer, in the future.
@@ -1589,8 +1677,8 @@
levels and are `contents1', `contents2', `contents3' and `contents4'.
These styles are chosen as appropriate while the table of contents is
being made. Do not declare them in a semantic-action file. See the
-`canonical.cfg' file for the current default definitions of all these
-styles.
+`liblouisutdml.ini' file for the current default definitions of all
+these styles.
The table of contents will be placed where the xml tag is that you
declared in the `contentsheader' semantic action (*note contentsheader:
@@ -1606,7 +1694,7 @@
`contentsheader' semantic action. If the file contains headers you can
obtain a table of contents by specifying `contents yes' in a
configuration file or `-Ccontents=yes' on the command line of
-`xml2brl'. In this case, the table of contents will appear at the
+`file2brl'. In this case, the table of contents will appear at the
beginning of the output. Pages will be numbered beginning with 1. When
the table of contents is complete, the material in the file will start
on a new page and the page number will be the value given in
@@ -1626,7 +1714,7 @@
5.2 Back-translation
====================
- xml2brl -b infile outfile
+ file2brl -b infile outfile
infile must be a braille file. It can have either upper-case or
lower-case letters, etc. outfile will contain the back-translation
@@ -1642,13 +1730,13 @@
space \x001b 1b escape character
- To perform the back-translation operation, `xml2brl' uses the
-liblouisutdml function `lbx_backTranslateFile'.
+ To perform the back-translation operation, `file2brl' uses the
+liblouisutdml function `lbu_backTranslateFile'.
5.3 Reformatting
================
- xml2brl -r infile outfile
+ file2brl -r infile outfile
As in the previous section, infile must be a braille file. It is
back-translated and then forward-translated to produce a braille file in
@@ -1671,16 +1759,16 @@
5.5 Browser-Friendly Output
===========================
- xml2brl infile outfile -CformatFor=browser
-
- infile can be any of the file types accepted by `xml2brl' (xml, html
-or text). If it contains html links or targets they will be formatted
-so that a browser can use them. This may be useful if a file contains
-internal links to different sections, such as its own table of
+ file2brl infile outfile -CformatFor=browser
+
+ infile can be any of the file types accepted by `file2brl' (xml,
+html or text). If it contains html links or targets they will be
+formatted so that a browser can use them. This may be useful if a file
+contains internal links to different sections, such as its own table of
contents. Text will be translated and formatted according to
configuration specifications. If the file contains mathematics expressed
as MathML it will be translated according to the mathematics code
-specified by the configuration. outfile should have the extension
+specified by the configuration. outfile should have the extension
`.html'. It will actually be xhtml. The `-CformatFor=browser' part of
the above example specifies a configuration setting, which of course
can also be specified in a configuration file.
@@ -1721,7 +1809,7 @@
Your configuration files should contain lines like these:
style graphspace
- rightHandPage yes
+ rightHandPage yes
In your semantic-action file you must assign a tag to this style.
Note that the semantic action `graphic' will invoke code to translate
@@ -1759,15 +1847,15 @@
6.7 Poetry
==========
-`canonical.cfg' defines two styles which can be used to format poetry,
-as follows:
+`liblouisutdml.ini' defines two styles which can be used to format
+poetry, as follows:
style stanza
- linesBefore 1
- linesAfter 1
+ linesBefore 1
+ linesAfter 1
ttyle line
- leftMargin 2
- firstLineIndent -2
+ leftMargin 2
+ firstLineIndent -2
Your document might then contain the following from Samuel Taylor
Coleridge's "Rime of the Ancient Mariner":
@@ -1821,7 +1909,7 @@
Four tables are used to translate xml documents containing a mixture
of text and mathematics. They can be found in the subdirectory
-`lbx_files' of the liblouisutdml directory and in the `tables'
+`lbu_files' of the liblouisutdml directory and in the `tables'
subdirectory of the liblouis distribution. First, the semantic-action
file `ukmaths.sem' is used to interpret the mathematical portions of
the xml document (The text portions are interpreted by another
@@ -2008,7 +2096,7 @@
===========
Liblouisutdml may contain code borrowed from the Linux screenreader
-BRLTTY, Copyright (C) 1999-2009 by the BRLTTY Team.
+BRLTTY, Copyright (C) 1999-2009 by the BRLTTY Team.
Copyright (C) 2004-2009 ViewPlus Technologies, Inc. `www.viewplus.com'.
@@ -2042,7 +2130,7 @@
by translation table files. All these files are plain text and can be
created and edited in any text editor. Configuration settings can also
be specified on the command line of the console-mode transcription
-program `xml2brl'.
+program `file2brl'.
The general operation of liblouisutdml is as follows. It uses the
libxml2 library to construct a parse tree of the xml document. After
@@ -2102,10 +2190,10 @@
the first filename in a configuration file list may have a path. Next,
in Windows liblouisutdml determines the path to itself. this is the
second path on which it will look for files. The liblouis `tables'
-directory and the liblouisutdml `lbx_files' directory are relative to
+directory and the liblouisutdml `lbu_files' directory are relative to
this path. In Unix systems, including the Mac,, these directories are
-absolute paths determined at compile time. liblouisutdml searches first
-the `tables' directory and then the `lbx_files' directory. Finally, it
+absolute paths determined at compile time. liblouisutdml searches first
+the `tables' directory and then the `lbu_files' directory. Finally, it
establishes the current directory as the final path to be searched. If
you wish the current directory to be the first path searched, prefix
the first configuration file name with `./' for Unix or `.\' for
@@ -2115,47 +2203,47 @@
function `set_paths', which is called from `readconfig.c' and in turn
calls `addPath' in the `paths.c' module.
-8.4 lbx_version
+8.4 lbu_version
===============
- char *lbx_version (void)
+ char *lbu_version (void)
This function returns a pointer to a character string containing the
version of liblouisutdml. Other information such as the release date
and perhaps notable changes may be added later.
-8.5 lbx_initialize
+8.5 lbu_initialize
==================
- void * lbx_initialize (
- const char *configFilelist,
- const char *logFileName,
- const char *settingsString)
+ void * lbu_initialize (
+ const char *configFilelist,
+ const char *logFileName,
+ const char *settingsString)
This function initializes the libxml2 library, processes
-`canonical.cfg' and configuration settings given in the configuration
-files given in `configFilelist'. This is a list of configuration file
-names separated by commas. If the first character is a comma it is
-taken to be a string containing configuration settings and is processed
-like the `settingsString' string. if the parameter `settingsString' is
-not `NULL' it is processed last. Such a string must conform to the
-format of a configuration file. Newlines should be represented with
-ASCII 10. If `logfilename' is not `null', a log file is produced on the
-current directory. If it is `null' any messages are printed on stderr.
-The function returns a pointer to the `UserData' structure. This
-pointer is `void' and must be cast to `(UserData *)' in the calling
-program. To access the information in this structure you must include
-`louisutdml.h'. This function is used by `xml2brl'.
-
-8.6 lbx_translateString
+`liblouisutdml.ini' and configuration settings given in the
+configuration files given in `configFilelist'. This is a list of
+configuration file names separated by commas. If the first character is
+a comma it is taken to be a string containing configuration settings
+and is processed like the `settingsString' string. if the parameter
+`settingsString' is not `NULL' it is processed last. Such a string must
+conform to the format of a configuration file. Newlines should be
+represented with ASCII 10. If `logfilename' is not `null', a log file
+is produced on the current directory. If it is `null' any messages are
+printed on stderr. The function returns a pointer to the `UserData'
+structure. This pointer is `void' and must be cast to `(UserData *)' in
+the calling program. To access the information in this structure you
+must include `louisutdml.h'. This function is used by `file2brl'.
+
+8.6 lbu_translateString
=======================
- int lbx_translateString (
- const char *configfilelist,
- char * inbuf,
- widechar *outbuf,
- int *outlen,
- unsigned int mode)
+ int lbu_translateString (
+ const char *configfilelist,
+ char * inbuf,
+ widechar *outbuf,
+ int *outlen,
+ unsigned int mode)
This function takes a well-formed xml expression in `inbuf' and
translates it into a string of 16-bit (or 32-bit if this has been
@@ -2168,7 +2256,7 @@
file. If no such line is present, a default header specifying UTF-8
encoding is used. The `mode' parameter specifies whether you want the
library to be initialized. If it is 0 everything is reset, the
-`canonical.cfg' file is processed and the configuration file and/or
+`liblouisutdml.ini' file is processed and the configuration file and/or
string (see previous section) are processed. If `mode' is 1
liblouisutdml simply prepares to handle a new document. For more on the
`mode' parameter see the next section.
@@ -2186,18 +2274,18 @@
function returns 1 if no errors were encountered and a negative number
if a complete translation could not be done.
-8.7 lbx_translateFile
+8.7 lbu_translateFile
=====================
- int lbx_translateFile (
- char *configfilelist,
- char *inputFileName,
- char *outputFileName,
- unsigned int mode)
+ int lbu_translateFile (
+ char *configfilelist,
+ char *inputFileName,
+ char *outputFileName,
+ unsigned int mode)
This function accepts a well-formed xml document in `inputFilename'
and produces a braille translation in `outputFilename'. As for
-`lbx_translateString', the `mode' parameter specifies whether the
+`lbu_translateString', the `mode' parameter specifies whether the
library is to be initialized with new configuration information or
simply prepared to handle a new document. In addition, the `mode'
parameter can specify that a document is in html, not xhtml.
@@ -2209,14 +2297,14 @@
`outputEncoding' line in the configuration file, `configfilelist'. The
function returns 1 if the translation was successful.
-8.8 lbx_translateTextFile
+8.8 lbu_translateTextFile
=========================
- int lbx_translateTextFile (
- char *configfilelist,
- char *inputFileName,
- char *outputFileName,
- unsigned int mode)
+ int lbu_translateTextFile (
+ char *configfilelist,
+ char *inputFileName,
+ char *outputFileName,
+ unsigned int mode)
This function accepts a text file in `inputFilename' and produces a
braille translation in `outputFilename'. The input file is assumed to
@@ -2225,18 +2313,18 @@
the divisions between paragraphs. Two blank lines cause a blank line
between paragraphs (or headers). The output file may be in UTF-8,
UTF-16, or Ascii8, as specified by the `outputEncoding' line in the
-configuration file, `configfilelist'. As for `lbx_translateString', the
+configuration file, `configfilelist'. As for `lbu_translateString', the
`mode' parameter specifies whether complete initialization is to be
done or simply initialization for a new document.
-8.9 lbx_backTranslateFile
+8.9 lbu_backTranslateFile
=========================
- int lbx_backTranslateFile (
- char *configfilelist,
- char *inputFileName,
- char *outputFileName,
- unsigned int mode)
+ int lbu_backTranslateFile (
+ char *configfilelist,
+ char *inputFileName,
+ char *outputFileName,
+ unsigned int mode)
This function accepts a braille file in `inputFilename' and produces
a back-translation in `outputFilename'. The input file is assumed to be
@@ -2247,19 +2335,19 @@
as specified by the `outputEncoding' line in the configuration file,
`configfilelist'. The mode parameter specifies whether or not the
library is to be initialized with new configuration information, as
-described in the section on `lbx_translateString' (*note
-lbx_translateString::).
-
-8.10 lbx_free
+described in the section on `lbu_translateString' (*note
+lbu_translateString::).
+
+8.10 lbu_free
=============
- void lbx_free (void)
+ void lbu_free (void)
This function should be called at the end of the application to free
all memory allocated by liblouisutdml and liblouis. If you wish to
change configuration files during your application, use a `mode'
parameter of 0 on the function call using the new configuration
-information. This will call the `lbx_free' function automatically.
+information. This will call the `lbu_free' function automatically.
Appendix A Example files
************************
@@ -2269,8 +2357,8 @@
software may change. Besides being used for reference, they can be
studied to see how things are done.
-A.1 `canonical.cfg'
-===================
+A.1 `liblouisutdml.ini'
+=======================
# canonical Configuration File
@@ -2291,186 +2379,186 @@
# and the value of the setting.
outputFormat
- cellsPerLine 40
- linesPerPage 25
- interpoint no
- lineEnd \r\n
- pageEnd \f
- fileEnd ^z
- printPages yes
- braillePages yes
- paragraphs yes
- beginningPageNumber 1
- printPageNumberAt top
- braillePageNumberAt bottom
- hyphenate no
- outputEncoding ascii8
- inputTextEncoding ascii8
- backFormat plain
- backLineLength 70
- formatFor textDevice
- interline no
- lineFill '
+ cellsPerLine 40
+ linesPerPage 25
+ interpoint no
+ lineEnd \r\n
+ pageEnd \f
+ fileEnd ^z
+ printPages yes
+ braillePages yes
+ paragraphs yes
+ beginningPageNumber 1
+ printPageNumberAt top
+ braillePageNumberAt bottom
+ hyphenate no
+ outputEncoding ascii8
+ inputTextEncoding ascii8
+ backFormat plain
+ backLineLength 70
+ formatFor textDevice
+ interline no
+ lineFill '
translation
- literarytextTable en-us-g2.ctb
- uncontractedTable en-us-g1.ctb
- compbrlTable en-us-compbrl.ctb
- mathtextTable en-us-g2.ctb
- mathexprTable nemeth.ctb
- editTable nemeth_edit.ctb
- interlineBackTable en-us-interline.ctb
+ literarytextTable en-us-g2.ctb
+ uncontractedTable en-us-g1.ctb
+ compbrlTable en-us-compbrl.ctb
***The diff for this file has been truncated for email.***
=======================================
--- /dist/helpDocs/tutorial.html Sun Oct 2 11:05:22 2011
+++ /dist/helpDocs/tutorial.html Sun Mar 11 08:09:03 2012
@@ -7,6 +7,17 @@
<body>
+<p>This tutorial and the manuals can be accessed from the help menu in
+the BrailleBlaster GUI.</p>
+
+<p>Parts of the GUI are being implemented incrementally. At present the
+Open, SaveAs and emboss itmes of the file menu are implemented. The
+translate item in the translate menu is implemented. The entire help
+menu is implemented.</p>
+
+<p>Below is a discussion of the command-line facilities provided by
+BrailleBlaster.</p>
+
<p>The command to run BrailleBlaster is simply</p>
<p>java -jar brailleblaster.jar</p>
=======================================
--- /dist/programData/liblouis/tables/Es-Es-G0.utb Sat Feb 11 05:38:38 2012
+++ /dist/programData/liblouis/tables/Es-Es-G0.utb Sun Mar 11 08:09:03 2012
@@ -96,6 +96,7 @@
uplow \x008C\x009C 1468,1238 oe
uplow \x00C3\x00E3 3567,168 a con tilde
uplow \x00D5\x00F5 12458,4567 o con tilde
+uplow \x00D1\x00F1 124567,124568 letra eñe
punctuation , 2 coma
punctuation ; 23 punto y coma
@@ -140,6 +141,7 @@
sign \X00B7 14678 # punto centrado
sign \X00B9 237 # Super uno
sign \X00BA 5678 # ordinal masculino
+sign \x00AA 23568 # ordinal femenino
sign \X00BF 267 #*abrir interrogación
sign \X00C5 12368 #*a mayúscula con círculo superescrito
=======================================
--- /dist/programData/liblouis/tables/is.ctb Sun Jan 30 03:56:40 2011
+++ /dist/programData/liblouis/tables/is.ctb Sun Mar 11 08:09:03 2012
@@ -16,25 +16,30 @@
# This software is maintained by Dave Mielke <dave@xxxxxxxxx>.
###############################################################################
-# BRLTTY Text Table - Icelandic
-#
-# Samuel Thibault <samuel.thibault@xxxxxxxxxxxx>
-#
-# This table is based on the Unesco report on the progress of unification
of
-# braille writing « L'ÉCRITURE BRAILLE DANS LE MONDE », by Sir Clutha
-# MACKENZIE: http://unesdoc.unesco.org/images/0013/001352/135251fo.pdf
-# The document is dated 1954, so this table may be quite outdated.
-
-# generated by ttbtest
+# BRLTTY Text Table - 8-dot Icelandic
+#
+# originally written by: Samuel Thibault <samuel.thibault@xxxxxxxxxxxx>
+# Updated and maintained by Birkir R. Gunnarsson birkir@xxxxxxxxxx
+# last updated February 16th, 2012
+# Table now compliant with the official IceBraille specifications
+# which can be found at http://www.midstod.is/Pages/239
+
space \s 0 SPACE
-punctuation ! 235 EXCLAMATION MARK
-punctuation " 2356 QUOTATION MARK
-punctuation ' 3 APOSTROPHE
+punctuation ! 2357 EXCLAMATION MARK
+punctuation " 56 QUOTATION MARK
+sign # 3456 number sign
+sign $ 14578 dollar sign
+sign % 46 per cent
+sign & 123468 ampersand
+punctuation ' 5 APOSTROPHE
punctuation ( 236 LEFT PARENTHESIS
punctuation ) 356 RIGHT PARENTHESIS
+sign * 35 asterisk
+math + 235 plus sign
punctuation , 2 COMMA
punctuation - 36 HYPHEN-MINUS
-punctuation . 256 FULL STOP
+punctuation . 3 FULL STOP
+math / 34 slash
digit 0 2458 DIGIT ZERO
digit 1 18 DIGIT ONE
digit 2 128 DIGIT TWO
@@ -45,9 +50,42 @@
digit 7 12458 DIGIT SEVEN
digit 8 1258 DIGIT EIGHT
digit 9 248 DIGIT NINE
-punctuation : 25 COLON
-punctuation ; 23 SEMICOLON
-punctuation ? 26 QUESTION MARK
+punctuation : 25 COLON
+punctuation ; 23 SEMICOLON
+math < 358 less than
+math = 2356 equals
+math > 267 greater than
+punctuation ? 26 ? questionmark
+sign @ 123456 at sign
+punctuation [ 12356 left bracket
+sign \\ 347 backslash
+punctuation ] 23456 right bracket
+sign ^ 346 caret/superscript symbol
+sign _ 3678 hyphen/underline
+punctuation { 123567 left brace
+sign | 4568 vertical bar
+punctuation } 234568 right brace
+
+# misc. punctuation and math symbols, less frequently used
+sign \X2026 6 elipsis
+punctuation \X201E 2378 open quotation symbol, used in Icelandic quotes
+sign ~ 457 tilde
+math ` 4
+math ° 256 degrees
+sign ¨ 38 dieresis
+sign \X2022 37 bullet
+punctuation \x2014 367 em dash
+punctuation \X2013 368 en dash, long dash
+sign © 1478 copyright
+sign \X2122 234578 trademark
+sign ® 123578 registerred
+sign \X20AC 1578 Euro symbol
+sign \x00A3 123478 pound sign
+sign \X00AB 2578 cents
+sign \x00A5 1345678 yen
+math \X00B1 123568 plus or minus
+math \x00F7 2367 divided by
+# English alphabet, Icelandic uses all of these though c, w and z are not
used in the Icelandic language
uppercase A 17 LATIN CAPITAL LETTER A
uppercase B 127 LATIN CAPITAL LETTER B
uppercase C 147 LATIN CAPITAL LETTER C
@@ -100,22 +138,26 @@
lowercase x 1346 LATIN SMALL LETTER X
lowercase y 13456 LATIN SMALL LETTER Y
lowercase z 1356 LATIN SMALL LETTER Z
-punctuation \x00a0 0 NO-BREAK SPACE
+# punctuation \x00a0 0 NO-BREAK SPACE
+
+# letters specific to Icelandic (though part of the Windows 1252 set)
uppercase \x00c1 167 LATIN CAPITAL LETTER A WITH ACUTE
-uppercase \x00c9 1267 LATIN CAPITAL LETTER E WITH ACUTE
-uppercase \x00cd 1467 LATIN CAPITAL LETTER I WITH ACUTE
-uppercase \x00d0 123567 LATIN CAPITAL LETTER ETH
+uppercase \x00c6 3457 LATIN CAPITAL LETTER AE
+uppercase \x00c9 23467 LATIN CAPITAL LETTER E WITH ACUTE
+uppercase \x00cd 1267 LATIN CAPITAL LETTER I WITH ACUTE
+uppercase \x00d0 1567 LATIN CAPITAL LETTER ETH
uppercase \x00d3 14567 LATIN CAPITAL LETTER O WITH ACUTE
-uppercase \x00d6 23467 LATIN CAPITAL LETTER O WITH DIAERESIS
-uppercase \x00da 1567 LATIN CAPITAL LETTER U WITH ACUTE
-uppercase \x00dd 12467 LATIN CAPITAL LETTER Y WITH ACUTE
-uppercase \x00de 234567 LATIN CAPITAL LETTER THORN
+uppercase \x00d6 2467 LATIN CAPITAL LETTER O WITH DIAERESIS
+uppercase \x00da 124567 LATIN CAPITAL LETTER U WITH ACUTE
+uppercase \x00dd 123467 LATIN CAPITAL LETTER Y WITH ACUTE
+uppercase \x00de 12467 LATIN CAPITAL LETTER THORN
lowercase \x00e1 16 LATIN SMALL LETTER A WITH ACUTE
-lowercase \x00e9 126 LATIN SMALL LETTER E WITH ACUTE
-lowercase \x00ed 146 LATIN SMALL LETTER I WITH ACUTE
-lowercase \x00f0 12356 LATIN SMALL LETTER ETH
+lowercase \x00e6 345 LATIN SMALL LETTER AE
+lowercase \x00e9 2346 LATIN SMALL LETTER E WITH ACUTE
+lowercase \x00ed 126 LATIN SMALL LETTER I WITH ACUTE
+lowercase \x00f0 156 LATIN SMALL LETTER ETH
lowercase \x00f3 1456 LATIN SMALL LETTER O WITH ACUTE
-lowercase \x00f6 2346 LATIN SMALL LETTER O WITH DIAERESIS
-lowercase \x00fa 156 LATIN SMALL LETTER U WITH ACUTE
-lowercase \x00fd 1246 LATIN SMALL LETTER Y WITH ACUTE
-lowercase \x00fe 23456 LATIN SMALL LETTER THORN
+lowercase \x00f6 246 LATIN SMALL LETTER O WITH DIAERESIS
+lowercase \x00fa 12456 LATIN SMALL LETTER U WITH ACUTE
+lowercase \x00fd 12346 LATIN SMALL LETTER Y WITH ACUTE
+lowercase \x00fe 1246 LATIN SMALL LETTER THORN
=======================================
--- /dist/programData/liblouis/tables/no-no-generic.ctb Sun Jan 30 03:56:40
2011
+++ /dist/programData/liblouis/tables/no-no-generic.ctb Sun Mar 11 08:09:03
2012
@@ -1,4 +1,4 @@
-# File: no-no-generic.dis
+# File: no-no-generic.ctb
# Quick hack for using with NVDA
# Based on the braille contraction modules in BRLTTY
=======================================
--- /dist/programData/liblouis/tables/no-no.ctb Sun Jan 30 03:56:40 2011
+++ /dist/programData/liblouis/tables/no-no.ctb Sun Mar 11 08:09:03 2012
@@ -280,3 +280,33 @@
sign \X00FD 12346 # 253 latin small letter y with acute
sign \X00FE 12468 # 254 latin small letter thorn
sign \X00FF 12568 # 255 latin small letter y with diaeresis
+
+# Added 21.02.2012
+
+sign \x20ac 2678 # Euro-tegn \200
+sign \x201a 67 # Enkelt nedre anførselstegn \202
+sign \x0192 45678 # Liten latinsk bokstav f med krok \203
+sign \x201e 3567 # Dobbelt nedre anførselstegn \204
+sign \x2026 37 # Horisontal ellipse (tre prikker) \205
+sign \x2020 47 # Dagger \206
+sign \x2021 457 # Dobbel dagger \207
+sign \x02c6 468 # Liten cirkumfleks (over bokstav) \210
+sign \x2030 4568 # Promille-tegn \211
+sign \x0160 15678 # Stor latinsk bokstav S med caron \212
+sign \x2039 378 # Enkelt anførselstegn med vinkelen mot venstre
\213
+sign \x0152 12345678 # Stor latinsk bokstav OE \214
+sign \x017d 234678 # Stor latinsk bokstav Z med caron \216
+sign \x2018 367 # Enkelt øvre anførselstegn \221
+sign \x2019 368 # Enkelt øvre anførselstegn \222
+sign \x201c 23567 # Dobbelt øvre anførselstegn \223
+sign \x201d 23568 # Dobbelt øvre anførselstegn \224
+sign \x2022 3678 # Kulepunkt \225
+sign \x2013 68 # En dash (n-tankestrek) \226
+sign \x2014 568 # Em dash (m-tankestrek) \227
+sign \x02dc 2568 # Liten tilde (over bokstav) \230
+sign \x2122 23458 # Trademark-tegn (varemerke) \231
+sign \x0161 1568 # Liten latinsk bokstav s med caron \232
+sign \x203a 678 # Enkelt anførselstegn med vinkelen mot høyre
\233
+sign \x0153 1234568 # Liten latinsk bokstav oe \234
+sign \x017e 23468 # Liten latinsk bokstav z med caron \236
+sign \x0178 125678 # Stor latinsk bokstav Y med trema \237
=======================================
--- /dist/programData/liblouisutdml/lbu_files/brf.cfg Sat Feb 11 05:38:38
2012
+++ /dist/programData/liblouisutdml/lbu_files/brf.cfg Sun Mar 11 08:09:03
2012
@@ -1,5 +1,6 @@
include preferences.cfg
formatfor brf
+mode notSync
paperWidth 9.5
paperheight 11
leftMargin 1
=======================================
--- /dist/programData/liblouisutdml/lbu_files/preferences.cfg Sat Feb 11
05:38:38 2012
+++ /dist/programData/liblouisutdml/lbu_files/preferences.cfg Sun Mar 11
08:09:03 2012
@@ -14,6 +14,7 @@
pageSeparatorNumber yes
numberBraillePages yes
backFormat html
+ backLineLength 70
hyphenate no
formatFor textDevice
lineEnd \r\n
@@ -24,10 +25,9 @@
printPageNumberAt top
braillePageNumberAt bottom
outputEncoding utf8
- backLineLength 70
- topMargin 0.5
contents no
lineFill '
+ topMargin 0.5
leftMargin 1
rightMargin 0.5
bottomMargin 0.5
@@ -64,7 +64,7 @@
pefSem utd.sem
#(miscellaneous)
- #include
+ #include (another configuration file)
#mode (built-in defaults)
inputTextEncoding ascii8
debug no
@@ -77,7 +77,7 @@
linesAfter 0
leftMargin 0
firstLineIndent 0
- translate contracted
+ #translationTable (a table name)
skipNumberLines no
format leftJustified
newPageBefore no
@@ -88,6 +88,7 @@
keepWithNext no
dontSplit no
orphanControl 0
+ newlineAfter yes
style arith
style attribution
=======================================
--- /dist/programData/liblouisutdml/lbu_files/sample-utd.cfg Sat Feb 11
05:38:38 2012
+++ /dist/programData/liblouisutdml/lbu_files/sample-utd.cfg Sun Mar 11
08:09:03 2012
@@ -2,7 +2,7 @@
formatfor utd
newEntries no
#mode notUC
-paperWidth 11.5
+paperWidth 9.5
paperheight 11
leftMargin 1
rightMargin 0.5
=======================================
--- /dist/programData/liblouisutdml/lbu_files/transinxml.cfg Sat Feb 11
05:38:38 2012
+++ /dist/programData/liblouisutdml/lbu_files/transinxml.cfg Sun Mar 11
08:09:03 2012
@@ -1,6 +1,7 @@
include preferences.cfg
formatFor transInXml
mode notSync
+lineEnd \n
paperWidth 11.5
paperheight 11
leftMargin 1
=======================================
--- /dist/programData/liblouisutdml/lbu_files/utd.sem Sun Jan 30 03:56:40
2011
+++ /dist/programData/liblouisutdml/lbu_files/utd.sem Sun Mar 11 08:09:03
2012
@@ -5,7 +5,7 @@
utdmeta meta,name,utd
utdbrl brl
utdbrlonly span,class,brlonly
-utdnewpage newpage,number
+utdnewpage newpage,brlnumber
utdnewline newline,xy
utdgraphic xxx
newentries no
=======================================
--- /dist/programData/liblouisutdml/lbu_files/viewxml.cfg Sat Feb 11
05:38:38 2012
+++ /dist/programData/liblouisutdml/lbu_files/viewxml.cfg Sun Mar 11
08:09:03 2012
@@ -1,3 +1,10 @@
+# Run this configuration file with the following command line.
+
+# xxx/file2brl -T -f viewxml.cfg infile.xml outfile.txt
+
+# or use the same options with the translate subcommand in
+# Brailleblaster.
+
outputFormat
cellsPerLine 32
linesPerPage 25
=======================================
--- /dist/programData/liblouisutdml/lbu_files/viewxml.ctb Sat Feb 11
05:38:38 2012
+++ /dist/programData/liblouisutdml/lbu_files/viewxml.ctb Sun Mar 11
08:09:03 2012
@@ -1,4 +1,4 @@
-# liblouis: U.S. English 8 dot Computer braille table
+# liblouis: Modified U.S. English 8 dot Computer braille table
space \t 9 tab
space \s 0 blank
@@ -73,7 +73,6 @@
sign | 1256
math / 34
sign * 16
-repeated \s 0
pass2 @3-3 @3-0-3
Other related posts:
- » [brailleblaster] push by john.bo...@xxxxxxxxxxxxxxxxx - Updating tutorial and programData on 2012-03-11 15:10 GMT - brailleblaster
