Skip to content

Commit

Permalink
revert: #1089 (Treat referencegroup entries similarly to reference en…
Browse files Browse the repository at this point in the history
…tries) (#1098)

* revert: #1089 (Treat referencegroup entries similarly to reference entries)

Revert "fix: Treat referencegroup entries similarly to reference entries (#1089)"

This reverts commit 8f14554.

Fixes #1097

* test: Add a single-rfc subseries test
  • Loading branch information
kesara authored Feb 6, 2024
1 parent 4cdfbbf commit f319275
Show file tree
Hide file tree
Showing 19 changed files with 126 additions and 95 deletions.
1 change: 1 addition & 0 deletions tests/input/draft-v3-features.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2734,6 +2734,7 @@ foo = bar
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.5591.xml"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.6353.xml"/>
</referencegroup>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="https://bib.ietf.org/public/rfc/bibxml-rfcsubseries/reference.BCP.45.xml"/>
<reference anchor="STPETER">
<front>
<title ascii="STPETER's document">&#5082;&#5026;&#5045;&#5036;&#5026;&#5036;&#5074;'s document</title>
Expand Down
20 changes: 10 additions & 10 deletions tests/valid/docfile.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@
<meta charset="utf-8">
<meta content="Cherokee,Common,Greek,Latin" name="scripts">
<meta content="initial-scale=1.0" name="viewport">
<title>Xml2rfc Vocabulary Version 3 Schema xml2rfc release 3.19.2</title>
<title>Xml2rfc Vocabulary Version 3 Schema xml2rfc release 3.19.3</title>
<meta content="xml2rfc(1)" name="author">
<meta content="
This document provides information about the XML schema implemented in this release of xml2rfc, and the individual elements of that schema. The document is generated from the RNG schema file that is part of the xml2rfc distribution, so schema information in this document should always be in sync with the schema in actual use. The textual descriptions depend on manual updates in order to reflect the implementation.
" name="description">
<meta content="xml2rfc 3.19.2" name="generator">
<meta content="xml2rfc-docs-3.19.2" name="ietf.draft">
<meta content="xml2rfc 3.19.3" name="generator">
<meta content="xml2rfc-docs-3.19.3" name="ietf.draft">
<link href="tests/out/docfile.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
<link href="xml2rfc.css" rel="stylesheet">
Expand All @@ -24,7 +24,7 @@
<thead><tr>
<td class="left"></td>
<td class="center">Xml2rfc Vocabulary V3 Schema</td>
<td class="right">January 2024</td>
<td class="right">February 2024</td>
</tr></thead>
<tfoot><tr>
<td class="left">xml2rfc(1)</td>
Expand All @@ -39,7 +39,7 @@
<dd class="workgroup">xml2rfc(1)</dd>
<dt class="label-published">Published:</dt>
<dd class="published">
<time datetime="2024-01-31" class="published">31 January 2024</time>
<time datetime="2024-02-06" class="published">6 February 2024</time>
</dd>
<dt class="label-authors">Author:</dt>
<dd class="authors">
Expand All @@ -49,7 +49,7 @@
</dd>
</dl>
</div>
<h1 id="title">Xml2rfc Vocabulary Version 3 Schema<br>xml2rfc release 3.19.2</h1>
<h1 id="title">Xml2rfc Vocabulary Version 3 Schema<br>xml2rfc release 3.19.3</h1>
<section id="section-abstract">
<h2 id="abstract"><a href="#abstract" class="selfRef">Abstract</a></h2>
<p id="section-abstract-1">
Expand Down Expand Up @@ -371,7 +371,7 @@ <h2 id="name-introduction">
<p id="section-1-5">
The latest version of this documentation is available in HTML form at <span><a href="https://ietf-tools.github.io/xml2rfc/">https://ietf-tools.github.io/xml2rfc/</a></span>.<a href="#section-1-5" class="pilcrow"></a></p>
<p id="section-1-6">
This documentation applies to xml2rfc version 3.19.2.<a href="#section-1-6" class="pilcrow"></a></p>
This documentation applies to xml2rfc version 3.19.3.<a href="#section-1-6" class="pilcrow"></a></p>
</section>
<section id="section-2">
<h2 id="name-schema-version-3-elements">
Expand Down Expand Up @@ -4226,9 +4226,9 @@ <h2 id="name-references-2">
<dt id="BCP14">[BCP14]</dt>
<dd>
<div class="refInstance" id="RFC2119">
<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>. </div>
<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>. </div>
<div class="refInstance" id="RFC8174">
<span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <span class="seriesInfo">DOI 10.17487/RFC8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc8174">https://www.rfc-editor.org/info/rfc8174</a>&gt;</span>. </div>
<span class="refAuthor">Leiba, B.</span>, <span class="refTitle">"Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words"</span>, <span class="seriesInfo">BCP 14</span>, <span class="seriesInfo">RFC 8174</span>, <time datetime="2017-05" class="refDate">May 2017</time>. </div>
<span>&lt;<a href="https://www.rfc-editor.org/bcp/bcp14.txt">https://www.rfc-editor.org/bcp/bcp14.txt</a>&gt;</span>
</dd>
<dd class="break"></dd>
Expand Down Expand Up @@ -6366,7 +6366,7 @@ <h2 id="name-xml2rfc-documentation-templ">
<p id="appendix-D-1">

The following variables are available for use in an xml2rfc
manpage Jinja2 template, as of xml2rfc version 3.19.2:<a href="#appendix-D-1" class="pilcrow"></a></p>
manpage Jinja2 template, as of xml2rfc version 3.19.3:<a href="#appendix-D-1" class="pilcrow"></a></p>
<span class="break"></span><dl class="dlNewline" id="appendix-D-2">
<dt id="appendix-D-2.1">{{ bare_latin_tags }}:</dt>
<dd style="margin-left: 1.5em" id="appendix-D-2.2"></dd>
Expand Down
4 changes: 2 additions & 2 deletions tests/valid/draft-miek-test.html
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.19.2" name="generator">
<meta content="xml2rfc 3.19.3" name="generator">
<meta content="RFC" name="keyword">
<meta content="Request for Comments" name="keyword">
<meta content="I-D" name="keyword">
Expand All @@ -26,7 +26,7 @@
<meta content="Extensible Markup Language" name="keyword">
<meta content="draft-gieben-writing-rfcs-pandoc-02" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.19.2
xml2rfc 3.19.3
Python 3.11.7
ConfigArgParse 1.7
google-i18n-address 3.1.0
Expand Down
4 changes: 2 additions & 2 deletions tests/valid/draft-template.html
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
Insert an abstract: MANDATORY. This template is for creating an
Internet Draft.
" name="description">
<meta content="xml2rfc 3.19.2" name="generator">
<meta content="xml2rfc 3.19.3" name="generator">
<meta content="template" name="keyword">
<meta content="draft-ietf-xml2rfc-template-05" name="ietf.draft">
<!-- Generator version information:
xml2rfc 3.19.2
xml2rfc 3.19.3
Python 3.11.7
ConfigArgParse 1.7
google-i18n-address 3.1.0
Expand Down
21 changes: 19 additions & 2 deletions tests/valid/draft-v3-features.prepped.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?xml version='1.0' encoding='utf-8'?>
<rfc version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="draft-v3-features" indexInclude="true" prepTime="2023-10-11T14:25:18" scripts="Cherokee,Common,Cyrillic,Greek,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.18.1 -->
<rfc version="3" sortRefs="true" category="exp" submissionType="independent" ipr="trust200902" docName="draft-v3-features" indexInclude="true" prepTime="2024-02-06T21:30:12" scripts="Cherokee,Common,Cyrillic,Greek,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.19.3 -->



Expand Down Expand Up @@ -3933,6 +3933,23 @@ foo = bar
<refcontent>additional prose goes <em>here</em></refcontent>
<annotation>Due to a <tt>&lt;displayreference&gt;</tt> element, this should be listed as "<xref target="REFTEST" derivedContent="0REFTEST"/>".</annotation>
</reference>
<referencegroup anchor="BCP45" target="https://www.rfc-editor.org/info/bcp45" xml:base="https://bib.ietf.org/public/rfc/bibxml-rfcsubseries/reference.BCP.45.xml" derivedAnchor="BCP45">
<reference anchor="RFC9245" target="https://www.rfc-editor.org/info/rfc9245" quoteTitle="true">
<front>
<title>IETF Discussion List Charter</title>
<author fullname="L. Eggert" initials="L." surname="Eggert"/>
<author fullname="S. Harris" initials="S." surname="Harris"/>
<date month="June" year="2022"/>
<abstract>
<t indent="0">The Internet Engineering Task Force (IETF) discussion mailing list furthers the development and specification of Internet technology through the general discussion of technical, procedural, operational, and other topics for which no dedicated mailing lists exist. As this is the most general IETF mailing list, considerable latitude in terms of topics is allowed, but there are posts and topics that are unsuitable for this mailing list. This document defines the charter for the IETF discussion list and explains its scope.</t>
<t indent="0">This document obsoletes RFC 3005 and updates RFC 3683.</t>
</abstract>
</front>
<seriesInfo name="BCP" value="45"/>
<seriesInfo name="RFC" value="9245"/>
<seriesInfo name="DOI" value="10.17487/RFC9245"/>
</reference>
</referencegroup>
<reference anchor="DUP" quoteTitle="true" derivedAnchor="DUP">
<front>
<title>Reference Duplicate Test</title>
Expand Down
17 changes: 9 additions & 8 deletions tests/valid/draft-v3-features.text
Original file line number Diff line number Diff line change
Expand Up @@ -1360,6 +1360,11 @@ Table of Contents
_here_, November 2014. Due to a <displayreference>
element, this should be listed as "[0REFTEST]".

[BCP45] Eggert, L. and S. Harris, "IETF Discussion List Charter",
BCP 45, RFC 9245, June 2022.

<https://www.rfc-editor.org/info/bcp45>

[DUP] Reschke, J., "Reference Duplicate Test", July 2016.

[DUP] Reschke, J., "Another Reference Duplicate Test", July
Expand All @@ -1382,23 +1387,19 @@ Table of Contents

[STD78] Schoenwaelder, J., "Simple Network Management Protocol
(SNMP) Context EngineID Discovery", STD 78, RFC 5343,
DOI 10.17487/RFC5343, September 2008,
<https://www.rfc-editor.org/info/rfc5343>.
September 2008.

Harrington, D. and J. Schoenwaelder, "Transport Subsystem
for the Simple Network Management Protocol (SNMP)",
STD 78, RFC 5590, DOI 10.17487/RFC5590, June 2009,
<https://www.rfc-editor.org/info/rfc5590>.
STD 78, RFC 5590, June 2009.

Harrington, D. and W. Hardaker, "Transport Security Model
for the Simple Network Management Protocol (SNMP)",
STD 78, RFC 5591, DOI 10.17487/RFC5591, June 2009,
<https://www.rfc-editor.org/info/rfc5591>.
STD 78, RFC 5591, June 2009.

Hardaker, W., "Transport Layer Security (TLS) Transport
Model for the Simple Network Management Protocol (SNMP)",
STD 78, RFC 6353, DOI 10.17487/RFC6353, July 2011,
<https://www.rfc-editor.org/info/rfc6353>.
STD 78, RFC 6353, July 2011.

<https://www.rfc-editor.org/info/std78>

Expand Down
17 changes: 12 additions & 5 deletions tests/valid/draft-v3-features.v3.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
This document tests features introduced in xml2rfc v3 vocabulary.
" name="description">
<meta content="xml2rfc 3.19.1" name="generator">
<meta content="xml2rfc 3.19.3" name="generator">
<meta content="draft-v3-features" name="ietf.draft">
<link href="tests/input/draft-v3-features.xml" rel="alternate" type="application/rfc+xml">
<link href="#copyright" rel="license">
Expand Down Expand Up @@ -4967,6 +4967,13 @@ <h2 id="name-some-references">
<span class="refAuthor">Reschke, J.</span>, <span class="refTitle">"Reference Test"</span>, <span class="refContent">additional prose goes <em>here</em></span>, <time datetime="2014-11" class="refDate">November 2014</time>. <span class="annotation">Due to a <code>&lt;displayreference&gt;</code> element, this should be listed as "<span>[<a href="#REFTEST" class="cite xref">0REFTEST</a>]</span>".</span>
</dd>
<dd class="break"></dd>
<dt id="BCP45">[BCP45]</dt>
<dd>
<div class="refInstance" id="RFC9245">
<span class="refAuthor">Eggert, L.</span> and <span class="refAuthor">S. Harris</span>, <span class="refTitle">"IETF Discussion List Charter"</span>, <span class="seriesInfo">BCP 45</span>, <span class="seriesInfo">RFC 9245</span>, <time datetime="2022-06" class="refDate">June 2022</time>. </div>
<span>&lt;<a href="https://www.rfc-editor.org/info/bcp45">https://www.rfc-editor.org/info/bcp45</a>&gt;</span>
</dd>
<dd class="break"></dd>
<dt id="DUP">[DUP]</dt>
<dd>
<span class="refAuthor">Reschke, J.</span>, <span class="refTitle">"Reference Duplicate Test"</span>, <time datetime="2016-07" class="refDate">July 2016</time>. </dd>
Expand All @@ -4992,13 +4999,13 @@ <h2 id="name-some-references">
<dt id="STD78">[STD78]</dt>
<dd>
<div class="refInstance" id="RFC5343">
<span class="refAuthor">Schoenwaelder, J.</span>, <span class="refTitle">"Simple Network Management Protocol (SNMP) Context EngineID Discovery"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5343</span>, <span class="seriesInfo">DOI 10.17487/RFC5343</span>, <time datetime="2008-09" class="refDate">September 2008</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc5343">https://www.rfc-editor.org/info/rfc5343</a>&gt;</span>. </div>
<span class="refAuthor">Schoenwaelder, J.</span>, <span class="refTitle">"Simple Network Management Protocol (SNMP) Context EngineID Discovery"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5343</span>, <time datetime="2008-09" class="refDate">September 2008</time>. </div>
<div class="refInstance" id="RFC5590">
<span class="refAuthor">Harrington, D.</span> and <span class="refAuthor">J. Schoenwaelder</span>, <span class="refTitle">"Transport Subsystem for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5590</span>, <span class="seriesInfo">DOI 10.17487/RFC5590</span>, <time datetime="2009-06" class="refDate">June 2009</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc5590">https://www.rfc-editor.org/info/rfc5590</a>&gt;</span>. </div>
<span class="refAuthor">Harrington, D.</span> and <span class="refAuthor">J. Schoenwaelder</span>, <span class="refTitle">"Transport Subsystem for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5590</span>, <time datetime="2009-06" class="refDate">June 2009</time>. </div>
<div class="refInstance" id="RFC5591">
<span class="refAuthor">Harrington, D.</span> and <span class="refAuthor">W. Hardaker</span>, <span class="refTitle">"Transport Security Model for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5591</span>, <span class="seriesInfo">DOI 10.17487/RFC5591</span>, <time datetime="2009-06" class="refDate">June 2009</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc5591">https://www.rfc-editor.org/info/rfc5591</a>&gt;</span>. </div>
<span class="refAuthor">Harrington, D.</span> and <span class="refAuthor">W. Hardaker</span>, <span class="refTitle">"Transport Security Model for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 5591</span>, <time datetime="2009-06" class="refDate">June 2009</time>. </div>
<div class="refInstance" id="RFC6353">
<span class="refAuthor">Hardaker, W.</span>, <span class="refTitle">"Transport Layer Security (TLS) Transport Model for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 6353</span>, <span class="seriesInfo">DOI 10.17487/RFC6353</span>, <time datetime="2011-07" class="refDate">July 2011</time>, <span>&lt;<a href="https://www.rfc-editor.org/info/rfc6353">https://www.rfc-editor.org/info/rfc6353</a>&gt;</span>. </div>
<span class="refAuthor">Hardaker, W.</span>, <span class="refTitle">"Transport Layer Security (TLS) Transport Model for the Simple Network Management Protocol (SNMP)"</span>, <span class="seriesInfo">STD 78</span>, <span class="seriesInfo">RFC 6353</span>, <time datetime="2011-07" class="refDate">July 2011</time>. </div>
<span>&lt;<a href="https://www.rfc-editor.org/info/std78">https://www.rfc-editor.org/info/std78</a>&gt;</span>
</dd>
<dd class="break"></dd>
Expand Down
16 changes: 8 additions & 8 deletions tests/valid/indexes.pages.text
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@


Network Working Group H. Person, Ed.
Internet-Draft January 31, 2024
Internet-Draft February 6, 2024
Intended status: Experimental
Expires: August 3, 2024
Expires: August 9, 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 August 3, 2024.
This Internet-Draft will expire on August 9, 2024.

Copyright Notice

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



Person Expires August 3, 2024 [Page 1]
Person Expires August 9, 2024 [Page 1]

Internet-Draft xml2rfc index tests January 2024
Internet-Draft xml2rfc index tests February 2024


This is another section!
Expand Down Expand Up @@ -109,9 +109,9 @@ Index



Person Expires August 3, 2024 [Page 2]
Person Expires August 9, 2024 [Page 2]

Internet-Draft xml2rfc index tests January 2024
Internet-Draft xml2rfc index tests February 2024


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



Person Expires August 3, 2024 [Page 3]
Person Expires August 9, 2024 [Page 3]
8 changes: 4 additions & 4 deletions tests/valid/indexes.prepped.xml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<?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="2024-01-31T23:23:59" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.19.2 -->
<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="2024-02-06T20:51:50" scripts="Common,Latin" symRefs="true" tocDepth="3" tocInclude="true">
<!-- xml2rfc v2v3 conversion 3.19.3 -->



Expand All @@ -20,7 +20,7 @@
</postal>
</address>
</author>
<date day="31" month="01" year="2024"/>
<date day="06" month="02" year="2024"/>
<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 3 August 2024.
This Internet-Draft will expire on 9 August 2024.
</t>
</section>
<section anchor="copyright" numbered="false" removeInRFC="false" toc="exclude" pn="section-boilerplate.2">
Expand Down
Loading

0 comments on commit f319275

Please sign in to comment.