IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add helper function footnote_spot that determins where to put new footnotes.

Browse Source
This commit is contained in:
Roland Meister 2013-03-11 23:33:38 +01:00
parent f276939666
commit 43b9ff99c8
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
sphinx/builders/epub.py
View File

@ -133,6 +133,8 @@ _link_target_template = u' [%(uri)s]'
_footnote_label_template = u'#%d' _footnote_label_template = u'#%d'
_footnotes_rubric_name = u'Footnotes'
_css_link_target_class = u'link-target' _css_link_target_class = u'link-target'
# XXX These strings should be localized according to epub_language # XXX These strings should be localized according to epub_language
@ -308,12 +310,33 @@ class EpubBuilder(StandaloneHTMLBuilder):
doc.note_autofootnote(footnote) doc.note_autofootnote(footnote)
return footnote return footnote
def footnote_spot(tree):
"""Find or create a spot to place footnotes.
The function returns the tuple (parent, index)."""
# The code uses the following heuristic:
# a) place them after the last existing footnote
# b) place them after an (empty) Footnotes rubric
# c) create an empty Footnotes rubric at the end of the document
fns = tree.traverse(nodes.footnote)
if fns:
fn = fns[-1]
return fn.parent, fn.parent.index(fn) + 1
for node in tree.traverse(nodes.rubric):
if len(node.children) == 1 and \
node.children[0].astext() == _footnotes_rubric_name:
return node.parent, node.parent.index(node) + 1
doc = tree.traverse(nodes.document)[0]
rub = nodes.rubric()
rub.append(nodes.Text(_footnotes_rubric_name))
doc.append(rub)
return doc, doc.index(rub) + 1
if show_urls == 'no': if show_urls == 'no':
return return
if show_urls == 'footnote': if show_urls == 'footnote':
doc = tree.traverse(nodes.document)[0] doc = tree.traverse(nodes.document)[0]
# XXX search place to put footnotes fn_spot, fn_idx = footnote_spot(tree)
bottom = doc
nr = 1 nr = 1
for node in tree.traverse(nodes.reference): for node in tree.traverse(nodes.reference):
uri = node.get('refuri', '') uri = node.get('refuri', '')
@ -331,9 +354,10 @@ class EpubBuilder(StandaloneHTMLBuilder):
footnote_ref = make_footnote_ref(doc, label) footnote_ref = make_footnote_ref(doc, label)
node.parent.insert(idx, footnote_ref) node.parent.insert(idx, footnote_ref)
footnote = make_footnote(doc, label, uri) footnote = make_footnote(doc, label, uri)
bottom.append(footnote) fn_spot.insert(fn_idx, footnote)
footnote_ref['refid'] = footnote['ids'][0] footnote_ref['refid'] = footnote['ids'][0]
footnote.add_backref(footnote_ref['ids'][0]) footnote.add_backref(footnote_ref['ids'][0])
fn_idx += 1
def write_doc(self, docname, doctree): def write_doc(self, docname, doctree):
"""Write one document file. """Write one document file.