metanorma-iso 2.0.8.1 → 2.1.0

data/lib/isodoc/iso/word_dis_convert.rb

@@ -0,0 +1,174 @@
+module IsoDoc
+  module Iso
+    class WordDISConvert < WordConvert
+      def default_file_locations(_options)
+        {
+          wordstylesheet: html_doc_path("wordstyle-dis.scss"),
+          standardstylesheet: html_doc_path("isodoc-dis.scss"),
+          header: html_doc_path("header-dis.html"),
+          wordcoverpage: html_doc_path("word_iso_titlepage-dis.html"),
+          wordintropage: html_doc_path("word_iso_intro-dis.html"),
+          ulstyle: "l3",
+          olstyle: "l2",
+        }
+      end
+
+      def initialize(options)
+        @libdir ||= File.dirname(__FILE__) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
+        options.merge!(default_file_locations(options))
+        super
+      end
+
+      def init_dis; end
+
+      def style_cleanup(docxml)
+        super
+        dis_styles(docxml)
+      end
+
+      STYLESMAP = {
+        AltTerms: "AdmittedTerm",
+        TableFootnote: "Tablefootnote",
+        formula: "Formula",
+        note: "Note",
+        NormRef: "RefNorm",
+        biblio: "BiblioEntry",
+        MsoNormal: "MsoBodyText",
+        FigureTitle: "Figuretitle",
+      }.freeze
+
+      def dis_styles(docxml)
+        STYLESMAP.each do |k, v|
+          docxml.xpath("//*[@class = '#{k}']").each { |s| s["class"] = v }
+        end
+        docxml.xpath("//h1[@class = 'ForewordTitle' or @class = 'IntroTitle']")
+          .each { |h| h.name = "p" }
+        dis_styles1(docxml)
+        docxml.xpath("//p[not(@class)]").each { |p| p["class"] = "MsoBodyText" }
+      end
+
+      def dis_styles1(docxml)
+        code_style(docxml)
+        figure_style(docxml)
+        example_style(docxml)
+      end
+
+      def example_style(docxml)
+        docxml.xpath("//div[@class = 'Example']").each do |d|
+          d.xpath("./p").each_with_index do |p, i|
+            next if p["class"] && p["class"] != "Example"
+
+            p["class"] = (i.zero? ? "Example" : "Examplecontinued")
+          end
+        end
+      end
+
+      def figure_name_attrs(_node)
+        { class: "FigureTitle", style: "text-align:center;" }
+      end
+
+      def table_title_attrs(_node)
+        { class: "Tabletitle", style: "text-align:center;" }
+      end
+
+      def word_annex_cleanup1(docxml, lvl)
+        docxml.xpath("//h#{lvl}[ancestor::*[@class = 'Section3']]").each do |h2|
+          h2.name = "p"
+          h2["class"] = "a#{lvl}"
+        end
+      end
+
+      def span_parse(node, out)
+        out.span **{ class: node["class"] } do |x|
+          node.children.each { |n| parse(n, x) }
+        end
+      end
+
+      def word_toc_preface(level)
+        <<~TOC.freeze
+          <span lang="EN-GB"><span
+          style='mso-element:field-begin'></span><span
+          style='mso-spacerun:yes'>&#xA0;</span>TOC \\o &quot;2-#{level}&quot; \\h \\z \\t
+          &quot;Heading 1;1;ANNEX;1;Biblio Title;1;Foreword Title;1;Intro Title;1;ANNEXN;1;ANNEXZ;1;na2;1;na3;1;na4;1;na5;1;na6;1;Title;1;Base_Heading;1;Box-title;1;Front Head;1;Index Head;1;AMEND Terms Heading;1;AMEND Heading 1 Unnumbered;1&quot;
+           <span style='mso-element:field-separator'></span></span>
+        TOC
+      end
+
+      def render_identifier(ident)
+        ret = super
+        ret[:sdo] = std_docid_semantic(ret[:sdo])
+        ret
+      end
+
+      FIGURE_NESTED_STYLES =
+        { Note: "Figurenote", example: "Figureexample" }.freeze
+
+      def figure_style(docxml)
+        docxml.xpath("//div[@class = 'figure']").each do |f|
+          FIGURE_NESTED_STYLES.each do |k, v|
+            f.xpath(".//*[@class = '#{k}']").each { |n| n["class"] = v }
+          end
+          f.xpath("./img").each do |i|
+            i.replace("<p class='FigureGraphic'>#{i.to_xml}</p>")
+          end
+        end
+      end
+
+      def code_style(doc)
+        span_style((doc.xpath("//tt//b") - doc.xpath("//tt//i//b")),
+                   "ISOCodebold")
+        span_style((doc.xpath("//tt//i") - doc.xpath("//tt//b//i")),
+                   "ISOCodeitalic")
+        span_style((doc.xpath("//b//tt") - doc.xpath("//b//i//tt")),
+                   "ISOCodebold")
+        span_style((doc.xpath("//i//tt") - doc.xpath("//i//b//tt")),
+                   "ISOCodeitalic")
+        span_style(doc.xpath("//tt"), "ISOCode")
+      end
+
+      def span_style(xpath, style)
+        xpath.each do |elem|
+          elem.name = "span"
+          elem["class"] = style
+        end
+      end
+
+      def make_tr_attr(cell, row, totalrows, header)
+        super.merge(header: header)
+      end
+
+      def word_cleanup(docxml)
+        word_table_cell_para(docxml)
+        super
+      end
+
+      def word_table_cell_para(docxml)
+        docxml.xpath("//td | //th").each do |t|
+          s = t["header"] == "true" ? "Tableheader" : "Tablebody"
+          t.delete("header")
+          if t.at("./p |./div")
+            t.xpath("./p | ./div").each { |p| p["class"] = s }
+          else
+            t.children = "<div class='#{s}'>#{t.children.to_xml}</div>"
+          end
+        end
+      end
+
+      def toWord(result, filename, dir, header)
+        result = from_xhtml(word_cleanup(to_xhtml(result)))
+          .gsub(/-DOUBLE_HYPHEN_ESCAPE-/, "--")
+        @wordstylesheet = wordstylesheet_update
+        ::Html2Doc::IsoDIS.new(
+          filename: filename,
+          imagedir: @localdir,
+          stylesheet: @wordstylesheet&.path,
+          header_file: header&.path, dir: dir,
+          asciimathdelims: [@openmathdelim, @closemathdelim],
+          liststyles: { ul: @ulstyle, ol: @olstyle }
+        ).process(result)
+        header&.unlink
+        @wordstylesheet.unlink if @wordstylesheet.is_a?(Tempfile)
+      end
+    end
+  end
+end

data/lib/isodoc/iso/xref.rb

@@ -10,36 +10,48 @@ module IsoDoc
         else
           initial_anchor_names1(doc)
         end
-        introduction_names(doc.at(ns("//introduction")))
+        if @parse_settings.empty? || @parse_settings[:clauses]
+          introduction_names(doc.at(ns("//introduction")))
+        end
       end
 
       def initial_anchor_names_amd(doc)
-        doc.xpath(ns("//preface/*")).each do |c|
-          c.element? and preface_names(c)
+        if @parse_settings.empty? || @parse_settings[:clauses]
+          doc.xpath(ns("//preface/*")).each do |c|
+            c.element? and preface_names(c)
+          end
+          doc.xpath(ns("//sections/clause")).each do |c|
+            c.element? and preface_names(c)
+          end
         end
-        sequential_asset_names(doc.xpath(ns("//preface/*")))
-        doc.xpath(ns("//sections/clause")).each do |c|
-          c.element? and preface_names(c)
+        if @parse_settings.empty?
+          sequential_asset_names(doc.xpath(ns("//preface/*")))
+          middle_section_asset_names(doc)
+          termnote_anchor_names(doc)
+          termexample_anchor_names(doc)
         end
-        middle_section_asset_names(doc)
-        termnote_anchor_names(doc)
-        termexample_anchor_names(doc)
       end
 
       def initial_anchor_names1(doc)
-        doc.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
-        # potentially overridden in middle_section_asset_names()
-        sequential_asset_names(doc.xpath(ns("//preface/*")))
-        n = Counter.new
-        n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
-        n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
-        doc.xpath(ns("//sections/clause[not(@type = 'scope')] | "\
-                     "//sections/terms | //sections/definitions")).each do |c|
-          n = section_names(c, n, 1)
+        if @parse_settings.empty? || @parse_settings[:clauses]
+          doc.xpath(ns("//preface/*")).each do |c|
+            c.element? and preface_names(c)
+          end
+          # potentially overridden in middle_section_asset_names()
+          sequential_asset_names(doc.xpath(ns("//preface/*")))
+          n = Counter.new
+          n = section_names(doc.at(ns("//clause[@type = 'scope']")), n, 1)
+          n = section_names(doc.at(ns(@klass.norm_ref_xpath)), n, 1)
+          doc.xpath(ns("//sections/clause[not(@type = 'scope')] | "\
+                       "//sections/terms | //sections/definitions")).each do |c|
+            n = section_names(c, n, 1)
+          end
+        end
+        if @parse_settings.empty?
+          middle_section_asset_names(doc)
+          termnote_anchor_names(doc)
+          termexample_anchor_names(doc)
         end
-        middle_section_asset_names(doc)
-        termnote_anchor_names(doc)
-        termexample_anchor_names(doc)
       end
 
       # we can reference 0-number clauses in introduction
@@ -68,6 +80,7 @@ module IsoDoc
           @anchors[c["id"]] = anchor_struct(i.print, nil, @labels["appendix"],
                                             "clause")
           @anchors[c["id"]][:level] = 2
+          @anchors[c["id"]][:subtype] = "annex"
           @anchors[c["id"]][:container] = clause["id"]
           j = Counter.new
           c.xpath(ns("./clause | ./references")).each do |c1|
@@ -78,10 +91,11 @@ module IsoDoc
         end
       end
 
+      # subclauses are not prefixed with "Clause"
+      # retaining sybtupe for the semantics
       def section_names1(clause, num, level)
         @anchors[clause["id"]] =
-          { label: num, level: level, xref: num }
-        # subclauses are not prefixed with "Clause"
+          { label: num, level: level, xref: num, subtype: "clause" }
         i = Counter.new
         clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
                         "./references"))
@@ -92,7 +106,8 @@ module IsoDoc
       end
 
       def annex_names1(clause, num, level)
-        @anchors[clause["id"]] = { label: num, xref: num, level: level }
+        @anchors[clause["id"]] = { label: num, xref: num, level: level,
+                                   subtype: "annex" }
         i = Counter.new
         clause.xpath(ns("./clause | ./references")).each do |c|
           i.increment(c)
@@ -166,7 +181,13 @@ module IsoDoc
 
       def back_anchor_names(docxml)
         super
-        docxml.xpath(ns("//indexsect")).each { |b| preface_names(b) }
+        if @parse_settings.empty? || @parse_settings[:clauses]
+          docxml.xpath(ns("//indexsect")).each { |b| preface_names(b) }
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        super.sub(%r{<br/>(.*)$}, "<br/><span class='obligation'>\\1</span>")
       end
     end
   end

data/lib/metanorma/iso/biblio.rng

@@ -851,17 +851,46 @@
   </define>
   <define name="bplace">
     <element name="place">
-      <optional>
-        <attribute name="uri">
-          <data type="anyURI"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="region"/>
-      </optional>
+      <choice>
+        <text/>
+        <group>
+          <ref name="bibliocity"/>
+          <zeroOrMore>
+            <ref name="biblioregion"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="bibliocountry"/>
+          </zeroOrMore>
+        </group>
+      </choice>
+    </element>
+  </define>
+  <define name="bibliocity">
+    <element name="city">
       <text/>
     </element>
   </define>
+  <define name="biblioregion">
+    <element name="region">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="bibliocountry">
+    <element name="country">
+      <ref name="RegionType"/>
+    </element>
+  </define>
+  <define name="RegionType">
+    <optional>
+      <attribute name="iso"/>
+    </optional>
+    <optional>
+      <attribute name="recommended">
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <text/>
+  </define>
   <define name="bprice">
     <element name="price">
       <attribute name="currency"/>

data/lib/metanorma/iso/boilerplate-fr.xml

@@ -1,7 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-    <p id="boilerplate-year">&#xa9; {{ agency }} {{ docyear }}</p>
+      <p id="boilerplate-year">&#xa9; <span class="std_publisher">{{ agency }}</span> <span class="std_docNumber">{{ docyear }}</span></p>
 
   <p id="boilerplate-message">
     Droits de reproduction réservés. Sauf indication contraire, ou requise dans le cadre de sa mise en œuvre,

data/lib/metanorma/iso/boilerplate-ru.xml

@@ -1,9 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-    <p id="boilerplate-year">
-    &#xa9; {{ agency }} {{ docyear }}
-  </p>
+      <p id="boilerplate-year">&#xa9; <span class="std_publisher">{{ agency }}</span> <span class="std_docNumber">{{ docyear }}</span></p>
 
   <p id="boilerplate-message">
     Все права защищены. Если иначе не определено или не требуется в контексте его реализации, никакая часть этой публикации не может быть воспроизведена или использована иначе в любой форме или каким-либо образом, электронным или механическим, включая фотокопирование, или публикацию в Интернете или интранете, без предварительного письменного разрешения. Разрешение может быть запрошено ISO по адресу, указанному ниже, или у органа — члена ISO страны запрашивающего.

data/lib/metanorma/iso/boilerplate.xml

@@ -1,9 +1,7 @@
 <boilerplate>
   <copyright-statement>
     <clause>
-    <p id="boilerplate-year">
-    &#xa9; {{ agency }} {{ docyear }}
-  </p>
+      <p id="boilerplate-year">&#xa9; <span class="std_publisher">{{ agency }}</span> <span class="std_docNumber">{{ docyear }}</span></p>
 
   <p id="boilerplate-message">
     All rights

data/lib/metanorma/iso/cleanup.rb

@@ -40,7 +40,8 @@ module Metanorma
         xmldoc.xpath("//bibdata/contributor[role/@type = 'publisher']"\
                      "/organization").each_with_object([]) do |x, prefix|
           x1 = x.at("abbreviation")&.text || x.at("name")&.text
-          (x1 == "ISO" and prefix.unshift("ISO")) or prefix << x1
+          #(x1 == "ISO" and prefix.unshift("ISO")) or prefix << x1
+          prefix << x1
         end
       end
 

data/lib/metanorma/iso/isodoc.rng

@@ -32,6 +32,43 @@
         <ref name="DocumentType"/>
       </element>
     </define>
+    <define name="admonition">
+      <element name="admonition">
+        <attribute name="type">
+          <ref name="AdmonitionType"/>
+        </attribute>
+        <optional>
+          <attribute name="class"/>
+        </optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+        <optional>
+          <attribute name="uri">
+            <data type="anyURI"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <ref name="tname"/>
+        </optional>
+        <zeroOrMore>
+          <ref name="paragraph-with-footnote"/>
+        </zeroOrMore>
+        <zeroOrMore>
+          <ref name="note"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="index">
       <element name="index">
         <optional>
@@ -851,6 +888,16 @@
             <ref name="MultilingualRenderingType"/>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="coverpage">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
+        <optional>
+          <attribute name="notag">
+            <data type="boolean"/>
+          </attribute>
+        </optional>
         <oneOrMore>
           <choice>
             <ref name="paragraph"/>
@@ -1178,6 +1225,7 @@
       <ref name="concept"/>
       <ref name="add"/>
       <ref name="del"/>
+      <ref name="span"/>
     </choice>
   </define>
   <define name="add">
@@ -1204,6 +1252,14 @@
       </choice>
     </element>
   </define>
+  <define name="span">
+    <element name="span">
+      <attribute name="class"/>
+      <oneOrMore>
+        <ref name="TextElement"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="concept">
     <element name="concept">
       <optional>

data/lib/metanorma/iso/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module ISO
-    VERSION = "2.0.8.1".freeze
+    VERSION = "2.1.0".freeze
   end
 end

data/lib/metanorma-iso.rb

@@ -7,6 +7,7 @@ require_relative "isodoc/iso/pdf_convert"
 require_relative "isodoc/iso/sts_convert"
 require_relative "isodoc/iso/isosts_convert"
 require_relative "isodoc/iso/presentation_xml_convert"
+require_relative "html2doc/lists"
 require "asciidoctor/extensions"
 
 if defined? Metanorma

data/lib/relaton/render/config.yml

@@ -0,0 +1,4 @@
+template:
+  # skip standardidentifier, it is inserted in front of formattedref within metanorma
+  standard: "<em><span_class='stddocTitle'>{{ title }}</span></em> ,_{{ extent }}." 
+  website: "{{ creatornames }} ({{ role }}) . <em><span_class='stddocTitle'>{{ title }}</span></em> [website]. {{ labels['version'] | capitalize }}_{{ edition_raw }}. {{ place }}: {{ publisher }}. {{date}}. {{ labels['updated'] | capitalize }}:_{{date_updated}}. {{ standardidentifier | first }}. {{ labels['availablefrom'] }}:_<span_class='biburl'>{{ uri }}</span>. [{{ labels['viewed'] }}:_{{date_accessed}}]. "

data/lib/relaton/render/general.rb

@@ -0,0 +1,13 @@
+require "relaton-render"
+
+module Relaton
+  module Render
+    module Iso
+      class General < ::Relaton::Render::IsoDoc::General
+        def config_loc
+          YAML.load_file(File.join(File.dirname(__FILE__), "config.yml"))
+        end
+      end
+    end
+  end
+end

data/metanorma-iso.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = `git ls-files -- {spec}/*`.split("\n")
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 2.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 2.1.0"
   spec.add_dependency "mnconvert", "~> 1.14"
   spec.add_dependency "ruby-jing"
   spec.add_dependency "tokenizer", "~> 0.3.0"

data/spec/isodoc/amd_spec.rb

@@ -128,7 +128,7 @@ RSpec.describe IsoDoc do
           <annex id="annex1" displayorder="5">
             <title>
               <strong>Annex A</strong>
-              <br/>(informative)</title>
+              <br/><span class="obligation">(informative)</span></title>
             <clause id="annex1a" inline-header="true">
               <title>A.1</title>
               <note id="AN">
@@ -252,21 +252,21 @@ RSpec.describe IsoDoc do
               <title>Foreword</title>
               <p id='A'>
                 This is a preamble 
-                <xref target='C'>0.1</xref>
-                <xref target='C1'>0.2</xref>
-                <xref target='D'>Scope</xref>
+                <xref target='C'><span class='citesec'>0.1</span></xref>
+                <xref target='C1'><span class='citesec'>0.2</span></xref>
+                <xref target='D'><span class='citesec'>Scope</span></xref>
                 <xref target='H'>[H]</xref>
                 <xref target='I'>[I]</xref>
                 <xref target='J'>[J]</xref>
                 <xref target='K'>[K]</xref>
                 <xref target='L'>[L]</xref>
-                <xref target='M'>Clause 4</xref>
-                <xref target='N'>Introduction</xref>
-                <xref target='O'>Clause 4.2</xref>
-                <xref target='P'>Annex A</xref>
-                <xref target='Q'>A.1</xref>
-                <xref target='Q1'>A.1.1</xref>
-                <xref target='Q2'>Annex A, Appendix 1</xref>
+                <xref target='M'><span class='citesec'>Clause 4</span></xref>
+                <xref target='N'><span class='citesec'>Introduction</span></xref>
+                <xref target='O'><span class='citesec'>Clause 4.2</span></xref>
+                <xref target='P'><span class='citeapp'>Annex A</span></xref>
+                <xref target='Q'><span class='citeapp'>A.1</span></xref>
+                <xref target='Q1'><span class='citeapp'>A.1.1</span></xref>
+                <xref target='Q2'><span class='citeapp'>Annex A, Appendix 1</span></xref>
                 <xref target='R'>[R]</xref>
               </p>
             </foreword>
@@ -297,7 +297,7 @@ RSpec.describe IsoDoc do
             <title>
               <strong>Annex A</strong>
               <br/>
-              (normative)
+              <span class="obligation">(normative)</span>
               <br/>
               <br/>
               <strong>Annex</strong>
@@ -503,7 +503,7 @@ RSpec.describe IsoDoc do
           </clause>
         </sections>
         <annex id="P" inline-header="false" obligation="normative" displayorder="10">
-          <title><strong>Annex A</strong><br/>(normative)<br/><br/><strong>Annex</strong></title>
+          <title><strong>Annex A</strong><br/><span class="obligation">(normative)</span><br/><br/><strong>Annex</strong></title>
           <clause id="Q" inline-header="false" obligation="normative">
             <title depth="2">A.1<tab/>Annex A.1</title>
             <clause id="Q1" inline-header="false" obligation="normative">
@@ -511,7 +511,8 @@ RSpec.describe IsoDoc do
             </clause>
           </clause>
         </annex>
-        <annex id="P1" inline-header="false" obligation="normative" displayorder="11"><title><strong>Annex B</strong><br/>(normative)</title></annex>
+        <annex id="P1" inline-header="false" obligation="normative" displayorder="11">
+        <title><strong>Annex B</strong><br/><span class="obligation">(normative)</span></title></annex>
         <bibliography>
           <references id="R" normative="true" obligation="informative" displayorder="7">
             <title depth="1">Normative References</title>