171bb9bcca1237173397de5b9ba4d19928b03712
[librarian.git] / CHANGELOG.md
1 # Change Log
2
3 This document records all notable changes to Librarian.
4
5 ## 24.4
6
7 - Add fundraising inserts in PDF.
8
9 ## 24.1
10
11 - Added cover logos support.
12
13 ## 23.12
14
15 - Added debug version for epub and epubcheck utility.
16
17 ## 23.10
18
19 - Remove direct verse styling from HTML.
20
21 ## 23.08
22
23 - Move statistics counter to L2 WLgit lDocument.
24
25 ## 23.07.1
26
27 - Add <category.thema.main>.
28 - Support Python 3.7--3.11.
29
30 ## 2.6.1
31
32 - Fix for better ignoring <extra>.
33
34 ## 2.6
35
36 - Change default cover to marquise.
37 - Add support for full predesigned covers to marquise.
38 - Remove support for changing actual cover class via coverClass.
39
40 ## 2.5.1
41
42 - Bugfix release.
43
44 ## 2.5
45
46 - Add html-snippet builder.
47 - Remove DateValue class.
48 - Fix some texts and tests.
49 - Drop Python < 3.6. Up to 3.9 is supported.
50
51 ## 2.4.13
52
53 - Added thema meta field.
54
55 ## 2.4.12
56
57 - Fix for marquise cover: allow scaling title text in all layouts.
58
59 ## 2.4.11.1
60
61 - Added assigning and preserving id attribute .
62
63 ## 2.4.10
64
65 - Added <wers_srodek>, <tab>, <rownlolegle> and <blok>.
66
67 ## 2.4.9
68
69 - Added verse counters to document statistics.
70
71 ## 2.4.8 (2022-07-23)
72
73 # Changed
74 - Shortening authors and translators list on new cover.
75 - Update lxml.
76
77
78 ## 2.4.7 (2022-07-18)
79
80 # Added
81 - Metadata types.
82
83 # Fixed
84 - Don't validate comment contents.
85 - Ignore translators on new cover if too long.
86
87
88 ## 2.4.6 (2022-07-15)
89
90 # Fixed:
91 - Bug in reading child books.
92
93
94 ## 2.4.5 (2022-07-08)
95
96 # Fixed
97 - Bug in reading picture XML.
98 - Bug in setting WLURI.slug
99
100
101 ## 2.4.4 (2022-07-07)
102
103 ### Fixed
104 - Packaging error.
105
106
107 ## 2.4.3 (2022-06-07)
108
109 ### Fixed
110 - Fix for new cover with custom size.
111
112
113 ## 2.4.2 (2022-05-23)
114
115 ### Fixed
116 - Error reporting on metadata parse error.
117
118
119 ## 2.4.1 (2022-05-12)
120
121 ### Added
122 - `category.legimi` metadata field
123
124 ### Changed
125 - Fix PDF support for 'Geometric shapes' characters.
126 - Explicitly ignore unknown elements in v2 elements API.
127
128
129 ## 2.4 (2022-05-06)
130
131 ### Added
132 - New 'marquise' cover style.
133 - 'Factory' cover style with a QR code.
134
135
136 ## 2.3.5 (2022-04-07)
137
138 ### Fixed
139 - Support for www tag.
140 - Support for mat with inline text.
141
142
143 ## 2.3.4 (2022-02-28)
144
145 ### Fixed:
146 - Document stats totaling bug.
147 - Legimi cover background position.
148
149
150 ## 2.3.3 (2021-12-23)
151
152 ### Added:
153 - Line numbering reset with numeracja.
154
155
156 ## 2.3.2 (2021-12-21)
157
158 ### Fixed:
159 - Legimi cover colors.
160 - EPUB/MOBI TOC styling.
161
162
163 ## 2.3.1 (2021-12-20)
164
165 ### Fixed:
166 - Additional logos order.
167
168
169 ## 2.3 (2021-12-20)
170
171 ### Added:
172 - New MOBI builder.
173 - Document statistics.
174 - Legimi cover classes.
175
176 ### Changed
177 - Default licensing info.
178
179
180 ## 2.2 (2021-10-07)
181
182 ### Added
183 - Support for block annotations.
184 - Option to use endnotes in PDF.
185
186 ### Fixed
187 - Avoid hanging conjunctions on covers.
188
189
190 ## 2.1 (2021-07-08)
191
192 ### Added
193 - Basic document structure validation.
194 - Support for headers inside quotes in epub.
195
196
197 ## 2.0 (2021-07-08)
198
199 ### Added
200 - New Document API.
201 - New EPUB builder.
202 - New `librarian` entry point for converters.
203
204
205 ## 1.15 (2021-03-02)
206
207 ### Fixed
208 - Epub: translator marked with MARC Relators role 'trl'.
209 - Epub: authors and translators dc:creator elements had duplicate `id`.
210 - Epub: 'Start' element in TOC was added inconsistently and in wrong order.
211
212
213 ## 1.14 (2021-02-05)
214
215 ### Changed
216 - Image sources are now URLs. This changes the API: instead of paths
217   given as `ilustr_path`, `transform` functions now accept
218   a new `base_url` parameter.
219 - Size limits introduced for images in all formats.
220
221
222 ## 1.13 (2021-01-27)
223
224 ### Changed
225 - Responsive images in HTML. This changes the html.transform API.
226
227
228 ## 1.12 (2021-01-27)
229
230 ### Added
231 - Content warnings.
232
233
234 ## 1.11.3 (2021-01-25)
235
236 ### Fixed
237 - Missing items in EPUB TOC.
238
239
240 ## 1.11.2 (2020-12-18)
241
242 ### Fixed
243 - MathML in EPUBs.
244 - Subchapters without chapters in EPUBs.
245
246
247 ## 1.11 (2020-12-09)
248
249 ### Added
250
251 - Experimental DAISY builder.
252
253
254 ## 1.10 (2020-11-09)
255
256 ### Added
257
258 - Support for `ref` tags in HTML.
259
260
261 ## 1.9 (2020-10-08)
262
263 ### Added
264
265 - Experimental class-based builders for HTML and TXT.
266
267
268 ### Changed
269
270 - Upgraded to EPUB 3, using ebooklib.
271
272
273
274 ## 1.8.3 (2020-05-28)
275
276 ### Fixed
277 - XML entities in MathML breaking PDF generation.
278 - Regression: verse numbering was lost.
279
280
281 ## 1.8.2 (2020-04-03)
282
283 ### Changed
284 - New Ebookpoint logo.
285
286
287 ## 1.8.1 (2020-02-18)
288
289 ### Changed
290 - Multiple authors on cover are now split into lines.
291
292
293 ## 1.8 (2020-02-12)
294
295 ### Added
296 - Support for tags: podtytul_*.
297 - Swappable CSS for HTML preview (as --css).
298 - First version of a test file in tests/uat.
299
300 ### Changed
301 - Verses in HTML are now generated as div, not p, to prevent blank lines on copying.
302
303
304 ## 1.7.8 (2020-02-05)
305
306 ### Added
307 - Preliminary support for new tag: animacja.
308
309
310 ## 1.7.7 (2019-12-31)
311
312 ### Changed
313 - Allow multiple source.URL fields.
314
315 ## 1.7.6 (2019-10-01)
316
317 ### Changed
318 - Epub: only attach images referenced in the text.
319
320
321 ## 1.7.5 (2019-08-19)
322
323 ### Changed
324 - Updated information on the back of EPUB and PDF files.
325
326
327 ## 1.7.4 (2019-08-01)
328
329 ### Fixed
330 - `html.tranform_abstract` bytes vs text confusion.
331 - Tests.
332
333
334 ## 1.7.3 (2019-07-31)
335
336 ### Added
337 - Support for wl:coverLogoUrl, for adding cover logos.
338
339
340 ## 1.7.2 (2019-03-12)
341
342 ### Fixed
343 - Fix for Picture in Python 3: open image in binary mode.
344
345
346 ## 1.7.1 (2019-03-01)
347
348 ### Fixed
349 - Bug in cover generation.
350
351
352 ## 1.7 (2019-02-27)
353
354 ### Added
355 - Python 3.4+ support, to existing Python 2.7 support.
356 - `coverter_path` argument in `mobi.transform`.
357 - Proper packaging info.
358 - This changelog.
359 - Tox configuration for tests.
360
361 ### Changed
362 - `from_bytes` methods replaced all `from_string` methods,
363    i.e. on: OutputFile, WorkInfo, BookInfo, WLDocument, WLPicture.
364 - `get_bytes` replaced `get_string` on OutputFile.
365
366 ### Removed
367 - Shims for Python < 2.7.