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