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