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