[Conversion Output] KePub Output Plugin

[evanft]

Nevermind.

[lilhand]

I've been struggling with a problem for some time and I haven't been able to find any solution or ideas. When I convert and send some books to my Kobo Glo HD, the page numbers are completely incorrect and messy. For example, the book will start on page 10 in the copyright information, then go to page 15 on the table of contents, jump to 40 on the dedication and then finally begin on page 2, only to jump to page 100 on chapter 2.

The weird thing is that the chapters are actually fine, but I can never know how far into the book I am because of this and the statistics on how long it is to the end of the book are totally wrong too.

I have no idea what to do about this and I haven't found anyone mentioning it. Any ideas?

Edit: I just noticed that this happens when simply changing the extension from epub to kepub.epub too, so maybe it's not just a problem with the conversion, but I still have no idea what to do.

[davidfor]

From memory, this is an issue with the ToC in the book. For a kepub to work best, every internal file needs to be in the ToCthere needs to be one one ToC per internal file and. If you edit the book in the calibre editor and rebuild the ToC properly, it should fix it.

[lilhand]

Thank you!

[jiembe]

I'm using "Kepub Output" to converting my epubs into kepubs. I'm very satisfied with the output.

However, I'm unable to get a link to the Cover page into the Table of Contents even if I have that link in the original epub file. Do someone know how to?

[davidfor]

Where is the link missing? In the generated NCX or when you look at the ToC on the device?

If the link is missing from the NCX, then you need to check the options for building the ToC. For a conversion, the ToC isn't usually carried over. It is rebuilt from the book using the options specified. The file for the cover is probably just embedding the cover image and has nothing extra that can be picked up as the ToC entry for the cover page. When I want to do this, I add a hidden heading to the file. This will be something like:

<h1 class="hidden">Title of the Book</h1>

And in the stylesheet:

.hidden { display: None }

This gives something for the the ToC builder to find without changing what the cover page looks like.

[jackie_w]

@davidfor,

I can confirm what jiembe says. A source epub which has a ToC entry in the NCX for each file including the cover page (a standard calibre SVG-type cover page) produces a kepub which still has the cover page but the NCX entry for the cover page disappears during the conversion process.

An epub-to-epub conversion using the same source epub and conversion settings does not lose the cover page entry in the NCX.

I can post a small test epub if you need one.

[davidfor]

@jackie_w: OK, that's not what I expected. I'll have a look over the weekend.

I probably have a suitable epub, but if you post your sample, then we are working from the same starting point. Can you also post the conversion logs? They will show the settings used and I can make sure I have them correct.

[jackie_w]

@davidfor,

I've attached the test source epub and the converted kepub. Hopefully that's enough, but let me know if something's missing.

This is only a guess but I think the problem might have something to do with the cover page file (titlepage.xhtml) being moved out of its text/ sub-directory into the root directory during the kepub conversion. Perhaps the NCX loses track of the move.

Conversion job details

Spoiler:

Convert book 1 of 1 (Ligatures)
Resolved conversion options
calibre version: 2.70.0
{'asciiize': False,
'author_sort': None,
'authors': None,
'base_font_size': 12.0,
'book_producer': None,
'change_justification': u'original',
'chapter': u'/',
'chapter_mark': u'pagebreak',
'comments': None,
'cover': u'D:\\sysfiles\\Temp\\calibre_u7scni\\ud1hoz.jpeg' ,
'debug_pipeline': None,
'dehyphenate': False,
'delete_blank_paragraphs': False,
'disable_font_rescaling': True,
'dont_split_on_page_breaks': False,
'duplicate_links_in_toc': False,
'embed_all_fonts': False,
'embed_font_family': None,
'enable_heuristics': False,
'epub_flatten': False,
'epub_inline_toc': False,
'epub_toc_at_end': False,
'expand_css': False,
'extra_css': None,
'extract_to': None,
'filter_css': u'',
'fix_indents': False,
'flow_size': 260,
'font_size_mapping': u'9, 10, 11, 12, 14, 16, 20, 36',
'format_scene_breaks': False,
'html_unwrap_factor': 0.4,
'input_encoding': None,
'input_profile': <calibre.customize.profiles.InputProfile object at 0x0000000005A9BE80>,
'insert_blank_line': False,
'insert_blank_line_size': 0.5,
'insert_metadata': False,
'isbn': None,
'italicize_common_cases': False,
'keep_ligatures': False,
'kepub_clean_markup': False,
'kepub_disable_hyphenation': False,
'kepub_hyphenate': False,
'kepub_replace_lang': True,
'language': None,
'level1_toc': None,
'level2_toc': None,
'level3_toc': None,
'line_height': 0.0,
'linearize_tables': False,
'margin_bottom': -1.0,
'margin_left': -1.0,
'margin_right': -1.0,
'margin_top': -1.0,
'markup_chapter_headings': False,
'max_toc_links': 0,
'minimum_line_height': 0.0,
'no_chapters_in_toc': False,
'no_default_epub_cover': False,
'no_inline_navbars': False,
'no_svg_cover': False,
'output_profile': <calibre.customize.profiles.TabletOutput object at 0x0000000005AB1908>,
'page_breaks_before': u'/',
'prefer_metadata_cover': False,
'preserve_cover_aspect_ratio': False,
'pretty_print': True,
'pubdate': None,
'publisher': None,
'rating': None,
'read_metadata_from_opf': u'D:\\sysfiles\\Temp\\calibre_u7scni\\2mxssl.opf',
'remove_fake_margins': False,
'remove_first_image': False,
'remove_paragraph_spacing': False,
'remove_paragraph_spacing_indent_size': 1.5,
'renumber_headings': True,
'replace_scene_breaks': u'',
'search_replace': '[]',
'series': None,
'series_index': None,
'smarten_punctuation': False,
'sr1_replace': None,
'sr1_search': None,
'sr2_replace': None,
'sr2_search': None,
'sr3_replace': None,
'sr3_search': None,
'start_reading_at': None,
'subset_embedded_fonts': False,
'tags': None,
'timestamp': None,
'title': None,
'title_sort': None,
'toc_filter': None,
'toc_threshold': 6,
'toc_title': None,
'transform_css_rules': '[]',
'unsmarten_punctuation': False,
'unwrap_lines': False,
'use_auto_toc': False,
'verbose': 2}
InputFormatPlugin: EPUB Input running
on D:\sysfiles\Temp\calibre_u7scni\uxvpj7.epub
Found HTML cover text/titlepage.xhtml
Parsing all content...
Parsing text/lig.htm ...
Parsing stylesheet.css ...
Parsing text/titlepage.xhtml ...
Reading TOC from NCX...
Merging user specified metadata...
Detecting structure...
Flattening CSS and remapping font sizes...
Source base font size is 12.00000pt
Cleaning up manifest...
Trimming unused files from manifest...
Trimming u'text/titlepage.xhtml' from manifest
Creating KePub Output...
Splitting markup on page breaks and flow limits, if any...
Looking for large trees in text/lig.htm...
No large trees found
Copying file 'D:\sysfiles\Temp\calibre_u7scni\irnoug_KePubOutpu tPluginInfo' to 'D:\sysfiles\Temp\calibre_u7scni\jmnn1z_epub_conta iner' as 'plugininfo.kte'
{'smarten_punctuation': False, 'replace_lang': True, 'hyphenate': False, 'no-hyphens': False, 'extended_kepub_features': True, 'clean_markup': False}
KoboTouchExtended:common:modify_epub:Found cover image ID 'cover'
KoboTouchExtended:common:modify_epub:Setting cover-image property
Forcing cleanup for file text/lig.htm
Forcing cleanup for file titlepage.xhtml
KoboTouchExtended:common:modify_epub:Overriding OPF language
KoboTouchExtended:common:modify_epub:Overriding content file language :: text/lig.htm
KoboTouchExtended:common:modify_epub:Overriding content file language :: titlepage.xhtml
KoboTouchExtended:common:modify_epub:Adding extended Kobo features to Ligatures by Aaa Zzz
Adding Kobo spans to text/lig.htm
Adding Kobo spans to titlepage.xhtml
Adding Kobo divs to text/lig.htm
Adding Kobo divs to titlepage.xhtml
Skipping file (many divs! handle it!)
Copying file 'D:\sysfiles\Temp\calibre_u7scni\kepub_uifnky_styl ehacks' to 'D:\sysfiles\Temp\calibre_u7scni\jmnn1z_epub_conta iner' as 'kte-css/stylehacks.css'
Adding reference to kte-css/stylehacks.css to file text/lig.htm
Adding reference to kte-css/stylehacks.css to file titlepage.xhtml
KEPUB output written to D:\sysfiles\Temp\calibre_u7scni\smerli.kepub

[davidfor]

The problem is in the calibre conversion code. For everything except epubs, the conversion process strips the ToC entry pointing to the cover before passing everything to the output plugin. I have made a change to add kepub to the exceptions and checked it in. Assuming Kovid agrees, it will be in the next release.

For those who want to check, the change is https://github.com/davidfor/calibre/...fd85fbb5bf941e

[jgoguen]

Should that be a list in the class, so plugins can override it?

[jackie_w]

Originally Posted by davidfor

Assuming Kovid agrees, it will be in the next release.

I see he did agree. I tried it in my 'run from source' calibre. It looks fine. Thank you

[davidfor]

Originally Posted by jgoguen

Should that be a list in the class, so plugins can override it?

I wouldn't code it as a list. If I was doing it properly, I would probably add a property along the lines of "supports_cover_in_toc". Default that to false in the base OutputPlugin class and set it to true wherever appropriate. That was more than I felt like doing yesterday and the change I made was in keeping with the coding style in of the class and method I was changing. And if we keep adding things like, this Kovid will eventually accept that kepubs are a standard format. Wouldn't we all like to edit kepubs in the calibre editor??? Just two or three changes if anyone is interested.

Also, is the git repository up to date? My local copy doesn't match but I'm not sure which are changes I've meant to throw away.

[jgoguen]

It should be. Though since I moved the code folder to my Dropbox it wouldn't be the first time I forgot to run "git push"

[Occivink]

Hi, the right side of my kepub books is slightly clipped, is that a known issue? I'm using an aura one, and it happens with all books that I've tried. The font settings also don't seem to have an influence on the issue.

Here is a sample of what it looks like: http://i.imgur.com/Dhavd3k.jpg