Merge branch 'main' into issues/0197-emdash

Author: SteveLLamb

smpte.js

@@ -195,6 +195,8 @@ function insertFrontMatter(docMetadata) {
       case smpte.ST_PUBTYPE:
       case smpte.RP_PUBTYPE:
       case smpte.EG_PUBTYPE:
+      case smpte.ER_PUBTYPE:
+      case smpte.RDD_PUBTYPE:
         if (docMetadata.pubPart !== null)
           actualPubNumber += `-<span itemprop="doc-part" id="doc-part">${docMetadata.pubPart}</span>`;
         if (docMetadata.pubStage === smpte.PUB_STAGE_PUB) {
@@ -623,7 +625,7 @@ function insertConformance(docMetadata) {
   if (!(docMetadata.pubType == smpte.RP_PUBTYPE || docMetadata.pubType == smpte.ST_PUBTYPE || docMetadata.pubType == smpte.AG_PUBTYPE)) {
     if (sec !== null)
       logger_.error(`An ${docMetadata.pubType} document must not contain a conformance section`);
-    if (docMetadata.pubType != smpte.EG_PUBTYPE)
+    if (!(docMetadata.pubType == smpte.EG_PUBTYPE || docMetadata.pubType == smpte.ER_PUBTYPE))
       return;
   }
 
@@ -700,6 +702,14 @@ function insertConformance(docMetadata) {
     interoperability information.</p>
     `;
 
+  } else if (docMetadata.pubType === smpte.ER_PUBTYPE) {
+
+    sec.innerHTML = `
+    <h2>Conformance</h2>
+    <p>This Engineering Report is meant to provide information to the 
+    industry. It does not impose requirements.</p>
+    `;
+
   }  else {
     sec.innerHTML = `
     <h2>Conformance</h2>
@@ -720,7 +730,7 @@ function insertConformance(docMetadata) {
 
 const SMPTE_FOREWORD_ID = "sec-foreword";
 
-const SMPTE_AG_FOREWORD_BOILERPLATE = `<h2>Foreword</h2>
+const SMPTE_GEN_FOREWORD_BOILERPLATE = `<h2>Foreword</h2>
 <p>The Society of Motion Picture and Television Engineers (SMPTE) is an
 internationally-recognized standards developing organization. Headquartered
 and incorporated in the United States of America, SMPTE has members in over
@@ -730,26 +740,43 @@ by SMPTE’s Technology Committees. Participation in these Committees is open
 to all with a bona fide interest in their work. SMPTE cooperates closely
 with other standards-developing organizations, including ISO, IEC and ITU.
 SMPTE Engineering Documents are drafted in accordance with the rules given
-in its Standards Operations Manual. For more information, please visit
+in its Standards Operations Manual.</p> 
+
+<p>For more information, please visit
 <a href="https://www.smpte.org">www.smpte.org</a>.</p>
+`
+
+const SMPTE_AG_FOREWORD_BOILERPLATE = `${SMPTE_GEN_FOREWORD_BOILERPLATE}
 
 <p>This Standards Administrative Guideline forms an adjunct to the use and
 interpretation of the SMPTE Standards Operations Manual. In the event of a
 conflict, the Operations Manual shall prevail.</p>
 `
+const SMPTE_RDD_FOREWORD_BOILERPLATE = `<h2>Foreword</h2>
+<p>This document is a Registered Disclosure Document prepared by the sponsor(s) identified 
+below. It has been examined by the appropriate SMPTE Technology Committee and is believed to 
+contain adequate information to satisfy the objectives defined in the Scope, and to be   
+technically consistent.</p>
+<p>This document is NOT a Standard, Recommended Practice or Engineering Guideline and does NOT 
+imply a finding or representation of the Society.</p>
+<p>Every attempt has been made to ensure that the information contained in this document is 
+accurate. Errors in this document should be reported to the SMPTE Registered Disclosure 
+Document proponent(s) identified below with a copy to 
+<a href="mailto:[email protected]">[email protected]</a>.</p>
+
+<p>All other inquiries in respect of this document, including inquiries as to intellectual 
+property requirements, should be addressed to the SMPTE Registered Disclosure Document 
+proponent(s) identified below.</p>
 
-const SMPTE_DOC_FOREWORD_BOILERPLATE = `<h2>Foreword</h2>
-<p>The Society of Motion Picture and Television Engineers (SMPTE) is an
-internationally-recognized standards developing organization. Headquartered
-and incorporated in the United States of America, SMPTE has members in over
-80 countries on six continents. SMPTE’s Engineering Documents, including
-Standards, Recommended Practices, and Engineering Guidelines, are prepared
-by SMPTE’s Technology Committees. Participation in these Committees is open
-to all with a bona fide interest in their work. SMPTE cooperates closely
-with other standards-developing organizations, including ISO, IEC and ITU.
-SMPTE Engineering Documents are drafted in accordance with the rules given
-in its Standards Operations Manual.</p> For more information, please visit
-<a href="https://www.smpte.org">www.smpte.org</a>.</p>
+{{authorProse}}
+
+`
+const SMPTE_ER_FOREWORD_BOILERPLATE = `${SMPTE_GEN_FOREWORD_BOILERPLATE}
+
+{{authorProse}}
+`
+
+const SMPTE_DOC_FOREWORD_BOILERPLATE = `${SMPTE_GEN_FOREWORD_BOILERPLATE}
 
 <p>At the time of publication no notice had been received by SMPTE claiming patent
 rights essential to the implementation of this Engineering Document.
@@ -778,6 +805,22 @@ function insertForeword(docMetadata) {
     return;
   }
 
+  if (docMetadata.pubType == smpte.RDD_PUBTYPE) {
+    if (sec === null)
+      logger_.error("RDD must contain a Foreword section.");
+
+  }
+
+  const SMPTE_PROPONENT_ID = document.getElementById("element-proponent");
+
+  if (SMPTE_PROPONENT_ID === null && docMetadata.pubType === smpte.RDD_PUBTYPE) {
+    logger_.error("Missing required proponents.");
+    return;
+  } if (SMPTE_PROPONENT_ID !== null && docMetadata.pubType !== smpte.RDD_PUBTYPE) {
+    logger_.error("Proponents only allowed for RDD documents.");
+    return;
+  } 
+
   if (sec === null && docMetadata.pubType != smpte.OM_PUBTYPE) {
     sec = document.createElement("section");
     sec.id = SMPTE_FOREWORD_ID;
@@ -788,20 +831,27 @@ function insertForeword(docMetadata) {
 
   let authorProse = sec.innerHTML;
 
-  if (smpte.ENGDOC_PUBTYPES.has(docMetadata.pubType)) {
+  if (smpte.ENGDOC_PUBTYPES.has(docMetadata.pubType) && docMetadata.pubType != smpte.RDD_PUBTYPE) {
     authorProse = `<p>This document was prepared by Technology Committee ${docMetadata.pubTC}.</p>` + authorProse;
   }
 
   if (docMetadata.pubType == smpte.AG_PUBTYPE) {
     if (authorProse.trim().length > 0)
       logger_.error("AGs cannot contain author-specified Foreword prose.")
     sec.innerHTML = fillTemplate(SMPTE_AG_FOREWORD_BOILERPLATE, {copyrightYear: (new Date()).getFullYear()});
+  } else if (docMetadata.pubType == smpte.RDD_PUBTYPE) {
+    sec.innerHTML = fillTemplate(SMPTE_RDD_FOREWORD_BOILERPLATE, {authorProse: authorProse, copyrightYear: (new Date()).getFullYear()});  
+  } else if (docMetadata.pubType == smpte.ER_PUBTYPE) {
+    sec.innerHTML = fillTemplate(SMPTE_ER_FOREWORD_BOILERPLATE, {authorProse: authorProse, copyrightYear: (new Date()).getFullYear()});  
   } else {
     sec.innerHTML = fillTemplate(SMPTE_DOC_FOREWORD_BOILERPLATE, {authorProse: authorProse, copyrightYear: (new Date()).getFullYear()});
   }
 
 }
 
+  
+  
+
 function addHeadingLinks(docMetadata) {
   const headings = document.querySelectorAll("h2, h3, h4, h5, h6");
 
@@ -1286,7 +1336,7 @@ function resolveLinks(docMetadata) {
 const CONFORMANCE_RE = /\s*(shall)|(should)|(may)\s/i;
 
 function checkConformanceNotation(docMetadata) {
-  if (docMetadata.pubType !== smpte.EG_PUBTYPE)
+  if (!(docMetadata.pubType == smpte.EG_PUBTYPE || docMetadata.pubType == smpte.ER_PUBTYPE))
     return;
 
   for (let section of document.querySelectorAll("section:not(:has(section))")) {
@@ -1299,7 +1349,7 @@ function checkConformanceNotation(docMetadata) {
     const r = CONFORMANCE_RE.exec(section.innerText);
 
     if (r !== null)
-      logger_.error(`An EG must not contain the conformance notation ${r[1]}`, section);
+      logger_.error(`An ${docMetadata.pubType} must not contain the conformance notation ${r[1]}`, section);
 
   };
 }