1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
|
if not modules then modules = { } end modules ['mtx-epub'] = {
version = 1.001,
comment = "companion to mtxrun.lua",
author = "Hans Hagen, PRAGMA-ADE, Hasselt NL",
copyright = "PRAGMA ADE / ConTeXt Development Team",
license = "see context related readme files"
}
-- The epub specification is far from beautiful. Especially the id related
-- part is messy and devices/programs react differently on them (so an id is not
-- really an id but has some special property). Then there is this ncx suffix
-- thing. Somehow it give the impression of a reversed engineered application
-- format so it will probably take a few cycles to let it become a real
-- clean standard. Thanks to Adam Reviczky, Luigi Scarso and Andy Thomas for
-- helping to figure out all the puzzling details.
-- This is preliminary code. At some point we will deal with images as well but
-- first we need a decent strategy to export them. More information will be
-- available on the wiki.
-- META-INF
-- container.xml
-- OEBPS
-- content.opf
-- toc.ncx
-- Images
-- Styles
-- Text
-- mimetype
local format, gsub, find = string.format, string.gsub, string.find
local concat = table.concat
local replace = utilities.templates.replace
local helpinfo = [[
<?xml version="1.0"?>
<application>
<metadata>
<entry name="name">mtx-epub</entry>
<entry name="detail">ConTeXt EPUB Helpers</entry>
<entry name="version">1.00</entry>
</metadata>
<flags>
<category name="basic">
<subcategory>
<flag name="make"><short>create epub zip file</short></flag>
</subcategory>
</category>
</flags>
<examples>
<category>
<title>Example</title>
<subcategory>
<example><command>mtxrun --script epub --make mydocument</command></example>
</subcategory>
</category>
</examples>
</application>
]]
local application = logs.application {
name = "mtx-epub",
banner = "ConTeXt EPUB Helpers 1.00",
helpinfo = helpinfo,
}
-- script code
scripts = scripts or { }
scripts.epub = scripts.epub or { }
local mimetype = "application/epub+zip"
local t_container = [[
<?xml version="1.0" encoding="UTF-8"?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
<rootfiles>
<rootfile full-path="OEBPS/%rootfile%" media-type="application/oebps-package+xml"/>
</rootfiles>
</container>
]]
-- urn:uuid:
-- <dc:identifier id="%identifier%" opf:scheme="UUID">%uuid%</dc:identifier>
local t_package = [[
<?xml version="1.0" encoding="UTF-8"?>
<package xmlns="http://www.idpf.org/2007/opf" unique-identifier="%identifier%" version="3.0">
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
<dc:title>%title%</dc:title>
<dc:language>%language%</dc:language>
<dc:identifier id="%identifier%">%uuid%</dc:identifier>
<dc:creator>%creator%</dc:creator>
<dc:date>%date%</dc:date>
<!--
<dc:subject>%subject%</dc:subject>
<dc:description>%description%</dc:description>
<dc:publisher>%publisher%</dc:publisher>
<dc:source>%source%</dc:source>
<dc:relation>%relation%</dc:relation>
<dc:coverage>%coverage%</dc:coverage>
<dc:rights>%rights%</dc:rights>
-->
<meta name="cover" content="%firstpage%" />
<meta name="generator" content="ConTeXt MkIV" />
<meta property="dcterms:modified">%date%</meta>
</metadata>
<manifest>
%manifest%
</manifest>
<spine toc="ncx">
<itemref idref="cover-xhtml" />
<itemref idref="%rootfile%" />
</spine>
</package>
]]
local t_item = [[ <item id="%id%" href="%filename%" media-type="%mime%" />]]
local t_nav = [[ <item id="%id%" href="%filename%" media-type="%mime%" properties="%properties%" />]]
-- <!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN" "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
local t_toc = [[
<?xml version="1.0" encoding="UTF-8"?>
<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
<head>
<meta charset="utf-8" />
<meta name="generator" content="ConTeXt MkIV" />
<meta name="dtb:uid" content="%identifier%" />
<meta name="dtb:depth" content="2" />
<meta name="dtb:totalPgeCount" content="0" />
<meta name="dtb:maxPageNumber" content="0" />
</head>
<docTitle>
<text>%title%</text>
</docTitle>
<docAuthor>
<text>%author%</text>
</docAuthor>
<navMap>
<navPoint id="np-1" playOrder="1">
<navLabel>
<text>start</text>
</navLabel>
<content src="%root%"/>
</navPoint>
</navMap>
</ncx>
]]
local t_navtoc = [[
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops">
<head>
<meta charset="utf-8" />
<title>navtoc</title>
</head>
<body>
<div class="navtoc">
<!-- <nav epub:type="lot"> -->
<nav epub:type="toc" id="navtoc">
<ol>
<li><a href="%root%">document</a></li>
</ol>
</nav>
</div>
</body>
</html>
]]
-- <html xmlns="http://www.w3.org/1999/xhtml">
-- <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
local t_coverxhtml = [[
<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta charset="utf-8" />
<title>cover page</title>
</head>
<body>
<div class="coverpage">
%content%
</div>
</body>
</html>
]]
local t_coverimg = [[
<img src="%image%" alt="The cover image" style="max-width: 100%%;" />
]]
-- We need to figure out what is permitted. Numbers only seem to give
-- problems is some applications as do names with dashes. Also the
-- optional toc is supposed to be there and although id's are by
-- concept neutral, there are sometimes hard requirements with respect
-- to their name like ncx and toc.ncx). Maybe we should stick to 3.0
-- only.
local function dumbid(filename)
-- return (string.gsub(os.uuid(),"%-%","")) -- to be tested
return file.nameonly(filename) .. "-" .. file.suffix(filename)
end
local mimetypes = {
xhtml = "application/xhtml+xml",
xml = "application/xhtml+xml",
html = "application/html",
css = "text/css",
svg = "image/svg+xml",
png = "image/png",
jpg = "image/jpeg",
ncx = "application/x-dtbncx+xml",
gif = "image/gif",
-- default = "text/plain",
}
local idmakers = {
ncx = function(filename) return "ncx" end,
-- css = function(filename) return "stylesheet" end,
default = function(filename) return dumbid(filename) end,
}
-- specification = {
-- name = "document",
-- identifier = "123",
-- root = "a.xhtml",
-- files = {
-- "a.xhtml",
-- "b.css",
-- "c.png",
-- }
-- }
local function relocateimages(imagedata,oldname,newname,subpath)
local data = io.loaddata(oldname)
local images = { }
local done = gsub(data,[[(id=")(.-)(".-background%-image *: * url%()(.-)(%))]], function(s1,id,s2,name,s3)
local newname = imagedata[id].newname
if newname then
if subpath then
name = file.join(subpath,file.basename(new name))
else
name = file.basename(newname)
end
-- name = url.addscheme(name)
end
images[#images+1] = name
if newname then
return s1 .. id .. s2 .. name .. s3
end
end)
if newname then
io.savedata(newname,done)
end
return images
end
local zippers = {
{
name = "zip",
binary = "zip",
uncompressed = "zip %s -X -0 %s",
compressed = "zip %s -X -9 -r %s",
},
{
name = "7z (7zip)",
binary = "7z",
uncompressed = "7z a -tzip -mx0 %s %s",
compressed = "7z a -tzip %s %s",
},
}
function scripts.epub.make()
local filename = environment.files[1]
if not filename or filename == "" or type(filename) ~= "string" then
application.report("provide filename")
return
end
filename = file.basename(filename)
local specfile = file.replacesuffix(filename,"specification")
if not lfs.isfile(specfile) then
application.report("unknown specificaton file %a",specfile)
return
end
local specification = dofile(specfile)
if not specification or not next(specification) then
application.report("invalid specificaton file %a",specfile)
return
end
-- images: { ... url = location ... }
local name = specification.name or file.removesuffix(filename)
local identifier = specification.identifier or ""
local files = specification.files or { file.addsuffix(filename,"xhtml") }
local images = specification.images or { }
local root = specification.root or files[1]
local language = specification.language or "en"
local creator = "context mkiv"
local author = specification.author or "anonymous"
local title = specification.title or name
local subtitle = specification.subtitle or ""
local firstpage = specification.firstpage or ""
local lastpage = specification.lastpage or ""
local imagefile = specification.imagefile or ""
if subtitle ~= "" then
title = format("%s, %s",title,subtitle)
end
-- identifier = gsub(identifier,"[^a-zA-z0-9]","")
if firstpage == "" then
-- firstpage = "firstpage.jpg" -- dummy
else
images[firstpage] = firstpage
end
if lastpage == "" then
-- lastpage = "lastpage.jpg" -- dummy
else
images[lastpage] = lastpage
end
local uuid = format("urn:uuid:%s",os.uuid(true)) -- os.uuid()
identifier = "bookid" -- for now
local epubname = name
local epubpath = file.replacesuffix(name,"tree")
local epubfile = file.replacesuffix(name,"epub")
local epubroot = file.replacesuffix(name,"opf")
local epubtoc = "toc.ncx"
local epubcover = "cover.xhtml"
application.report("creating paths in tree %a",epubpath)
lfs.mkdir(epubpath)
lfs.mkdir(file.join(epubpath,"META-INF"))
lfs.mkdir(file.join(epubpath,"OEBPS"))
local used = { }
local function registerone(filename)
local suffix = file.suffix(filename)
local mime = mimetypes[suffix]
if mime then
local idmaker = idmakers[suffix] or idmakers.default
used[#used+1] = replace(t_item, {
id = idmaker(filename),
filename = filename,
mime = mime,
} )
return true
end
end
local function copyone(filename,alternative)
if registerone(filename) then
local target = file.join(epubpath,"OEBPS",file.basename(filename))
local source = alternative or filename
file.copy(source,target)
application.report("copying %a to %a",source,target)
end
end
if lfs.isfile(epubcover) then
copyone(epubcover)
epubcover = false
else
registerone(epubcover)
end
copyone("toc.ncx")
local function copythem(files)
for i=1,#files do
local filename = files[i]
if type(filename) == "string" then
local suffix = file.suffix(filename)
if suffix == "xhtml" then
local alternative = file.replacesuffix(filename,"html")
if lfs.isfile(alternative) then
copyone(filename,alternative)
else
copyone(filename)
end
elseif suffix == "css" then
if filename == "export-example.css" then
if lfs.isfile(filename) then
os.remove(filename)
local original = resolvers.findfile(filename)
application.report("updating local copy of %a from %a",filename,original)
file.copy(original,filename)
else
filename = resolvers.findfile(filename)
end
elseif not lfs.isfile(filename) then
filename = resolvers.findfile(filename)
else
-- use specific local one
end
copyone(filename)
else
copyone(filename)
end
end
end
end
copythem(files)
-- ["image-1"]={
-- ["height"]="7.056cm",
-- ["name"]="file:///t:/sources/cow.svg",
-- ["page"]="1",
-- ["width"]="9.701cm",
-- }
local theimages = { }
local pdftosvg = string.formatters[ [[mudraw -o "%s" "%s" %s]] ]
for id, data in table.sortedpairs(images) do
local name = url.filename(data.name)
local used = url.filename(data.used)
local base = file.basename(used)
local page = data.page or ""
if file.suffix(used) == "pdf" then
-- todo : check timestamp and prefix, rename to image-*
local command = pdftosvg(name,used,page)
application.report("running command %a\n\n",command)
os.execute(command)
else
name = used
end
data.newname = name
theimages[#theimages+1] = name
end
used[#used+1] = replace(t_nav, {
id = "nav",
filename = "nav.xhtml",
properties = "nav",
mime = "application/xhtml+xml",
})
io.savedata(file.join(epubpath,"OEBPS","nav.xhtml"),replace(t_navtoc, { -- version 3.0
root = root,
} ) )
copythem(theimages)
local idmaker = idmakers[file.suffix(root)] or idmakers.default
io.savedata(file.join(epubpath,"mimetype"),mimetype)
io.savedata(file.join(epubpath,"META-INF","container.xml"),replace(t_container, { -- version 2.0
rootfile = epubroot
} ) )
io.savedata(file.join(epubpath,"OEBPS",epubroot),replace(t_package, {
identifier = identifier,
title = title,
language = language,
uuid = uuid,
creator = creator,
date = os.date("!%Y-%m-%dT%H:%M:%SZ"),
firstpage = idmaker(firstpage),
manifest = concat(used,"\n"),
rootfile = idmaker(root)
} ) )
-- t_toc is replaced by t_navtoc in >= 3
io.savedata(file.join(epubpath,"OEBPS",epubtoc), replace(t_toc, {
identifier = uuid, -- identifier,
title = title,
author = author,
root = root,
} ) )
if epubcover then
io.savedata(file.join(epubpath,"OEBPS",epubcover), replace(t_coverxhtml, {
content = firstpage ~= "" and replace(t_coverimg, { image = firstpage }) or "no cover page defined",
} ) )
end
if imagefile ~= "" then
local target = file.join(epubpath,"OEBPS",imagefile)
application.report("relocating images")
relocateimages(images,imagefile,target) -- ,file.join(epubpath,"OEBPS"))
end
application.report("creating archive\n\n")
lfs.chdir(epubpath)
os.remove(epubfile)
local usedzipper = false
local function zipped(zipper)
local ok = os.execute(format(zipper.uncompressed,epubfile,"mimetype"))
if ok == 0 then
os.execute(format(zipper.compressed,epubfile,"META-INF"))
os.execute(format(zipper.compressed,epubfile,"OEBPS"))
usedzipper = zipper.name
return true
end
end
-- nice way
for i=1,#zippers do
if os.which(zippers[i].binary) and zipped(zippers[i]) then
break
end
end
-- trial and error
if not usedzipper then
for i=1,#zippers do
if zipped(zippers[i]) then
break
end
end
end
lfs.chdir("..")
if usedzipper then
local treefile = file.join(epubpath,epubfile)
os.remove(epubfile)
file.copy(treefile,epubfile)
if lfs.isfile(epubfile) then
os.remove(treefile)
end
application.report("epub archive made using %s: %s",usedzipper,epubfile)
else
local list = { }
for i=1,#zippers do
list[#list+1] = zippers[i].name
end
application.report("no epub archive made, install one of: % | t",list)
end
end
--
if environment.argument("make") then
scripts.epub.make()
elseif environment.argument("exporthelp") then
application.export(environment.argument("exporthelp"),environment.files[1])
else
application.help()
end
-- java -jar d:\epubcheck\epubcheck-3.0.1.jar -v 3.0 -mode xhtml mkiv-publications.tree\mkiv-publications.epub
|