Skip to content

fix: Include figure prefix in name before rendering text #966

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft

fix: Include figure prefix in name before rendering text #966

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fc90be2
fix: Include figure prefix in name before rendering text
kesara Feb 2, 2023
4a28467
fix: Update tjoin method include prefix before rendering
kesara Feb 3, 2023
48d5f5e
chore: Run yestests
kesara Aug 31, 2023
1924291
chore: Run yestests with the fix
kesara Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/valid/draft-miek-test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
intervaltree 3.1.0
Jinja2 3.1.2
lxml 4.9.3
platformdirs 3.9.1
platformdirs 3.10.0
pycountry 22.3.5
PyYAML 6.0.1
requests 2.31.0
Expand Down
8 changes: 4 additions & 4 deletions tests/valid/draft-miek-test.pages.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,8 +791,8 @@ A.1. A Very Long Title Considerations With Regards to the Already

Test a very long title.

A.1.1. S/MIME encrypted and signed over a simple message, Injected
Headers with hcp_minimal (+ Legacy Display)
A.1.1. S/MIME encrypted and signed over a simple message,
Injected Headers with hcp_minimal (+ Legacy Display)

Test long title edge case

Expand Down Expand Up @@ -1102,8 +1102,8 @@ A.10. Figure tests
This is a figure
This is a figure

Figure 4: This is the caption, with text in `typewriter`. Which
isnt converted to a <spanx> style, because this is copied as-is.
Figure 4: This is the caption, with text in `typewriter`. Which isnt
converted to a <spanx> style, because this is copied as-is.

And how a figure that is not centered, do to using figure and not
Figure.
Expand Down
8 changes: 4 additions & 4 deletions tests/valid/draft-miek-test.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -662,8 +662,8 @@ A.1. A Very Long Title Considerations With Regards to the Already

Test a very long title.

A.1.1. S/MIME encrypted and signed over a simple message, Injected
Headers with hcp_minimal (+ Legacy Display)
A.1.1. S/MIME encrypted and signed over a simple message,
Injected Headers with hcp_minimal (+ Legacy Display)

Test long title edge case

Expand Down Expand Up @@ -930,8 +930,8 @@ A.10. Figure tests
This is a figure
This is a figure

Figure 4: This is the caption, with text in `typewriter`. Which
isnt converted to a <spanx> style, because this is copied as-is.
Figure 4: This is the caption, with text in `typewriter`. Which isnt
converted to a <spanx> style, because this is copied as-is.

And how a figure that is not centered, do to using figure and not
Figure.
Expand Down
8 changes: 4 additions & 4 deletions tests/valid/draft-miek-test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -791,8 +791,8 @@ A.1. A Very Long Title Considerations With Regards to the Already

Test a very long title.

A.1.1. S/MIME encrypted and signed over a simple message, Injected
Headers with hcp_minimal (+ Legacy Display)
A.1.1. S/MIME encrypted and signed over a simple message,
Injected Headers with hcp_minimal (+ Legacy Display)

Test long title edge case

Expand Down Expand Up @@ -1102,8 +1102,8 @@ A.10. Figure tests
This is a figure
This is a figure

Figure 4: This is the caption, with text in `typewriter`. Which
isnt converted to a <spanx> style, because this is copied as-is.
Figure 4: This is the caption, with text in `typewriter`. Which isnt
converted to a <spanx> style, because this is copied as-is.

And how a figure that is not centered, do to using figure and not
Figure.
Expand Down
2 changes: 1 addition & 1 deletion tests/valid/draft-template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
intervaltree 3.1.0
Jinja2 3.1.2
lxml 4.9.3
platformdirs 3.9.1
platformdirs 3.10.0
pycountry 22.3.5
PyYAML 6.0.1
requests 2.31.0
Expand Down
12 changes: 6 additions & 6 deletions tests/valid/indexes.pages.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@


Network Working Group H. Person, Ed.
Internet-Draft August 29, 2023
Internet-Draft August 31, 2023
Intended status: Experimental
Expires: March 1, 2024
Expires: March 3, 2024


xml2rfc index tests
Expand All @@ -26,7 +26,7 @@ Status of This Memo
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."

This Internet-Draft will expire on March 1, 2024.
This Internet-Draft will expire on March 3, 2024.

Copyright Notice

Expand All @@ -53,7 +53,7 @@ Table of Contents



Person Expires March 1, 2024 [Page 1]
Person Expires March 3, 2024 [Page 1]

Internet-Draft xml2rfc index tests August 2023

Expand Down Expand Up @@ -109,7 +109,7 @@ Index



Person Expires March 1, 2024 [Page 2]
Person Expires March 3, 2024 [Page 2]

Internet-Draft xml2rfc index tests August 2023

Expand Down Expand Up @@ -165,4 +165,4 @@ Author's Address



Person Expires March 1, 2024 [Page 3]
Person Expires March 3, 2024 [Page 3]
6 changes: 3 additions & 3 deletions tests/valid/indexes.prepped.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8'?>
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="indexes-00" indexInclude="true" prepTime="2023-08-29T11:20:28" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="indexes-00" indexInclude="true" prepTime="2023-08-31T01:58:48" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.18.0 -->


Expand All @@ -20,7 +20,7 @@
</postal>
</address>
</author>
<date day="29" month="08" year="2023"/>
<date day="31" month="08" year="2023"/>
<boilerplate>
<section anchor="status-of-memo" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.1">
<name slugifiedName="name-status-of-this-memo">Status of This Memo</name>
Expand All @@ -41,7 +41,7 @@
material or to cite them other than as "work in progress."
</t>
<t indent="0" pn="section-boilerplate.1-4">
This Internet-Draft will expire on 1 March 2024.
This Internet-Draft will expire on 3 March 2024.
</t>
</section>
<section anchor="copyright" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.2">
Expand Down
6 changes: 3 additions & 3 deletions tests/valid/indexes.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@


Network Working Group H. Person, Ed.
Internet-Draft August 29, 2023
Internet-Draft August 31, 2023
Intended status: Experimental
Expires: March 1, 2024
Expires: March 3, 2024


xml2rfc index tests
Expand All @@ -26,7 +26,7 @@ Status of This Memo
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."

This Internet-Draft will expire on March 1, 2024.
This Internet-Draft will expire on March 3, 2024.

Copyright Notice

Expand Down
8 changes: 4 additions & 4 deletions tests/valid/indexes.v3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</tr></thead>
<tfoot><tr>
<td class="left">Person</td>
<td class="center">Expires March 1, 2024</td>
<td class="center">Expires March 3, 2024</td>
<td class="right">[Page]</td>
</tr></tfoot>
</table>
Expand All @@ -36,12 +36,12 @@
<dd class="internet-draft">indexes-00</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2023-08-29" class="published">August 29, 2023</time>
<time datetime="2023-08-31" class="published">August 31, 2023</time>
</dd>
<dt class="label-intended-status">Intended Status:</dt>
<dd class="intended-status">Experimental</dd>
<dt class="label-expires">Expires:</dt>
<dd class="expires"><time datetime="2024-03-01">March 1, 2024</time></dd>
<dd class="expires"><time datetime="2024-03-03">March 3, 2024</time></dd>
<dt class="label-authors">Author:</dt>
<dd class="authors">
<div class="author">
Expand Down Expand Up @@ -71,7 +71,7 @@ <h2 id="name-status-of-this-memo">
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
<p id="section-boilerplate.1-4">
This Internet-Draft will expire on March 1, 2024.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
This Internet-Draft will expire on March 3, 2024.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
</section>
</div>
<div id="copyright">
Expand Down
2 changes: 1 addition & 1 deletion tests/valid/manpage.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
xml2rfc(1) xml2rfc(1)
29 August 2023
31 August 2023


Xml2rfc Vocabulary Version 3 Schema
Expand Down
2 changes: 1 addition & 1 deletion tests/valid/rfc7911.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
intervaltree 3.1.0
Jinja2 3.1.2
lxml 4.9.3
platformdirs 3.9.1
platformdirs 3.10.0
pycountry 22.3.5
PyYAML 6.0.1
requests 2.31.0
Expand Down
14 changes: 7 additions & 7 deletions tests/valid/sourcecode.pages.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@


Network Working Group H. Person, Ed.
Internet-Draft August 29, 2023
Internet-Draft August 31, 2023
Intended status: Experimental
Expires: March 1, 2024
Expires: March 3, 2024


xml2rfc sourcecode tests
Expand All @@ -26,7 +26,7 @@ Status of This Memo
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."

This Internet-Draft will expire on March 1, 2024.
This Internet-Draft will expire on March 3, 2024.

Copyright Notice

Expand All @@ -53,7 +53,7 @@ Table of Contents



Person Expires March 1, 2024 [Page 1]
Person Expires March 3, 2024 [Page 1]

Internet-Draft xml2rfc sourcecode tests August 2023

Expand Down Expand Up @@ -109,7 +109,7 @@ Internet-Draft xml2rfc sourcecode tests August 2023



Person Expires March 1, 2024 [Page 2]
Person Expires March 3, 2024 [Page 2]

Internet-Draft xml2rfc sourcecode tests August 2023

Expand Down Expand Up @@ -165,7 +165,7 @@ Internet-Draft xml2rfc sourcecode tests August 2023



Person Expires March 1, 2024 [Page 3]
Person Expires March 3, 2024 [Page 3]

Internet-Draft xml2rfc sourcecode tests August 2023

Expand Down Expand Up @@ -221,4 +221,4 @@ Author's Address



Person Expires March 1, 2024 [Page 4]
Person Expires March 3, 2024 [Page 4]
6 changes: 3 additions & 3 deletions tests/valid/sourcecode.prepped.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='utf-8'?>
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="sourcecode-00" prepTime="2023-08-29T11:20:36" indexInclude="true" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="sourcecode-00" prepTime="2023-08-31T01:58:55" indexInclude="true" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.18.0 -->


Expand All @@ -20,7 +20,7 @@
</postal>
</address>
</author>
<date day="29" month="08" year="2023"/>
<date day="31" month="08" year="2023"/>
<boilerplate>
<section anchor="status-of-memo" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.1">
<name slugifiedName="name-status-of-this-memo">Status of This Memo</name>
Expand All @@ -41,7 +41,7 @@
material or to cite them other than as "work in progress."
</t>
<t indent="0" pn="section-boilerplate.1-4">
This Internet-Draft will expire on 1 March 2024.
This Internet-Draft will expire on 3 March 2024.
</t>
</section>
<section anchor="copyright" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.2">
Expand Down
6 changes: 3 additions & 3 deletions tests/valid/sourcecode.text
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@


Network Working Group H. Person, Ed.
Internet-Draft August 29, 2023
Internet-Draft August 31, 2023
Intended status: Experimental
Expires: March 1, 2024
Expires: March 3, 2024


xml2rfc sourcecode tests
Expand All @@ -26,7 +26,7 @@ Status of This Memo
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."

This Internet-Draft will expire on March 1, 2024.
This Internet-Draft will expire on March 3, 2024.

Copyright Notice

Expand Down
8 changes: 4 additions & 4 deletions tests/valid/sourcecode.v3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
</tr></thead>
<tfoot><tr>
<td class="left">Person</td>
<td class="center">Expires March 1, 2024</td>
<td class="center">Expires March 3, 2024</td>
<td class="right">[Page]</td>
</tr></tfoot>
</table>
Expand All @@ -36,12 +36,12 @@
<dd class="internet-draft">sourcecode-00</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2023-08-29" class="published">August 29, 2023</time>
<time datetime="2023-08-31" class="published">August 31, 2023</time>
</dd>
<dt class="label-intended-status">Intended Status:</dt>
<dd class="intended-status">Experimental</dd>
<dt class="label-expires">Expires:</dt>
<dd class="expires"><time datetime="2024-03-01">March 1, 2024</time></dd>
<dd class="expires"><time datetime="2024-03-03">March 3, 2024</time></dd>
<dt class="label-authors">Author:</dt>
<dd class="authors">
<div class="author">
Expand Down Expand Up @@ -71,7 +71,7 @@ <h2 id="name-status-of-this-memo">
time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress."<a href="#section-boilerplate.1-3" class="pilcrow">¶</a></p>
<p id="section-boilerplate.1-4">
This Internet-Draft will expire on March 1, 2024.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
This Internet-Draft will expire on March 3, 2024.<a href="#section-boilerplate.1-4" class="pilcrow">¶</a></p>
</section>
</div>
<div id="copyright">
Expand Down
16 changes: 12 additions & 4 deletions xml2rfc/writers/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,9 +529,14 @@ def tjoin(self, text, e, width, **kwargs):
if width < minwidth(text):
self.die(e, "Trying to render text in a too narrow column: width: %s, text: '%s'" % (width, text))
kwargs['hang'] = j.hang
etext = self.render(e, width, **kwargs)
itext = indent(etext, j.indent, j.hang)
if text:

if e.tag == "name":
e.text = f"{text}{j.join if e.text or len(e.getchildren()) > 0 else ''} {e.text or ''}"
etext = self.render(e, width, **kwargs)
text = indent(etext, j.indent, j.hang).lstrip(stripspace)
elif text:
etext = self.render(e, width, **kwargs)
itext = indent(etext, j.indent, j.hang)
if '\n' in j.join:
text += j.join + itext
elif j.join.strip(stripspace) and not itext.strip(stripspace):
Expand All @@ -540,7 +545,10 @@ def tjoin(self, text, e, width, **kwargs):
else:
text += j.join + itext.lstrip(stripspace)
else:
etext = self.render(e, width, **kwargs)
itext = indent(etext, j.indent, j.hang)
text = itext

return text

def ljoin(self, lines, e, width, **kwargs):
Expand Down Expand Up @@ -1737,7 +1745,7 @@ def render_figure(self, e, width, **kwargs):
pn = e.get('pn')
num = pn.split('-')[1].capitalize()
children = e.getchildren()
title = "Figure %s" % (num, )
title = f"Figure {num}"
if len(children) and children[0].tag == 'name':
name = children[0]
children = children[1:]
Expand Down