https://ofosos.org/enContents © 2025 <a href="mailto:mark@ofosos.org">Mark Meyer</a> Sun, 13 Apr 2025 16:19:22 GMTNikola (getnikola.com)http://blogs.law.harvard.edu/tech/rsshttps://ofosos.org/posts/2017/12/04/next-steps-for-ox-epub/Mark Meyer<h2>About <code>ox-epub</code></h2> <p>I'm the author of <a href="https://github.com/ofosos/ox-epub">ox-epub</a> an <a href="https://orgmode.org">org mode</a> extension that let's you export your org files in EPUB format. This allows you to easily get your notes or plans onto a Kindle or other ebook device. Documents formatted with org-epub display well on limited capability devices like phones and e-readers.</p> <p>This week I'm preparing <code>ox-epub</code> version 0.3.0. This version will come with baked in support for mathematical formulae. On the project side, this version also now includes a basic CI pipeline using Travis CI. The documentation has been expanded to include actual sample code, besides the reference-oriented README file.</p> <p><code>ox-epub</code> is a niche mode, there were a total of 48 downloads on MELPA during the 8 month lifetime of the project. But reception on Github was more welcome, all counted, it received 25 stars and has already two other contributors, besides me. Every few weeks or so, somebody pops in to report an issue or request help.</p> <p>So what are the next steps for <code>ox-epub</code>?</p> <h2>Parity with <code>ox-html</code></h2> <p>One of the earlier issues <code>ox-epub</code> faced was the bulging feature set of <code>ox-html</code>. Fortunately most of these translate well into the epub format. It was necessary to adapt ox-epub for image export, formula export and linking.</p> <p>In this category, most of the time will be spent on reviewing <code>ox-html</code> and writing test/sample code to verify that those features actually work with <code>ox-epub</code> and translate well into the EPUB format.</p> <p>This point will take up most of the time. This should be time well invested. Future-proofing <code>ox-epub</code> and enabling people to use the features they expect to be there.</p> <h2>Better ebooks</h2> <p><code>ox-epub</code> already supports title pages with custom images, as well as custom stylesheets for your books. It also has support for setting the most common metadata defined in the EPUB specification</p> <p>There's also baked in support for automatically generating the table of contents. The outline is directly taken from the headings of your <code>org</code> document. This table of contents is then specially treated by an ebook reader and presented out of band to the user, to facilitate document navigation.</p> <p>Some options for the future are:</p> <ul> <li>Fine grained table of contens inclusion</li> <li>Support for footnotes</li> <li>Preview function from <code>C-c C-e</code> menu</li> </ul> <p>Nowadays the EPUB 3 specification has been out for some time, adoption however remains laggard. In essence we're limited to create EPUB 2 books. These however will convert well into MOBI or any other format that you could imagine, because of their limited functionality.</p> <p>I've mixed feelings about EPUB 3. While it allows to use JavaScript and HTML in a more convenient way, I don't see these as essential elements of the EPUB experience. For me an EPUB is basically about getting electronic text into a form that I can easily digest in longer sessions. Something that seems elusive, when sitting in front of a Laptop.</p>emacsorgox-epubhttps://ofosos.org/posts/2017/12/04/next-steps-for-ox-epub/Mon, 04 Dec 2017 08:51:29 GMT