Plugin for inserting endnotes in an epub 2.0

elibrarian · 09-11-2015, 12:14 PM

Plugin for easy insertion of epub 2.0 style footnotes.

The text for the notes must be at the place in the surrounding text, where the reference should be inserted, surrounded by ^[ ... ] - same way as Pandoc inline-notes. Read more and see some screen captures in the attached pdf.

License: No formalized license as such - do whatever you like with my code, as long as you don't charge for it, and if you come up with any improvements, please share.

---

What's new?

0.2.0: Plugin can be run on epubs with existing notes.

0.2.0: If it finds any notes (in a known format), it will try to determine the highest reference number and continue from there, or the user can choose a higher number to start from. (E. g. if highest found is 59, then it might be convenient to start new numbers at 100, then the new notes wil be easy to find with a regex like \d\d\d or \d{3})

0.2.0: If a footnote.css stylesheet file exists in the epub, it will not be overwritten, but user will get a warning to check the format of any newly inserted notes.

0.2.0: Plugin autostarts.

0.2.0 Now Python 3 only.

April 8. 2018: New version 0.2.1:

0.2.1: Now doesn't insert multiple instances of the css-reference (thanks to BeckyEbook)

0.2.1: Updated intro/userguide.

December 20. 2023: New version 0.2.2:

0.2.2: Corrected an error regarding "/"s in notes and now provide an icon. All thanks go to BeckyEbook!

Future updates: Since I don't do epub version 2-books any more, this plugin will not be updated any further. (But anyone who wants to can manipulate the code and share alternate versions

Update 18. dec. 2019: From my (admittedly not very extensive) tests of this plugin with non-standard epubs and Sigil 1.0, it still works as advertised.

Regards,

Kim

KevinH · 09-11-2015, 01:21 PM

Hi Kim,

Wonderful. Thanks for contributing to Sigil via your plugin. I am tied up at work right now, but I will add plugin to the official Sigil Plugin Index thread when I get a free moment this weekend. If you have any technical questions about plugin development, please don't hesitate to ask in the main plugin thread.

Thanks!

KevinH

theducks · 09-11-2015, 02:23 PM

Quote:

Originally Posted by KevinH

Hi Kim,

Wonderful. Thanks for contributing to Sigil via your plugin. I am tied up at work right now, but I will add plugin to the official Sigil Plugin Index thread when I get a free moment this weekend. If you have any technical questions about plugin development, please don't hesitate to ask in the main plugin thread.

Thanks!

KevinH

I added it, but for some reason the item spacing is off

DiapDealer · 09-11-2015, 03:30 PM

Did you really just make a pdf to document how to use an epub plugin?

PeterT · 09-11-2015, 04:16 PM

Quote:

Originally Posted by DiapDealer

Did you really just make a pdf to document how to use an epub plugin?

He's following the lead of a certain calibre plugin author...

elibrarian · 09-11-2015, 04:16 PM

Quote:

Originally Posted by DiapDealer

Did you really just make a pdf to document how to use an epub plugin?

Yup - I use Libreoffice and Snap8 all the time to make docs like this at work, so it was the easiest way for me instead of fiddling for hours with image placements in an epub ...

Regards

Kim

Pablo · 09-14-2015, 11:52 AM

Very nice plugin eLibrarian!

CalibUser · 09-14-2015, 03:14 PM

Thanks, eLibrarian. This will be useful for some ePubs that I am writing.

gipsy · 09-29-2015, 06:09 AM

@elibrarian

If the 2 ^[...] are near, the search find them as one
I solve it changing the

Code:

		found = re.search(r'\^\[.*\]',html)

to

Code:

		found = re.search(r'\^\[.*?\]',html)

EDIT: Doesn't work right. It delete the text till the last ] in those that are near
I try to figure out why

elibrarian · 09-29-2015, 09:17 AM

I've uploaded a new version to the first post of this thread. I think I've nailed the problem with deleting text too.

Regards,

Kim

gipsy · 09-29-2015, 10:04 AM

Thanks Kim, works fine now

Leonatus · 09-30-2015, 06:01 AM

A really useful tool! Thank you so much!

I'd use it principally for OCRing of scientific texts. In the original text of those, there usually appear footnotes. As I understand it, to make the tool run, I need to "cut" the footnote text and place it next to the corresponding "body" text first, right?

elibrarian · 09-30-2015, 08:40 AM

Quote:

Originally Posted by Leonatus

As I understand it, to make the tool run, I need to "cut" the footnote text and place it next to the corresponding "body" text first, right?

If I understand you correctly, then yes - see the first image in the pdf-intro, where "Mälaren" is the word you want to explain, and ^[En sø i Sverige - A lake in Sweden] is what is to become a note. Text between the [...] wil be moved to the note at the end of the file.

Just try it on any epub - as long as it is on a copy and/or you don't save, no harm is done

Regards,

Kim

Leonatus · 10-01-2015, 03:23 AM

Thank you, Kim,
the actual book I'm OCRing has some footnotes, so it's a good oportunity.

Leonatus · 10-08-2015, 12:50 PM

Kim, I tested it, and I'm overwhelmed! Really amazing!

09-29-2015, 06:09 AM	#9
gipsy Connoisseur Posts: 81 Karma: 10 Join Date: Nov 2013 Device: Kobo Aura HD	@elibrarian If the 2 ^[...] are near, the search find them as one I solve it changing the Code: found = re.search(r'\^\[.\]',html) to Code: found = re.search(r'\^\[.?\]',html) EDIT: Doesn't work right. It delete the text till the last ] in those that are near I try to figure out why Last edited by gipsy; 09-29-2015 at 08:13 AM.

Similar Threads
Thread	Thread Starter	Forum	Replies	Last Post
endnotes in epub with Sigil, multiple html	BMaloney	Sigil	9	10-10-2019 05:34 PM
How to publish epub with endnotes on Feedbooks?	Begemot	Writers' Corner	6	09-04-2015 06:51 AM
Conversion of Endnotes .docx to .epub	profjones	Conversion	1	11-01-2013 09:05 AM
Public domain ePub with endnotes.	John F	Reading Recommendations	8	03-27-2012 12:09 PM
Linked endnotes in epub	virtual_ink	ePub	30	08-30-2011 05:47 PM

09-11-2015, 01:21 PM	#2
KevinH Sigil Developer Posts: 8,251 Karma: 5568412 Join Date: Nov 2009 Device: many	Hi Kim, Wonderful. Thanks for contributing to Sigil via your plugin. I am tied up at work right now, but I will add plugin to the official Sigil Plugin Index thread when I get a free moment this weekend. If you have any technical questions about plugin development, please don't hesitate to ask in the main plugin thread. Thanks! KevinH

09-11-2015, 03:30 PM	#4
DiapDealer Grand Sorcerer Posts: 28,077 Karma: 199770456 Join Date: Jan 2010 Device: Nexus 7, Kindle Fire HD	Did you really just make a pdf to document how to use an epub plugin?

09-14-2015, 11:52 AM	#7
Pablo Guru Posts: 971 Karma: 4999999 Join Date: Mar 2009 Location: Rosario, Argentina Device: SONY PRS-T2, Kindle Paperwhite 11th gen	Very nice plugin eLibrarian!

09-14-2015, 03:14 PM	#8
CalibUser Addict Posts: 202 Karma: 62362 Join Date: Jul 2015 Device: Sony	Thanks, eLibrarian. This will be useful for some ePubs that I am writing.

09-29-2015, 09:17 AM	#10
elibrarian Imperfect Perfectionist Posts: 570 Karma: 863576 Join Date: Dec 2011 Location: Ølstykke, Denmark Device: none	I've uploaded a new version to the first post of this thread. I think I've nailed the problem with deleting text too. Regards, Kim

09-29-2015, 10:04 AM	#11
gipsy Connoisseur Posts: 81 Karma: 10 Join Date: Nov 2013 Device: Kobo Aura HD	Thanks Kim, works fine now

09-30-2015, 06:01 AM	#12
Leonatus Wizard Posts: 1,038 Karma: 11227259 Join Date: Mar 2013 Location: Guben, Brandenburg, Germany Device: Kobo Clara 2E, Tolino Shine 3	A really useful tool! Thank you so much! I'd use it principally for OCRing of scientific texts. In the original text of those, there usually appear footnotes. As I understand it, to make the tool run, I need to "cut" the footnote text and place it next to the corresponding "body" text first, right?

10-01-2015, 03:23 AM	#14
Leonatus Wizard Posts: 1,038 Karma: 11227259 Join Date: Mar 2013 Location: Guben, Brandenburg, Germany Device: Kobo Clara 2E, Tolino Shine 3	Thank you, Kim, the actual book I'm OCRing has some footnotes, so it's a good oportunity.

10-08-2015, 12:50 PM	#15
Leonatus Wizard Posts: 1,038 Karma: 11227259 Join Date: Mar 2013 Location: Guben, Brandenburg, Germany Device: Kobo Clara 2E, Tolino Shine 3	Kim, I tested it, and I'm overwhelmed! Really amazing!

Advert

Advert