blob: 27cdc73de0406d5d2c3b34fb35e30e86091a70b2 [file] [log] [blame]
Christian Egli343b1ae2016-07-14 17:40:54 +02001liblouis 3.0.0 has been released
Christian Egli15c482e2009-01-27 16:23:57 +00002
Christian Egli554b70f2014-09-01 13:47:30 +02003The liblouis developer team is proud to announce the liblouis release
Christian Egli343b1ae2016-07-14 17:40:54 +020043.0.0. The release is available for download at:
Christian Egli15c482e2009-01-27 16:23:57 +00005
Christian Egli554b70f2014-09-01 13:47:30 +02006 https://github.com/liblouis/liblouis/releases
Christian Egli15c482e2009-01-27 16:23:57 +00007
8Introduction
Christian Egli554b70f2014-09-01 13:47:30 +02009============
Christian Egli15c482e2009-01-27 16:23:57 +000010
11Liblouis is an open-source braille translator and back-translator. It
Christian Egli183d9e72011-05-09 07:38:36 +000012features support for computer, literary and math braille, supports
13contracted and uncontracted translation for many, many languages[1].
Christian Egli971d4e82009-01-30 10:09:52 +000014It plays an important role in an open source accessibility stack and
Christian Egli343b1ae2016-07-14 17:40:54 +020015is used by screenreaders such as NVDA, Orca and JAWS. A companion
16project liblouisutdml[2] deals with formatting of braille.
Christian Egli15c482e2009-01-27 16:23:57 +000017
18Changes in this release
Christian Egli554b70f2014-09-01 13:47:30 +020019=======================
Christian Egli15c482e2009-01-27 16:23:57 +000020
Christian Egli343b1ae2016-07-14 17:40:54 +020021This is the biggest release of liblouis in years. The major news are
22that we now have proper support for UEB and secondly that liblouis is
23now licensed under LGPLv2.1+.
Christian Eglia1f030c2016-06-17 12:35:38 +020024
Christian Egli343b1ae2016-07-14 17:40:54 +020025In order to support UEB the internals of liblouis have seen a major
26rewrite. New Opcodes have been added to support the requirements for
27proper UEB for example for emphasis handling or to handle proper
28translation of numbers. Changes to the opcodes are described in the
29documentation. Some of these changes are not backwards compatible. All
30tables that come with liblouis have been migrated. If you have private
31tables look at the section on upgrading from previous versions in the
32wiki[3].
Christian Eglia1f030c2016-06-17 12:35:38 +020033
34This release also changes the C API. External applications will have
35to adapt the way they call liblouis. In particular the typeform
36parameter has changed.
Christian Eglieb7178f2012-09-10 10:08:16 +000037
Christian Egli343b1ae2016-07-14 17:40:54 +020038The license of the library and most of the tables has been changed to
39LGPLv2.1. For a detailed list which tables are still in the process of
40migrating the license refer to the wiki page about the license
41change[4].
42
Christian Egli7617fa92014-03-03 11:15:35 +000043New features
44~~~~~~~~~~~~
Christian Eglieb7178f2012-09-10 10:08:16 +000045
Christian Egli343b1ae2016-07-14 17:40:54 +020046- Numerous features to support UEB properly. Thanks to Mike Gray,
47 William Freeman, Davy Kager, Keith Creasy and the American Printing
48 House for the Blind for sponsoring this work.
Christian Eglia1f030c2016-06-17 12:35:38 +020049 - support the many emphasis classes needed for UEB.
50 - support translation of numbers according to the rules of UEB.
51 - Capitalization is now handled just like emphasis.
Christian Egli343b1ae2016-07-14 17:40:54 +020052 - support for numeric mode
53- UTF-8 support for all tools thanks to Christian Egli.
Christian Eglia1f030c2016-06-17 12:35:38 +020054- The YAML tests now allow for an optional test description. See the
55 documentation for more details.
Christian Egli343b1ae2016-07-14 17:40:54 +020056- Add `lou_checkTable' and `lou_getTypeformForEmphClass' to the C API
57 and to the Python bindings
Christian Egli2d6ae7e2014-12-01 14:37:01 +010058
59Bug fixes
60~~~~~~~~~
61
Christian Eglia1f030c2016-06-17 12:35:38 +020062- Stop buffer overrun in lou_getProgramPath, and also free memory
63 after usage. Thanks to Michael Curran.
Christian Eglifa68aba2015-06-01 13:40:29 +020064
65Other changes
66~~~~~~~~~~~~~
67
Christian Egli343b1ae2016-07-14 17:40:54 +020068- The license of the library and most of the tables has been changed
69 to LGPLv2.1+.
Christian Eglia1f030c2016-06-17 12:35:38 +020070- Improvements to the test suite:
71 - Output is printed to stderr. This helps with locating errors when
72 testing with the YAML test suite.
73 - typeform is included in output.
Christian Egli2d6ae7e2014-12-01 14:37:01 +010074
Christian Eglib4b192b2015-03-02 10:54:30 +010075Braille table improvements
76~~~~~~~~~~~~~~~~~~~~~~~~~~
Christian Egli2d6ae7e2014-12-01 14:37:01 +010077
Christian Eglia1f030c2016-06-17 12:35:38 +020078- Improved Finish 6-dot braille thanks to Jukka Eerikäinen
79- Improvements to the Chinese braille table thanks to Coscell Kao
80- Improvements to Mongolian thanks to Tsengel Maidar and Sreeja Param
81- Added new Slovak tables based off the official Slovak braille
82 standard thanks to Peter Vagner
83- Changes to the Norwegian tables. There are now three Norwegian 8-dot
84 tables
85 - no-no-comp8.ctb: Norwegian 8-dot computer braille table
86 - no-no-8dot.utb: Norwegian 8-dot braille table
87 - no-no-8dot-fallback-6dot-g0.utb: Norwegian 8-dot braille table
88 with uncontracted 6-dot fallback
Christian Egli343b1ae2016-07-14 17:40:54 +020089- Changes to the Dutch tables
90 - Conforms better to the standard.
91 - nl-BE-g1.ctb renamed to nl-BE-g0.utb
92 - nl-NL-g1.ctb renamed to nl-NL-g0.utb
93- Improvements to Danish tables: Added grade 2 with limited
94 contractions to 6 and 8 dots. Corrected contraction of many words.
95 - Renamed:
96 - da-ansi8.dis -> da-dk-octobraille.dis
97 - da-dk-g16.utb -> da-dk-g16.ctb
98 - da-dk-g18.utb -> da-dk-g18.ctb
99 - hyph_da_DK.dic -> hyph_brl_da_dk.dic
100 - Removed: da-dk-g28caps.cti, da-dk-g28-patches.cti and
101 da-chardefs8.cti
Christian Eglia1f030c2016-06-17 12:35:38 +0200102
103Backwards incompatible changes
104~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
105
106- The json based harness test suite has been removed as its
107 functionality has been superceded by the YAML tests. Please use
108 these from now on.
109- A number of opcodes to handle emphasis have been renamed.
110- The C API regarding the typeform parameter has changed.
Christian Egli2d6ae7e2014-12-01 14:37:01 +0100111
Christian Eglib4b192b2015-03-02 10:54:30 +0100112Next release
113============
Christian Egli2d6ae7e2014-12-01 14:37:01 +0100114
Christian Egli343b1ae2016-07-14 17:40:54 +0200115The next release will be published on September 5, 2016 so please keep
116up the excellent work and keep those improvements coming.
Christian Egli15c482e2009-01-27 16:23:57 +0000117
118Share and Enjoy!
119
120-- Christian Egli, on behalf of the liblouis developers
Christian Egli971d4e82009-01-30 10:09:52 +0000121
122Footnotes
Christian Egli554b70f2014-09-01 13:47:30 +0200123=========
Christian Egli971d4e82009-01-30 10:09:52 +0000124
Christian Egli983d5232014-05-20 09:19:50 +0200125[1] See https://github.com/liblouis/liblouis/tree/master/tables
Christian Egli5833e352015-06-11 10:22:22 +0200126[2] See https://github.com/liblouis/liblouisutdml
Christian Eglia1f030c2016-06-17 12:35:38 +0200127[3] See https://github.com/liblouis/liblouis/wiki/Emphasis-Opcodes#upgrade-from-previous-versions
Christian Egli343b1ae2016-07-14 17:40:54 +0200128[4] See https://github.com/liblouis/liblouis/wiki/Licensing-of-liblouis-tables