metanorma-iso 1.8.0 → 1.8.5

data/lib/isodoc/iso/metadata.rb

@@ -16,6 +16,7 @@ module IsoDoc
 
       def status_abbrev(stage, substage, iter, draft, doctype)
         return "" unless stage
+
         if %w(technical-report technical-specification).include?(doctype)
           stage = "DTS" if stage == "DIS"
           stage = "FDTS" if stage == "FDIS"
@@ -37,12 +38,12 @@ module IsoDoc
           set(:statusabbr, status_abbrev(docstatus["abbreviation"] || "??",
                                          isoxml&.at(ns("//bibdata/status/substage"))&.text,
                                          isoxml&.at(ns("//bibdata/status/iteration"))&.text,
-                                         isoxml&.at(ns("//version/draft"))&.text,
+                                         isoxml&.at(ns("//bibdata/version/draft"))&.text,
                                          isoxml&.at(ns("//bibdata/ext/doctype"))&.text))
           unpublished(docstatus.text) and
             set(:stageabbr, docstatus["abbreviation"])
         end
-        revdate = isoxml.at(ns("//version/revision-date"))
+        revdate = isoxml.at(ns("//bibdata/version/revision-date"))
         set(:revdate, revdate&.text)
       end
 

data/lib/isodoc/iso/presentation_xml_convert.rb

@@ -26,23 +26,23 @@ module IsoDoc
         @xrefs = Xref.new(lang, script, klass, labels, options)
       end
 
-      def figure1(f)
-        return if labelled_ancestor(f) && f.ancestors("figure").empty?
+      def figure1(node)
+        return if labelled_ancestor(node) && node.ancestors("figure").empty?
 
-        lbl = @xrefs.anchor(f["id"], :label, false) or return
-        figname = f.parent.name == "figure" ? "" : "#{@i18n.figure} "
-        connective = f.parent.name == "figure" ? "  " : " — "
-        prefix_name(f, connective, l10n("#{figname}#{lbl}"), "name")
+        lbl = @xrefs.anchor(node["id"], :label, false) or return
+        figname = node.parent.name == "figure" ? "" : "#{@i18n.figure} "
+        connective = node.parent.name == "figure" ? "  " : " — "
+        prefix_name(node, connective, l10n("#{figname}#{lbl}"), "name")
       end
 
-      def example1(f)
-        n = @xrefs.get[f["id"]]
+      def example1(node)
+        n = @xrefs.get[node["id"]]
         lbl = if n.nil? || n[:label].nil? || n[:label].empty?
                 @i18n.example
               else
                 l10n("#{@i18n.example} #{n[:label]}")
               end
-        prefix_name(f, " — ", lbl, "name")
+        prefix_name(node, " — ", lbl, "name")
       end
 
       def eref_localities1_zh(target, type, from, to, n, delim)
@@ -56,7 +56,8 @@ module IsoDoc
         ret += "–#{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-/) || n["droploc"] == "true"
+          type == "list" || target.match(/^IEV$|^IEC 60050-/) ||
+          n["droploc"] == "true"
         ret += ")" if type == "list"
         ret
       end
@@ -95,10 +96,10 @@ module IsoDoc
         end
       end
 
-      def clause1(f)
-        if !f.at(ns("./title")) &&
-            !%w(sections preface bibliography).include?(f.parent.name)
-          f["inline-header"] = "true"
+      def clause1(node)
+        if !node.at(ns("./title")) &&
+            !%w(sections preface bibliography).include?(node.parent.name)
+          node["inline-header"] = "true"
         end
         super
       end

data/lib/isodoc/iso/sts_convert.rb

@@ -4,28 +4,25 @@ require "mn2sts"
 module IsoDoc
   module Iso
 
-    # A {Converter} implementation that generates HTML output, and a document
-    # schema encapsulation of the document for validation
-    #
     class StsConvert < IsoDoc::XslfoPdfConvert
-      def initialize(options)
+      def initialize(_options) # rubocop:disable Lint/MissingSuper
         @libdir = File.dirname(__FILE__)
         @format = :sts
         @suffix = "sts.xml"
       end
 
-      def convert(input_filename, file = nil, debug = false, output_filename = nil)
-        file = File.read(input_filename, encoding: "utf-8") if file.nil?
-        docxml, filename, dir = convert_init(file, input_filename, debug)
-        /\.xml$/.match(input_filename) or
-          input_filename = Tempfile.open([filename, ".xml"], encoding: "utf-8") do |f|
-          f.write file
-          f.path
+      def convert(in_fname, file = nil, debug = false, out_fname = nil)
+        file = File.read(in_fname, encoding: "utf-8") if file.nil?
+        _docxml, filename, dir = convert_init(file, in_fname, debug)
+        unless /\.xml$/.match?(in_fname)
+          in_fname = Tempfile.open([filename, ".xml"], encoding: "utf-8") do |f|
+            f.write file
+            f.path
+          end
         end
         FileUtils.rm_rf dir
-        Mn2sts.convert(input_filename, output_filename || "#{filename}.#{@suffix}")
+        Mn2sts.convert(in_fname, out_fname || "#{filename}.#{@suffix}")
       end
     end
   end
 end
-

data/lib/isodoc/iso/word_convert.rb

@@ -14,34 +14,34 @@ module IsoDoc
         @htmlToClevels = 3 if @htmlToClevels.zero?
       end
 
+      def font_choice(options)
+        if options[:script] == "Hans" then '"Source Han Sans",serif'
+        else '"Cambria",serif'
+        end
+      end
+
       def default_fonts(options)
-        {
-          bodyfont: (options[:script] == "Hans" ? '"Source Han Sans",serif' :
-                     '"Cambria",serif'),
-                     headerfont: (options[:script] == "Hans" ? '"Source Han Sans",sans-serif' :
-                                  '"Cambria",serif'),
-                                  monospacefont: '"Courier New",monospace',
-                                  normalfontsize: "11.0pt",
-                                  monospacefontsize: "9.0pt",
-                                  smallerfontsize: "10.0pt",
-                                  footnotefontsize: "10.0pt",
-        }
+        { bodyfont: font_choice(options),
+          headerfont: font_choice(options),
+          monospacefont: '"Courier New",monospace',
+          normalfontsize: "11.0pt",
+          monospacefontsize: "9.0pt",
+          smallerfontsize: "10.0pt",
+          footnotefontsize: "10.0pt" }
       end
 
       def default_file_locations(options)
-        {
-          htmlstylesheet: (options[:alt] ? html_doc_path("style-human.scss") :
-                           html_doc_path("style-iso.scss")),
-        htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
-        htmlintropage: html_doc_path("html_iso_intro.html"),
-        wordstylesheet: html_doc_path("wordstyle.scss"),
-        standardstylesheet: html_doc_path("isodoc.scss"),
-        header: html_doc_path("header.html"),
-        wordcoverpage: html_doc_path("word_iso_titlepage.html"),
-        wordintropage: html_doc_path("word_iso_intro.html"),
-        ulstyle: "l3", 
-        olstyle: "l2",
-        }
+        a = options[:alt] ? "style-human.scss" : "style-iso.scss"
+        { htmlstylesheet: html_doc_path(a),
+          htmlcoverpage: html_doc_path("html_iso_titlepage.html"),
+          htmlintropage: html_doc_path("html_iso_intro.html"),
+          wordstylesheet: html_doc_path("wordstyle.scss"),
+          standardstylesheet: html_doc_path("isodoc.scss"),
+          header: html_doc_path("header.html"),
+          wordcoverpage: html_doc_path("word_iso_titlepage.html"),
+          wordintropage: html_doc_path("word_iso_intro.html"),
+          ulstyle: "l3",
+          olstyle: "l2" }
       end
 
       def make_body(xml, docxml)
@@ -54,9 +54,10 @@ module IsoDoc
         end
       end
 
-      def colophon(body, docxml)
-        stage =  @meta.get[:stage_int]
+      def colophon(body, _docxml)
+        stage = @meta.get[:stage_int]
         return if !stage.nil? && stage < 60
+
         body.br **{ clear: "all", style: "page-break-before:left;"\
                     "mso-break-type:section-break" }
         body.div **{ class: "colophon" } do |div|
@@ -67,35 +68,55 @@ module IsoDoc
         super
         xml.xpath("//div[@class = 'figure']//table[@class = 'dl']").each do |t|
           t["class"] = "figdl"
-          d = t.add_previous_sibling("<div class='figdl'/>")
+          d = t.add_previous_sibling("<div class='figdl' "\
+                                     "style='page-break-after:avoid;'/>")
           t.parent = d.first
         end
       end
 
       # force Annex h2 down to be p.h2Annex, so it is not picked up by ToC
-      def word_annex_cleanup1(docxml, i)
-        docxml.xpath("//h#{i}[ancestor::*[@class = 'Section3']]").each do |h2|
+      def word_annex_cleanup1(docxml, lvl)
+        docxml.xpath("//h#{lvl}[ancestor::*[@class = 'Section3']]").each do |h2|
           h2.name = "p"
-          h2["class"] = "h#{i}Annex"
+          h2["class"] = "h#{lvl}Annex"
         end
       end
 
       def word_annex_cleanup(docxml)
-        word_annex_cleanup1(docxml, 2)
-        word_annex_cleanup1(docxml, 3)
-        word_annex_cleanup1(docxml, 4)
-        word_annex_cleanup1(docxml, 5)
-        word_annex_cleanup1(docxml, 6)
+        (2..6).each { |i| word_annex_cleanup1(docxml, i) }
+      end
+
+      def word_annex_cleanup_h1(docxml)
+        docxml.xpath("//h1[@class = 'Annex']").each do |h|
+          h.name = "p"
+          h["class"] = "ANNEX"
+        end
+        %w(BiblioTitle ForewordTitle IntroTitle).each do |s|
+          docxml.xpath("//*[@class = '#{s}']").each do |h|
+            h.name = "p"
+          end
+        end
+      end
+
+      def style_cleanup(docxml)
+        word_annex_cleanup_h1(docxml)
+        style_cleanup1(docxml)
+      end
+
+      def style_cleanup1(docxml)
+        docxml.xpath("//*[@class = 'example']").each do |p|
+          p["class"] = "Example"
+        end
       end
 
       def authority_hdr_cleanup(docxml)
-        docxml&.xpath("//div[@class = 'boilerplate-license']").each do |d|
+        docxml&.xpath("//div[@class = 'boilerplate-license']")&.each do |d|
           d.xpath(".//h1").each do |p|
             p.name = "p"
             p["class"] = "zzWarningHdr"
           end
         end
-        docxml&.xpath("//div[@class = 'boilerplate-copyright']").each do |d|
+        docxml&.xpath("//div[@class = 'boilerplate-copyright']")&.each do |d|
           d.xpath(".//h1").each do |p|
             p.name = "p"
             p["class"] = "zzCopyrightHdr"
@@ -120,11 +141,104 @@ module IsoDoc
       def word_cleanup(docxml)
         authority_hdr_cleanup(docxml)
         super
+        style_cleanup(docxml)
         docxml
       end
 
-      def footnote_reference_format(a)
-        a.children = "<span class='MsoFootnoteReference'>#{a.children.to_xml}</span>)"
+      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;1-#{level}&quot; \\h \\z \\t &quot;Heading
+            1;1;ANNEX;1;Biblio Title;1;Foreword Title;1;Intro Title;1&quot; <span
+            style='mso-element:field-separator'></span></span>
+        TOC
+      end
+
+      def footnote_reference_format(link)
+        link.children =
+          "<span class='MsoFootnoteReference'>#{link.children.to_xml}</span>)"
+      end
+
+      def bibliography_attrs
+        { class: "BiblioTitle" }
+      end
+
+      def bibliography(xml, out)
+        f = xml.at(ns(bibliography_xpath)) and f["hidden"] != "true" or return
+        page_break(out)
+        out.div do |div|
+          div.h1 **bibliography_attrs do |h1|
+            f&.at(ns("./title"))&.children&.each { |c2| parse(c2, h1) }
+          end
+          biblio_list(f, div, true)
+        end
+      end
+
+      def bibliography_parse(node, out)
+        node["hidden"] != true or return
+        out.div do |div|
+          clause_parse_title(node, div, node.at(ns("./title")), out,
+                             bibliography_attrs)
+          biblio_list(node, div, true)
+        end
+      end
+
+      def para_class(node)
+        if !node.ancestors("definition").empty? && !@in_footnote
+          "Definition"
+        elsif !node.ancestors("foreword").empty? && !@in_footnote
+          "ForewordText"
+        else
+          super
+        end
+      end
+
+      def termref_attrs
+        { class: "Source" }
+      end
+
+      def termref_parse(node, out)
+        out.p **termref_attrs do |p|
+          p << "[TERMREF]"
+          node.children.each { |n| parse(n, p) }
+          p << "[/TERMREF]"
+        end
+      end
+
+      def figure_name_attrs(node)
+        s = node.ancestors("annex").empty? ? "FigureTitle" : "AnnexFigureTitle"
+        { class: s, style: "text-align:center;" }
+      end
+
+      def figure_name_parse(node, div, name)
+        return if name.nil?
+
+        div.p **figure_name_attrs(node) do |p|
+          name.children.each { |n| parse(n, p) }
+        end
+      end
+
+      def table_title_attrs(node)
+        s = node.ancestors("annex").empty? ? "Tabletitle" : "AnnexTableTitle"
+        { class: s, style: "text-align:center;" }
+      end
+
+      def table_title_parse(node, out)
+        name = node.at(ns("./name")) or return
+        out.p **table_title_attrs(node) do |p|
+          name&.children&.each { |n| parse(n, p) }
+        end
+      end
+
+      def annex_name(_annex, name, div)
+        return if name.nil?
+
+        name&.at(ns("./strong"))&.remove # supplied by CSS list numbering
+        div.h1 **{ class: "Annex" } do |t|
+          name.children.each { |c2| parse(c2, t) }
+        end
       end
 
       include BaseConvert

data/lib/isodoc/iso/xref.rb

@@ -4,25 +4,35 @@ module IsoDoc
     end
 
     class Xref < IsoDoc::Xref
-      def initial_anchor_names(d)
-        if @klass.amd(d)
-          d.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
-          sequential_asset_names(d.xpath(ns("//preface/*")))
-          d.xpath(ns("//sections/clause")).each { |c| c.element? and preface_names(c) }
-          middle_section_asset_names(d)
-          termnote_anchor_names(d)
-          termexample_anchor_names(d)
+      def initial_anchor_names(doc)
+        if @klass.amd(doc)
+          initial_anchor_names_amd(doc)
         else
           super
         end
-        introduction_names(d.at(ns("//introduction")))
+        introduction_names(doc.at(ns("//introduction")))
+      end
+
+      def initial_anchor_names_amd(doc)
+        doc.xpath(ns("//preface/*")).each do |c|
+          c.element? and preface_names(c)
+        end
+        sequential_asset_names(doc.xpath(ns("//preface/*")))
+        doc.xpath(ns("//sections/clause")).each do |c|
+          c.element? and preface_names(c)
+        end
+        middle_section_asset_names(doc)
+        termnote_anchor_names(doc)
+        termexample_anchor_names(doc)
       end
 
       # 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.at(ns("./clause")) and
+          @anchors[clause["id"]] = { label: "0", level: 1, type: "clause",
+                                     xref: clause.at(ns("./title"))&.text }
         i = Counter.new
         clause.xpath(ns("./clause")).each do |c|
           i.increment(c)
@@ -35,17 +45,19 @@ module IsoDoc
         super
       end
 
-      def appendix_names(clause, num)
+      def appendix_names(clause, _num)
         i = Counter.new
         clause.xpath(ns("./appendix")).each do |c|
           i.increment(c)
-          @anchors[c["id"]] = anchor_struct(i.print, nil, @labels["appendix"], "clause")
+          @anchors[c["id"]] = anchor_struct(i.print, nil, @labels["appendix"],
+                                            "clause")
           @anchors[c["id"]][:level] = 2
           @anchors[c["id"]][:container] = clause["id"]
           j = Counter.new
           c.xpath(ns("./clause | ./references")).each do |c1|
             j.increment(c1)
-            appendix_names1(c1, l10n("#{@labels["appendix"]} #{i.print}.#{j.print}"), 3, clause["id"])
+            lbl = "#{@labels['appendix']} #{i.print}.#{j.print}"
+            appendix_names1(c1, l10n(lbl), 3, clause["id"])
           end
         end
       end
@@ -56,8 +68,8 @@ module IsoDoc
         # subclauses are not prefixed with "Clause"
         i = Counter.new
         clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
-                        "./references")).
-                       each do |c|
+                        "./references"))
+          .each do |c|
           i.increment(c)
           section_names1(c, "#{num}.#{i.print}", level + 1)
         end
@@ -73,7 +85,8 @@ module IsoDoc
       end
 
       def appendix_names1(clause, num, level, container)
-        @anchors[clause["id"]] = { label: num, xref: num, level: level, container: container }
+        @anchors[clause["id"]] = { label: num, xref: num, level: level,
+                                   container: container }
         i = Counter.new
         clause.xpath(ns("./clause | ./references")).each do |c|
           i.increment(c)
@@ -86,28 +99,30 @@ module IsoDoc
         clause.xpath(ns(".//formula")).each do |t|
           next if t["id"].nil? || t["id"].empty?
 
-          @anchors[t["id"]] =
-            anchor_struct("#{num}#{hiersep}#{c.increment(t).print}", t,
-                          t["inequality"] ? @labels["inequality"] : @labels["formula"],
-                          "formula", t["unnumbered"])
+          @anchors[t["id"]] = anchor_struct(
+            "#{num}#{hiersep}#{c.increment(t).print}", t,
+            t["inequality"] ? @labels["inequality"] : @labels["formula"],
+            "formula", t["unnumbered"]
+          )
         end
       end
 
-      def figure_anchor(t, sublabel, label)
-        @anchors[t["id"]] = anchor_struct(
+      def figure_anchor(elem, sublabel, label)
+        @anchors[elem["id"]] = anchor_struct(
           (sublabel ? "#{label} #{sublabel}" : label),
-          nil, @labels["figure"], "figure", t["unnumbered"])
-        sublabel && t["unnumbered"] != "true" and
-          @anchors[t["id"]][:label] = sublabel
+          nil, @labels["figure"], "figure", elem["unnumbered"]
+        )
+        sublabel && elem["unnumbered"] != "true" and
+          @anchors[elem["id"]][:label] = sublabel
       end
 
       def sequential_figure_names(clause)
         c = IsoDoc::XrefGen::Counter.new
         j = 0
-        clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]")).
-          each do |t|
+        clause.xpath(ns(".//figure | .//sourcecode[not(ancestor::example)]"))
+          .each do |t|
           j = subfigure_increment(j, c, t)
-          sublabel = j.zero? ? nil : "#{(j+96).chr})"
+          sublabel = j.zero? ? nil : "#{(j + 96).chr})"
           next if t["id"].nil? || t["id"].empty?
 
           figure_anchor(t, sublabel, c.print)