Update release announcement
diff --git a/ANNOUNCEMENT b/ANNOUNCEMENT
index afb053a..b165df5 100644
--- a/ANNOUNCEMENT
+++ b/ANNOUNCEMENT
@@ -1,7 +1,7 @@
-liblouis 3.4.0 has been released
+liblouis 3.5.0 has been released
The liblouis developer team is proud to announce the liblouis release
-3.4.0. The release is available for download at:
+3.5.0. The release is available for download at:
https://github.com/liblouis/liblouis/releases
@@ -18,127 +18,154 @@
Changes in this release
=======================
-This release brings together a lot of work by lots of different
-people. Probably the most prominent fix is the work on output
-positions by Bue and Bert. NVDA should benefit from this. Then there
-are new and massively improved tables like the Lithuanian 6-dot table
-by Rimas or the improved back-translation for French by Michel and
-André-Abush to name just a few. There are too many contributors to
-name them here, thanks to them all.
+This release has a number of Braille table improvements, cleanups and
+meta data enhancements. The most prominent new feature however is
+probably the much improved test coverage. This has helped in tracing
+and fixing a number of long standing bugs.
-For a detailed list of all the changes refer to
+For a detailed list of all the changes refer to [the list of closed
+issues].
- https://github.com/liblouis/liblouis/milestone/14?closed=1
+
+[the list of closed issues]
+https://github.com/liblouis/liblouis/milestone/15?closed=1
New features
~~~~~~~~~~~~
-- Add support for `inputPos' and `outputPos' checking in
- `lou_checkyaml' thanks to Bue Vester-Andersen. See the manual for
- details and examples.
+- The same name can now be used in more than one `class' rule. The
+ effect is that both set of characters become part of that one class.
Bug fixes
~~~~~~~~~
-- output positions (`outputPos') are now calculated based on input
- positions (`inputPos') thanks to Bert Frees. This avoids a whole
- class of bugs that previously plagued the output positions. This fix
- also obviates the need for the `pass1Only' flag. See below for the
- deprecation notice.
+- Fix a regression in inputPositions thanks to Bert Frees
+- Treat characters within the range `compbrlStart' and `compbrlEnd' as
+ a special case. This fixes many if not most of the problems with
+ cursor position and the `compbrlAtCursor' mode. Thanks to Dave
+ Mielke.
+- Fix `swapdd' opcode thanks to Bert Frees
+- Fix negation of attribute matcher in multipass expressions thanks to
+ Bert Frees
Braille table improvements
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- Addition of Nemeth and Kangxi radical characters and other
- improvements to Chinese braille (`zh-tw.ctb') thanks to Bo-Cheng
- Jhan and 黃偉豪.
-- Improvements to the Spanish chardefs table thanks to Luis Lorente
- Barajas and Simon Aittamaa.
-- Fixed a lowercase ó in Spanish first reported for NVDA thanks to
- Sukil Etxenike.
-- New Norwegian 6-dot display braille table for Braillo embossers
- thanks to Lars Bjørndal
-- Added a bunch of whitespace-like codepoints as spaces thanks to
- Rimas Kudelis
-- Added Lithuanian 6-dot table thanks to Rimas Kudelis.
-- Addition of more characters to the French tables thanks to Samuel
- Thibault
-- Improvements to the Hungarian tables thanks to Attila Hammer
-- Improvements to the Mongolian tables thanks to Tsengel Maidar
-- Fix some math signs in Czech Braille (`cs-chardefs.cti'). Thanks to
- Christian Herden of ViewPlus for reporting this.
-- Updates to the SEB British Braille Tables thanks to Paul Wood
-- Massive improvements to French back-translation thanks to Michel
- Such and André-Abush Clause
+- Add a display table that maps braille dots to brl/brf character set.
+ For an in depth explanation see the corresponding [github issue].
+ Thanks to Rimas Kudelis
+- Major Improvements to Unified French Grade 2 thanks to André-Abush
+ Clause
+- Fix braille number input for Greek Braille thanks to Dave Mielke
+- Add a fix for "phad" according to UEB Rule 10.7.3 thanks to Anthony
+ Tibbs
+- Updates to the Urdu tables thanks to Jake Kyle from Compass Braille
+- Updates to the Chinese braille table (`zh-tw.ctb') thanks to
+ Bo-Cheng Jhan
+- `IPA.utb' now contains a more complete list of phonetic symbols,
+ including some that might conflict with other tables. For this
+ reason it is not suitable for inclusion in other tables. A separate
+ table `IPA-unicode-range.uti' has been added for this purpose.
+ Thanks to Ludovic Oger.
+- The Mongolian table has been improved and there is now also support
+ for grade 2 thanks to Tsengel Maidar.
+- Minor updates to the Danish tables thanks to Bue Vester-Andersen
+- Fix back translation of numbers in Dutch, Finnish and Canadian
+ French, thanks to Leonard de Ruijter.
+- New table for Ukrainian thanks to Sergiy Moskalets.
+
+[github issue] https://github.com/liblouis/liblouis/issues/503
Other changes
~~~~~~~~~~~~~
Improved documentation
----------------------
-- Bue Vester-Andersen added some notes about back-translation and
- documented all possible values of the `mode' parameter. Also the
- description of `decpoint' and `litdigit' was improved.
-- The `match' opcode is now documented thanks to Mike Gray and
- Christian Egli.
+- Extend the documentation on multipass opcodes. Thanks to Dave Mielke
+ and Christian Egli.
+- Remove the deprecation note of the '=' dots operand. While there are
+ still problems with back-translation we will not remove support for
+ it. See also the discussion in the [github issue].
-lou_maketable
--------------
-Numerous bug fixes and performance enhancements thanks to Bert Frees
+[github issue] https://github.com/liblouis/liblouis/issues/500
+Improved meta data information in tables
+----------------------------------------
-Code refactoring
-----------------
-Many global variables have been removed thanks to Bert Frees
+The meta data in the tables such as locale, contraction grade, etc has
+been improved and is now also used when testing from a YAML test.
+Thanks to Bert Frees.
+Major overhaul of the YAML test suite
+-------------------------------------
-Code formatting
----------------
-Thanks to clang-format There is now a uniform coding style over the
-whole code base
+* Support for proper testing of cursor positions
+Due to problems in the cursor position computation the YAML test suite
+was improved to support proper testing of cursor position also in
+combination with input, output position and modes. In essence all of
+the liblouis API is now supported and can be tested via the YAML
+tests. Thanks to Christian Egli.
-Fix broken NMakefile
---------------------
-Thanks to Davy Kager building with nmake should work again
+* Support for table selection via meta data query
+The tables to be tested can now be specified via a meta data query in
+addition to specifying them by filename. See the documentation for
+more details. Internally the YAML tests have been split up into tests
+that test the braille translation for a particular locale (now located
+in `tests/braille_specs') and tests that check a specific feature of
+liblouis. Thanks to Bert Frees.
Deprecation notice
~~~~~~~~~~~~~~~~~~
-The `pass1Only' flag has been deprecated. Its use should be avoided,
-and it will be completely removed from the code in the next version of
-Liblouis. When using the `pass1Only' flag in this release you will get
-a warning.
+None
Backwards incompatible changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-None
+- The translation mode `comp8Dots' has been removed as it was never
+ really implemented anyway
+- Support for the `pass1Only' flag has now been removed. Thanks to Bue
+ Vester-Andersen.
+- The old UEB tables `UEBC-g1.ctb' and `UEBC-g2.ctb' have been removed
+ as the have been superseded by `en-ueb-g1.ctb' and `en-ueb-g2.ctb'.
+- The french tables `fr-2007.ctb', `fr-fr-g1.utb', `fr-fr-g2.ctb',
+ `fr-ca-g1.utb' and `fr-ca-g2.ctb' have been removed. Use
+ `fr-bfu-comp6.utb' for 6 dots literary, `fr-bfu-comp8.utb' for 8
+ dots computer and `fr-bfu-g2.ctb' for contracted braille instead.
New, renamed or removed tables
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
New
---
-- no-no-braillo-047-01.dis
-- lt-6dot.utb
+ - IPA-unicode-range.uti
+ - mn-MN-g2.ctb
+ - uk.utb
Renamed
-------
-None
+ - mn-MN.utb -> mn-MN-g1.utb
Removed
-------
-None
+
+ - fr-2007.ctb
+ - fr-ca-g1.utb
+ - Fr-Ca-g2.ctb
+ - fr-fr-g1.utb
+ - Fr-Fr-g2.ctb
+ - UEBC-g1.ctb
+ - UEBC-g2.ctb
Next release
============
-The next release will be published on March 5 2018 so please keep up
+The next release will be published on June 4 2018 so please keep up
the excellent work and keep those improvements coming.
Share and Enjoy!
