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

refactor: LaTeX: Assign node_ids to footnotemark and footnotetext

Browse Source 
On converting footnote nodes for the LaTeX writer, node_ids for footnote
nodes are almost cleared.  This copies the original node_id to the
footnotemark node (as refid) and footnotetext node (as node_id).  It's
useful to improve footnote features.
This commit is contained in:
Takeshi KOMIYA
2021-02-10 01:38:51 +09:00
parent 5935a4b152
commit 124edda281
1 changed files with 21 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
sphinx/builders/latex/transforms.py
View File

@@ -192,7 +192,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
headings having footnotes
<footnote_reference>
1
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
@@ -203,11 +203,9 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
<section>
<title>
headings having footnotes
<footnotemark>
<footnotemark refid="id1">
1
<footnotetext>
footnote body
<footnotetext>
<footnotetext ids="id1">
<label>
1
<paragraph>
@@ -222,7 +220,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
1
blah blah blah ...
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
@@ -231,7 +229,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
After::
blah blah blah
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
@@ -251,7 +249,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
1
blah blah blah ...
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
@@ -260,13 +258,13 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
After::
blah blah blah
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
blah blah blah
<footnotemark>
<footnotemark refid="id1">
1
blah blah blah ...
@@ -274,7 +272,7 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
Before::
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
@@ -291,26 +289,26 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
<table>
<title>
title having footnote_reference
<footnote_reference refid="1">
<footnote_reference refid="id1">
1
<tgroup>
<thead>
<row>
<entry>
header having footnote_reference
<footnote_reference refid="2">
<footnote_reference refid="id2">
2
<tbody>
<row>
...
<footnote ids="1">
<footnote ids="id1">
<label>
1
<paragraph>
footnote body
<footnote ids="2">
<footnote ids="id2">
<label>
2
<paragraph>
@@ -321,23 +319,23 @@ class LaTeXFootnoteTransform(SphinxPostTransform):
<table>
<title>
title having footnote_reference
<footnotemark>
<footnotemark refid="id1">
1
<tgroup>
<thead>
<row>
<entry>
header having footnote_reference
<footnotemark>
<footnotemark refid="id2">
2
<tbody>
<footnotetext>
<footnotetext ids="id1">
<label>
1
<paragraph>
footnote body
<footnotetext>
<footnotetext ids="id2">
<label>
2
<paragraph>
@@ -382,7 +380,7 @@ class LaTeXFootnoteVisitor(nodes.NodeVisitor):
self.restricted = None
pos = node.parent.index(node)
for i, footnote, in enumerate(self.pendings):
fntext = footnotetext('', *footnote.children)
fntext = footnotetext('', *footnote.children, ids=footnote['ids'])
node.parent.insert(pos + i + 1, fntext)
self.pendings = []
@@ -427,7 +425,7 @@ class LaTeXFootnoteVisitor(nodes.NodeVisitor):
def depart_table(self, node: nodes.table) -> None:
tbody = list(node.traverse(nodes.tbody))[0]
for footnote in reversed(self.table_footnotes):
fntext = footnotetext('', *footnote.children)
fntext = footnotetext('', *footnote.children, ids=footnote['ids'])
tbody.insert(0, fntext)
self.table_footnotes = []
@@ -442,13 +440,13 @@ class LaTeXFootnoteVisitor(nodes.NodeVisitor):
number = node.astext().strip()
docname = node['docname']
if self.restricted:
mark = footnotemark('', number)
mark = footnotemark('', number, refid=node['refid'])
node.replace_self(mark)
if (docname, number) not in self.appeared:
footnote = self.get_footnote_by_reference(node)
self.pendings.append(footnote)
elif (docname, number) in self.appeared:
mark = footnotemark('', number)
mark = footnotemark('', number, refid=node['refid'])
node.replace_self(mark)
else:
footnote = self.get_footnote_by_reference(node)