Sigil Plugin Framework Documentation
Hi,
Please note there currently exists 4 types of Sigil plugins:
1. edit - used to create modify and delete files in the ebook currently being edited by Sigil
2. input - used to load a newly created epub into Sigil
3. output - used to read the ebook currently in Sigil and convert or generate a new ebook file you store externally. No changes to the current ebook inside Sigil are made.
4. validation - used to return error messages from epub validators run on the current ebook in Sigil. It inherits from the output plugin.
For specific information on interface calls available for each type of plugin, check out:
bookcontainer.py for the interface for an "edit" type plugin
outputcontainer.py for the interface for an "output" type plugin
inputcontainer.py for the interface for an "input" container
validationcontainer.py for the interface for a "validation" type plugin
The current Sigil Plugin Framework Documentation is up-to-date with the upcoming Sigil 0.9.991 (pre Sigil-1.0) release. Here it is as an epub for reference by Sigil Plugin Developers.
Hope this helps,
KevinH
Last edited by KevinH; 11-07-2019 at 03:03 PM.
Reason: Adding Latest Version
|