//////////////////////////////////////////////////////////////////////////////
// Copyright (c) 2010, 2026 Contributors to the Eclipse Foundation
//
// See the NOTICE file(s) distributed with this work for additional
// information regarding copyright ownership.
//
// This program and the accompanying materials are made available
// under the terms of the MIT License which is available at
// https://opensource.org/licenses/MIT
//
// SPDX-License-Identifier: MIT
//////////////////////////////////////////////////////////////////////////////

include::_root_attributes.asciidoc[]

indexterm:[release, notes]

:leveloffset: -2

[[release-notes-chapter-index]]
== Chi release notes

The release notes for the versions of Chi and the associated tools, as part of the Eclipse ESCET project, are listed below in reverse chronological order.

See also the Eclipse ESCET link:https://eclipse.dev/escet/{escet-deploy-folder-name}/release-notes.html[toolkit release notes] covering those aspects that are common to the various Eclipse ESCET tools.

=== Version 12.0

TBD

=== Version 11.0 (2026-03-31)

Improvements and fixes:

* The Chi simulator SVG output now no longer scales on hi-DPI displays on Windows.
  This prevents severe performance regressions observed in ESCET v10.0.
  ESCET v10.0 adopted the Eclipse IDE 2025-09, which comes with improved hi-DPI support on Windows, which caused the regressions (issue {escet-issue}1334[#1334]).
* The Chi simulator SVG output no longer hangs when showing SVG files with inline images encoded using base64 that contain spaces (issue {escet-issue}1324[#1324]).

=== Version 10.0 (2025-12-19)

Improvements and fixes:

* The Chi simulator SVG visualizer has been fixed for handling of vendor-specific CSS properties starting with a `-`, such as Inkscape CSS properties, in `style` attributes of SVG elements.
  Vendor-specific properties are now removed to ensure that the Batik SVG library, used to render SVG images, properly processes the properties that follow the vendor-specific properties (issue {escet-issue}886[#886]).
* The Chi simulator SVG visualizer now properly handles and reports CSS rendering errors, similar to SVG XML/DOM errors (issue {escet-issue}888[#888]).
* The Chi documentation no longer contains zero width space characters generated by AsciiDoc, ensuring that there are no undesired line breaks caused by them (issue {escet-issue}1279[#1279]).
* The Chi documentation no longer links to `index.html` in link URLs, but instead now links to the parent that contains the `index.html`, resulting in nicer URLs (issue {escet-issue}1317[#1317]).

=== Version 9.0 (2025-09-30)

Improvements and fixes:

* The Chi website home page now links to the 'Community' page (issue {escet-issue}982[#982]).
* The Chi website home page now shows some news teasers and links to the new 'News' page with all the news (issue {escet-issue}982[#982]).

=== Version 8.0 (2025-06-30)

Improvements and fixes:

* The Chi text editor now has greatly improved performance when the Chi model has many warnings or errors.
  This may in certain cases also prevent the IDE from freezing indefinitely (issue {escet-issue}995[#995]).
* The Chi simulator can now be started in the ESCET IDE from right click menus of `.chix` files and editors (issue {escet-issue}1229[#1229]).
* The Chi simulator documentation now indicates that the simulator can be started from `.chix` files (issue {escet-issue}1229[#1229]).
* The Chi tool manual has some small textual improvements (issue {escet-issue}1229[#1229]).
* The screenshots of Chi in the ESCET IDE, as part of the Chi documentation and Chi website, have been updated to include the ESCET icon introduced in release v3.0 (issue {escet-issue}1197[#1197]).

=== Version 7.0 (2025-03-31)

Improvements and fixes:

* The Chi website now shows the Chi logo (issue {escet-issue}1140[#1140]).

=== Version 6.0 (2024-12-20)

Improvements and fixes:

* The Chi text editor's dark theme now uses a lighter red color for string literals, for better contrast (issue {escet-issue}966[#966]).
* The Chi documentation on the ESCET website and in the Eclipse help now use a darker green color for numbers in source code, for better contrast (issue {escet-issue}1030[#1030]).

=== Version 5.0 (2024-10-03)

This release contains no specific changes for Chi.

=== Version 4.0 (2024-06-30)

This release contains no specific changes for Chi.

=== Version 3.0 (2024-03-31)

Improvements and fixes:

* The Chi documentation has some small fixes (issue {escet-issue}740[#740]).
* The Chi website has an improved link color (issue {escet-issue}38[#38]).

=== Version 2.0 (2023-12-22)

This release contains no specific changes for Chi.

=== Version 1.0 (2023-09-30)

This release contains no specific changes for Chi.

=== Version 0.10 (2023-06-30)

Improvements and fixes:

* The Chi simulator's SVG visualizer _Save as_ dialog now properly starts in the directory that contains the SVG file, also on Windows.
And it now properly handles paths with spaces and other special characters in them (issue {escet-issue}221[#221]).

=== Version 0.9 (2023-03-31)

Improvements and fixes:

* The Chi documentation features railroad diagrams, which are now generated using a new and improved railroad diagram generator (issues {escet-issue}112[#112] and {escet-issue}505[#505]).

=== Version 0.8 (2022-12-21)

Improvements and fixes:

* Normally, `.chi` files are opened with the Chi text editor.
Large files are now however opened with the default non-Chi text editor to avoid performance issues.
You can open a file in an editor of your choosing by right clicking it and selecting menu:Open With[] and then selecting the editor of your choosing, or choosing menu:Other...[] to open a dialog to choose from a larger selection of editors (issue {escet-issue}199[#199]).

=== Version 0.7 (2022-09-30)

New features:

* The Chi text editor now has theming support, and comes with a dark theme in addition to the existing light theme.
The text editor now automatically uses its dark theme when the Eclipse built-in dark theme is used, and uses a light theme otherwise.
The text editor theming behavior can be configured via the Eclipse Preferences dialog (issue {escet-issue}347[#347]).

Improvements and fixes:

* The Chi text editor light theme's default color has changed from a near-black slightly-brown color to pure black (issue {escet-issue}347[#347]).

=== Version 0.6 (2022-07-07)

Improvements and fixes:

* Links in the documentation to non-Chi ESCET documentation webpages now use version-specific URLs (issue {escet-issue}386[#386]).
* Improved bibliography references in documentation (issue {escet-issue}365[#365]).
* The issue numbers in the release notes now link to the corresponding GitLab issue (issue {escet-issue}396[#396]).
* Small website style improvements (issue {escet-issue}367[#367]).

=== Version 0.5 (2022-03-29)

Improvements and fixes:

* Some small changes to the documentation (issue {escet-issue}271[#271]).
* The release notes for each version now contain the release date, with the exception of milestone releases and release candidates (issue {escet-issue}314[#314]).

=== Version 0.4 (2021-12-17)

Improvements and fixes:

* Introduced a brand new website (issue {escet-issue}35[#35]).
* Many website URLs have changed due to various website structure changes (issues {escet-issue}35[#35] and {escet-issue}73[#73]).
* Various documentation/website textual improvements, style improvements and other changes (issues {escet-issue}35[#35], {escet-issue}54[#54], {escet-issue}236[#236] and {escet-issue}248[#248]).
* The Chi simulator SVG visualizer functionality to save the image as an SVG file no longer crashes (issue {escet-issue}205[#205]).
* The Chi simulator SVG visualizer functionality to save as an image no longer asks duplicate overwrite questions (issue {escet-issue}223[#223]).
* The Chi simulator no longer crashes when showing an SVG visualizer if the SVG file can't be loaded (issue {escet-issue}207[#207]).

=== Version 0.3 (2021-10-01)

Improvements and fixes:

* The website and Eclipse help now use multi-page HTML rather than a single HTML file, although the website still contains a link to the single-page HTML that allows easily searching the full documentation (issue {escet-issue}36[#36]).
* Enabled section anchors for documentation on the website, and disabled section anchors for Eclipse help (issue {escet-issue}36[#36]).
* Several small documentation fixes and improvements (issues {escet-issue}36[#36] and {escet-issue}166[#166]).

=== Version 0.2 (2021-07-07)

Improvements and fixes:

* Chi simulator no longer crashes when using the Eclipse Compiler for Java (ecj) as Java compiler (issue {escet-issue}46[#46]).

=== Version 0.1 (2021-04-02)

The first release of Chi as part of the Eclipse ESCET project.
This release is based on the initial contribution by the Eindhoven University of Technology (TU/e).

Most notable changes compared to the last TU/e release:

* The Chi simulator no longer crashes on code generation.
