| 1 |
Changelog |
| 2 |
========= |
| 3 |
|
| 4 |
All notable changes to this project will be documented in this file. |
| 5 |
|
| 6 |
The format is based on `Keep a Changelog`_, |
| 7 |
and this project adheres to `Semantic Versioning`_. |
| 8 |
|
| 9 |
`Unreleased`_ |
| 10 |
------------- |
| 11 |
|
| 12 |
Nothing yet. |
| 13 |
|
| 14 |
`v2.1.0`_ - 2025-02-12 |
| 15 |
---------------------- |
| 16 |
|
| 17 |
Added: |
| 18 |
|
| 19 |
* Complete type annotations for the whole library. |
| 20 |
* :func:`.effects.expand` for increasing the resolution of a font, |
| 21 |
along with the ``bdflib-expand`` command-line tool to wrap it. |
| 22 |
* A new ``bdflib-validate`` command-line tool to exercise the rewritten parser |
| 23 |
(described below). |
| 24 |
* :meth:`.Font.get` to match the existing :meth:`.Font.__getitem__` method. |
| 25 |
|
| 26 |
Changed: |
| 27 |
|
| 28 |
* :func:`.reader.read_bdf` is much more robust, |
| 29 |
reports errors with a well-defined :class:`.reader.ParseError` class |
| 30 |
(instead of random :class:`AssertionError` |
| 31 |
and :class:`ValueError` exceptions), |
| 32 |
and can report warnings as well as errors. |
| 33 |
If your code did not check exceptions too closely |
| 34 |
(and it probably shouldn't have), |
| 35 |
it should still work just fine. |
| 36 |
|
| 37 |
Fixed: |
| 38 |
|
| 39 |
* :meth:`.Font.new_glyph_from_data` now raises :class:`.GlyphExists` |
| 40 |
*before* adding the glyph to the font, |
| 41 |
rather than after. |
| 42 |
|
| 43 |
`v2.0.1`_ - 2022-01-14 |
| 44 |
---------------------- |
| 45 |
|
| 46 |
Fixed: |
| 47 |
|
| 48 |
* Fixed the v2.0.0 changelog entry. |
| 49 |
|
| 50 |
`v2.0.0`_ - 2022-01-14 |
| 51 |
---------------------- |
| 52 |
|
| 53 |
Added: |
| 54 |
|
| 55 |
* This changelog! |
| 56 |
* Documentation for the :attr:`.FontFiller.missing_chars` |
| 57 |
and :attr:`.FontFiller.unknown_classes` attributes. |
| 58 |
* :class:`.Font` now stores the standard BDF fields as attributes |
| 59 |
(:attr:`~.Font.name`, :attr:`~.Font.ptSize`, :attr:`~.Font.xdpi`, |
| 60 |
:attr:`~.Font.ydpi`). |
| 61 |
* :mod:`bdflib.xlfd` makes it easy to check whether a font |
| 62 |
conforms to the X Logical Font Descriptor conventions, |
| 63 |
and to automatically fix many conformance problems. |
| 64 |
|
| 65 |
Changed: |
| 66 |
|
| 67 |
* Now that :class:`.Font` stores BDF fields in standard attributes, |
| 68 |
and now that :mod:`bdflib.xlfd` exists, |
| 69 |
the :class:`.Font` class no longer needs to assume |
| 70 |
BDF custom properties are used for anything in particular. |
| 71 |
In particular, the standard BDF fields are no longer mirrored |
| 72 |
to XLFD-style properties, |
| 73 |
there's no special property names that cannot be overwritten, |
| 74 |
and XLFD properties will no longer be automatically synthesised |
| 75 |
when writing out a BDF font. |
| 76 |
* The :class:`.Glyph` constructor |
| 77 |
(and therefore :meth:`.Font.new_glyph_from_data()`) |
| 78 |
now takes bitmap data in the form of a list of integers, |
| 79 |
not the hex-encoded string used in the BDF on-disk format. |
| 80 |
|
| 81 |
Removed: |
| 82 |
|
| 83 |
* Support for Python 2.x |
| 84 |
* Support for fonts whose point-size |
| 85 |
(the first parameter to the `SIZE` field in the font header) |
| 86 |
is a non-integer. I don't know why I ever thought this was a good idea. |
| 87 |
|
| 88 |
`v1.1.3`_ - 2019-04-23 |
| 89 |
---------------------- |
| 90 |
|
| 91 |
Fixed: |
| 92 |
|
| 93 |
* We now support BDF comments in more places |
| 94 |
(although all the comments in a file are still concatenated) |
| 95 |
* We now support values being separated from keywords |
| 96 |
by more than a single space. |
| 97 |
|
| 98 |
`v1.1.2`_ - 2019-04-22 |
| 99 |
---------------------- |
| 100 |
|
| 101 |
Added: |
| 102 |
|
| 103 |
* The examples in the API reference and tutorial |
| 104 |
are now automatically tested. |
| 105 |
|
| 106 |
Fixed: |
| 107 |
|
| 108 |
* The documentation now includes the `tutorial.bdf` file |
| 109 |
used by the tutorial. |
| 110 |
|
| 111 |
`v1.1.1`_ - 2018-11-19 |
| 112 |
---------------------- |
| 113 |
|
| 114 |
Changed: |
| 115 |
|
| 116 |
* Set the package long description to the README contents. |
| 117 |
|
| 118 |
`v1.1.0`_ - 2018-11-19 |
| 119 |
---------------------- |
| 120 |
|
| 121 |
Added: |
| 122 |
|
| 123 |
* Standalone documentation, including a tutorial |
| 124 |
* The :meth:`.Glyph.iter_pixels()` method, |
| 125 |
making it easier to get at the glyph bitmap data. |
| 126 |
|
| 127 |
Fixed: |
| 128 |
|
| 129 |
* :class:`.FontFiller` now supports |
| 130 |
supports generating spacing characters made from only combining characters. |
| 131 |
|
| 132 |
`v1.0.4`_ - 2016-10-19 |
| 133 |
---------------------- |
| 134 |
|
| 135 |
Added: |
| 136 |
|
| 137 |
* Support for Python 3. |
| 138 |
|
| 139 |
`v1.0.3`_ - 2016-09-25 |
| 140 |
---------------------- |
| 141 |
|
| 142 |
Fixed: |
| 143 |
|
| 144 |
* No longer breaks on BDF files containing blank lines. |
| 145 |
|
| 146 |
`v1.0.2`_ - 2016-03-27 |
| 147 |
---------------------- |
| 148 |
|
| 149 |
Added: |
| 150 |
|
| 151 |
* a README |
| 152 |
* Support for running tests with Tox |
| 153 |
|
| 154 |
Fixed: |
| 155 |
|
| 156 |
* No longer requires to be installed from a Git checkout. |
| 157 |
|
| 158 |
`v1.0.1`_ - 2015-04-06 |
| 159 |
---------------------- |
| 160 |
|
| 161 |
Changed: |
| 162 |
|
| 163 |
* Repository moved from Gitorious to GitLab |
| 164 |
|
| 165 |
`v1.0.0`_ - 2009-03-22 |
| 166 |
---------------------- |
| 167 |
|
| 168 |
Initial release. |
| 169 |
|
| 170 |
.. _Keep a Changelog: https://keepachangelog.com/en/1.0.0/ |
| 171 |
.. _Semantic Versioning: https://semver.org/spec/v2.0.0.html |
| 172 |
.. _v1.0.0: https://gitlab.com/Screwtapello/bdflib/-/tree/v1.0.0 |
| 173 |
.. _v1.0.1: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.0.0...v1.0.1 |
| 174 |
.. _v1.0.2: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.0.1...v1.0.2 |
| 175 |
.. _v1.0.3: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.0.2...v1.0.3 |
| 176 |
.. _v1.0.4: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.0.3...v1.0.4 |
| 177 |
.. _v1.1.0: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.0.4...v1.1.0 |
| 178 |
.. _v1.1.1: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.1.0...v1.1.1 |
| 179 |
.. _v1.1.1: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.1.0...v1.1.1 |
| 180 |
.. _v1.1.2: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.1.1...v1.1.2 |
| 181 |
.. _v1.1.3: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.1.2...v1.1.3 |
| 182 |
.. _v2.0.0: https://gitlab.com/Screwtapello/bdflib/-/compare/v1.1.3...v2.0.0 |
| 183 |
.. _v2.0.1: https://gitlab.com/Screwtapello/bdflib/-/compare/v2.0.0...v2.0.1 |
| 184 |
.. _v2.1.0: https://gitlab.com/Screwtapello/bdflib/-/compare/v2.0.1...v2.1.0 |
| 185 |
.. _Unreleased: https://gitlab.com/Screwtapello/bdflib/-/compare/v2.1.0...master |