Skip to content

Commit

Permalink
CHANGELOG: Fix a typo and some Markdown warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
bertrand-lorentz committed Jul 28, 2023
1 parent 19cb78b commit ebac474
Showing 1 changed file with 11 additions and 7 deletions.
18 changes: 11 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,30 +3,33 @@
_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:

## In this release

This release:

- Improves translation of EFX-1.
- Adds support for translating EFX-2 expressions and templates.
- 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.
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.
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.
- An extensive refactoring in the type management system has rearranged the package structure. As a result some import statements in 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.

Expand All @@ -39,11 +42,12 @@ Further alpha and beta releases of SDK 2 and EFX Toolkit 2 will be issued. While
You can download the latest EFX Toolkit from Maven Central.
[![Maven Central](https://img.shields.io/maven-central/v/eu.europa.ted.eforms/efx-toolkit-java?label=Download%20&style=flat-square)](https://central.sonatype.com/artifact/eu.europa.ted.eforms/efx-toolkit-java)

Documentation for the EFX Toolkit is available at: https://docs.ted.europa.eu/eforms/latest/efx-toolkit
Documentation for the EFX Toolkit is available at: <https://docs.ted.europa.eu/eforms/latest/efx-toolkit>

---

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

Expand Down

0 comments on commit ebac474

Please sign in to comment.