Skip to content

fix(html,pdf): Keep reference URL together #1229

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
kesara wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

fix(html,pdf): Keep reference URL together #1229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7732815
chore: Run yestests (pre-changes)
kesara Feb 28, 2025
4556948
fix(html,pdf): Keep reference URL together
kesara Feb 28, 2025
6e4655a
chore: Run yestests (post-changes)
kesara Feb 28, 2025
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
58 changes: 29 additions & 29 deletions tests/valid/docfile.html
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 14 additions & 11 deletions tests/valid/draft-miek-test.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
This version is adapted to work with "xml2rfc" version 2.x.

' name="description">
<meta content="xml2rfc 3.25.0" name="generator">
<meta content="xml2rfc 3.27.0" name="generator">
<meta content="RFC" name="keyword">
<meta content="Request for Comments" name="keyword">
<meta content="I-D" name="keyword">
Expand All @@ -26,21 +26,20 @@
<meta content="Extensible Markup Language" name="keyword">
<meta content="draft-gieben-writing-rfcs-pandoc-02" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.25.0
xml2rfc 3.27.0
Python 3.12.7
ConfigArgParse 1.7
google-i18n-address 3.1.1
intervaltree 3.1.0
Jinja2 3.1.4
lxml 5.3.0
Jinja2 3.1.5
lxml 5.3.1
platformdirs 4.3.6
pycountry 24.6.1
pydyf 0.9.0
PyYAML 6.0.2
requests 2.32.3
setuptools 75.5.0
setuptools 75.8.2
wcwidth 0.2.13
weasyprint 61.2
weasyprint 64.1
-->
<link href="draft-miek-test.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
Expand Down Expand Up @@ -417,7 +416,7 @@
/* Fix PDF info block run off issue */
@media print {
#identifiers dd {
float: none;
max-width: 100%;
}
}
#identifiers .authors .author {
Expand Down Expand Up @@ -481,6 +480,10 @@
margin-bottom: 0.25em;
}

.references .link {
display: inline-block;
}

/* index */
.index ul {
margin: 0 0 0 1em;
Expand Down Expand Up @@ -2490,7 +2493,7 @@ <h3 id="name-informative-references">
<dl class="references">
<dt id="VIM">[VIM]</dt>
<dd>
<span class="refAuthor">Gieben, R.</span>, <span class="refTitle">"VIM syntax file for RFCs and I-Ds"</span>, <time datetime="2012-10" class="refDate">October 2012</time>, <span>&lt;<a href="http://github.com/miekg/rfc">http://github.com/miekg/rfc</a>&gt;</span>. </dd>
<span class="refAuthor">Gieben, R.</span>, <span class="refTitle">"VIM syntax file for RFCs and I-Ds"</span>, <time datetime="2012-10" class="refDate">October 2012</time>, <span class="link">&lt;<a href="http://github.com/miekg/rfc">http://github.com/miekg/rfc</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand All @@ -2501,11 +2504,11 @@ <h3 id="name-normative-references">
<dl class="references">
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">ftp://ftp.isi.edu/in-notes/rfc2119.txt</a>&gt;</span>. </dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span class="link">&lt;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">ftp://ftp.isi.edu/in-notes/rfc2119.txt</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC4641">[RFC4641]</dt>
<dd>
<span class="refAuthor">Kolkman, O.</span> and <span class="refAuthor">R. Gieben</span>, <span class="refTitle">"DNSSEC Operational Practices"</span>, <span class="seriesInfo">RFC 4641</span>, <time datetime="2006-09" class="refDate">September 2006</time>, <span>&lt;<a href="http://www.rfc-editor.org/rfc/rfc4641.txt">http://www.rfc-editor.org/rfc/rfc4641.txt</a>&gt;</span>. </dd>
<span class="refAuthor">Kolkman, O.</span> and <span class="refAuthor">R. Gieben</span>, <span class="refTitle">"DNSSEC Operational Practices"</span>, <span class="seriesInfo">RFC 4641</span>, <time datetime="2006-09" class="refDate">September 2006</time>, <span class="link">&lt;<a href="http://www.rfc-editor.org/rfc/rfc4641.txt">http://www.rfc-editor.org/rfc/rfc4641.txt</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand Down
8 changes: 4 additions & 4 deletions tests/valid/draft-miek-test.v3.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
This version is adapted to work with "xml2rfc" version 2.x.

' name="description">
<meta content="xml2rfc 3.25.0" name="generator">
<meta content="xml2rfc 3.27.0" name="generator">
<meta content="RFC" name="keyword">
<meta content="Request for Comments" name="keyword">
<meta content="I-D" name="keyword">
Expand Down Expand Up @@ -1301,7 +1301,7 @@ <h3 id="name-informative-references">
<dl class="references">
<dt id="VIM">[VIM]</dt>
<dd>
<span class="refAuthor">Gieben, R.</span>, <span class="refTitle">"VIM syntax file for RFCs and I-Ds"</span>, <time datetime="2012-10" class="refDate">October 2012</time>, <span>&lt;<a href="http://github.com/miekg/rfc">http://github.com/miekg/rfc</a>&gt;</span>. </dd>
<span class="refAuthor">Gieben, R.</span>, <span class="refTitle">"VIM syntax file for RFCs and I-Ds"</span>, <time datetime="2012-10" class="refDate">October 2012</time>, <span class="link">&lt;<a href="http://github.com/miekg/rfc">http://github.com/miekg/rfc</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand All @@ -1312,11 +1312,11 @@ <h3 id="name-normative-references">
<dl class="references">
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">ftp://ftp.isi.edu/in-notes/rfc2119.txt</a>&gt;</span>. </dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span class="link">&lt;<a href="ftp://ftp.isi.edu/in-notes/rfc2119.txt">ftp://ftp.isi.edu/in-notes/rfc2119.txt</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC4641">[RFC4641]</dt>
<dd>
<span class="refAuthor">Kolkman, O.</span> and <span class="refAuthor">R. Gieben</span>, <span class="refTitle">"DNSSEC Operational Practices"</span>, <span class="seriesInfo">RFC 4641</span>, <time datetime="2006-09" class="refDate">September 2006</time>, <span>&lt;<a href="http://www.rfc-editor.org/rfc/rfc4641.txt">http://www.rfc-editor.org/rfc/rfc4641.txt</a>&gt;</span>. </dd>
<span class="refAuthor">Kolkman, O.</span> and <span class="refAuthor">R. Gieben</span>, <span class="refTitle">"DNSSEC Operational Practices"</span>, <span class="seriesInfo">RFC 4641</span>, <time datetime="2006-09" class="refDate">September 2006</time>, <span class="link">&lt;<a href="http://www.rfc-editor.org/rfc/rfc4641.txt">http://www.rfc-editor.org/rfc/rfc4641.txt</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand Down
37 changes: 20 additions & 17 deletions tests/valid/draft-template.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,24 @@
Insert an abstract: MANDATORY. This template is for creating an
Internet Draft.
" name="description">
<meta content="xml2rfc 3.25.0" name="generator">
<meta content="xml2rfc 3.27.0" name="generator">
<meta content="template" name="keyword">
<meta content="draft-ietf-xml2rfc-template-05" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.25.0
xml2rfc 3.27.0
Python 3.12.7
ConfigArgParse 1.7
google-i18n-address 3.1.1
intervaltree 3.1.0
Jinja2 3.1.4
lxml 5.3.0
Jinja2 3.1.5
lxml 5.3.1
platformdirs 4.3.6
pycountry 24.6.1
pydyf 0.9.0
PyYAML 6.0.2
requests 2.32.3
setuptools 75.5.0
setuptools 75.8.2
wcwidth 0.2.13
weasyprint 61.2
weasyprint 64.1
-->
<link href="draft-template.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
Expand Down Expand Up @@ -406,7 +405,7 @@
/* Fix PDF info block run off issue */
@media print {
#identifiers dd {
float: none;
max-width: 100%;
}
}
#identifiers .authors .author {
Expand Down Expand Up @@ -470,6 +469,10 @@
margin-bottom: 0.25em;
}

.references .link {
display: inline-block;
}

/* index */
.index ul {
margin: 0 0 0 1em;
Expand Down Expand Up @@ -2099,7 +2102,7 @@ <h3 id="name-normative-references">
<dd class="break"></dd>
<dt id="RFC2119">[RFC2119]</dt>
<dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;</span>. </dd>
<span class="refAuthor">Bradner, S.</span>, <span class="refTitle">"Key words for use in RFCs to Indicate Requirement Levels"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 2119</span>, <span class="seriesInfo">DOI 10.17487/RFC2119</span>, <time datetime="1997-03" class="refDate">March 1997</time>, <span class="link">&lt;<a href="https://www.rfc-editor.org/info/rfc2119">https://www.rfc-editor.org/info/rfc2119</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand All @@ -2110,35 +2113,35 @@ <h3 id="name-informative-references">
<dl class="references">
<dt id="DOI_10.1145_2975159">[DOI_10.1145_2975159]</dt>
<dd>
<span class="refAuthor">Singh, A.</span>, <span class="refAuthor">Ong, J.</span>, <span class="refAuthor">Agarwal, A.</span>, <span class="refAuthor">Anderson, G.</span>, <span class="refAuthor">Armistead, A.</span>, <span class="refAuthor">Bannon, R.</span>, <span class="refAuthor">Boving, S.</span>, <span class="refAuthor">Desai, G.</span>, <span class="refAuthor">Felderman, B.</span>, <span class="refAuthor">Germano, P.</span>, <span class="refAuthor">Kanagala, A.</span>, <span class="refAuthor">Liu, H.</span>, <span class="refAuthor">Provost, J.</span>, <span class="refAuthor">Simmons, J.</span>, <span class="refAuthor">Tanda, E.</span>, <span class="refAuthor">Wanderer, J.</span>, <span class="refAuthor">Hölzle, U.</span>, <span class="refAuthor">Stuart, S.</span>, <span class="refAuthor">Vahdat, A.</span>, and <span class="refAuthor">Association for Computing Machinery (ACM)</span>, <span class="refTitle">"Jupiter rising"</span>, <span class="refContent">Communications of the ACM, vol. 59, no. 9, pp. 88-97</span>, <span class="seriesInfo">DOI 10.1145/2975159</span>, <time datetime="2016-08-24" class="refDate">24 August 2016</time>, <span>&lt;<a href="https://doi.org/10.1145/2975159">https://doi.org/10.1145/2975159</a>&gt;</span>. </dd>
<span class="refAuthor">Singh, A.</span>, <span class="refAuthor">Ong, J.</span>, <span class="refAuthor">Agarwal, A.</span>, <span class="refAuthor">Anderson, G.</span>, <span class="refAuthor">Armistead, A.</span>, <span class="refAuthor">Bannon, R.</span>, <span class="refAuthor">Boving, S.</span>, <span class="refAuthor">Desai, G.</span>, <span class="refAuthor">Felderman, B.</span>, <span class="refAuthor">Germano, P.</span>, <span class="refAuthor">Kanagala, A.</span>, <span class="refAuthor">Liu, H.</span>, <span class="refAuthor">Provost, J.</span>, <span class="refAuthor">Simmons, J.</span>, <span class="refAuthor">Tanda, E.</span>, <span class="refAuthor">Wanderer, J.</span>, <span class="refAuthor">Hölzle, U.</span>, <span class="refAuthor">Stuart, S.</span>, <span class="refAuthor">Vahdat, A.</span>, and <span class="refAuthor">Association for Computing Machinery (ACM)</span>, <span class="refTitle">"Jupiter rising"</span>, <span class="refContent">Communications of the ACM, vol. 59, no. 9, pp. 88-97</span>, <span class="seriesInfo">DOI 10.1145/2975159</span>, <time datetime="2016-08-24" class="refDate">24 August 2016</time>, <span class="link">&lt;<a href="https://doi.org/10.1145/2975159">https://doi.org/10.1145/2975159</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="DOMINATION">[DOMINATION]</dt>
<dd>
<span class="refAuthor">Mad Dominators, Inc.</span>, <span class="refTitle">"Ultimate Plan for Taking Over the World"</span>, <time datetime="1984" class="refDate">1984</time>, <span>&lt;<a href="http://www.example.com/dominator.html">http://www.example.com/dominator.html</a>&gt;</span>. </dd>
<span class="refAuthor">Mad Dominators, Inc.</span>, <span class="refTitle">"Ultimate Plan for Taking Over the World"</span>, <time datetime="1984" class="refDate">1984</time>, <span class="link">&lt;<a href="http://www.example.com/dominator.html">http://www.example.com/dominator.html</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="I-D.iab-xml2rfc">[I-D.iab-xml2rfc]</dt>
<dd>
<span class="refAuthor">Hoffman, P. E.</span>, <span class="refTitle">"The "xml2rfc" Version 3 Vocabulary"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-iab-xml2rfc-04</span>, <time datetime="2016-06-22" class="refDate">22 June 2016</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-iab-xml2rfc-04">https://datatracker.ietf.org/doc/html/draft-iab-xml2rfc-04</a>&gt;</span>. </dd>
<span class="refAuthor">Hoffman, P. E.</span>, <span class="refTitle">"The "xml2rfc" Version 3 Vocabulary"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-iab-xml2rfc-04</span>, <time datetime="2016-06-22" class="refDate">22 June 2016</time>, <span class="link">&lt;<a href="https://datatracker.ietf.org/doc/html/draft-iab-xml2rfc-04">https://datatracker.ietf.org/doc/html/draft-iab-xml2rfc-04</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="I-D.iab-xml2rfcv2">[I-D.iab-xml2rfcv2]</dt>
<dd>
<span class="refAuthor">Reschke, J.</span>, <span class="refTitle">"The 'XML2RFC' version 2 Vocabulary"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-iab-xml2rfcv2-00</span>, <time datetime="2015-01-09" class="refDate">9 January 2015</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-iab-xml2rfcv2-00">https://datatracker.ietf.org/doc/html/draft-iab-xml2rfcv2-00</a>&gt;</span>. </dd>
<span class="refAuthor">Reschke, J.</span>, <span class="refTitle">"The 'XML2RFC' version 2 Vocabulary"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-iab-xml2rfcv2-00</span>, <time datetime="2015-01-09" class="refDate">9 January 2015</time>, <span class="link">&lt;<a href="https://datatracker.ietf.org/doc/html/draft-iab-xml2rfcv2-00">https://datatracker.ietf.org/doc/html/draft-iab-xml2rfcv2-00</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="I-D.narten-iana-considerations-rfc2434bis">[I-D.narten-iana-considerations-rfc2434bis]</dt>
<dd>
<span class="refAuthor">Alvestrand, H. T.</span> and <span class="refAuthor">T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-narten-iana-considerations-rfc2434bis-09</span>, <time datetime="2008-03-26" class="refDate">26 March 2008</time>, <span>&lt;<a href="https://datatracker.ietf.org/doc/html/draft-narten-iana-considerations-rfc2434bis-09">https://datatracker.ietf.org/doc/html/draft-narten-iana-considerations-rfc2434bis-09</a>&gt;</span>. </dd>
<span class="refAuthor">Alvestrand, H. T.</span> and <span class="refAuthor">T. Narten</span>, <span class="refTitle">"Guidelines for Writing an IANA Considerations Section in RFCs"</span>, <span class="refContent">Work in Progress</span>, <span class="seriesInfo">Internet-Draft, draft-narten-iana-considerations-rfc2434bis-09</span>, <time datetime="2008-03-26" class="refDate">26 March 2008</time>, <span class="link">&lt;<a href="https://datatracker.ietf.org/doc/html/draft-narten-iana-considerations-rfc2434bis-09">https://datatracker.ietf.org/doc/html/draft-narten-iana-considerations-rfc2434bis-09</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC2629">[RFC2629]</dt>
<dd>
<span class="refAuthor">Rose, M.</span>, <span class="refTitle">"Writing I-Ds and RFCs using XML"</span>, <span class="seriesInfo">RFC 2629</span>, <span class="seriesInfo">DOI 10.17487/RFC2629</span>, <time datetime="1999-06" class="refDate">June 1999</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc2629">https://www.rfc-editor.org/info/rfc2629</a>&gt;</span>. </dd>
<span class="refAuthor">Rose, M.</span>, <span class="refTitle">"Writing I-Ds and RFCs using XML"</span>, <span class="seriesInfo">RFC 2629</span>, <span class="seriesInfo">DOI 10.17487/RFC2629</span>, <time datetime="1999-06" class="refDate">June 1999</time>, <span class="link">&lt;<a href="https://www.rfc-editor.org/info/rfc2629">https://www.rfc-editor.org/info/rfc2629</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="RFC3552">[RFC3552]</dt>
<dd>
<span class="refAuthor">Rescorla, E.</span> and <span class="refAuthor">B. Korver</span>, <span class="refTitle">"Guidelines for Writing RFC Text on Security Considerations"</span>, <span class="seriesInfo">BCP 72</span>, <span class="seriesInfo">RFC 3552</span>, <span class="seriesInfo">DOI 10.17487/RFC3552</span>, <time datetime="2003-07" class="refDate">July 2003</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc3552">https://www.rfc-editor.org/info/rfc3552</a>&gt;</span>. </dd>
<span class="refAuthor">Rescorla, E.</span> and <span class="refAuthor">B. Korver</span>, <span class="refTitle">"Guidelines for Writing RFC Text on Security Considerations"</span>, <span class="seriesInfo">BCP 72</span>, <span class="seriesInfo">RFC 3552</span>, <span class="seriesInfo">DOI 10.17487/RFC3552</span>, <time datetime="2003-07" class="refDate">July 2003</time>, <span class="link">&lt;<a href="https://www.rfc-editor.org/info/rfc3552">https://www.rfc-editor.org/info/rfc3552</a>&gt;</span>. </dd>
<dd class="break"></dd>
<dt id="SHARING">[SHARING]</dt>
<dd>
<span class="refAuthor">Sesame Street</span>, <span class="refTitle">"I Learned to Share in Kindergarten"</span>, <time datetime="1972" class="refDate">1972</time>, <span>&lt;<a href="http://www.example.com/sharing.html">http://www.example.com/sharing.html</a>&gt;</span>. </dd>
<span class="refAuthor">Sesame Street</span>, <span class="refTitle">"I Learned to Share in Kindergarten"</span>, <time datetime="1972" class="refDate">1972</time>, <span class="link">&lt;<a href="http://www.example.com/sharing.html">http://www.example.com/sharing.html</a>&gt;</span>. </dd>
<dd class="break"></dd>
</dl>
</section>
Expand Down
Loading