metanorma-iec 1.0.3 → 1.0.8

data/lib/asciidoctor/iec/front.rb

@@ -0,0 +1,220 @@
+module Asciidoctor
+  module Iec
+    class Converter < ISO::Converter
+      def metadata_author(node, xml)
+        publishers = node.attr("publisher") || "IEC"
+        publishers.split(/,[ ]?/).each do |p|
+          xml.contributor do |c|
+            c.role **{ type: "author" }
+            c.organization { |a| organization(a, p) }
+          end
+        end
+      end
+
+      def metadata_publisher(node, xml)
+        publishers = node.attr("publisher") || "IEC"
+        publishers.split(/,[ ]?/).each do |p|
+          xml.contributor do |c|
+            c.role **{ type: "publisher" }
+            c.organization { |a| organization(a, p) }
+          end
+        end
+      end
+
+      def metadata_copyright(node, xml)
+        publishers = node.attr("publisher") || "IEC"
+        publishers.split(/,[ ]?/).each do |p|
+          xml.copyright do |c|
+            c.from (node.attr("copyright-year") || Date.today.year)
+            c.owner do |owner|
+              owner.organization { |o| organization(o, p) }
+            end
+          end
+        end
+      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, false)
+        dn = id_edition_suffix(dn, node)
+        xml.docidentifier dn, **attr_code(type: "iso")
+      end
+
+      def id_edition_suffix(dn, node)
+        ed = node.attr("edition") || 1
+        dn += " ED #{ed}"
+        dn
+      end
+
+      STAGE_CODES = {
+        "PNW" => "1000",
+        "ANW" => "2000",
+        "CAN" => "2098",
+        "ACD" => "2099",
+        "CD" => "3020",
+        "BWG" => "3092",
+        "A2CD" => "3099",
+        "2CD" => "3520",
+        "3CD" => "3520",
+        "4CD" => "3520",
+        "5CD" => "3520",
+        "6CD" => "3520",
+        "7CD" => "3520",
+        "8CD" => "3520",
+        "9CD" => "3520",
+        "CDM" => "3591",
+        "A3CD" => "3592",
+        "A4CD" => "3592",
+        "A5CD" => "3592",
+        "A6CD" => "3592",
+        "A7CD" => "3592",
+        "A8CD" => "3592",
+        "A9CD" => "3592",
+        "ACDV" => "3599",
+        "CCDV" => "4020",
+        "CDVM" => "4091",
+        "NCDV" => "4092",
+        "NADIS" => "4093",
+        "ADIS" => "4099",
+        "ADTR" => "4099",
+        "ADTS" => "4099",
+        "RDISH" => "5000",
+        "RFDIS" => "5000",
+        "CDISH" => "5020",
+        "CDPAS" => "5020",
+        "CDTR" => "5020",
+        "CDTS" => "5020",
+        "CFDIS" => "5020",
+        "DTRM" => "5092",
+        "DTSM" => "5092",
+        "NDTR" => "5092",
+        "NDTS" => "5092",
+        "NFDIS" => "5092",
+        "APUB" => "5099",
+        "BPUB" => "6000",
+        "PPUB" => "6060",
+        "RR" => "9092",
+        "AMW" => "9220",
+        "WPUB" => "9599",
+        "DELPUB" => "9960",
+      }.freeze
+
+      DOC_STAGE = {
+        "00": "PWI",
+        "10": "NWIP",
+        "20": "WD",
+        "30": "CD",
+        "40": "CDV",
+        "50": "FDIS",
+        "60": "PPUB",
+        "90": "RR",
+        "92": "AMW",
+        "95": "WPUB",
+        "99": "DELPUB",
+      }.freeze
+
+      STAGE_ABBRS = {
+        "00" => {"00" => "PWI"},
+        "10" => {"00" => "PNW"},
+        "20" => {"00" => "ANW", "98" => "CAN", "99" => "ACD"},
+        "30" => {"00" => "CD", "20" => "CD", "92" => "BWG", "97" => "MERGED", "98" => "DREJ", "99" => "A2CD"},
+        "35" => {"00" => "CD", "20" => "CD", "91" => "CDM", "92" => "ACD", "99" => "ACDV"},
+        "40" => {"00" => "CCDV", "20" => "CCDV", "91" => "CDVM", "92" => "NCDV", "93" => "NADIS", "95" => "ADISSB", "99" => "ADIS"},
+        "50" => {"00" => "RFDIS", "20" => "CFDIS", "92" => "NFDIS", "95" => "APUBSB", "99" => "APUB"},
+        "60" => {"00" => "BPUB", "60" => "PPUB"},
+        "90" => {"00" => "RR", "92" => "RR"},
+        "92" => {"00" => "AMW", "20" => "AMW"},
+        "95" => {"00" => "WPUB", "99" => "WPUB"},
+        "99" => {"00" => "DELPUB", "60" => "DELPUB"},
+      }.freeze
+
+      STAGE_NAMES = {
+        "00": "Preliminary work item",
+        "10": "New work item proposal",
+        "20": "Working draft",
+        "30": "Committee draft",
+        "35": "Committee draft",
+        "40": "Committed draft for vote",
+        "50": "Final draft international standard",
+        "60": "International standard",
+        "90": "Review",
+        "92": "Review",
+        "95": "Withdrawal",
+        "99": "Deleted",
+      }.freeze
+
+      def status_abbrev1(stage, substage, iter, doctype, draft)
+        return "" unless stage
+        abbr = STAGE_ABBRS.dig(stage, substage) || "??"
+        if stage == "35" && substage == "92"
+          iter = (iter.to_i + 1) % "02"
+        end
+        case doctype
+        when "technical-report"
+          stage = "ADTR" if stage == "40" && substage == "99"
+          stage = "CDTR" if stage == "50" && substage == "20"
+          stage = "DTRM" if stage == "50" && substage == "92"
+        when "technical-specification"
+          stage = "ADTS" if stage == "40" && substage == "99"
+          stage = "CDTS" if stage == "50" && substage == "20"
+          stage = "DTSM" if stage == "50" && substage == "92"
+        when "interpretation-sheet"
+          stage = "RDISH" if stage == "50" && substage == "00"
+          stage = "CDISH" if stage == "50" && substage == "20"
+        when "publicly-available-specification"
+          stage = "CDPAS" if stage == "50" && substage == "20"
+        end
+        abbr = abbr.sub(/CD$/, "#{iter}CD") if iter
+        abbr
+      end
+
+      def stage_abbr(stage, substage)
+        return "PPUB" if stage == "60"
+        DOC_STAGE[stage.to_sym] || "??"
+      end
+
+      def stage_name(stage, substage, _doctype, _iteration)
+        STAGE_NAMES[stage.to_sym]
+      end
+
+      def get_stage(node)
+        stage = node.attr("status") || node.attr("docstage") || "60"
+        m = /([0-9])CD$/.match(stage) and
+          node.set_attr("iteration", m[1])
+        STAGE_CODES[stage] and stage = STAGE_CODES[stage][0..1]
+        stage
+      end
+
+      def get_substage(node)
+        st = node.attr("status") || node.attr("docstage")
+        stage = get_stage(node)
+        node.attr("docsubstage") ||
+          ( stage == "60" ? "60" :
+           STAGE_CODES[st] ? STAGE_CODES[st][2..3] :
+           "00" )
+      end
+
+      def id_stage_abbr(stage, substage, node)
+        return "" if stage == "60"
+        abbr = DOC_STAGE[stage.to_sym] || ""
+        abbr = node.attr("iteration") + abbr if node.attr("iteration")
+        abbr
+      end
+
+      def metadata_status(node, xml)
+        stage = get_stage(node)
+        substage = get_substage(node)
+        xml.status do |s|
+          s.stage stage, **attr_code(abbreviation: stage_abbr(stage, substage))
+          s.substage substage,
+            **attr_code(abbreviation: status_abbrev1(stage, substage,
+                                                     node.attr("iteration"), 
+                                                     doctype(node),node.attr("draft")))
+          node.attr("iteration") && (s.iteration node.attr("iteration"))
+        end
+      end
+    end
+  end
+end

data/lib/asciidoctor/iec/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>

data/lib/asciidoctor/iec/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">
@@ -88,6 +91,12 @@
     </define>
     <define name="sections">
       <element name="sections">
+        <zeroOrMore>
+          <choice>
+            <ref name="note"/>
+            <ref name="admonition"/>
+          </choice>
+        </zeroOrMore>
         <ref name="clause"/>
         <optional>
           <choice>
@@ -260,6 +269,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">
@@ -507,8 +518,13 @@
         </attribute>
       </optional>
       <oneOrMore>
-        <ref name="paragraph-with-footnote"/>
+        <ref name="BasicBlock"/>
       </oneOrMore>
     </element>
   </define>
+  <define name="stagename">
+    <element name="stagename">
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/isodoc/iec/base_convert.rb

@@ -72,6 +72,163 @@ module IsoDoc
         obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
         l10n("<b>#{@annex_lbl} #{num}</b><br/><br/>#{obl}")
       end
+
+      def convert1(docxml, filename, dir)
+        id = docxml&.at(ns("//bibdata/docnumber"))&.text
+        @is_iev = id == "60050"
+        id = docxml&.at(ns("//bibdata/docidentifier[@type = 'iso']"))&.text
+        m = /60050-(\d+)/.match(id) and @iev_part = m[1]
+        super
+      end
+
+      def introduction(isoxml, out)
+        return super unless @is_iev
+        f = isoxml.at(ns("//introduction")) || return
+        title_attr = { class: "IntroTitle" }
+        page_break(out)
+        out.div **{ class: "Section3", id: f["id"] } do |div|
+          clause_name(nil, @labels["introduction_iev"], div, title_attr)
+          f.elements.each do |e|
+            parse(e, div) unless e.name == "title"
+          end
+        end
+      end
+
+      def introduction_names(clause)
+        return super unless @is_iev
+      end
+
+      def bibliography(isoxml, out)
+        return super unless @is_iev
+      end
+
+      def biblio_list(f, div, biblio)
+        return super unless @is_iev
+        i = 0
+        f.children.each do |b|
+          parse(b, div) unless %w(title bibitem).include? b.name
+        end
+      end
+
+      def terms_parse(node, out)
+        return super unless @is_iev
+        page_break(out)
+        out.div **attr_code(id: node["id"]) do |div|
+          out.p(**{ class: "zzSTDTitle2" }) do |p|
+            p.b do |b|
+              b << "#{anchor(node['id'], :label)} "
+              node&.at(ns("./title"))&.children&.each { |c2| parse(c2, b) }
+            end
+          end
+          node.children.reject { |c1| c1.name == "title" }.each do |c1|
+            parse(c1, div)
+          end
+        end
+      end
+
+      def initial_anchor_names(d)
+        super
+        return unless @is_iev
+        terms_iev_names(d)
+        middle_section_asset_names(d)
+        termnote_anchor_names(d)
+        termexample_anchor_names(d)
+      end
+
+      def terms_iev_names(d)
+        d.xpath(ns("//sections/clause/terms")).each_with_index do |t, i|
+          num = "#{@iev_part}-%02d" % [i+1]
+          @anchors[t["id"]] =
+            { label: num, xref: l10n("#{@labels["section_iev"]}-#{num}"), level: 2,
+              type: "clause" }
+          t.xpath(ns("./term")).each_with_index do |c, i|
+            num2 = "%02d" % [i+1]
+            section_names1(c, "#{num}-#{num2}", 3)
+          end
+        end
+      end
+
+      def termref_cleanup(docxml)
+        return super unless @is_iev
+        docxml.
+          gsub(%r{\s*\[/TERMREF\]\s*</p>\s*<p>\s*\[TERMREF\]}, "; ").
+          gsub(/\[TERMREF\]\s*/, l10n("#{@source_lbl}: ")).
+          gsub(/\s*\[MODIFICATION\]\s*\[\/TERMREF\]/, l10n(", #{@modified_lbl} [/TERMREF]")).
+          gsub(/\s*\[\/TERMREF\]\s*/, l10n("")).
+          gsub(/\s*\[MODIFICATION\]/, l10n(", #{@modified_lbl} &mdash; "))
+      end
+
+      def set_termdomain(termdomain)
+        return super unless @is_iev
+      end
+
+      def term_suffix(node, out)
+        return unless @is_iev
+        domain = node&.at(ns("../domain"))&.text
+        return unless domain
+        out << ", &lt;#{domain}&gt;"
+      end
+
+      def deprecated_term_parse(node, out)
+        out.p **{ class: "DeprecatedTerms", style:"text-align:left;" } do |p|
+          p << l10n("#{@deprecated_lbl}: ")
+          node.children.each { |c| parse(c, p) }
+          term_suffix(node, p)
+        end
+      end
+
+      def admitted_term_parse(node, out)
+        out.p **{ class: "AltTerms", style:"text-align:left;" } do |p|
+          node.children.each { |c| parse(c, p) }
+          term_suffix(node, p)
+        end
+      end
+
+      def term_parse(node, out)
+        return super unless @is_iev
+        out.p **{ class: "Terms", style:"text-align:left;" } do |p|
+          node.children.each { |c| parse(c, p) }
+          term_suffix(node, p)
+        end
+      end
+
+      def admonition_parse(node, out)
+        type = node["type"]
+        name = admonition_name(node, type)
+        out.div **{ id: node["id"], class: admonition_class(node) } do |div|
+          node.first_element_child.name == "p" ?
+            admonition_p_parse(node, div, name) : admonition_parse1(node, div, name)
+        end
+      end
+
+      def admonition_parse1(node, div, name)
+        div.p do |p|
+          admonition_name_parse(node, p, name) if name
+        end
+        node.children.each { |n| parse(n, div) unless n.name == "name" }
+      end
+
+      def admonition_p_parse(node, div, name)
+        div.p do |p|
+          admonition_name_parse(node, p, name) if name
+          node.first_element_child.children.each { |n| parse(n, p) }
+        end
+        node.element_children[1..-1].each { |n| parse(n, div) }
+      end
+
+      def admonition_name_parse(_node, div, name)
+        name.children.each { |n| parse(n, div) }
+        div << " &mdash; "
+      end
+
+      def clause_parse_title(node, div, c1, out)
+        IsoDoc::Common.instance_method(:clause_parse_title).bind(self).call(node, div, c1, out)
+      end
+
+      def biblio_list(f, div, biblio)
+        biblio = false
+        super
+      end
     end
   end
 end