File: README

package info (click to toggle)
liblouisutdml 2.5.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 4,188 kB
  • ctags: 1,825
  • sloc: ansic: 18,386; sh: 8,978; makefile: 803; java: 108; xml: 18
file content (45 lines) | stat: -rw-r--r-- 1,904 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
INTRODUCTION

Liblouisutdml is an open-source library providing complete braille 
transcription services for xml, html and text documents. It translates 
into appropriate braille codes and formats according to its style sheet 
and the specifications in the document. A command-line program, file2brl 
which uses this library is also included. The latest version of liblouis 
is required. Java bindings are built in to the library.

The library is licensed under the GNU Lesser General Public License 
(LGPL) 
version 3 or later. See the file COPYING.LIB.

The command line tools, are licensed under the GNU General Public
License version 3.0 or later. See the file COPYING.

DOCUMENTATION

For documentation, see liblouisutdml.html or liblouisutdml.txt. These are
in the docs directory. For an example of a configuration file, see
liblouisutdml.ini and preferences.cfg . For examples of
semantics-action files, see dtbook.sem and nemeth.sem . These files are 
in the lbu_files subdirectory.
For examples of translation tables, see
en-us-g2.ctb en-us-g1.ctb chardefs.cti nemeth.ctb and whatever other
files they may include. These are all in the tables directory of 
liblouis.

INSTALLATION

First obtain the latest version of liblouis and compile it. Before
compiling, you should chose between 16- and 32-bit Unicode, as described
in the README file and the documentation. liblouisutdml inherits this
choice from liblouis.

After unpacking the distribution tarball for liblouisutdml go to the 
directory it creates. After running "configure" run "make" and "make 
install". You will need root privileges for the installation step.

This will produce the liblouisutdml library and the program file2brl . 
To compile the Java bindings go to the java subdirectory and run ant .

Note that that the library and programs will not work properly unless
you have first installed the latest version of liblouis.