1
0
summary_footnotes/summary_footnotes.py
Jessica Lares cdeff7d1bb Adds support for named footnotes
Adds BeautifulSoup's re to imported modules in order to create variable for finding instances of the "fnref-" id followed by a wildcard. It takes the place of the original "footnote" class in footnotes_div.
2018-03-10 17:06:15 -08:00

68 lines
2.2 KiB
Python

"""
Summary Footnotes
-------------
Fix handling of footnote links inside article summaries.
Option to either remove them or make them link to the article page.
Also never show the footnotes themselves in the summary.
"""
from pelican import contents
from pelican import signals
from bs4 import BeautifulSoup, re
from six import text_type
def initialized(pelican):
from pelican.settings import DEFAULT_CONFIG
DEFAULT_CONFIG.setdefault('SUMMARY_FOOTNOTES_MODE',
'link')
if pelican:
pelican.settings.setdefault('SUMMARY_FOOTNOTES_MODE',
'link')
orig_summary = contents.Content.summary
contents.Content.summary = \
property(lambda instance:
get_summary(instance, orig_summary),
orig_summary.fset, orig_summary.fdel,
orig_summary.__doc__)
def transform_summary(summary, article_url, site_url, mode):
summary = BeautifulSoup(summary, 'html.parser')
footnote_id = re.compile('fnref-\w')
footnotes_div = summary.findAll('div', {'id': footnote_id})
footnote_links = summary.findAll('a', {'class':'footnote-ref'})
if footnotes_div or footnote_links:
for div in footnotes_div:
div.extract()
for link in footnote_links:
if mode == 'remove':
link.extract()
elif mode == 'link':
# only rewrite once
if link['href'][0] == '#':
link['href'] = "%s/%s%s" % (site_url,
article_url,
link['href'])
else:
raise Exception("Unknown summary_footnote mode: %s" % mode)
return text_type(summary)
return None
def get_summary(self, orig_summary):
summary = orig_summary.fget(self)
new_summary = transform_summary(summary,
self.url,
self.settings['SITEURL'],
self.settings["SUMMARY_FOOTNOTES_MODE"])
if new_summary is not None:
return new_summary
else:
return summary
def register():
signals.initialized.connect(initialized)