Register Guidelines E-Books Search Today's Posts Mark Forums Read

Go Back   MobileRead Forums > E-Book Software > Sigil > Plugins

Notices

Reply
 
Thread Tools Search this Thread
Old 07-01-2017, 06:18 AM   #1
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
[Plugin] FootnoteLinker Sigil plugin

Updated: December 29, 2019
Current Version: "0.3.3"

This very simple plugin will automatically generate links to endnotes and backlinks to footnote anchors.
By default, it'll look for footnote anchors with a noteanchor class attribute (e.g. <sup class="noteanchor">1</sup>) and endnote defintions with a note class attribute (e.g. <p class="note">1. Footnote definition...</p>).
You'll also need to right-click the endnotes file and select Add Semantics... > Notes/Footnotes. (For an example, see the test file.)

Please make sure to make a backup copy before running this plugin!


Credits: roger64 for beta testing and feedback.

Installation:

1. Select Manage Plugins from the Plugins menu and select Use Bundled Python, if it isn't already selected.
2. Click Add Plugin and select FootnoteLinker_v0.3.3.zip. This will install the FootnoteLinker plugin, which you can select via Plugins > Edit > FootnoteLinker.

License: GNU General Public License v3 (GPL-3)
Attached Thumbnails
Click image for larger version

Name:	FootnoteLinker.png
Views:	1111
Size:	12.2 KB
ID:	158078  
Attached Files
File Type: epub FNLTest.epub (2.7 KB, 2267 views)
File Type: zip FootnoteLinker_v0.3.3.zip (7.0 KB, 2326 views)

Last edited by Doitsu; 12-29-2019 at 04:23 AM. Reason: New version w/Sigil 1.0 support
Doitsu is offline   Reply With Quote
Old 07-04-2017, 07:24 PM   #2
Auramazda
Member
Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.Auramazda is no ebook tyro.
 
Posts: 16
Karma: 1422
Join Date: Mar 2016
Device: none
I find a little problem, if you use the plugin then add some other note and use again the plugin in the foot note page you have two link of the past note:
1 1 in matters of taste, there is no argument...
not a big problem for me just for information
Auramazda is offline   Reply With Quote
Old 07-05-2017, 04:04 AM   #3
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
Quote:
Originally Posted by Auramazda View Post
I find a little problem, if you use the plugin then add some other note and use again the plugin in the foot note page you have two link of the past note
Ideally, you should run this plugin only once, but I've updated the code to allow users to run it multiple times.
Doitsu is offline   Reply With Quote
Old 07-05-2017, 10:17 AM   #4
nqk
Fanatic
nqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beautynqk does all things with Zen-like beauty
 
Posts: 513
Karma: 32106
Join Date: Feb 2012
Device: Onyx Boox Leaf
Dear Doitsu,

Would you please make this for Calibre Editor too?
nqk is offline   Reply With Quote
Old 07-05-2017, 10:54 AM   #5
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
Quote:
Originally Posted by nqk View Post
Would you please make this for Calibre Editor too?
Unfortunately, that is not possible, since this plugin uses the Beautiful Soup Python package, which is bundled with Sigil but not with Calibre.
Doitsu is offline   Reply With Quote
Old 07-05-2017, 11:43 AM   #6
PeterT
Grand Sorcerer
PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.PeterT ought to be getting tired of karma fortunes by now.
 
PeterT's Avatar
 
Posts: 12,117
Karma: 73448614
Join Date: Nov 2007
Location: Toronto
Device: Nexus 7, Clara, Touch, Tolino EPOS
I was sure beautiful soup was in Calibre; I'm sure it's used by many of the recipes for news downloads.

Sent from my Nexus 7 using Tapatalk
PeterT is offline   Reply With Quote
Old 07-05-2017, 11:50 AM   #7
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
Quote:
Originally Posted by PeterT View Post
I was sure beautiful soup was in Calibre; I'm sure it's used by many of the recipes for news downloads.
AFAIK, all bundled Python packages are supposed to be in the C:\Program Files\Calibre2\app\pylib.zip archive, but I didn't see beautiful soup. Is there any Calibre folder or file that contains optional Python packages?

EDIT: I just checked the recipe documentation and it looks that your right, because one of the examples contain the following import:

Code:
from calibre.ebooks.BeautifulSoup import BeautifulSoup

Last edited by Doitsu; 07-05-2017 at 11:54 AM.
Doitsu is offline   Reply With Quote
Old 07-05-2017, 01:25 PM   #8
KevinH
Sigil Developer
KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.KevinH ought to be getting tired of karma fortunes by now.
 
Posts: 7,506
Karma: 5433350
Join Date: Nov 2009
Device: many
Yes, that is a copy of the original BS module for python 2 (it used to be a single file). I think it even has some Kovid improvements to it. Should work basically the same way to the extent that BS4 was almost backwards compatible with the original BS.
KevinH is offline   Reply With Quote
Old 07-24-2017, 01:29 PM   #9
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
I attached a new version, which allows users to customize the footnote and anchor id prefixes.
Doitsu is offline   Reply With Quote
Old 10-12-2017, 01:59 PM   #10
KarenD
Junior Member
KarenD began at the beginning.
 
Posts: 2
Karma: 10
Join Date: Oct 2017
Device: Kindle Paperwhite
Doitsu I'm using your plugin (thank you) and I'm stuck. I'm getting this error message:

Status: failed
Error: Missing Notes guide item. Use Add Semantics > Notes to mark the footnote definitions file.

I've put the class="noteanchor" in the <sup> tags and the class="note" in the end notes section on the <p> tags, just like in the example ePub.

I've left the items in the box (in your intial post) as you have them (although I don't know what the 2nd, 4th and 5th items mean and I can't find them anywhere in your example ePub either).

I have no idea what the "Add Semantics" bit means either - I can't find any menu items called that.

Any idea what's going wrong and how I can get it to work?
Thanks
KarenD is offline   Reply With Quote
Old 10-12-2017, 04:51 PM   #11
Doitsu
Grand Sorcerer
Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.Doitsu ought to be getting tired of karma fortunes by now.
 
Doitsu's Avatar
 
Posts: 5,582
Karma: 22735033
Join Date: Dec 2010
Device: Kindle PW2
Quote:
Originally Posted by KarenD View Post
I'm getting this error message:

Status: failed
Error: Missing Notes guide item. Use Add Semantics > Notes to mark the footnote definitions file.
Add Semantics is a a Book Browser context menu item. You'll have to right-click the (X)HTML file that contains the footnote definitions in the Book Browser and select Add Semantics... > Notes.

This'll add the following line to content.opf:

Code:
<guide>
    <!-- more entries -->
    <reference type="notes" title="Notes" href="Text/endnotes.xhtml"/>
    <!-- more entries -->
  </guide>
(Of course the file name href will differ from your file name.)

After adding the Notes semantic you should also see (Notes) after your endnotes file, if you hover the mouse over it in the Book Browser.
Doitsu is offline   Reply With Quote
Old 10-12-2017, 04:56 PM   #12
BetterRed
null operator (he/him)
BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.BetterRed ought to be getting tired of karma fortunes by now.
 
Posts: 20,457
Karma: 26645808
Join Date: Mar 2012
Location: Sydney Australia
Device: none
ninja'd by the chief warrior himself

@KarenD - right click the xhtml file where you have the notes, select Add Semantics, a list of available values will pop (n.b. different, but similar lists for ePub2 and ePub3) select the one for Notes

BR
BetterRed is offline   Reply With Quote
Old 10-13-2017, 09:48 AM   #13
KarenD
Junior Member
KarenD began at the beginning.
 
Posts: 2
Karma: 10
Join Date: Oct 2017
Device: Kindle Paperwhite
Thank you! That got it working Had no idea there was a right click menu on the files.
KarenD is offline   Reply With Quote
Old 04-04-2018, 01:50 PM   #14
billyray520
Junior Member
billyray520 began at the beginning.
 
Posts: 7
Karma: 10
Join Date: Apr 2018
Device: Kindle Fire
Hey Doitsu, this plugin is great. I am using it with success on the first go. However, I know this is a style thing, but can you fix the plugin so it DOES NOT automatically put the square brackets around the footnote number? I think they look awful. I'm doing a scholarly book which is heavily footnoted. I would rather just have a space on either side of the footnote number (in the main body of the text) But I would want the underline for the link to be just under the number. I had to go back and fix all of the footnotes manually this time.
*Please*
billyray520 is offline   Reply With Quote
Old 04-04-2018, 11:26 PM   #15
roger64
Wizard
roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.roger64 ought to be getting tired of karma fortunes by now.
 
Posts: 2,608
Karma: 3000161
Join Date: Jan 2009
Device: Kindle PW3 (wifi)
Hi

I use square brackets for my notes, not for aesthetical reasons but for practical ones. With them, I can click on the links on any ePub, less so when I keep only a plain number (well, clicking ability improves with the number of digits).

When I produce an ePub, I usually add square brackets using this joint regex with the Calibre editor (written in .json format, you can import it). Most probably, you can achieve a similar result with Sigil. You could adapt it so that to make it work in reverse order (i.e. to suppress all unwanted square brackets in one go ). Anyway you certainly do not need to do that manually...

Admittedly, a Preference setting giving the user an alternative choice of using or not square brackets would be quite nice, but I have no idea on how difficult it would be to implement...
Attached Files
File Type: zip crochets.json.zip (350 Bytes, 482 views)
roger64 is online now   Reply With Quote
Reply

Thread Tools Search this Thread
Search this Thread:

Advanced Search

Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
epubcheck plugin for Sigil Doitsu Plugins 502 02-20-2024 06:58 AM
kindlegen plugin for Sigil Doitsu Plugins 169 02-16-2024 06:48 AM
[Plugin] PunctuationSmarten Sigil plugin DiapDealer Plugins 138 07-11-2023 11:22 AM
[Plugin] ePub3-itizer - epub3 output plugin for Sigil KevinH Plugins 435 01-19-2023 09:46 PM
[Plugin] KindleImport Sigil plugin DiapDealer Plugins 187 07-04-2022 10:11 AM


All times are GMT -4. The time now is 06:04 AM.


MobileRead.com is a privately owned, operated and funded community.