metanorma-iec 1.0.3 → 1.0.4

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">
@@ -511,4 +514,9 @@
       </oneOrMore>
     </element>
   </define>
+  <define name="stagename">
+    <element name="stagename">
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/isodoc/iec/base_convert.rb

@@ -72,6 +72,124 @@ 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 textcleanup(docxml)
+        return super unless @is_iev
+        docxml.
+          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
     end
   end
 end

data/lib/isodoc/iec/html/htmlstyle.scss

@@ -285,14 +285,17 @@ div.figure > img {
 */
 
 .document-type-band {
-    @include docBand(2, 100%, 180px);
+    @include docBand($order: 2, $offset: 180px);
+
+    .document-type {
+        top: 20px;
+    }
 }
 
 .document-stage-band {
     @include docBand(1, 210px);
 }
 
-p.document-type,
 p.document-stage {
     @include docBandTitle(210px);
 }

data/lib/isodoc/iec/i18n-en.yaml

@@ -1,3 +1,5 @@
 introduction: INTRODUCTION
+introduction_iev: INTRODUCTION<br/>Principles and rules followed
 foreword: FOREWORD
 IEC: INTERNATIONAL ELECTROTECHNICAL COMMISSION
+section_iev: Section

data/lib/isodoc/iec/i18n-fr.yaml

@@ -1,3 +1,5 @@
 introduction: INTRODUCTION
+introduction_iev: INTRODUCTION<br/>Principes d’établissement et règles suivies
 foreword: AVANT-PROPOS
 IEC: COMMISSION ELECTROTECHNIQUE INTERNATIONALE
+section_iev: Section

data/lib/isodoc/iec/metadata.rb

@@ -4,66 +4,17 @@ require "metanorma-iso"
 module IsoDoc
   module Iec
     class  Metadata < IsoDoc::Iso::Metadata
-      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
-
-      def stage_abbr(stage)
-        ret = STAGE_ABBRS.dig(stage, "00") || "??"
-        ret = "PPUB" if stage == "60"
-        ret
-      end
-
-      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 docstatus(isoxml, _out)
         docstatus = isoxml.at(ns("//bibdata/status/stage"))
+        substage = isoxml.at(ns("//bibdata/status/substage"))
         set(:unpublished, false)
         if docstatus
           set(:stage, docstatus.text)
           set(:stage_int, docstatus.text.to_i)
           set(:unpublished, unpublished(docstatus.text))
-          set(:statusabbr, status_abbrev1(docstatus.text,
-                                          isoxml&.at(ns("//bibdata/status/substage"))&.text,
-                                          isoxml&.at(ns("//bibdata/status/iteration"))&.text,
-                                          isoxml&.at(ns("//bibdata/ext/doctype"))&.text,
-                                          isoxml&.at(ns("//version/draft"))&.text))
+          set(:statusabbr, substage["abbreviation"])
           unpublished(docstatus.text) and
-            set(:stageabbr, stage_abbr(docstatus.text))
+            set(:stageabbr, docstatus["abbreviation"])
         end
         revdate = isoxml.at(ns("//version/revision-date"))
         set(:revdate, revdate&.text)

data/lib/metanorma/iec/version.rb

@@ -1,6 +1,6 @@
 module Metanorma
   module Iec
-    VERSION = "1.0.3"
+    VERSION = "1.0.4"
   end
 end
 

data/spec/asciidoctor-iec/base_spec.rb

@@ -123,8 +123,8 @@ RSpec.describe Asciidoctor::Iec do
          <language>en</language>
          <script>Latn</script>
          <status>
-           <stage>10</stage>
-           <substage>20</substage>
+           <stage abbreviation="NWIP">10</stage>
+           <substage abbreviation="??">20</substage>
            <iteration>3</iteration>
          </status>
          <copyright>
@@ -159,6 +159,7 @@ RSpec.describe Asciidoctor::Iec do
 <structuredidentifier>
   <project-number part="1">IEC 1000</project-number>
 </structuredidentifier>
+<stagename>New work item proposal</stagename>
        </ext>
        </bibdata>
        #{UNPUBLISHED_BOILERPLATE}
@@ -234,8 +235,8 @@ RSpec.describe Asciidoctor::Iec do
          <language>el</language>
          <script>Grek</script>
          <status>
-           <stage>30</stage>
-           <substage>99</substage>
+           <stage abbreviation="CD">30</stage>
+           <substage abbreviation="A22CD">99</substage>
            <iteration>2</iteration>
          </status>
          <copyright>
@@ -274,6 +275,7 @@ RSpec.describe Asciidoctor::Iec do
          <structuredidentifier>
            <project-number part="1" subpart="1">ISO/IEC/IETF 1000</project-number>
          </structuredidentifier>
+         <stagename>Committee draft</stagename>
          </ext>
        </bibdata>
     #{UNPUBLISHED_BOILERPLATE.sub(/IEC #{Date.today.year}/, "ISO/IEC/IETF 2001")}
@@ -355,8 +357,8 @@ RSpec.describe Asciidoctor::Iec do
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>50</stage>
-    <substage>00</substage>
+    <stage abbreviation="FDIS">50</stage>
+    <substage abbreviation="RFDIS">00</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -377,6 +379,7 @@ RSpec.describe Asciidoctor::Iec do
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>Final draft international standard</stagename>
   </ext>
 </bibdata>
 #{UNPUBLISHED_BOILERPLATE}
@@ -418,8 +421,8 @@ OUTPUT
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>60</stage>
-    <substage>60</substage>
+    <stage abbreviation="PPUB">60</stage>
+    <substage abbreviation="PPUB">60</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -440,6 +443,7 @@ OUTPUT
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>International standard</stagename>
   </ext>
 </bibdata>
 #{BOILERPLATE}
@@ -482,8 +486,8 @@ OUTPUT
   <language>en</language>
   <script>Latn</script>
   <status>
-    <stage>60</stage>
-    <substage>00</substage>
+    <stage abbreviation="PPUB">60</stage>
+    <substage abbreviation="BPUB">00</substage>
   </status>
   <copyright>
     <from>#{Date.today.year}</from>
@@ -504,6 +508,7 @@ OUTPUT
     <structuredidentifier>
       <project-number>IEC 1000</project-number>
     </structuredidentifier>
+    <stagename>International standard</stagename>
   </ext>
 </bibdata>
 #{BOILERPLATE}

data/spec/asciidoctor-iec/blocks_spec.rb

@@ -352,7 +352,7 @@ RSpec.describe Asciidoctor::Iec do
       #{BLANK_HDR}
        <sections>
          <quote id="_">
-         <source type="inline" bibitemid="ISO7301" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></source>
+         <source type="inline" bibitemid="ISO7301" citeas=""><localityStack><locality type="section"><referenceFrom>1</referenceFrom></locality></localityStack></source>
          <author>ISO</author>
          <p id="_">Block quotation</p>
        </quote>
@@ -429,7 +429,11 @@ RSpec.describe Asciidoctor::Iec do
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="identical">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
        </termsource>
        </term>
        </terms>
@@ -457,7 +461,11 @@ RSpec.describe Asciidoctor::Iec do
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="modified">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
          <modification>
            <p id="_">with adjustments</p>
          </modification>

data/spec/asciidoctor-iec/cleanup_spec.rb

@@ -163,7 +163,11 @@ RSpec.describe Asciidoctor::Iec do
          <term id="_">
          <preferred>Term1</preferred>
          <termsource status="identical">
-         <origin bibitemid="ISO2191" type="inline" citeas=""><locality type="section"><referenceFrom>1</referenceFrom></locality></origin>
+         <origin bibitemid="ISO2191" type="inline" citeas="">
+         <localityStack>
+        <locality type="section"><referenceFrom>1</referenceFrom></locality>
+         </localityStack>
+        </origin>
        </termsource>
        </term>
        </terms>

data/spec/asciidoctor-iec/iev_spec.rb

@@ -0,0 +1,161 @@
+require "spec_helper"
+require "fileutils"
+
+RSpec.describe Asciidoctor::Iec do
+  it "generates reference boilerplate for IEV" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      [bibliography]
+      == Normative References
+
+      * [[[A,B]]], _TITLE_
+    INPUT
+<?xml version='1.0' encoding='UTF-8'?>
+       <iec-standard xmlns='https://www.metanorma.org/ns/iec'>
+         <bibdata type='standard'>
+           <docidentifier type='iso'>IEC 60050 ED 1</docidentifier>
+           <docnumber>60050</docnumber>
+           <contributor>
+             <role type='author'/>
+             <organization>
+               <name>International Electrotechnical Commission</name>
+               <abbreviation>IEC</abbreviation>
+             </organization>
+           </contributor>
+           <contributor>
+             <role type='publisher'/>
+             <organization>
+               <name>International Electrotechnical Commission</name>
+               <abbreviation>IEC</abbreviation>
+             </organization>
+           </contributor>
+           <language>en</language>
+           <script>Latn</script>
+           <status>
+             <stage abbreviation="PPUB">60</stage>
+             <substage abbreviation="PPUB">60</substage>
+           </status>
+           <copyright>
+             <from>2020</from>
+             <owner>
+               <organization>
+                 <name>International Electrotechnical Commission</name>
+                 <abbreviation>IEC</abbreviation>
+               </organization>
+             </owner>
+           </copyright>
+           <ext>
+             <doctype>article</doctype>
+             <editorialgroup>
+               <technical-committee/>
+               <subcommittee/>
+               <workgroup/>
+             </editorialgroup>
+             <structuredidentifier>
+               <project-number>IEC 60050</project-number>
+             </structuredidentifier>
+                   <stagename>International standard</stagename>
+           </ext>
+         </bibdata>
+         #{BOILERPLATE}
+         <sections> </sections>
+         <bibliography>
+           <references id='_' obligation='informative'>
+             <title>Normative References</title>
+             <p id='_'>There are no normative references in this document.</p>
+             <bibitem id='A'>
+               <formattedref format='application/x-isodoc+xml'>
+                 <em>TITLE</em>
+               </formattedref>
+               <docidentifier>B</docidentifier>
+             </bibitem>
+           </references>
+         </bibliography>
+       </iec-standard>
+    OUTPUT
+  end
+
+      it "generates terms boilerplate for IEV" do
+     expect(xmlpp(strip_guid(Asciidoctor.convert(<<~"INPUT", backend: :iec, header_footer: true)))).to be_equivalent_to xmlpp(<<~"OUTPUT")
+      = Document title
+      Author
+      :docfile: test.adoc
+      :nodoc:
+      :novalid:
+      :no-isobib:
+      :docnumber: 60050
+
+      == Terms and definitions
+      === General
+      ==== Term 1
+INPUT
+<iec-standard xmlns='https://www.metanorma.org/ns/iec'>
+  <bibdata type='standard'>
+    <docidentifier type='iso'>IEC 60050 ED 1</docidentifier>
+    <docnumber>60050</docnumber>
+    <contributor>
+      <role type='author'/>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+      </organization>
+    </contributor>
+    <contributor>
+      <role type='publisher'/>
+      <organization>
+        <name>International Electrotechnical Commission</name>
+        <abbreviation>IEC</abbreviation>
+      </organization>
+    </contributor>
+    <language>en</language>
+    <script>Latn</script>
+    <status>
+      <stage abbreviation="PPUB">60</stage>
+      <substage abbreviation="PPUB">60</substage>
+    </status>
+    <copyright>
+      <from>2020</from>
+      <owner>
+        <organization>
+          <name>International Electrotechnical Commission</name>
+          <abbreviation>IEC</abbreviation>
+        </organization>
+      </owner>
+    </copyright>
+    <ext>
+      <doctype>article</doctype>
+      <editorialgroup>
+        <technical-committee/>
+        <subcommittee/>
+        <workgroup/>
+      </editorialgroup>
+      <structuredidentifier>
+        <project-number>IEC 60050</project-number>
+      </structuredidentifier>
+      <stagename>International standard</stagename>
+    </ext>
+  </bibdata>
+           #{BOILERPLATE}
+  <sections>
+    <clause id='_' obligation='normative'>
+      <title>Terms and definitions</title>
+      <terms id='_' obligation='normative'>
+        <title>General</title>
+        <term id='_'>
+          <preferred>Term 1</preferred>
+        </term>
+      </terms>
+    </clause>
+  </sections>
+</iec-standard>
+
+OUTPUT
+  end
+end