diff --git a/CHANGELOG.md b/CHANGELOG.md index bee0181..5c2650e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,13 +1,38 @@ -# EFX Toolkit 1.3.0 Release Notes +# EFX Toolkit 2.0.0-alpha.1 Release Notes _The EFX Toolkit for Java developers is a library that enables the transpilation of [EFX](https://docs.ted.europa.eu/eforms/latest/efx) expressions and templates to different target languages. It also includes an implementation of an EFX-to-XPath transpiler._ --- ## In this release: -- Updated the XPath 2.0 parser, XPathContextualizer and XPathScriptGenerator to correctly translate sequences. -- Improved numeric formatting. The EfxTranslator API now includes overloaded methods that permit control of numeric formatting. The existing API has been preserved. -- Improved handling of multilingual text fields by adding automatic selection of the visualisation language. +This release: +- Improves translation of EFX-1. +- Adds support for translating EFX-2 expressions and templates. +- Removes support of the obsolete EFX versions included in pre-release versions of the SDK (SDK 0.x.x). +- Introduces some breaking changes in the interfaces that need to be implemented by new translators (SymbolResolver, ScriptGenerator, MarkupGenerator). + +## EFX-1 Support + +Although this is a pre-release version of the EFX Toolkit, it provides production-level support for EFX-1 transpilation. +EFX-1 is the current version of EFX released with SDK 1. Transpilation of EFX-1 to XPath is on par with the EFX Toolkit 1.3.0. + +## EFX-2 Support + +The new version of EFX is still under development and will be released with SDK 2.0.0. For more information of EFX-2 see the release notes of the eForms SDK 2.0.0-alpha.1. + +## Breaking changes + +For users of the Toolkit that have implemented custom transpilers, this release contains a few breaking changes. +More specifically: +- Some additional methods have been added to the SymbolResolver, ScriptGenerator and MarkupGenerator API. As a guide for your implementations please look a the implementations included in the EFX Toolkit for use by the EFX-to-XPath transpilation. +- Some deprecated methods were removed. +- An extensive refactoring in the type management system has rearranged the package structure. As a result some import statements i your code will need to be updated. + +Users of the Toolkit that only use the included EFX-to-XPath transpiler will not be affected by the above changes. + +## Future development + +Further alpha and beta releases of SDK 2 and EFX Toolkit 2 will be issued. While in "alpha" development stage, further braking changes may be introduced. SDK 2 and EFX 2 are expected to continue to be under development util late 2023. --- @@ -20,5 +45,6 @@ Documentation for the EFX Toolkit is available at: https://docs.ted.europa.eu/ef This version of the EFX Toolkit has a compile-time dependency on the following versions of eForms SDK versions and uses the EFX grammar that each version provides: - eForms SDK 1.x.x +- eForms SDK 2.0.0-alpha.1 It also depends on the [eForms Core Java library](https://github.com/OP-TED/eforms-core-java) version 1.0.5.