MobileRead Forums - View Single Post

jgoguen · 08-20-2013, 09:28 PM

THIS PLUGIN IS BEING INTERMITTENTLY DEVELOPED! FEATURE REQUESTS AND BUG REPORTS MAY TAKE A FEW DAYS TO BE REPLIED TO.

This plugin allows creating KePub files without requiring a Kobo device to be connected.Converted books are saved to the calibre library as the 'KEPUB' format. ePub books processed with this plugin and sent to a modern Kobo device will be rendered using Kobo's internal kepub renderer instead of the standard ePub renderer.

Please see the README file for the most current details. I will try to keep this post up to date, but the README is always up to date.

WARNING: THE CONVERSION OUTPUT FORMAT PLUGIN GENERATES FILES WHOSE INTERNAL STRUCTURE IS STILL UNDER DEVELOPMENT. THE KEPUB FILE STRUCTURE IS NOT YET FULLY UNDERSTOOD. DO NOT, UNDER ANY CIRCUMSTANCES, DELETE THE FILES FOR THE SOURCE FORMAT. ALWAYS HAVE A NON-KEPUB FORMAT FOR YOUR BOOKS.

The main benefits of using the kepub renderer (which some may prefer not to have) are:

Page numbers show the number of page turns remaining in the current chapter instead of the estimated number of pages for the entire book.
- If you don't want this, there is an option in the driver settings to force full-book page numbers.
Reading statistics (time left in this chapter, time for the next chapter, time to complete the book)
The book title is shown at the top of each page.
The chapter title, if any, is shown at the bottom of each page with the page numbers.

You are encouraged to install these two plugins as well, to ensure KePub metadata is correctly processed:

KePub Metadata Reader - https://www.mobileread.com/forums/sh...d.php?t=261009
KePub Metadata Writer - https://www.mobileread.com/forums/sh...d.php?t=261010

Usage
To use this plugin after installing:

Select the book(s) you want to convert.
Select the KEPUB output format
Choose your settings
Convert the books

WARNING: THE CONVERSION OUTPUT FORMAT PLUGIN GENERATES FILES WHOSE INTERNAL STRUCTURE IS STILL UNDER DEVELOPMENT. THE KEPUB FILE STRUCTURE IS NOT YET FULLY UNDERSTOOD. DO NOT, UNDER ANY CIRCUMSTANCES, DELETE THE FILES FOR THE SOURCE FORMAT. ALWAYS HAVE A NON-KEPUB FORMAT FOR YOUR BOOKS.

Special Notes

This plugin requires calibre 5.0.0 or later!
This device plugin enables access to Kobo features that are written with the expectation that only unmodified Kobo-purchased books will be used. Do not approach Kobo for support unless you see the exact same issue with a book purchased from Kobo and synced to your device via Kobo Desktop or direct wireless download.
Conversion defaults can be set in Preferences -> Output

Installation Directions

Open Preferences -> Plugins -> Get new plugins and install the 'KePub Output' plugin. You may also download the attached zip file and install the plugin manually, then restart calibre as described in the Introduction to Plugins thread.

Contributing

Decided you want to contribute to the development of this plugin? Awesome! If you want to contribute to the development of this plugin, you have many options:

Contribute code, whether for existing bug reports, for new bugs that you found, or for new features that you really want to see implemented. To contribute code, you may fork the repository and send a pull request, or you may send me a PM here with a Git patch file.
Submit bug reports on GitHub. Although I'm happy to discuss the plugin here, I may still ask you to create a bug report; this is so I actually remember to investigate your request!
Test pre-released code from GitHub. Between releases, new code is committed and may be installed using directions provided in the README file. Based on your testing, you may submit bug reports, provide feedback, think of new feature requests, or just generally enjoy early access (and not necessarily stable code!) to upcoming versions of the plugin.
Translate the plugin on the plugin's Transifex page.

Although I'm generally perfectly happy to discuss possible issues here, any issues sent to me through any means other than the Github bug tracker (including email, PM, etc.) may be silently ignored. This is not because I don't care! It's because I have a terrible memory, the Github issue tracker is my "to-do list" for this plugin, and there's been instances where I've seen a post or PM here and promptly forgotten all about it until I happened to stumble across the post again later. If you aren't sure if you have an issue, feel free to post here and we can work together to decide if you need to make a new Github issue or not. If you are sure you have an issue, or if you have an error or exception from calibre, post a new issue. It isn't necessary to post here when you make a new issue, I get notified of all new bugs and I check the list regularly. The worst that could possibly happen on Github is the same that could happen here: I'll tell you that it's not a bug and you'll have the opportunity to convince me otherwise!

Version History

Spoiler: