FootnoteManipulator plugin
Recently I produced an ePub that contained a plethora of footnotes. As the ePub developed and went through several reviews, I found that I needed to add/delete footnotes and this became time consuming. Consequently, I developed the attached plugin with the following features:
- Footnotes can be placed at the end of each xhtml section or all the footnotes can be placed together in one xhtml section;
- All hyperlinks to the footnotes are numbered automatically in the form 1, 2, 3, etc. Text may be included for each numbered hyperlink (eg 'Note 1') and/or brackets can be placed around the hyperlink (eg [1]). In each of these examples the number is inserted automatically and is incremented for each separate footnote;
- The hyperlink for each footnote can be set up as a superscript if required;
- The hyperlink (backlink) in the footnote itself that takes the reader back to the main text may include a number that is incremented automatically in each footnote or text may be placed in the footnote without a number (eg 'Back'). Alternatively, both an automatically incremented number and specified text may be included in the backlink;
- The hyperlink in the footnote itself that takes the reader back to the main text may be placed at either the start or the end of the footnote;
- A css file to format the footnotes may be specified and this is imported into the ePub when the plugin runs. The sample css file in the manual also formats the text that is to be hyperlinked; this distinguishes the text for the footnote from that of the main text;
- The settings for the plugin may be saved so that they may be used with other ePubs;
- Footnotes can be moved back into the body of the text in the appropriate xhtml section; this is useful if it becomes necessary to add more footnotes later or delete some of the existing footnotes. Then, when the plugin is run to reinsert the footnotes, the notes will be inserted with updated numbers in the correct sequence;
- Advanced users can specify the name of the ID for the footnote.
This plugin has been tested on epub 2.0 books and epub 3.0 using Sigil version 0.9.14 running on windows 11.
Important: Please backup your epub before running this plugin.
How to install this plugin: See the manual.
Licence: See the manual.
Update to version 0.1.1.0
- Bug fixed: The previous version looked for updates and froze if an update was found.
- Bug fixed: When reinstating footnotes an extra space was introduced into the beginning of the reinstated footnote.
- Feature added: An image for the plugin that can be included in the toolbar has been added (thanks to BeckyEbook).
- Feature added: You can include the epub:type="footnote" in footnotes and you can include epub:type="noteref" in hyperlinks for ePub 3 ebooks.
- Feature added: You can specify the names for classes, hyperlinks and IDs that are associated with footnotes.
- Feature added: You can set the time interval between reminders for installing an update when an update becomes available.
Updated to version 0.1.1.2- Bug fixed: name 'ttk' is not defined
Updated to version 0.1.1.3
This version will produce popup footnotes for ePub 3 books. To enable popup footnotes click the
Advanced button in the main dialog and then tick the box marked
Include ePub types.