metanorma-iso 1.3.21 → 1.3.26

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

@@ -5,74 +5,18 @@ require "json"
 require "pathname"
 require "open-uri"
 require "pp"
+require_relative "front_id"
 
 module Asciidoctor
   module ISO
     class Converter < Standoc::Converter
-      def metadata_id(node, xml)
-        iso_id(node, xml)
-        node&.attr("tc-docnumber")&.split(/,\s*/)&.each do |n|
-          xml.docidentifier(n, **attr_code(type: "iso-tc"))
-        end
-        xml.docnumber node&.attr("docnumber")
-      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")
-      end
-
-      def id_langsuffix(dn, node)
-        lang = node.attr("language") || "en"
-        suffix = case lang
-                 when "en" then "(E)"
-                 when "fr" then "(F)"
-                 else
-                   "(X)"
-                 end
-        "#{dn} #{suffix}"
-      end
-
       def metadata_ext(node, xml)
         super
         structured_id(node, xml)
-      end
-
-      def structured_id(node, xml)
-        return unless node.attr("docnumber")
-        part, subpart = node&.attr("partnumber")&.split(/-/)
-        xml.structuredidentifier do |i|
-          i.project_number node.attr("docnumber"),
-            **attr_code(part: part, subpart: subpart)
-        end
-      end
-
-      def add_id_parts(dn, part, subpart)
-        dn += "-#{part}" if part
-        dn += "-#{subpart}" if subpart
-        dn
-      end
-
-      def id_stage_abbr(stage, substage, node)
-        IsoDoc::Iso::Metadata.new("en", "Latn", {}).
-          status_abbrev(stage, substage, node.attr("iteration"),
-                       node.attr("draft"))
-      end
-
-      def id_stage_prefix(dn, node)
-        stage = get_stage(node)
-        substage = get_substage(node)
-        if stage && (stage.to_i < 60 || stage.to_i == 60 && substage.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")
-        end
-        dn
+        xml.stagename stage_name(get_stage(node), get_substage(node),
+                                 node.attr("doctype"), node.attr("iteration"))
+        @amd && a = node.attr("updates-document-type") and
+          xml.updates_document_type a
       end
 
       def organization(org, orgname)
@@ -121,19 +65,12 @@ module Asciidoctor
         end
       end
 
-      def get_stage(node)
-        stage = node.attr("status") || node.attr("docstage") || "60"
-      end
-
-      def get_substage(node)
-        stage = get_stage(node)
-        node.attr("docsubstage") || ( stage == "60" ? "60" : "00" )
-      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 +104,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 +131,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/front_id.rb

@@ -0,0 +1,196 @@
+require "date"
+require "nokogiri"
+require "htmlentities"
+require "json"
+require "pathname"
+require "open-uri"
+require "twitter_cldr"
+
+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",
+        "50": "Final draft",
+        "60": "International standard",
+        "90": "Review",
+        "95": "Withdrawal",
+      }.freeze
+
+      def stage_abbr(stage, substage, doctype)
+        return nil if stage.to_i > 60
+        ret = STAGE_ABBRS[stage.to_sym]
+        ret = "PRF" if stage == "60" && substage == "00"
+        if %w(amendment technical-corrigendum technical-report 
+          technical-specification).include?(doctype)
+          ret = "NP" if stage == "10"
+          ret = "AWI" if stage == "10" && substage == "99"
+          ret = "D" if stage == "40" and doctype == "amendment"
+          ret = "FD" if stage == "50" and
+            %w(amendment technical-corrigendum).include?(doctype)
+          ret = "D" if stage == "50" and
+            %w(technical-report technical-specification).include?(doctype)
+        end
+        ret
+      end
+
+      def stage_name(stage, substage, doctype, iteration = nil)
+        return "Proof" if stage == "60" && substage == "00"
+        ret = STAGE_NAMES[stage.to_sym]
+        if iteration && %w(20 30).include?(stage)
+          prefix  = iteration.to_i.localize(@lang.to_sym).
+            to_rbnf_s("SpelloutRules", "spellout-ordinal")
+          ret = "#{prefix.capitalize} #{ret.downcase}"
+        end
+        ret
+      end
+
+      def metadata_id(node, xml)
+        iso_id(node, xml)
+        node&.attr("tc-docnumber")&.split(/,\s*/)&.each do |n|
+          xml.docidentifier(n, **attr_code(type: "iso-tc"))
+        end
+        xml.docnumber node&.attr("docnumber")
+      end
+
+      def iso_id(node, xml)
+        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(/-/)
+          return 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)
+        lang = node.attr("language") || "en"
+        suffix = case lang
+                 when "en" then "(E)"
+                 when "fr" then "(F)"
+                 else
+                   "(X)"
+                 end
+        "#{dn}#{suffix}"
+      end
+
+      def structured_id(node, xml)
+        return unless node.attr("docnumber")
+        part, subpart = node&.attr("partnumber")&.split(/-/)
+        xml.structuredidentifier do |i|
+          i.project_number node.attr("docnumber"),
+            **attr_code(part: part, subpart: subpart,
+                        amendment: node.attr("amendment-number"),
+                        corrigendum: node.attr("corrigendum-number"),
+                        origyr: node.attr("created-date"))
+        end
+      end
+
+      def add_id_parts(dn, part, subpart)
+        dn += "-#{part}" if part
+        dn += "-#{subpart}" if subpart
+        dn
+      end
+
+      def id_stage_abbr(stage, substage, node)
+        ret = IsoDoc::Iso::Metadata.new("en", "Latn", {}).
+          status_abbrev(stage_abbr(stage, substage, node.attr("doctype")),
+                        substage, node.attr("iteration"),
+                        node.attr("draft"), node.attr("doctype"))
+        if %w(amendment technical-corrigendum amendment
+          technical-corrigendum).include?(node.attr("doctype"))
+          ret = ret + " " unless %w(40 50).include?(stage)
+        end
+        ret
+      end
+
+      def id_stage_prefix(dn, node, force_year)
+        stage = get_stage(node)
+        typeabbr = get_typeabbr(node)
+        if stage && (stage.to_i < 60)
+          dn = unpub_stage_prefix(dn, stage, typeabbr, node)
+        elsif typeabbr && !@amd then dn = "/#{typeabbr}#{dn}"
+        end
+        (force_year || !(stage && (stage.to_i < 60))) and
+          dn = id_add_year(dn, node)
+        dn
+      end
+
+      def unpub_stage_prefix(dn, stage, typeabbr, node)
+        abbr = id_stage_abbr(stage, get_substage(node), node)
+        %w(40 50).include?(stage) && i = node.attr("iteration") and
+          itersuffix = ".#{i}"
+        return dn if abbr.nil? || abbr.empty? # prefixes added in cleanup
+        return "/#{abbr}#{typeabbr} #{dn}#{itersuffix}" unless @amd
+        a = dn.split(%r{/})
+        a[-1] = "#{abbr}#{a[-1]}#{itersuffix}"
+        a.join("/")
+      end
+
+      def id_add_year(dn, node)
+        year = node.attr("copyright-year")
+        @amd and year ||= node.attr("updated-date")&.sub(/-.*$/, "")
+        dn += ":#{year}" if year
+        dn
+      end
+
+      def get_stage(node)
+        stage = node.attr("status") || node.attr("docstage") || "60"
+      end
+
+      def get_substage(node)
+        stage = get_stage(node)
+        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
+    end
+  end
+end

data/lib/asciidoctor/iso/isodoc.rng

@@ -53,6 +53,14 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="case">
+            <choice>
+              <value>capital</value>
+              <value>lowercase</value>
+            </choice>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
@@ -129,6 +137,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -305,6 +316,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"/>
@@ -884,7 +910,15 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
-      <ref name="paragraph"/>
+      <oneOrMore>
+        <choice>
+          <ref name="paragraph"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="formula"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termexample">
@@ -911,7 +945,10 @@
   </define>
   <define name="origin">
     <element name="origin">
-      <ref name="erefType"/>
+      <choice>
+        <ref name="erefType"/>
+        <ref name="termref"/>
+      </choice>
     </element>
   </define>
   <define name="modification">
@@ -919,6 +956,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>