feat: Add xml2rfc class to HTML body element (#847)

* chore: to the weird test thing * feat: add an xml2rfc class to body element
ietf-tools · Sep 22, 2022 · 055d64d · 055d64d
1 parent cc6b083
commit 055d64d
Show file tree

Hide file tree

Showing 48 changed files with 588 additions and 270 deletions.
diff --git a/tests/valid/docfile.html b/tests/valid/docfile.html
@@ -18,13 +18,13 @@
 <link href="xml2rfc.css" rel="stylesheet">
 <link href="rfc-local.css" rel="stylesheet" type="text/css">
 </head>
-<body>
+<body class="xml2rfc">
 <script src="metadata.min.js"></script>
 <table class="ears">
 <thead><tr>
 <td class="left"></td>
 <td class="center">Xml2rfc Vocabulary V3 Schema</td>
-<td class="right">August 2022</td>
+<td class="right">September 2022</td>
 </tr></thead>
 <tfoot><tr>
 <td class="left">xml2rfc(1)</td>

diff --git a/tests/valid/draft-miek-test.html b/tests/valid/draft-miek-test.html
@@ -27,7 +27,7 @@
 <meta content="draft-gieben-writing-rfcs-pandoc-02" name="ietf.draft">
 <!-- Generator version information:
  xml2rfc 3.14.2
- Python 3.9.13
+ Python 3.9.14
  appdirs 1.4.4
  ConfigArgParse 1.5.3
  google-i18n-address 2.5.2
@@ -40,7 +40,7 @@
  pycountry 22.3.5
  PyYAML 6.0
  requests 2.28.1
- setuptools 63.2.0
+ setuptools 65.3.0
  six 1.16.0
  weasyprint 56.1
 -->
@@ -1196,7 +1196,7 @@
 <link href="rfc-local.css" rel="stylesheet" type="text/css">
 <script type="application/javascript">async function addMetadata(){try{const e=document.styleSheets[0].cssRules;for(let t=0;t<e.length;t++)if(/#identifiers/.exec(e[t].selectorText)){const a=e[t].cssText.replace("#identifiers","#external-updates");document.styleSheets[0].insertRule(a,document.styleSheets[0].cssRules.length)}}catch(e){console.log(e)}const e=document.getElementById("external-metadata");if(e)try{var t,a="",o=function(e){const t=document.getElementsByTagName("meta");for(let a=0;a<t.length;a++)if(t[a].getAttribute("name")===e)return t[a].getAttribute("content");return""}("rfc.number");if(o){t="https://www.rfc-editor.org/rfc/rfc"+o+".json";try{const e=await fetch(t);a=await e.json()}catch(e){t=document.URL.indexOf("html")>=0?document.URL.replace(/html$/,"json"):document.URL+".json";const o=await fetch(t);a=await o.json()}}if(!a)return;e.style.display="block";const s="",d="https://datatracker.ietf.org/doc",n="https://datatracker.ietf.org/ipr/search",c="https://www.rfc-editor.org/info",l=a.doc_id.toLowerCase(),i=a.doc_id.slice(0,3).toLowerCase(),f=a.doc_id.slice(3).replace(/^0+/,""),u={status:"Status",obsoletes:"Obsoletes",obsoleted_by:"Obsoleted By",updates:"Updates",updated_by:"Updated By",see_also:"See Also",errata_url:"Errata"};let h="<dl style='overflow:hidden' id='external-updates'>";["status","obsoletes","obsoleted_by","updates","updated_by","see_also","errata_url"].forEach(e=>{if("status"==e){a[e]=a[e].toLowerCase();var t=a[e].split(" "),o=t.length,w="",p=1;for(let e=0;e<o;e++)p<o?w=w+r(t[e])+" ":w+=r(t[e]),p++;a[e]=w}else if("obsoletes"==e||"obsoleted_by"==e||"updates"==e||"updated_by"==e){var g,m="",b=1;g=a[e].length;for(let t=0;t<g;t++)a[e][t]&&(a[e][t]=String(a[e][t]).toLowerCase(),m=b<g?m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>, ":m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>",b++);a[e]=m}else if("see_also"==e){var y,L="",C=1;y=a[e].length;for(let t=0;t<y;t++)if(a[e][t]){a[e][t]=String(a[e][t]);var _=a[e][t].slice(0,3),v=a[e][t].slice(3).replace(/^0+/,"");L=C<y?"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>, ":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>, ":"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>",C++}a[e]=L}else if("errata_url"==e){var R="";R=a[e]?R+"<a href='"+a[e]+"'>Errata exist</a> | <a href='"+d+"/"+l+"'>Datatracker</a>| <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>":"<a href='"+d+"/"+l+"'>Datatracker</a> | <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>",a[e]=R}""!=a[e]?"Errata"==u[e]?h+=`<dt>More info:</dt><dd>${a[e]}</dd>`:h+=`<dt>${u[e]}:</dt><dd>${a[e]}</dd>`:"Errata"==u[e]&&(h+=`<dt>More info:</dt><dd>${a[e]}</dd>`)}),h+="</dl>",e.innerHTML=h}catch(e){console.log(e)}else console.log("Could not locate metadata <div> element");function r(e){return e.charAt(0).toUpperCase()+e.slice(1)}}window.removeEventListener("load",addMetadata),window.addEventListener("load",addMetadata);</script>
 </head>
-<body>
+<body class="xml2rfc">
 <script src="metadata.min.js"></script>
 <table class="ears">
 <thead><tr>

diff --git a/tests/valid/draft-miek-test.v3.html b/tests/valid/draft-miek-test.v3.html
@@ -16,7 +16,7 @@
  This version is adapted to work with "xml2rfc" version 2.x. 
  
  ' name="description">
-<meta content="xml2rfc 3.12.7" name="generator">
+<meta content="xml2rfc 3.13.1" name="generator">
 <meta content="RFC" name="keyword">
 <meta content="Request for Comments" name="keyword">
 <meta content="I-D" name="keyword">
@@ -30,7 +30,7 @@
 <link href="xml2rfc.css" rel="stylesheet">
 <link href="rfc-local.css" rel="stylesheet" type="text/css">
 </head>
-<body>
+<body class="xml2rfc">
 <script src="metadata.min.js"></script>
 <table class="ears">
 <thead><tr>

diff --git a/tests/valid/draft-template-old.exp.xml b/tests/valid/draft-template-old.exp.xml
@@ -474,15 +474,17 @@ main(int argc, char *argv[])
  <references title="Normative References">
  <!--?rfc include="http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml"?-->
  <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119" xml:base="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml" quote-title="true">
-<front>
-<title>Key words for use in RFCs to Indicate Requirement Levels</title>
-<author initials="S." surname="Bradner" fullname="S. Bradner"><organization/></author>
-<date year="1997" month="March"/>
-<abstract><t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t></abstract>
-</front>
-<seriesInfo name="BCP" value="14"/>
-<seriesInfo name="RFC" value="2119"/>
-<seriesInfo name="DOI" value="10.17487/RFC2119"/>
+ <front>
+ <title>Key words for use in RFCs to Indicate Requirement Levels</title>
+ <author fullname="S. Bradner" initials="S." surname="Bradner"/>
+ <date month="March" year="1997"/>
+ <abstract>
+ <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
+ </abstract>
+ </front>
+ <seriesInfo name="BCP" value="14"/>
+ <seriesInfo name="RFC" value="2119"/>
+ <seriesInfo name="DOI" value="10.17487/RFC2119"/>
 </reference>
 
  <reference anchor="min_ref" quote-title="true">

diff --git a/tests/valid/draft-template-old.prepped.xml b/tests/valid/draft-template-old.prepped.xml
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='utf-8'?>
-<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" category="info" consensus="false" docName="draft-ietf-xml2rfc-template-05" indexInclude="true" ipr="trust200902" prepTime="2022-08-29T03:59:06" scripts="Common,Latin" sortRefs="true" submissionType="IETF" symRefs="true" tocDepth="4" tocInclude="true" xml:lang="en">
- <!-- xml2rfc v2v3 conversion 3.14.1 -->
+<rfc xmlns:xi="http://www.w3.org/2001/XInclude" version="3" category="info" consensus="false" docName="draft-ietf-xml2rfc-template-05" indexInclude="true" ipr="trust200902" prepTime="2022-09-22T04:58:46" scripts="Common,Latin" sortRefs="true" submissionType="IETF" symRefs="true" tocDepth="4" tocInclude="true" xml:lang="en">
+ <!-- xml2rfc v2v3 conversion 3.14.2 -->
 
 
 
@@ -553,12 +553,10 @@ main(int argc, char *argv[])
  <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119" xml:base="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml" quoteTitle="true" derivedAnchor="RFC2119">
  <front>
  <title>Key words for use in RFCs to Indicate Requirement Levels</title>
- <author initials="S." surname="Bradner" fullname="S. Bradner">
- <organization showOnFrontPage="true"/>
- </author>
- <date year="1997" month="March"/>
+ <author fullname="S. Bradner" initials="S." surname="Bradner"/>
+ <date month="March" year="1997"/>
  <abstract>
- <t indent="0">In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
+ <t indent="0">In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized.  This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
  </abstract>
  </front>
  <seriesInfo name="BCP" value="14"/>

diff --git a/tests/valid/draft-template-old.v2v3.xml b/tests/valid/draft-template-old.v2v3.xml
@@ -33,7 +33,7 @@
 <?rfc multiple-initials="yes" ?>
 <!-- end of list of popular I-D processing instructions -->
 <rfc xmlns:xi="http://www.w3.org/2001/XInclude" category="info" docName="draft-ietf-xml2rfc-template-05" ipr="trust200902" obsoletes="" updates="" submissionType="IETF" xml:lang="en" tocInclude="true" tocDepth="4" symRefs="true" sortRefs="true" version="3">
- <!-- xml2rfc v2v3 conversion 3.14.1 -->
+ <!-- xml2rfc v2v3 conversion 3.14.2 -->
  <?v3xml2rfc silence=".*[Pp]ostal address" ?>
  <?v3xml2rfc silence="The document date .*? is more than 3 days away from today's date" ?>
  <?v3xml2rfc silence="Found SVG with width or height specified" ?>
@@ -452,12 +452,10 @@ main(int argc, char *argv[])
  <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119" xml:base="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml">
  <front>
  <title>Key words for use in RFCs to Indicate Requirement Levels</title>
- <author initials="S." surname="Bradner" fullname="S. Bradner">
- <organization/>
- </author>
- <date year="1997" month="March"/>
+ <author fullname="S. Bradner" initials="S." surname="Bradner"/>
+ <date month="March" year="1997"/>
  <abstract>
- <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
+ <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized.  This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
  </abstract>
  </front>
  <seriesInfo name="BCP" value="14"/>

diff --git a/tests/valid/draft-template.exp.xml b/tests/valid/draft-template.exp.xml
@@ -417,12 +417,10 @@ main(int argc, char *argv[])
  <reference anchor="RFC2119" target="https://www.rfc-editor.org/info/rfc2119" xml:base="https://bib.ietf.org/public/rfc/bibxml/reference.RFC.2119.xml">
  <front>
  <title>Key words for use in RFCs to Indicate Requirement Levels</title>
- <author initials="S." surname="Bradner" fullname="S. Bradner">
- <organization/>
- </author>
- <date year="1997" month="March"/>
+ <author fullname="S. Bradner" initials="S." surname="Bradner"/>
+ <date month="March" year="1997"/>
  <abstract>
- <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized. This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
+ <t>In many standards track documents several words are used to signify the requirements in the specification. These words are often capitalized.  This document defines these words as they should be interpreted in IETF documents. This document specifies an Internet Best Current Practices for the Internet Community, and requests discussion and suggestions for improvements.</t>
  </abstract>
  </front>
  <seriesInfo name="BCP" value="14"/>

diff --git a/tests/valid/draft-template.html b/tests/valid/draft-template.html
@@ -16,7 +16,7 @@
 <meta content="draft-ietf-xml2rfc-template-05" name="ietf.draft">
 <!-- Generator version information:
  xml2rfc 3.14.2
- Python 3.9.13
+ Python 3.9.14
  appdirs 1.4.4
  ConfigArgParse 1.5.3
  google-i18n-address 2.5.2
@@ -29,7 +29,7 @@
  pycountry 22.3.5
  PyYAML 6.0
  requests 2.28.1
- setuptools 63.2.0
+ setuptools 65.3.0
  six 1.16.0
  weasyprint 56.1
 -->
@@ -1185,7 +1185,7 @@
 <link href="rfc-local.css" rel="stylesheet" type="text/css">
 <script type="application/javascript">async function addMetadata(){try{const e=document.styleSheets[0].cssRules;for(let t=0;t<e.length;t++)if(/#identifiers/.exec(e[t].selectorText)){const a=e[t].cssText.replace("#identifiers","#external-updates");document.styleSheets[0].insertRule(a,document.styleSheets[0].cssRules.length)}}catch(e){console.log(e)}const e=document.getElementById("external-metadata");if(e)try{var t,a="",o=function(e){const t=document.getElementsByTagName("meta");for(let a=0;a<t.length;a++)if(t[a].getAttribute("name")===e)return t[a].getAttribute("content");return""}("rfc.number");if(o){t="https://www.rfc-editor.org/rfc/rfc"+o+".json";try{const e=await fetch(t);a=await e.json()}catch(e){t=document.URL.indexOf("html")>=0?document.URL.replace(/html$/,"json"):document.URL+".json";const o=await fetch(t);a=await o.json()}}if(!a)return;e.style.display="block";const s="",d="https://datatracker.ietf.org/doc",n="https://datatracker.ietf.org/ipr/search",c="https://www.rfc-editor.org/info",l=a.doc_id.toLowerCase(),i=a.doc_id.slice(0,3).toLowerCase(),f=a.doc_id.slice(3).replace(/^0+/,""),u={status:"Status",obsoletes:"Obsoletes",obsoleted_by:"Obsoleted By",updates:"Updates",updated_by:"Updated By",see_also:"See Also",errata_url:"Errata"};let h="<dl style='overflow:hidden' id='external-updates'>";["status","obsoletes","obsoleted_by","updates","updated_by","see_also","errata_url"].forEach(e=>{if("status"==e){a[e]=a[e].toLowerCase();var t=a[e].split(" "),o=t.length,w="",p=1;for(let e=0;e<o;e++)p<o?w=w+r(t[e])+" ":w+=r(t[e]),p++;a[e]=w}else if("obsoletes"==e||"obsoleted_by"==e||"updates"==e||"updated_by"==e){var g,m="",b=1;g=a[e].length;for(let t=0;t<g;t++)a[e][t]&&(a[e][t]=String(a[e][t]).toLowerCase(),m=b<g?m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>, ":m+"<a href='"+s+"/rfc/".concat(a[e][t])+"'>"+a[e][t].slice(3)+"</a>",b++);a[e]=m}else if("see_also"==e){var y,L="",C=1;y=a[e].length;for(let t=0;t<y;t++)if(a[e][t]){a[e][t]=String(a[e][t]);var _=a[e][t].slice(0,3),v=a[e][t].slice(3).replace(/^0+/,"");L=C<y?"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>, ":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>, ":"RFC"!=_?L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+_+" "+v+"</a>":L+"<a href='"+s+"/info/"+_.toLowerCase().concat(v.toLowerCase())+"'>"+v+"</a>",C++}a[e]=L}else if("errata_url"==e){var R="";R=a[e]?R+"<a href='"+a[e]+"'>Errata exist</a> | <a href='"+d+"/"+l+"'>Datatracker</a>| <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>":"<a href='"+d+"/"+l+"'>Datatracker</a> | <a href='"+n+"/?"+i+"="+f+"&submit="+i+"'>IPR</a> | <a href='"+c+"/"+l+"'>Info page</a>",a[e]=R}""!=a[e]?"Errata"==u[e]?h+=`<dt>More info:</dt><dd>${a[e]}</dd>`:h+=`<dt>${u[e]}:</dt><dd>${a[e]}</dd>`:"Errata"==u[e]&&(h+=`<dt>More info:</dt><dd>${a[e]}</dd>`)}),h+="</dl>",e.innerHTML=h}catch(e){console.log(e)}else console.log("Could not locate metadata <div> element");function r(e){return e.charAt(0).toUpperCase()+e.slice(1)}}window.removeEventListener("load",addMetadata),window.addEventListener("load",addMetadata);</script>
 </head>
-<body>
+<body class="xml2rfc">
 <script src="metadata.min.js"></script>
 <table class="ears">
 <thead><tr>

diff --git a/tests/valid/draft-template.nroff b/tests/valid/draft-template.nroff
@@ -1,4 +1,8 @@
+<<<<<<< HEAD
+.\" automatically generated by xml2rfc v3.13.1 on 2022-07-28T16:52:57Z
+=======
 .\" automatically generated by xml2rfc v3.13.1 on 2022-08-03T04:17:14Z
+>>>>>>> cc6b083cdf58be559d8d6011f9adedfa583bbc6f
 
 .pl 10.0i
 .po 0
@@ -668,27 +672,27 @@ World", 1984, <http://www.example.com/dominator.html>.
 Narten, T. and H. Alvestrand, "Guidelines for Writing an
 IANA Considerations Section\0in RFCs", \%draft-narten-iana-
 \%considerations-rfc2434bis-09 (work in progress), March
-2008.
+2008, \%<https://www.ietf.org/archive/id/draft-narten-iana-
+\%considerations-rfc2434bis-09.txt>.
 .ti 3
 
 [JUPITER] Singh, A., Ong, J., Agarwal, A., Anderson, G., Armistead,
 A., Bannon, R., Boving, S., Desai, G., Felderman, B.,
 Germano, P., Kanagala, A., Liu, H., Provost, J., Simmons,
-J., Tanda, E., Wanderer, J., Hoelzle, U., Stuart, S., and
-A. Vahdat, "Jupiter rising: a decade of clos topologies
-and centralized control in Google's datacenter network",
-Communications of the ACM\0Vol. 59, pp. \%88-97,
-DOI\010.1145/2975159, August 2016.
+J., Tanda, E., Wanderer, J., Hoelzle, U., Stuart, S.,
+Vahdat, A., and Association for Computing Machinery (ACM),
+"Jupiter rising", DOI\010.1145/2975159, August 2016,
+<http://dx.doi.org/10.1145/2975159>.
 .bp
 .ti 3
-[RFC2629] Rose, M., "Writing \%I-Ds and RFCs using XML", RFC\02629,
-DOI\010.17487/RFC2629, June 1999,
+[RFC2629] Rose, M., "Writing \%I-Ds and RFCs using XML",
+DOI\010.17487/RFC2629, RFC\02629, June 1999,
 \%<https://www.rfc-editor.org/info/rfc2629>.
 .ti 3
 
 [RFC3552] Rescorla, E. and B. Korver, "Guidelines for Writing RFC
-Text on Security Considerations", BCP\072, RFC\03552,
-DOI\010.17487/RFC3552, July 2003,
+Text on Security Considerations", DOI\010.17487/RFC3552,
+BCP\072, RFC\03552, July 2003,
 \%<https://www.rfc-editor.org/info/rfc3552>.
 .ti 3