File size: 4,432 Bytes
d1ceb73 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 |
import re
from ..core import BlockState
from ..util import unikey
from ..helpers import LINK_LABEL
__all__ = ['footnotes']
_PARAGRAPH_SPLIT = re.compile(r'\n{2,}')
# https://michelf.ca/projects/php-markdown/extra/#footnotes
REF_FOOTNOTE = (
r'^(?P<footnote_lead> {0,3})'
r'\[\^(?P<footnote_key>' + LINK_LABEL + r')]:[ \t]'
r'(?P<footnote_text>[^\n]*(?:\n+|$)'
r'(?:(?P=footnote_lead) {1,3}(?! )[^\n]*\n+)*'
r')'
)
INLINE_FOOTNOTE = r'\[\^(?P<footnote_key>' + LINK_LABEL + r')\]'
def parse_inline_footnote(inline, m: re.Match, state):
key = unikey(m.group('footnote_key'))
ref = state.env.get('ref_footnotes')
if ref and key in ref:
notes = state.env.get('footnotes')
if not notes:
notes = []
if key not in notes:
notes.append(key)
state.env['footnotes'] = notes
state.append_token({
'type': 'footnote_ref',
'raw': key,
'attrs': {'index': notes.index(key) + 1}
})
else:
state.append_token({'type': 'text', 'raw': m.group(0)})
return m.end()
def parse_ref_footnote(block, m: re.Match, state: BlockState):
ref = state.env.get('ref_footnotes')
if not ref:
ref = {}
key = unikey(m.group('footnote_key'))
if key not in ref:
ref[key] = m.group('footnote_text')
state.env['ref_footnotes'] = ref
return m.end()
def parse_footnote_item(block, key: str, index: int, state: BlockState):
ref = state.env.get('ref_footnotes')
text = ref[key]
lines = text.splitlines()
second_line = None
for second_line in lines[1:]:
if second_line:
break
if second_line:
spaces = len(second_line) - len(second_line.lstrip())
pattern = re.compile(r'^ {' + str(spaces) + r',}', flags=re.M)
text = pattern.sub('', text).strip()
items = _PARAGRAPH_SPLIT.split(text)
children = [{'type': 'paragraph', 'text': s} for s in items]
else:
text = text.strip()
children = [{'type': 'paragraph', 'text': text}]
return {
'type': 'footnote_item',
'children': children,
'attrs': {'key': key, 'index': index}
}
def md_footnotes_hook(md, result: str, state: BlockState):
notes = state.env.get('footnotes')
if not notes:
return result
children = [
parse_footnote_item(md.block, k, i + 1, state)
for i, k in enumerate(notes)
]
state = BlockState()
state.tokens = [{'type': 'footnotes', 'children': children}]
output = md.render_state(state)
return result + output
def render_footnote_ref(renderer, key: str, index: int):
i = str(index)
html = '<sup class="footnote-ref" id="fnref-' + i + '">'
return html + '<a href="#fn-' + i + '">' + i + '</a></sup>'
def render_footnotes(renderer, text: str):
return '<section class="footnotes">\n<ol>\n' + text + '</ol>\n</section>\n'
def render_footnote_item(renderer, text: str, key: str, index: int):
i = str(index)
back = '<a href="#fnref-' + i + '" class="footnote">↩</a>'
text = text.rstrip()[:-4] + back + '</p>'
return '<li id="fn-' + i + '">' + text + '</li>\n'
def footnotes(md):
"""A mistune plugin to support footnotes, spec defined at
https://michelf.ca/projects/php-markdown/extra/#footnotes
Here is an example:
.. code-block:: text
That's some text with a footnote.[^1]
[^1]: And that's the footnote.
It will be converted into HTML:
.. code-block:: html
<p>That's some text with a footnote.<sup class="footnote-ref" id="fnref-1"><a href="#fn-1">1</a></sup></p>
<section class="footnotes">
<ol>
<li id="fn-1"><p>And that's the footnote.<a href="#fnref-1" class="footnote">↩</a></p></li>
</ol>
</section>
:param md: Markdown instance
"""
md.inline.register(
'footnote',
INLINE_FOOTNOTE,
parse_inline_footnote,
before='link',
)
md.block.register(
'ref_footnote',
REF_FOOTNOTE,
parse_ref_footnote,
before='ref_link',
)
md.after_render_hooks.append(md_footnotes_hook)
if md.renderer and md.renderer.NAME == 'html':
md.renderer.register('footnote_ref', render_footnote_ref)
md.renderer.register('footnote_item', render_footnote_item)
md.renderer.register('footnotes', render_footnotes)
|