metanorma-iso 1.4.2 → 1.5.2

data/lib/isodoc/iso/metadata.rb

@@ -3,7 +3,7 @@ require "isodoc"
 module IsoDoc
   module Iso
     class  Metadata < IsoDoc::Metadata
-      def initialize(lang, script, labels)
+      def initialize(lang, script, i18n)
         super
         @metadata = {
           tc: "XXXX",

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -1,4 +1,4 @@
-require_relative "base_convert"
+require_relative "init"
 require "isodoc"
 
 module IsoDoc
@@ -8,6 +8,104 @@ module IsoDoc
     # schema encapsulation of the document for validation
     #
     class PresentationXMLConvert < IsoDoc::PresentationXMLConvert
+      def initialize(options)
+        super
+      end
+
+      def convert1(docxml, filename, dir)
+        if amd(docxml)
+          @oldsuppressheadingnumbers = @suppressheadingnumbers
+          @suppressheadingnumbers = true
+        end
+        super
+      end
+
+      def annex(isoxml)
+        amd(isoxml) and @suppressheadingnumbers = @oldsuppressheadingnumbers
+        super
+        isoxml.xpath(ns("//annex//clause | //annex//appendix")).each do |f|
+          clause1(f)
+        end
+        amd(isoxml) and @suppressheadingnumbers = true
+      end
+
+      def xref_init(lang, script, klass, labels, options)
+        @xrefs = Xref.new(lang, script, klass, labels, options)
+      end
+
+      def figure1(f)
+        return if labelled_ancestor(f) && f.ancestors("figure").empty?
+        lbl = @xrefs.anchor(f['id'], :label, false) or return
+        figname = f.parent.name == "figure" ? "" : "#{@i18n.figure} "
+        connective = f.parent.name == "figure" ? "&nbsp; " : "&nbsp;&mdash; "
+        prefix_name(f, connective, l10n("#{figname}#{lbl}"), "name")
+      end
+
+      def example1(f)
+        n = @xrefs.get[f["id"]]
+        lbl = (n.nil? || n[:label].nil? || n[:label].empty?) ? @i18n.example :
+          l10n("#{@i18n.example} #{n[:label]}")
+        prefix_name(f, "&nbsp;&mdash; ", lbl, "name")
+      end
+
+      def eref_localities1_zh(target, type, from, to, delim)
+        subsection = from&.text&.match(/\./)
+        ret = (delim == ";") ? ";" : (type == "list") ? "" : delim
+        ret += " 第#{from.text}" if from
+        ret += "&ndash;#{to.text}" if to
+        loc = (@i18n.locality[type] || type.sub(/^locality:/, "").capitalize )
+        ret += " #{loc}" unless subsection && type == "clause" ||
+          type == "list" || target.match(/^IEV$|^IEC 60050-/)
+        ret += ")" if type == "list"
+        ret
+      end
+
+      def eref_localities1(target, type, from, to, delim, lang = "en")
+        return "" if type == "anchor"
+        subsection = from&.text&.match(/\./)
+        type = type.downcase
+        lang == "zh" and
+          return l10n(eref_localities1_zh(target, type, from, to, delim))
+        ret = (delim == ";") ? ";" : (type == "list") ? "" : delim
+        loc = @i18n.locality[type] || type.sub(/^locality:/, "").capitalize
+        ret += " #{loc}" unless subsection && type == "clause" ||
+          type == "list" || target.match(/^IEV$|^IEC 60050-/)
+        ret += " #{from.text}" if from
+        ret += "&ndash;#{to.text}" if to
+        ret += ")" if type == "list"
+        l10n(ret)
+      end
+
+      def prefix_container(container, linkend, target)
+        delim = @xrefs.anchor(target, :type) == "listitem" ? " " : ", "
+        l10n(@xrefs.anchor(container, :xref) + delim + linkend)
+      end
+
+      def example_span_label(node, div, name)
+        return if name.nil?
+        div.span **{ class: "example_label" } do |p|
+          name.children.each { |n| parse(n, div) }
+        end
+      end
+
+      def clause1(f)
+        if !f.at(ns("./title")) &&
+            !%w(sections preface bibliography).include?(f.parent.name)
+          f["inline-header"] = "true"
+        end
+        super
+      end
+
+      def clause(docxml)
+        docxml.xpath(ns("//clause[not(ancestor::annex)] | "\
+                        "//terms | //definitions | //references | "\
+                        "//preface/introduction[clause]")).
+        each do |f|
+          clause1(f)
+        end
+      end
+
+      include Init
     end
   end
 end

data/lib/isodoc/iso/sections.rb

@@ -37,11 +37,10 @@ module IsoDoc
 
       def introduction(isoxml, out)
         f = isoxml.at(ns("//introduction")) || return
-        num = f.at(ns(".//clause")) ? "0" : nil
         title_attr = { class: "IntroTitle" }
         page_break(out)
         out.div **{ class: "Section3", id: f["id"] } do |div|
-          clause_name(num, @introduction_lbl, div, title_attr)
+          clause_name(nil, f.at(ns("./title")), div, title_attr)
           f.elements.each do |e|
             parse(e, div) unless e.name == "title"
           end
@@ -52,15 +51,11 @@ module IsoDoc
         f = isoxml.at(ns("//foreword")) || return
         page_break(out)
         out.div **attr_code(id: f["id"]) do |s|
-          s.h1(**{ class: "ForewordTitle" }) { |h1| h1 << @foreword_lbl }
+          clause_name(nil, f.at(ns("./title")) || @i18n.foreword, s,
+                      { class: "ForewordTitle" })
           f.elements.each { |e| parse(e, s) unless e.name == "title" }
         end
       end
-
-      def clause_parse_title(node, div, c1, out)
-        return inline_header_title(out, node, c1) if c1.nil?
-        super
-      end
     end
   end
 end

data/lib/isodoc/iso/word_convert.rb

@@ -1,6 +1,6 @@
 require_relative "base_convert"
 require "isodoc"
-require_relative "metadata"
+require_relative "init"
 
 module IsoDoc
   module Iso
@@ -121,6 +121,7 @@ module IsoDoc
       end
 
       include BaseConvert
+      include Init
     end
   end
 end

data/lib/isodoc/iso/xref.rb

@@ -21,6 +21,8 @@ module IsoDoc
       # we can reference 0-number clauses in introduction
       def introduction_names(clause)
         return if clause.nil?
+        clause.at(ns("./clause")) and @anchors[clause["id"]] = 
+          { label: "0", level: 1, xref: clause.at(ns("./title"))&.text, type: "clause" }
         clause.xpath(ns("./clause")).each_with_index do |c, i|
           section_names1(c, "0.#{i + 1}", 2)
         end

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "1.4.2".freeze
+    VERSION = "1.5.2".freeze
   end
 end

data/metanorma-iso.gemspec

@@ -30,8 +30,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
 
   spec.add_dependency "ruby-jing"
-  spec.add_dependency "isodoc", "~> 1.1.0"
-  spec.add_dependency "metanorma-standoc", "~> 1.4.0"
+  spec.add_dependency "isodoc", "~> 1.2.0"
+  spec.add_dependency "metanorma-standoc", "~> 1.5.0"
   spec.add_dependency "tokenizer", "~> 0.3.0"
   spec.add_dependency "twitter_cldr"
   spec.add_dependency "mn2sts", "~> 1.2.0"
@@ -41,7 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "equivalent-xml", "~> 0.6"
   spec.add_development_dependency "guard", "~> 2.14"
   spec.add_development_dependency "guard-rspec", "~> 4.7"
-  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rake" #, "~> 12.0"
   spec.add_development_dependency "rspec", "~> 3.6"
   spec.add_development_dependency "rubocop", "= 0.54.0"
   spec.add_development_dependency "simplecov", "~> 0.15"

data/spec/asciidoctor-iso/base_spec.rb

@@ -186,6 +186,7 @@ RSpec.describe Asciidoctor::ISO do
       :language: el
       :script: Grek
       :publisher: IEC,IETF,ISO
+      :copyright-holder: ISO,IETF
       :copyright-year: 2001
       :doctype: technical-report
     INPUT
@@ -248,8 +249,8 @@ RSpec.describe Asciidoctor::ISO do
            <from>2001</from>
            <owner>
              <organization>
-               <name>International Electrotechnical Commission</name>
-               <abbreviation>IEC</abbreviation>
+               <name>International Organization for Standardization</name>
+               <abbreviation>ISO</abbreviation>
              </organization>
            </owner>
          </copyright>
@@ -261,15 +262,6 @@ RSpec.describe Asciidoctor::ISO do
              </organization>
            </owner>
          </copyright>
-         <copyright>
-           <from>2001</from>
-           <owner>
-             <organization>
-               <name>International Organization for Standardization</name>
-               <abbreviation>ISO</abbreviation>
-             </organization>
-           </owner>
-         </copyright>
          <ext>
          <doctype>technical-report</doctype>
          <editorialgroup>

data/spec/asciidoctor-iso/cleanup_spec.rb

@@ -190,7 +190,7 @@ RSpec.describe Asciidoctor::ISO do
       </p>
       </foreword></preface><sections>
       </sections><bibliography><references id="_" obligation="informative" normative="true">
-        <title>Normative References</title>
+        <title>Normative references</title>
         <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
         <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
@@ -233,7 +233,7 @@ RSpec.describe Asciidoctor::ISO do
         </p>
       </foreword></preface><sections>
       </sections><bibliography><references id="_" obligation="informative" normative="true">
-        <title>Normative References</title>
+        <title>Normative references</title>
         <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
         <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
@@ -333,7 +333,7 @@ RSpec.describe Asciidoctor::ISO do
     INPUT
       #{BLANK_HDR}
       <sections></sections>
-      <bibliography><references id="_" obligation="informative" normative="true"><title>Normative References</title>
+      <bibliography><references id="_" obligation="informative" normative="true"><title>Normative references</title>
       <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
              <bibitem id="iso216" type="standard">
          <title format="text/plain">Reference</title>
@@ -638,7 +638,7 @@ RSpec.describe Asciidoctor::ISO do
       </fn>
       </p>
       </clause></sections><bibliography><references id="_" obligation="informative" normative="true">
-        <title>Normative References</title>
+        <title>Normative references</title>
         <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
         <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>

data/spec/asciidoctor-iso/inline_spec.rb

@@ -128,7 +128,7 @@ RSpec.describe Asciidoctor::ISO do
        <sections>
 
        </sections><bibliography><references id="_" obligation="informative" normative="true">
-         <title>Normative References</title>
+         <title>Normative references</title>
          <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
          <bibitem id="ISO712">
          <formattedref format="application/x-isodoc+xml">Reference</formattedref>

data/spec/asciidoctor-iso/refs_spec.rb

@@ -16,7 +16,7 @@ RSpec.describe Asciidoctor::ISO do
        #{BLANK_HDR}
        <sections>
               </sections><bibliography><references id="_" obligation="informative" normative="true">
-         <title>Normative References</title>
+         <title>Normative references</title>
          <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
          <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
@@ -65,7 +65,7 @@ RSpec.describe Asciidoctor::ISO do
   </clause>
 </sections>
       <bibliography><references id="_" obligation="informative" normative="true">
-        <title>Normative References</title>
+        <title>Normative references</title>
         <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
         <bibitem id="iso123" type="standard">
          <title format="text/plain">Standard</title>
@@ -101,7 +101,7 @@ RSpec.describe Asciidoctor::ISO do
               <sections>
 
        </sections><bibliography><references id="_" obligation="informative" normative="true">
-         <title>Normative References</title>
+         <title>Normative references</title>
          <p id="_">The following documents are referred to in the text in such a way that some or all of their content constitutes requirements of this document. For dated references, only the edition cited applies. For undated references, the latest edition of the referenced document (including any amendments) applies.</p>
          <bibitem id="iso123">
          <formattedref format="application/x-isodoc+xml">

data/spec/asciidoctor-iso/section_spec.rb

@@ -66,7 +66,7 @@ RSpec.describe Asciidoctor::ISO do
   <title>Acknowledgements</title>
 </acknowledgements>
 </preface><sections>
-       <clause id="_" obligation="normative">
+       <clause id="_" obligation="normative" inline-header='false' type="scope">
          <title>Scope</title>
          <p id="_">Text</p>
        </clause>
@@ -88,7 +88,9 @@ standardization at the following addresses:</p>
          <preferred>Term1</preferred>
        </term>
        </terms>
-       <clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title><terms id="_" obligation="normative">
+       <clause id="_" obligation="normative"><title>Terms, definitions, symbols and abbreviated terms</title>
+<terms id="_" obligation="normative">
+<title>Normal Terms</title>
        <p id='_'>For the purposes of this document, the following terms and definitions apply.</p>
 <p id='_'>
   ISO and IEC maintain terminological databases for use in
@@ -108,13 +110,14 @@ standardization at the following addresses:</p>
     </p>
   </li>
 </ul>
-         <title>Normal Terms</title>
          <term id="term-term2">
          <preferred>Term2</preferred>
        </term>
        </terms>
-       <definitions id="_"><title>Symbols and Abbreviated Terms</title></definitions></clause>
-       <definitions id="_"><title>Symbols and Abbreviated Terms</title></definitions>
+       <definitions id="_" obligation="normative">
+<title>Symbols and abbreviated terms</title></definitions></clause>
+       <definitions id="_" obligation="normative">
+<title>Symbols and abbreviated terms</title></definitions>
        <clause id="_" inline-header="false" obligation="normative"><title>Clause 4</title><clause id="_" inline-header="false" obligation="normative">
          <title>Introduction</title>
        </clause>
@@ -134,7 +137,7 @@ standardization at the following addresses:</p>
        <appendix id="_" inline-header="false" obligation="normative">
           <title>Appendix 1</title>
        </appendix></annex><bibliography><references id="_" obligation="informative" normative="true">
-         <title>Normative References</title>
+         <title>Normative references</title>
          <p id="_">There are no normative references in this document.</p>
        </references><clause id="_" obligation="informative">
          <title>Bibliography</title>

data/spec/asciidoctor-iso/validate_spec.rb

@@ -3,6 +3,93 @@ require "fileutils"
 
 RSpec.describe Asciidoctor::ISO do
 
+it "Warns of missing scope" do
+    FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  text
+  INPUT
+    expect(File.read("test.err")).to include "Scope clause missing"
+  FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  == Scope
+  INPUT
+    expect(File.read("test.err")).not_to include "Scope clause missing"
+
+end
+
+it "Warns of missing normative references" do
+    FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  text
+  INPUT
+    expect(File.read("test.err")).to include "Normative references missing"
+  FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  [bibliography]
+  == Normative references
+  INPUT
+    expect(File.read("test.err")).not_to include "Normative references missing"
+
+end
+
+it "Warns of missing terms & definitions" do
+    FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  text
+  INPUT
+    expect(File.read("test.err")).to include "Terms & definitions missing"
+  FileUtils.rm_f "test.err"
+    Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
+  = Document title
+  Author
+  :docfile: test.adoc
+  :nodoc:
+  :no-isobib:
+  :doctype: pizza
+
+  == Terms and definitions
+  === Term 1
+  INPUT
+    expect(File.read("test.err")).not_to include "Terms & definitions missing"
+
+end
+
+
 it "Warns of illegal doctype" do
     FileUtils.rm_f "test.err"
     Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
@@ -527,7 +614,7 @@ it "Style warning if Symbols and Abbreviated Terms contains extraneous matter" d
     expect(File.read("test.err")).to include "Symbols and Abbreviated Terms can only contain a definition list"
 end
 
-it "Warning if do not start with scope or introduction" do
+it "Warning if missing foreword" do
     FileUtils.rm_f "test.err"
   Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
   #{VALIDATING_BLANK_HDR}
@@ -536,19 +623,15 @@ it "Warning if do not start with scope or introduction" do
 
   Paragraph
   INPUT
-    expect(File.read("test.err")).to include "Prefatory material must be followed by (clause) Scope"
+    expect(File.read("test.err")).to include "Initial section must be (content) Foreword"
 end
 
-it "Warning if introduction not followed by scope" do
+it "Warning if do not start with scope or introduction" do
     FileUtils.rm_f "test.err"
   Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
   #{VALIDATING_BLANK_HDR}
-
-  .Foreword 
   Foreword
 
-  == Introduction
-
   == Symbols and Abbreviated Terms
 
   Paragraph
@@ -556,7 +639,7 @@ it "Warning if introduction not followed by scope" do
     expect(File.read("test.err")).to include "Prefatory material must be followed by (clause) Scope"
 end
 
-it "Warning if normative references not followed by terms and definitions" do
+it "Warning if introduction not followed by scope" do
     FileUtils.rm_f "test.err"
   Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
   #{VALIDATING_BLANK_HDR}
@@ -564,19 +647,16 @@ it "Warning if normative references not followed by terms and definitions" do
   .Foreword 
   Foreword
 
-  == Scope
-
-  [bibliography]
-  == Normative References
+  == Introduction
 
   == Symbols and Abbreviated Terms
 
   Paragraph
   INPUT
-    expect(File.read("test.err")).to include "Normative References must be followed by Terms and Definitions"
+    expect(File.read("test.err")).to include "Prefatory material must be followed by (clause) Scope"
 end
 
-it "Warning if there are no clauses in the document" do
+it "Warning if normative references not followed by terms and definitions" do
     FileUtils.rm_f "test.err"
   Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
   #{VALIDATING_BLANK_HDR}
@@ -589,20 +669,19 @@ it "Warning if there are no clauses in the document" do
   [bibliography]
   == Normative References
 
-  == Terms and Definitions
-
   == Symbols and Abbreviated Terms
 
+  Paragraph
   INPUT
-    expect(File.read("test.err")).to include "Document must contain clause after Terms and Definitions"
+    expect(File.read("test.err")).to include "Normative References must be followed by Terms and Definitions"
 end
 
-it "Warning if scope occurs after Terms and Definitions" do
+it "Warning if there are no clauses in the document" do
     FileUtils.rm_f "test.err"
   Asciidoctor.convert(<<~"INPUT", backend: :iso, header_footer: true)
   #{VALIDATING_BLANK_HDR}
 
-  .Foreword
+  .Foreword 
   Foreword
 
   == Scope
@@ -612,10 +691,10 @@ it "Warning if scope occurs after Terms and Definitions" do
 
   == Terms and Definitions
 
-  == Scope
+  == Symbols and Abbreviated Terms
 
   INPUT
-    expect(File.read("test.err")).to include "Scope must occur before Terms and Definitions"
+    expect(File.read("test.err")).to include "Document must contain at least one clause"
 end
 
 it "Warning if scope occurs after Terms and Definitions" do