@@ -1,4 +1,44 @@
11
2+5.28
3+----
4+
5+This release improves Vty's support for multi-column Unicode characters
6+and provides greater compatibility with a wider array of terminal
7+emulators. The following sections summarize the relevant changes, but an
8+overview of the new functionality is motivated and detailed in the new
9+"Multi-Column Character Support" README section. For
10+historical context, please also consider reading over
11+[#175](https://github.com/jtdaugherty/vty/issues/175).
12+
13+API changes:
14+ * New modules were added:
15+ * `Graphics.Vty.UnicodeWidthTable.Types`
16+ * `Graphics.Vty.UnicodeWidthTable.IO`
17+ * `Graphics.Vty.UnicodeWidthTable.Query`
18+ * `Graphics.Vty.UnicodeWidthTable.Install`
19+ * The `Config` type got a new field, `allowCustomUnicodeWidthTables`,
20+ that controls whether `mkVty` will attempt to load a Unicode width
21+ table if specified in the configuration.
22+
23+Configuration file changes:
24+ * A new syntax was added to support specifying Unicode width tables on
25+ a per-`TERM` basis. The syntax is `widthMap <TERM> <PATH>`. See the
26+ documentation for `Graphics.Vty.Config` for details. Since prior
27+ versions of this library will silently ignore any configuration file
28+ lines they cannot parse, this change to user configuration files is
29+ at least non-breaking for older versions of Vty.
30+
31+Other changes:
32+ * The `mkVty` function now automatically attempts to load a custom
33+ Unicode width table if one is specified in the configuration,
34+ provided `allowCustomUnicodeWidthTables` is not set to `Just False`.
35+ See the documentation for `Graphics.Vty.mkVty` for details.
36+ * Vty now includes a command line tool, `vty-build-width-table`, that
37+ queries the terminal emulator to construct a custom Unicode width
38+ table and optionally update the Vty configuration file to use it.
39+ Programs that want to use that tool's functionality may also do so
40+ via the API exposed in the various modules listed above.
41+
2425.27
343----
444