Checks and verifies the OPF metadata and guide data sections
Requirements
Plugin Type: Validation
MIT Licence(OSI)
Minimum Sigil requirement: v0.9.3 or higher
Python Requirements: Python 3.4+ (Bundled or External)
OS Requirements: Windows, Linux or OSX
*** Tested on Windows 7, 8 & 10 only ***
Current Version: "0.1.1"
Installation
* Select the
Plugins > Manage Plugins menu item. In the dialog box, select either the
Bundled Python or the
External Python(Python 3.8+ should be installed on your computer to run this plugin externally).
* Click
Add Plugin and select
VerifyOPFData_vXXX.zip. This will load and install the plugin into Sigil, which you can then run by selecting
Plugins > Validation > VerifyOPFData
Description
This validation plugin checks and verifies the data in the OPF file metadata and guide sections to minimum requirements as described below:
- Checks for any missing metadata entries.
- Checks for any duplicate metadata entries.
- Checks for any unnecessary third party promotion data in the metadata section(e.g. entries for Sigil, Calibre etc).
- Checks that the appropriate data is present in the guide section.
All plugin results will be displayed in the
Validation Results panel in Sigil. Only Epub 2 files can be used with this plugin(Added in v0.1.1).
Preferences
The editable JSON prefs data for this plugin is shown below:
Code:
{
"third_party_list": [
"Jutoh",
"Calibre",
"Sigil",
"Scrivener",
"LibreOffice",
"Epubor",
"Atlantis",
"Kindle Create",
"Adobe"
],
"show_errors_and_warnings_only": true
}
third_party_list
This is an editable search list of third party names that the plugin uses to find any unnecessary third party promotion entries in the metadata section(such as entries for Calibre or Sigil) that can be removed.
show_errors_and_warnings_only
When this flag is set to “true”, only errors and warnings will be displayed in the
Validation Results panel. But if this flag is set to “false” then errors, warnings and data that is present in the metadata section will also be displayed.
Plugin Run
Just load a valid epub 2 file into Sigil and run the plugin as described above.
Changes: