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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
|
"""
Python Markdown
A Python implementation of John Gruber's Markdown.
Documentation: https://python-markdown.github.io/
GitHub: https://github.com/Python-Markdown/markdown/
PyPI: https://pypi.org/project/Markdown/
Started by Manfred Stienstra (http://www.dwerg.net/).
Maintained for a few years by Yuri Takhteyev (http://www.freewisdom.org).
Currently maintained by Waylan Limberg (https://github.com/waylan),
Dmitry Shachnev (https://github.com/mitya57) and Isaac Muse (https://github.com/facelessuser).
Copyright 2007-2018 The Python Markdown Project (v. 1.7 and later)
Copyright 2004, 2005, 2006 Yuri Takhteyev (v. 0.2-1.6b)
Copyright 2004 Manfred Stienstra (the original version)
License: BSD (see LICENSE.md for details).
"""
from markdown.test_tools import TestCase
class TestFootnotes(TestCase):
default_kwargs = {'extensions': ['footnotes']}
maxDiff = None
def test_basic_footnote(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
"""
),
'<p>paragraph<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_multiple_footnotes(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]: Footnote 1
[^2]: Footnote 2
"""
),
'<p>foo<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<p>bar<sup id="fnref:2"><a class="footnote-ref" href="#fn:2">2</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>Footnote 1 <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'<li id="fn:2">\n'
'<p>Footnote 2 <a class="footnote-backref" href="#fnref:2"'
' title="Jump back to footnote 2 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_multiple_footnotes_multiline(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]: Footnote 1
line 2
[^2]: Footnote 2
"""
),
'<p>foo<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<p>bar<sup id="fnref:2"><a class="footnote-ref" href="#fn:2">2</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>Footnote 1\nline 2 <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'<li id="fn:2">\n'
'<p>Footnote 2 <a class="footnote-backref" href="#fnref:2"'
' title="Jump back to footnote 2 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_footnote_multi_line(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
line 2
"""
),
'<p>paragraph<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote\nline 2 <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_footnote_multi_line_lazy_indent(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]: A Footnote
line 2
"""
),
'<p>paragraph<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote\nline 2 <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_footnote_multi_line_complex(self):
self.assertMarkdownRenders(
self.dedent(
"""
paragraph[^1]
[^1]:
A Footnote
line 2
* list item
> blockquote
"""
),
'<p>paragraph<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote\nline 2</p>\n'
'<ul>\n<li>list item</li>\n</ul>\n'
'<blockquote>\n<p>blockquote</p>\n</blockquote>\n'
'<p><a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_footnote_multple_complex(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]:
A Footnote
line 2
* list item
> blockquote
[^2]: Second footnote
paragraph 2
"""
),
'<p>foo<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<p>bar<sup id="fnref:2"><a class="footnote-ref" href="#fn:2">2</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote\nline 2</p>\n'
'<ul>\n<li>list item</li>\n</ul>\n'
'<blockquote>\n<p>blockquote</p>\n</blockquote>\n'
'<p><a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'<li id="fn:2">\n'
'<p>Second footnote</p>\n'
'<p>paragraph 2 <a class="footnote-backref" href="#fnref:2"'
' title="Jump back to footnote 2 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_footnote_multple_complex_no_blank_line_between(self):
self.assertMarkdownRenders(
self.dedent(
"""
foo[^1]
bar[^2]
[^1]:
A Footnote
line 2
* list item
> blockquote
[^2]: Second footnote
paragraph 2
"""
),
'<p>foo<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<p>bar<sup id="fnref:2"><a class="footnote-ref" href="#fn:2">2</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote\nline 2</p>\n'
'<ul>\n<li>list item</li>\n</ul>\n'
'<blockquote>\n<p>blockquote</p>\n</blockquote>\n'
'<p><a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'<li id="fn:2">\n'
'<p>Second footnote</p>\n'
'<p>paragraph 2 <a class="footnote-backref" href="#fnref:2"'
' title="Jump back to footnote 2 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>'
)
def test_backlink_text(self):
"""Test backlink configuration."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'<p>paragraph<sup id="fnref:1"><a class="footnote-ref" href="#fn:1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn:1">\n'
'<p>A Footnote <a class="footnote-backref" href="#fnref:1"'
' title="Jump back to footnote 1 in the text">back</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>',
extension_configs={'footnotes': {'BACKLINK_TEXT': 'back'}}
)
def test_footnote_separator(self):
"""Test separator configuration."""
self.assertMarkdownRenders(
'paragraph[^1]\n\n[^1]: A Footnote',
'<p>paragraph<sup id="fnref-1"><a class="footnote-ref" href="#fn-1">1</a></sup></p>\n'
'<div class="footnote">\n'
'<hr />\n'
'<ol>\n'
'<li id="fn-1">\n'
'<p>A Footnote <a class="footnote-backref" href="#fnref-1"'
' title="Jump back to footnote 1 in the text">↩</a></p>\n'
'</li>\n'
'</ol>\n'
'</div>',
extension_configs={'footnotes': {'SEPARATOR': '-'}}
)
|
