]> OzVa Git service - shopping-channel/commitdiff
projects / shopping-channel / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 8e3c594)
Added epub & mobi generation
authorMax Value <greenwoodw50@gmail.com>
Thu, 23 Jan 2025 18:44:30 +0000 (18:44 +0000)
committerMax Value <greenwoodw50@gmail.com>
Thu, 23 Jan 2025 18:44:30 +0000 (18:44 +0000)
Autogeneration of documentation from the items.json file

File hosted at: https://data.ozva.co.uk/shopping/docs/item_manifest.mobi

.gitignore patch | blob | history
auth/generate_docs.py [new file with mode: 0755] patch | blob
auth/index.php patch | blob | history
docs/epub/META-INF/container.xml [new file with mode: 0644] patch | blob
docs/epub/info_page.html [new file with mode: 0644] patch | blob
docs/epub/mimetype [new file with mode: 0644] patch | blob
docs/epub/stylesheet.css [new file with mode: 0644] patch | blob
docs/epub/title_page.html [new file with mode: 0644] patch | blob

diff --git a/.gitignore b/.gitignore
index d259f05826e219b63605ef521d42f2b7dc2351f1..bd69528791fc3cae1def822b11a5f87d7891dc6e 100644 (file)
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,7 @@
 *.ttf
+.venv/
+item[0-9].html
+content.opf
+toc.ncx
+*.epub
+*.mobi
diff --git a/auth/generate_docs.py b/auth/generate_docs.py
new file mode 100755 (executable)
index 0000000..aa9b76f
--- /dev/null
+++ b/auth/generate_docs.py
@@ -0,0 +1,158 @@
+#!.venv/bin/python
+
+import json
+import os
+
+# clean up working-directory
+for filename in os.listdir("../docs/epub"):
+       if filename[:4] == "item": os.remove("../docs/epub/" + filename)
+
+# generate item pages
+with open("../items.json", "r") as f:
+       items = json.loads(f.read())
+
+for (i, item) in enumerate(items):
+       with open(f"../docs/epub/item{i}.html", "w") as f:
+               f.write(f"""
+       <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+               "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+       <html xmlns="http://www.w3.org/1999/xhtml">
+       <head>
+               <title>{item['code']}</title>
+       </head>
+       <body>
+               <h1>{item['code']}</h1>
+               <h2>{item['subtext']}</h2>
+               <p><b>Description:</b> {item['description']}</p>
+               <table>
+                       <tr>
+                               <th>Rating</th>
+                               <td>{item['rating']}</td>
+                       </tr>
+                       <tr>
+                               <th>Starting price</th>
+                               <td>{item['origionalPrice']}</td>
+                       </tr>
+                       <tr>
+                               <th>In stock</th>
+                               <td>{item['stockCount']}</td>
+                       </tr>
+               </table>
+               <h3>Anchor notes:</h3>
+               <p>{item['notes']}</p>
+       </body>
+       </html>
+       """)
+
+# update manifest
+manifest_items = " ".join([
+       f"<item id='item{i}' href='item{i}.html' media-type='application/xhtml+xml' />"
+       for i in range(len(items))
+       ])
+toc_items = " ".join([
+       f"<itemref idref='item{i}' />"
+       for i in range(len(items))
+       ])
+
+with open("../docs/epub/content.opf", "w") as f:
+       f.write(f"""
+<?xml version="1.0"?>
+
+<package xmlns="http://www.idpf.org/2007/opf" unique-identifier="dcidid"
+       version="2.0">
+
+<metadata xmlns:dc="http://purl.org/dc/elements/1.1/"
+       xmlns:dcterms="http://purl.org/dc/terms/"
+       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xmlns:opf="http://www.idpf.org/2007/opf">
+
+       <dc:title>XMDV Teleshopping item manifest</dc:title>
+       <dc:language xsi:type="dcterms:RFC3066">en</dc:language>
+       <dc:identifier id="dcidid" opf:scheme="URI">
+               http://data.ozva.co.uk/shopping/docs/item_manifest.epub
+               </dc:identifier>
+       <dc:subject>Teleshopping, Manifest</dc:subject>
+       <dc:description>Describing all items to be sold during the XMDV Teleshopping performance</dc:description>
+       <dc:creator>William Greenwood</dc:creator>
+       <dc:publisher>Goodnight Publishing</dc:publisher>
+       <dc:date xsi:type="dcterms:W3CDTF">2024-12-28</dc:date>
+       <dc:rights>Creative Commons BY-SA 3.0 License.</dc:rights>
+</metadata>
+
+<manifest>
+       <item id="ncx"      href="toc.ncx"
+               media-type="application/x-dtbncx+xml" />
+       <item id="css"      href="stylesheet.css"
+               media-type="text/css" />
+       <item id="title"    href="title_page.html"
+               media-type="application/xhtml+xml" />
+       <item id="intro"    href="info_page.html"
+               media-type="application/xhtml+xml" />
+       {manifest_items}
+</manifest>
+
+<spine toc="ncx">
+       <itemref idref="title" />
+       <itemref idref="intro" />
+       {toc_items}
+</spine>
+
+</package>
+""")
+
+toc_items = " ".join([
+       f"""
+<navPoint id="navPoint-{i+3}" playOrder="{i+3}">
+       <navLabel>
+               <text>{i+1}: {item["code"]}</text>
+       </navLabel>
+       <content src="item{i}.html"/>
+</navPoint>
+       """
+       for (i, item) in enumerate(items)
+       ])
+
+with open("../docs/epub/toc.ncx", "w") as f:
+       f.write(f"""
+<?xml version="1.0"?>
+<!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN"
+       "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
+
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1">
+
+<head>
+       <meta name="dtb:uid" content="http://data.ozva.co.uk/shopping/docs/item_manifest.epub"/>
+       <meta name="dtb:depth" content="2"/>
+       <meta name="dtb:totalPageCount" content="0"/>
+       <meta name="dtb:maxPageNumber" content="0"/>
+</head>
+
+<docTitle>
+       <text>XMDV Teleshopping item manifest</text>
+</docTitle>
+
+<navMap>
+       <navPoint id="navPoint-1" playOrder="1">
+               <navLabel>
+                       <text>Title Page</text>
+               </navLabel>
+               <content src="title_page.html"/>
+       </navPoint>
+       <navPoint id="navPoint-2" playOrder="2">
+               <navLabel>
+                       <text>Information</text>
+               </navLabel>
+               <content src="info_page.html"/>
+       </navPoint>
+       {toc_items}
+</navMap>
+
+</ncx>
+""")
+
+os.system("""
+       zip -X0 ../docs/item_manifest.epub ../docs/epub/mimetype &&
+       zip -Xur9D ../docs/item_manifest.epub ../docs/epub/* &&
+       ebook-convert ../docs/item_manifest.epub ../docs/item_manifest.mobi
+       """)
+
diff --git a/auth/index.php b/auth/index.php
index b502d945790d3157dc248c04ed61bf2af2ed2033..af74f39880971e3706cc8e45c15279a9c11725d0 100644 (file)
--- a/auth/index.php
+++ b/auth/index.php
@@ -28,6 +28,10 @@ fclose($file);
 
 $clockIncrement = 10;
 
+if (!empty($_POST['generate_docs'])) {
+       exec("./generate_docs.py");
+}
+
 if (!empty($_POST['update'])) {
 
        for ($i = 0; $i < 5; $i ++) {
@@ -522,6 +526,7 @@ for ($i = 0; $i < 360; $i += $clockIncrement) {
                        </fieldset>
                        <br>
                        <input style="vertical-align: top;" type="submit" name="update" value="Update">
+                       <input style="vertical-align: top;" type="submit" name="generate_docs" value="Generate docs">
                        <details style="display: inline-block;">
                                <summary>Current data</summary>
 <?php echo "<pre>" . var_export($data, true) . "</pre>" ?>
diff --git a/docs/epub/META-INF/container.xml b/docs/epub/META-INF/container.xml
new file mode 100644 (file)
index 0000000..b640723
--- /dev/null
+++ b/docs/epub/META-INF/container.xml
@@ -0,0 +1,7 @@
+<?xml version="1.0"?>
+<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
+       <rootfiles>
+               <rootfile full-path="content.opf"
+                       media-type="application/oebps-package+xml"/>
+       </rootfiles>
+</container>
diff --git a/docs/epub/info_page.html b/docs/epub/info_page.html
new file mode 100644 (file)
index 0000000..bdd496a
--- /dev/null
+++ b/docs/epub/info_page.html
@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title>Information</title>
+</head>
+    <body>
+        <h1>Infomation page</h1>
+        <p>Information will go here!</p>
+    </body>
+</html>
diff --git a/docs/epub/mimetype b/docs/epub/mimetype
new file mode 100644 (file)
index 0000000..403c4f0
--- /dev/null
+++ b/docs/epub/mimetype
@@ -0,0 +1 @@
+application/epub+zip
diff --git a/docs/epub/stylesheet.css b/docs/epub/stylesheet.css
new file mode 100644 (file)
index 0000000..773dd89
--- /dev/null
+++ b/docs/epub/stylesheet.css
@@ -0,0 +1,4 @@
+@page {
+    margin-bottom: 5pt;
+    margin-top: 5pt;
+}
diff --git a/docs/epub/title_page.html b/docs/epub/title_page.html
new file mode 100644 (file)
index 0000000..75d96ea
--- /dev/null
+++ b/docs/epub/title_page.html
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
+    "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+    <title>Title Page</title>
+</head>
+    <body>
+    <h1>XMDV Teleshopping</h1>
+    <h2>Item manifest</h2>
+    <p>Info on all items contained within the GFX system.</p><br/>
+    <p>HIDDEN INFORMATION. NOT TO BE SHARED WITH THE ANCHOR.</p>
+    </body>
+</html>
Shopping channel GFX management system built for XMDV Shopping.