[Plugin] CombineNCXHeadings

[slowsmile]

Combines the chapter titles and chapter subtitles into single headings in the NCX TOC

Requirements
Plugin Type: Edit
MIT Licence(OSI)
Minimum Sigil requirement: v0.9.3 or higher
Python Requirements: Python 3.4+ (Bundled or External)
OS Requirements: Windows, OSX or Linux
*** Tested on Windows 10, OSX and Linux ***
Current Version: "0.1.3"

Installation
* Select Manage Plugins from the Plugins menu. In the dialog box, select either the Bundled Python or the External Python(Python 3.4+ should be installed on your computer to run this plugin externally).

* Click Add Plugin and select CombineNCXHeadings_vXXX.zip. This will load and install the plugin into Sigil, which you can then select and run using Plugins > Edit > CombineNCXHeadings.

Description
This plugin combines the chapter title headings(as h1) and chapter subtitle headings(as h2) from the html files into single headings in the NCX TOC. The plugin user will also be able to:

• Separately and individually style the word case of the chapter title and chapter subtitle parts of the combined headings in the NCX TOC.
  
• Add a separator of your choice between the chapter title and chapter subtitle parts of the combined NCX TOC headings.
  
• Lone chapter title headings(with no chapter subtitles) will also be styled in the user's chosen word case style.
  
• This plugin will only create a single level NCX TOC.

For title case only, the plugin user can also more tightly control the title case output by adding the appropriate words to the ignore_titlecase variable in the plugin's associated JSON file. All words in the JSON string will automatically be excluded from title case conversion and will be displayed in lower case instead.

Updates:
This plugin will now create a flat NCX TOC showing all sub-headings formatted with h3 - h6 (Fixed in v0.1.2).If you wish to add indents to your sub-heading entries in your NCX TOC, you can do this in Sigil using Tools > Edit Table of Contents in the normal way by selecting each of the relevant headings in turn and using the Arrow Keys on your keyboard to directly add/remove indents in the edit window as you prefer.

Changes:

Spoiler:

v0.1.3 -- Fixed 'import sys' problem(thanks to @DiapDealer).
v0.1.3 -- Removed non-related README.txt file from plugin directory(thanks to @BeckyEBook).
v0.1.2 -- Fixed a problem where, after running the plugin, any h3 - h6 sub-headings were not displayed in the NCX TOC. See Update section for more details. Thanks to AlanHK
v0.1.1 -- Removed README file and added MIT License file. Thanks to Ambaquista.
v0.1.0 -- Initial release

[slowsmile]

Can someone please add this plugin to the Sigil Plugin Index? With thanks.

[KevinH]

Now added.

Originally Posted by slowsmile

Can someone please add this plugin to the Sigil Plugin Index? With thanks.

[AlanHK]

Could be useful.
What I've been doing when I have chapters like:


<h1>Chapter 4</h1>
<h2>Whatever happens</h2>

is use regex to make it
<h1>Chapter 4<br/>
<span class="chapsub">Whatever happens</span></h1>

Before I do "generate TOC" I convert
<br/>
<span class="chapsub">

to :<br/>
<span class="chapsub">

So I get
Chapter 4: Whatever happens
in the toc file. Then I delete the colon from the chapter files.

I'll still do this when there are other levels of heading (e.g. "Parts" ) that I want to retain, but if there are just chapters this might be simpler.

[slowsmile]

#AlanHK...I'm not really sure how your above example relates to my plugin. From your example, it's seems that you're actually removing the chapter subtitles from the epub TOC page. This plugin doesn't change or touch the epub TOC page. The plugin just combines the chapter title with the chapter subtitle in the toc.ncx file to give you a single-level NCX TOC. See example below:

It just changes the NCX headings from this:

      <navPoint id="navPoint-7" playOrder="7">
        <navLabel>
           <text>CHAPTER 1</text>
         </navLabel>
        <content src="section-0007.xhtml#auto_bookmark_toc_8"/>
      <navPoint id="navPoint-8" playOrder="8">
          <navLabel>
            <text>All About Kindle Create</text>
           </navLabel>
           <content src="section-0007.xhtml#a__Toc29195570"/>
       <navPoint id="navPoint-9" playOrder="9">
           <navLabel>
             <text>Limitations of this Book</text>
           </navLabel>
           <content src="section-0007.xhtml#a__Toc29195571"/>

To this:

    <navPoint id="navPoint-3" playOrder="3">
      <navLabel>
        <text>CHAPTER 1 — All About Kindle Create</text>
      </navLabel>
      <content src="section-0007.xhtml"/>
    </navPoint>
    <navPoint id="navPoint-4" playOrder="4">
      <navLabel>
        <text>CHAPTER 2 — Preparing a Word Doc Using Ms Word</text>
      </navLabel>
      <content src="section-0009.xhtml"/>

[Doitsu]

Originally Posted by AlanHK

What I've been doing when I have chapters like:


<h1>Chapter 4</h1>
<h2>Whatever happens</h2>

is use regex to make it
<h1>Chapter 4<br/>
<span class="chapsub">Whatever happens</span></h1>

IMHO, it'd more efficient, if you used a regex to convert the heading to:

<h1 title="Chapter 4: Whatever happens">Chapter 4<br/>
<span class="chapsub">Whatever happens</span></h1>

Since Sigil will use title attributes to generate the TOC, you could simply re-generate the TOC without having to add/remove colons.

[AlanHK]

Originally Posted by Doitsu

Since Sigil will use title attributes to generate the TOC, you could simply re-generate the TOC without having to add/remove colons.

Yes, but now you have to manually update the "Title=" bit. Probably that would be simpler though, unless you were changing several chapter heads.

I do use "Title=" on pages with no visible headings (dedication, etc).

[Ambaquista]

[QUOTE=slowsmile;4011146]

Combines the chapter titles and chapter subtitles into single headings in the NCX TOC

Something wrong!

In the page:
https://www.mobileread.com/forums/sh...d.php?t=331485
I click in:
"Attached Files
File Type: zip CombineNCXHeadings_v010.zip (22.3 KB, 135 views)"
and I get the plugin
"RemoveUnusedBookmarks
Removes all unused bookmarks from the epub file "

Can you please fix this?

Thank you
b rgds
Ambaquista

[BeckyEbook]

Plugin is OK. Only readme.html file is related to other plugin.

[slowsmile]

@Ambaquista...I downloaded the CombineNCXHeadings_v010.zip file from your link and installed it in Sigil. And when I tested the plugin, it worked without problems. Regarding the README file, please ignore that file. I will upload another version of this plugin later without the readme file.

[slowsmile]

Plugin Update(v0.1.1):

-- Removed README file and added MIT License file. Thanks to Ambaquista.

[Ambaquista]

OK
Thanks all the kind (and fast!) answers!
b rgds

[AlanHK]

A book had chapter heads like

<h1>17</h1>
<h2>Jack<h2>
<h3>Monday</h3>

There is some other formatting between heads that makes it difficult to combine them into a single heading in the text.

Sigil generated a TOC with three levels; I wanted all 3 titles to be combined in the TOC.

Using the plugin, it combined h1 and h2, but simply deleted the h3 text.

So adding at least one more level would be appreciated.

Also, it offers a choice of space, em or en dash and tilde as a separator.
Could add period and colon to those. Or just allow to type in any character.
(I know I can just use the tilde and replace it in the ncx myself.)

So I went back back to using regex to build a "title=" tag in the h1 from the other heads.

[slowsmile]

@AlanHK...The plugin's prime purpose is to allow the plugin user to easily combine just the chapter title and chapter subtitle in various ways on a single line in the NCX TOC. As I see it, there is no provision or requirement for adding a third heading level or extra subheading to the NCX line, which I think would perhaps over-complicate the plugin and cause more confusion than anything else, which is why I prefer not to add any further heading levels to the existing NCX heading displays for this plugin.

[AlanHK]

OK. 3 levels of heading isn't too common. So I'll sharpen up my regex.

However, simply deleting lower level headings in the TOC is not good.
If it doesn't combine them it should leave them.
Now it erases all subheads within a chapter.

And configurable separator character would be nice.