metanorma-iso 1.3.23 → 1.4.0

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,9 +53,96 @@
         <optional>
           <attribute name="alt"/>
         </optional>
+        <optional>
+          <attribute name="case">
+            <choice>
+              <value>capital</value>
+              <value>lowercase</value>
+            </choice>
+          </attribute>
+        </optional>
         <text/>
       </element>
     </define>
+    <define name="ul">
+      <element name="ul">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="ol">
+      <element name="ol">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <attribute name="type">
+          <choice>
+            <value>roman</value>
+            <value>alphabet</value>
+            <value>arabic</value>
+            <value>roman_upper</value>
+            <value>alphabet_upper</value>
+          </choice>
+        </attribute>
+        <oneOrMore>
+          <ref name="li"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="dl">
+      <element name="dl">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <oneOrMore>
+          <ref name="dt"/>
+          <ref name="dd"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="example">
       <element name="example">
         <attribute name="id">
@@ -69,6 +156,19 @@
         <optional>
           <attribute name="subsequence"/>
         </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <optional>
           <ref name="tname"/>
         </optional>
@@ -89,6 +189,296 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="table">
+      <element name="table">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="alt"/>
+        </optional>
+        <optional>
+          <attribute name="summary"/>
+        </optional>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <optional>
+          <ref name="thead"/>
+        </optional>
+        <ref name="tbody"/>
+        <optional>
+          <ref name="tfoot"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="table-note"/>
+        </zeroOrMore>
+        <optional>
+          <ref name="dl"/>
+        </optional>
+      </element>
+    </define>
+    <define name="figure">
+      <element name="figure">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <optional>
+          <ref name="source"/>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <choice>
+          <ref name="image"/>
+          <ref name="video"/>
+          <ref name="audio"/>
+          <ref name="pre"/>
+          <oneOrMore>
+            <ref name="paragraph-with-footnote"/>
+          </oneOrMore>
+          <zeroOrMore>
+            <ref name="figure"/>
+          </zeroOrMore>
+        </choice>
+        <zeroOrMore>
+          <ref name="fn"/>
+        </zeroOrMore>
+        <optional>
+          <ref name="dl"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="sourcecode">
+      <element name="sourcecode">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="lang"/>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="callout"/>
+          </choice>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="annotation"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="formula">
+      <element name="formula">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="inequality">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <ref name="stem"/>
+        <optional>
+          <ref name="dl"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="ParagraphType">
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+      <optional>
+        <attribute name="align">
+          <ref name="Alignments"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-with-next">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-lines-together">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <zeroOrMore>
+        <ref name="TextElement"/>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="note"/>
+      </zeroOrMore>
+    </define>
+    <define name="paragraph-with-footnote">
+      <element name="p">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="align">
+            <ref name="Alignments"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <choice>
+            <ref name="TextElement"/>
+            <ref name="fn"/>
+          </choice>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
+    <define name="quote">
+      <element name="quote">
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="alignment">
+            <ref name="Alignments"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="quote-source"/>
+        </optional>
+        <optional>
+          <ref name="quote-author"/>
+        </optional>
+        <oneOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </oneOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="BibDataExtensionType">
       <ref name="doctype"/>
       <optional>
@@ -129,6 +519,9 @@
             </choice>
           </attribute>
         </optional>
+        <attribute name="normative">
+          <data type="boolean"/>
+        </attribute>
         <optional>
           <ref name="section-title"/>
         </optional>
@@ -154,6 +547,30 @@
         <attribute name="id">
           <data type="ID"/>
         </attribute>
+        <optional>
+          <attribute name="unnumbered">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="number"/>
+        </optional>
+        <optional>
+          <attribute name="subsequence"/>
+        </optional>
+        <optional>
+          <attribute name="keep-with-next">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="keep-lines-together">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="type"/>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -303,11 +720,11 @@
         <ref name="paragraph"/>
       </element>
     </define>
-    <define name="TextElement" combine="choice">
-      <ref name="concept"/>
-    </define>
   </include>
   <!-- end overrides -->
+  <define name="TextElement" combine="choice">
+    <ref name="concept"/>
+  </define>
   <define name="concept">
     <element name="concept">
       <optional>
@@ -899,7 +1316,36 @@
       <attribute name="id">
         <data type="ID"/>
       </attribute>
-      <ref name="paragraph"/>
+      <optional>
+        <attribute name="unnumbered">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="number"/>
+      </optional>
+      <optional>
+        <attribute name="subsequence"/>
+      </optional>
+      <optional>
+        <attribute name="keep-with-next">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <optional>
+        <attribute name="keep-lines-together">
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+      <oneOrMore>
+        <choice>
+          <ref name="paragraph"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="formula"/>
+        </choice>
+      </oneOrMore>
     </element>
   </define>
   <define name="termexample">