metanorma-iso 1.3.20 → 1.3.25

data/lib/asciidoctor/iso/cleanup.rb

@@ -5,6 +5,7 @@ require "json"
 require "pathname"
 require "open-uri"
 require "pp"
+require "asciidoctor/iso/term_lookup_cleanup"
 
 module Asciidoctor
   module ISO
@@ -13,12 +14,12 @@ module Asciidoctor
         "//clause[title = 'Scope']//fn".freeze
 
       NORMREF_FOOTNOTES =
-        "//references[title = 'Normative References']//fn".freeze
+        "//references[@normative = 'true']//fn".freeze
 
       POST_NORMREF_FOOTNOTES =
         "//sections//clause[not(title = 'Scope')]//fn | "\
         "//annex//fn | "\
-        "//references[title = 'Bibliography']//fn".freeze
+        "//references[@normative = 'false']//fn".freeze
 
       def other_footnote_renumber(xmldoc)
         seen = {}
@@ -35,6 +36,7 @@ module Asciidoctor
       end
 
       def id_prefix(prefix, id)
+        return id.text if @amd # we're just inheriting the prefixes from parent doc
         prefix.join("/") + ( id.text.match(%{^/}) ? "" :  " " ) + id.text
       end
 
@@ -57,6 +59,8 @@ module Asciidoctor
           id.content = id_prefix(prefix, id)
         id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-with-lang']") and
           id.content = id_prefix(prefix, id)
+        id = xmldoc.at("//bibdata/docidentifier[@type = 'iso-reference']") and
+          id.content = id_prefix(prefix, id)
       end
 
       def format_ref(ref, type, isopub)
@@ -86,6 +90,11 @@ module Asciidoctor
         end
       end
 
+      def termdef_cleanup(xmldoc)
+        Asciidoctor::ISO::TermLookupCleanup.new(xmldoc, @log).call
+        super
+      end
+
       # TODO sort by authors
       # sort by: doc class (ISO, IEC, other standard (not DOI &c), other
       # then standard class (docid class other than DOI &c)
@@ -108,6 +117,14 @@ module Asciidoctor
           "#{num.nil? ? abbrid : sprintf("%09d", num.to_i)} :: "\
           "#{partid} :: #{id&.text} :: #{title}"
       end
+
+      def sections_cleanup(x)
+        super
+        return unless @amd
+        x.xpath("//*[@inline-header]").each do |h|
+          h.delete('inline-header')
+        end
+      end
     end
   end
 end

data/lib/asciidoctor/iso/front.rb

@@ -9,6 +9,49 @@ require "pp"
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
+       STAGE_ABBRS = {
+        "00": "PWI",
+        "10": "NWIP",
+        "20": "WD",
+        "30": "CD",
+        "40": "DIS",
+        "50": "FDIS",
+        "60": "IS",
+        "90": "(Review)",
+        "95": "(Withdrawal)",
+      }.freeze
+
+       STAGE_NAMES = {
+        "00": "Preliminary work item",
+        "10": "New work item proposal",
+        "20": "Working draft",
+        "30": "Committee draft",
+        "40": "Draft international standard",
+        "50": "Final draft international standard",
+        "60": "International standard",
+        "90": "Review",
+        "95": "Withdrawal",
+      }.freeze
+
+      def stage_abbr(stage, substage, doctype)
+        return nil if stage.to_i > 60
+        return "PRF" if stage == "60" && substage == "00"
+        ret = STAGE_ABBRS[stage.to_sym]
+        ret = "DTS" if ret == "DIS" && %w(technical-report technical-specification).include?(doctype)
+        ret = "FDTS" if ret == "FDIS" && %w(technical-report technical-specification).include?(doctype)
+        ret
+      end
+
+      def stage_name(stage, substage, doctype)
+        return "Proof" if stage == "60" && substage == "00"
+        ret = STAGE_NAMES[stage.to_sym]
+        if %w(technical-report technical-specification).include? doctype
+        ret = "Draft technical standard" if ret == "Draft international standard"
+        ret = "Final draft technical standard" if ret == "Final draft international standard"
+        end
+        ret
+      end
+
       def metadata_id(node, xml)
         iso_id(node, xml)
         node&.attr("tc-docnumber")&.split(/,\s*/)&.each do |n|
@@ -18,12 +61,34 @@ module Asciidoctor
       end
 
       def iso_id(node, xml)
-        return unless node.attr("docnumber")
-        part, subpart = node&.attr("partnumber")&.split(/-/)
-        dn = add_id_parts(node.attr("docnumber"), part, subpart)
-        dn = id_stage_prefix(dn, node)
-        xml.docidentifier dn, **attr_code(type: "iso")
-        xml.docidentifier id_langsuffix(dn, node), **attr_code(type: "iso-with-lang")
+        return unless !@amd && node.attr("docnumber") || @amd && node.attr("updates")
+        dn = iso_id1(node)
+        dn1 = id_stage_prefix(dn, node, false)
+        dn2 = id_stage_prefix(dn, node, true)
+        xml.docidentifier dn1, **attr_code(type: "iso")
+        xml.docidentifier id_langsuffix(dn1, node), **attr_code(type: "iso-with-lang")
+        xml.docidentifier id_langsuffix(dn2, node), **attr_code(type: "iso-reference")
+      end
+
+      def iso_id1(node)
+        if @amd
+          dn = node.attr("updates")
+          return add_amd_parts(dn, node)
+        else
+          part, subpart = node&.attr("partnumber")&.split(/-/)
+          dn = add_id_parts(node.attr("docnumber"), part, subpart)
+        end
+      end
+
+      def add_amd_parts(dn, node)
+        a = node.attr("amendment-number")
+        c = node.attr("corrigendum-number")
+        case node.attr("doctype")
+        when "amendment"
+          "#{dn}/Amd.#{node.attr('amendment-number')}"
+        when "technical corrigendum"
+          "#{dn}/Cor.#{node.attr('corrigendum-number')}"
+        end
       end
 
       def id_langsuffix(dn, node)
@@ -34,12 +99,15 @@ module Asciidoctor
                  else
                    "(X)"
                  end
-        "#{dn} #{suffix}"
+        "#{dn}#{suffix}"
       end
 
       def metadata_ext(node, xml)
         super
         structured_id(node, xml)
+        xml.stagename stage_name(get_stage(node), get_substage(node), node.attr("doctype"))
+        @amd && a = node.attr("updates-document-type") and
+          xml.updates_document_type a
       end
 
       def structured_id(node, xml)
@@ -47,7 +115,8 @@ module Asciidoctor
         part, subpart = node&.attr("partnumber")&.split(/-/)
         xml.structuredidentifier do |i|
           i.project_number node.attr("docnumber"),
-            **attr_code(part: part, subpart: subpart)
+            **attr_code(part: part, subpart: subpart, amendment: node.attr("amendment-number"),
+                        corrigendum: node.attr("corrigendum-number"), origyr: node.attr("created-date"))
         end
       end
 
@@ -59,18 +128,27 @@ module Asciidoctor
 
       def id_stage_abbr(stage, substage, node)
         IsoDoc::Iso::Metadata.new("en", "Latn", {}).
-          status_abbrev(stage, substage, node.attr("iteration"),
-                       node.attr("draft"))
+          status_abbrev(stage_abbr(stage, substage, node.attr("doctype")),
+          substage, node.attr("iteration"),
+          node.attr("draft"), node.attr("doctype"))
       end
 
-      def id_stage_prefix(dn, node)
+      def id_stage_prefix(dn, node, force_year)
         stage = get_stage(node)
         substage = get_substage(node)
-        if stage && (stage.to_i < 60 || stage.to_i == 60 && substage.to_i < 60)
+        typeabbr = get_typeabbr(node)
+        if stage && (stage.to_i < 60)
           abbr = id_stage_abbr(stage, substage, node)
-          dn = "/#{abbr} #{dn}" unless abbr.nil? || abbr.empty? # prefixes added in cleanup
-        else
-          dn += ":#{node.attr("copyright-year")}" if node.attr("copyright-year")
+          unless abbr.nil? || abbr.empty? # prefixes added in cleanup
+            dn = @amd ? dn.sub(/ /, "/#{abbr} ") : "/#{abbr} #{typeabbr}#{dn}"
+          end
+        elsif typeabbr && !@amd
+          dn = "/#{typeabbr}#{dn}"
+        end
+        if force_year || !(stage && (stage.to_i < 60))
+          year = @amd ? (node.attr("copyright-year") || node.attr("updated-date").sub(/-.*$/, "")) :
+            node.attr("copyright-year")
+          dn += ":#{year}" if year
         end
         dn
       end
@@ -130,10 +208,21 @@ module Asciidoctor
         node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
       end
 
+      def get_typeabbr(node)
+        case node.attr("doctype")
+        when "technical-report" then "TR "
+        when "technical-specification" then "TS "
+        else
+          nil
+        end
+      end
+
       def metadata_status(node, xml)
+        stage = get_stage(node)
+        substage = get_substage(node)
         xml.status do |s|
-          s.stage get_stage(node)
-          s.substage get_substage(node)
+          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage, node.attr("doctype")))
+          s.substage substage
           node.attr("iteration") && (s.iteration node.attr("iteration"))
         end
       end
@@ -167,12 +256,21 @@ module Asciidoctor
         end
       end
 
+      def title_amd(node, t, lang, at)
+        return unless node.attr("title-amendment-#{lang}")
+        t.title(**attr_code(at.merge(type: "title-amd"))) do |t1|
+          t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(node.attr("title-amendment-#{lang}"))
+        end
+      end
+
       def title_full(node, t, lang, at)
         title = node.attr("title-main-#{lang}")
         intro = node.attr("title-intro-#{lang}")
         part = node.attr("title-part-#{lang}")
+        amd = node.attr("title-amendment-#{lang}")
         title = "#{intro} -- #{title}" if intro
         title = "#{title} -- #{part}" if part
+        title = "#{title} -- #{amd}" if amd && @amd
         t.title **attr_code(at.merge(type: "main")) do |t1|
           t1 << Asciidoctor::Standoc::Utils::asciidoc_sub(title)
         end
@@ -185,6 +283,7 @@ module Asciidoctor
           title_intro(node, xml, lang, at)
           title_main(node, xml, lang, at)
           title_part(node, xml, lang, at)
+          title_amd(node, xml, lang, at) if @amd
         end
       end
     end

data/lib/asciidoctor/iso/isodoc.rng

@@ -101,9 +101,7 @@
         <ref name="structuredidentifier"/>
       </zeroOrMore>
     </define>
-    <define name="TitleType">
-      <text/>
-    </define>
+    <!-- TitleType = text -->
     <define name="sections">
       <element name="sections">
         <oneOrMore>
@@ -131,6 +129,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -307,6 +308,21 @@
     </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
+  <define name="concept">
+    <element name="concept">
+      <optional>
+        <attribute name="term"/>
+      </optional>
+      <choice>
+        <ref name="eref"/>
+        <ref name="xref"/>
+        <ref name="termref"/>
+      </choice>
+    </element>
+  </define>
   <define name="BasicBlock" combine="choice">
     <choice>
       <ref name="requirement"/>
@@ -913,7 +929,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -921,6 +940,15 @@
       <ref name="paragraph"/>
     </element>
   </define>
+  <define name="termref">
+    <element name="termref">
+      <attribute name="base"/>
+      <attribute name="target"/>
+      <optional>
+        <text/>
+      </optional>
+    </element>
+  </define>
   <define name="structuredidentifier">
     <element name="structuredidentifier">
       <optional>

data/lib/asciidoctor/iso/isostandard-amd.rng

@@ -0,0 +1,98 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar ns="https://www.metanorma.org/ns/iso" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
+  <!-- default namespace isostandard = "https://www.metanorma.com/ns/iso" -->
+  <include href="isostandard.rng">
+    <start>
+      <ref name="iso-standard"/>
+    </start>
+    <define name="sections">
+      <element name="sections">
+        <oneOrMore>
+          <ref name="clause"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="clause">
+      <element name="clause">
+        <optional>
+          <attribute name="type"/>
+        </optional>
+        <optional>
+          <attribute name="change">
+            <choice>
+              <value>add</value>
+              <value>delete</value>
+              <value>modify</value>
+            </choice>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="locality"/>
+        </optional>
+        <ref name="Clause-Section"/>
+      </element>
+    </define>
+    <define name="iso-standard">
+      <element name="iso-standard">
+        <ref name="bibdata"/>
+        <optional>
+          <ref name="boilerplate"/>
+        </optional>
+        <ref name="preface"/>
+        <oneOrMore>
+          <ref name="sections"/>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="documentnumber">
+      <element name="project-number">
+        <optional>
+          <attribute name="part">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="subpart">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="amendment">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="corrigendum">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="origyr">
+            <data type="int"/>
+          </attribute>
+        </optional>
+        <text/>
+      </element>
+    </define>
+    <define name="BibDataExtensionType">
+      <ref name="doctype"/>
+      <ref name="editorialgroup"/>
+      <zeroOrMore>
+        <ref name="ics"/>
+      </zeroOrMore>
+      <ref name="structuredidentifier"/>
+      <optional>
+        <ref name="stagename"/>
+      </optional>
+      <optional>
+        <ref name="updates_document_type"/>
+      </optional>
+    </define>
+  </include>
+  <!-- end overrides -->
+  <define name="updates_document_type">
+    <element name="updates-document-type">
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+</grammar>

data/lib/asciidoctor/iso/isostandard.rng

@@ -43,6 +43,9 @@
         <ref name="ics"/>
       </zeroOrMore>
       <ref name="structuredidentifier"/>
+      <optional>
+        <ref name="stagename"/>
+      </optional>
     </define>
     <define name="bdate">
       <element name="date">
@@ -260,6 +263,8 @@
         <value>publicly-available-specification</value>
         <value>international-workshop-agreement</value>
         <value>guide</value>
+        <value>amendment</value>
+        <value>technical-corrigendum</value>
       </choice>
     </define>
     <define name="structuredidentifier">
@@ -511,4 +516,9 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="stagename">
+    <element name="stagename">
+      <text/>
+    </element>
+  </define>
 </grammar>