[Plugin] ShowSemantics

[Doitsu]

[Plugin] ShowSemantics - Shows landmarks and guide items in a table

Released: August 8, 2023
Current Version: "0.2.3"

This plugin is primarily intended for epub3 authors interested in creating epub2 compatible epub3 books. The plugin also works with epub2 books, however, if you only work with epub2 books, you can display the same information by selecting Tools > Reports... > All files.

Disclaimer: Even though it's unlikely that the plugin will somehow corrupt the epub that you're working on or crash Sigil, you might want to save your ePub in Sigil before running this plugin.

Credits: Both BeckyEbook and odamizu provided helpful feedback during the beta test. BeckyEbook also created the plugin icon. DiapDealer provided a PySide6/PyQt5 library.

System requirements

This plugin requires Sigil 0.9.8 or higher. If you uncheck the Use Bundled Python option, you'll also need to install Python, PyQt5, and lxml.

Installation

1. Select Manage Plugins from the Plugins menu and enable the Use Bundled Python option, if it isn't already enabled.
2. Click Add Plugin and select ShowSemantics_v0.2.3.zip. This will install the plugin, which you can select via Plugins > Edit > ShowSemantics.

Settings

By default, the plugin will only display landmarks, guide items and cover image metadata and manifest entries. However, advanced users can also enable the following repair options by editing ShowSemantics.json:

"fix_cover": false, (epub2 and epub3 books)

Many epub3 apps won't display a cover image, if the cover-image manifest properties attribute is missing. If you enable this setting, the plugin will try and add (or update) cover image metadata entries and properties.

"add_landmarks": false (epub3 books only)

Many epub3 books have EPUB2 guide sections but no EPUB3 landmarks sections. However, many epub3 apps ignore EPUB2 guide sections. If you enable this setting, the plugin will try to add landmarks based on guide item values. (This'll only work, if the book contains an EPUB2 guide section.)

"add_guides": false, (epub3 books only)

Many epub3 books have no EPUB2 guide sections, because they're usually ignored by epub3 apps. However, if you want to create epub2-compatible epub3 books, you can enable this setting to have the plugin generate EPUB2 guide items from EPUB3 landmarks. (This'll only work, if the book contains an EPUB3 landmarks section.)

BTW, if you don't enable any of these settings, you can change the following entry in plugin.xml to true:

<autoclose>false</autoclose>

This'll hide the Plugin Runner window and you won't have to click the OK button to close the Plugin Runner window.

License: GNU General Public License v3 (GPL-3)

[odamizu]

I really like this plugin. Doitsu!

And thank you BeckyEbook for the nifty plugin icon

[DiapDealer]

Looks useful ... Thanks! I added it to the plugin index.

*Note that those who may be using non-bundled Python installations don't really need to install bs4. You seem to be using the sigil_bs4 module exclusively, and that's always available to plugins (bundled-python or non-).