metanorma-bsi 0.0.1

data/lib/isodoc/bsi/html_convert.rb

@@ -0,0 +1,56 @@
+require "isodoc"
+require "metanorma-iso"
+require_relative "base_convert"
+require_relative "init"
+
+module IsoDoc
+  module BSI
+    class HtmlConvert < IsoDoc::Iso::HtmlConvert
+      def initialize(options)
+        super
+        @libdir = File.dirname(__FILE__)
+      end
+
+      # TODO : true font is BSI Gesta, which is a webfont
+      def default_fonts(options)
+        {
+          bodyfont: (options[:script] == "Hans" ? '"Source Han Sans",serif' : '"Tahoma",sans-serif'),
+          headerfont: (options[:script] == "Hans" ? '"Source Han Sans",sans-serif' : '"Tahoma",sans-serif'),
+          monospacefont: '"Courier New",monospace',
+          monospacefontsize: "1.0em",
+          footnotefontsize: "0.9em",
+        }
+      end
+
+      def default_file_locations(_options)
+        @libdir = File.dirname(__FILE__)
+        {
+          htmlstylesheet: html_doc_path("htmlstyle.scss"),
+          htmlcoverpage: html_doc_path("html_bsi_titlepage.html"),
+          htmlintropage: html_doc_path("html_bsi_intro.html"),
+        }
+      end
+
+      def htmlstyle(docxml)
+        ret = super
+        b = ret.at("div[@class = 'boilerplate_legal']/ol")
+        b and b["type"] = "1"
+        ret
+      end
+
+      def authority_cleanup(docxml)
+        auth = docxml.at("//div[@id = 'boilerplate-feedback' or @class = 'boilerplate-feedback']")
+        auth&.remove
+        super
+      end
+
+      def insert_tab(out, n)
+        tab = "&#x2003;"
+        [1..n].each { out << tab }
+      end
+
+      include BaseConvert
+      include Init
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+introduction: INTRODUCTION
+introduction_iev: INTRODUCTION<br/>Principles and rules followed
+foreword: FOREWORD
+BSI: BRITISH STANDARDS INSTITUTE
+formula: Equation
+inequality: Inequality
+section_iev: Section
+price-code: Price Code
+term_def_boilerplate: |
+      <p>ISO and IEC maintain terminological databases for use in
+      standardization at the following addresses:</p>
+
+      <ul>
+      <li> <p>IEC Electropedia: available at
+      <link target="http://www.electropedia.org"/>
+      </p> </li>
+      <li> <p>ISO Online browsing platform: available at
+        <link target="http://www.iso.org/obp"/></p> </li>
+      </ul>
+norm_with_refs_pref:
+      The following documents are referred to in the text in such a way
+      that some or all of their content constitutes provisions 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.
+biblio_pref:
+      For dated references, only the edition cited applies.
+      For undated references, the latest edition of the referenced
+      document (including any amendments) applies.
+internal_terms_boilerplate: |
+        <p>For the purposes of this British Standard,
+            the following terms and definitions apply.</p>
+external_terms_boilerplate: |
+          <p>For the purposes of this British Standard,
+            the terms and definitions given in % apply.</p>
+internal_external_terms_boilerplate: |
+          <p>For the purposes of this British Standard, the terms and definitions
+            given in % and the following apply.</p>
+commentary: COMMENTARY %1 ON %2
+commentary_xref: Commentary %1 on %2
+doctype_dict:
+  international-standard: International Standard
+  technical-specification: Technical Specification
+  technical-report: Technical Report
+  publicly-available-specification: Publicly Available Specification
+  international-workshop-agreement: International Workshop Agreement
+  guide: Guide
+  interpretation-sheet: Interpretation Sheet
+function_dict:
+  emc: Basic EMC Publication
+  safety: Basic Safety Publication
+  environment: Basic Environment Publication
+  quality-assurance: Basic Quality Assurance Publication
+horizontal_dict:
+  "true": Horizontal Standard
+  "false": 

data/lib/isodoc/bsi/i18n.rb

@@ -0,0 +1,15 @@
+module IsoDoc
+  module BSI
+    class I18n < IsoDoc::Iso::I18n
+      def load_yaml1(lang, script)
+        y = if lang == "en"
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            else
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            end
+        super.merge(y)
+      end
+    end
+  end
+end
+

data/lib/isodoc/bsi/init.rb

@@ -0,0 +1,24 @@
+require "isodoc"
+require_relative "metadata"
+require_relative "xref"
+require_relative "i18n"
+
+module IsoDoc
+  module BSI
+    module Init
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def xref_init(lang, script, _klass, labels, options)
+        @xrefs = Xref.new(lang, script,
+                          HtmlConvert.new(language: lang, script: script),
+                          labels, options)
+      end
+
+      def i18n_init(lang, script, i18nyaml = nil)
+        @i18n = I18n.new(lang, script, i18nyaml || @i18nyaml)
+      end
+    end
+  end
+end

data/lib/isodoc/bsi/metadata.rb

@@ -0,0 +1,33 @@
+require "isodoc"
+require "metanorma-iso"
+
+module IsoDoc
+  module BSI
+    class Metadata < IsoDoc::Iso::Metadata
+      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, substage["abbreviation"])
+          unpublished(docstatus.text) and
+            set(:stageabbr, docstatus["abbreviation"])
+        end
+        revdate = isoxml.at(ns("//version/revision-date"))
+        set(:revdate, revdate&.text)
+      end
+
+      def unpublished(status)
+        status.to_i.positive? && status.to_i < 60
+      end
+
+       def docid(isoxml, _out)
+        dn = isoxml.at(ns("//bibdata/docidentifier[@type = 'BS']"))
+        set(:docnumber, dn&.text)
+      end
+    end
+  end
+end

data/lib/isodoc/bsi/pdf_convert.rb

@@ -0,0 +1,17 @@
+require_relative "base_convert"
+require "isodoc"
+
+module IsoDoc
+  module BSI
+    class PdfConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        super
+      end
+
+      def pdf_stylesheet(_docxml)
+        "bsi.international-standard.xsl"
+      end
+    end
+  end
+end

data/lib/isodoc/bsi/presentation_xml_convert.rb

@@ -0,0 +1,72 @@
+require_relative "init"
+require "isodoc"
+
+module IsoDoc
+  module BSI
+    class PresentationXMLConvert < IsoDoc::Iso::PresentationXMLConvert
+      def block(docxml)
+        super
+        commentary(docxml)
+      end
+
+      def termnote1(termnote)
+        note1(termnote)
+      end
+
+      def commentary(docxml)
+        docxml.xpath(ns("//admonition[@type = 'commentary']")).each do |f|
+          commentary1(f)
+        end
+      end
+
+      # introduce name element
+      def commentary1(node)
+        n = @xrefs.get[node["id"]]
+        prefix_name(node, "", n[:label].upcase, "name")
+      end
+
+      def eref_localities1_zh(target, type, from, to, n, delim)
+        subsection = from&.text&.match(/\./)
+        ret = if delim == ";"
+                ";"
+              else
+                type == "list" ? "" : delim
+              end
+        ret += " 第#{from.text}" if from
+        ret += "&ndash;#{to.text}" if to
+        ret = "<strong>#{ret}</strong>" if type == "clause"
+        loc = (@i18n.locality[type] || type.sub(/^locality:/, "").capitalize)
+        ret += " #{loc}" unless subsection && type == "clause" ||
+          type == "list" || target.match(/^IEV$|^IEC 60050-/) ||
+          n["droploc"] == "true"
+        ret += ")" if type == "list"
+        ret
+      end
+
+      def eref_localities1(target, type, from, to, delim, n, 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, n, delim))
+        ret = if delim == ";"
+                ";"
+              else
+                type == "list" ? "" : delim
+              end
+        ret += eref_locality_populate(type, n) unless subsection &&
+          type == "clause" || type == "list" ||
+          target.match(/^IEV$|^IEC 60050-/)
+        range = " #{from.text}" if from
+        range += "&ndash;#{to.text}" if to
+        range &&= "<strong>#{range}</strong>" if type == "clause"
+        ret += " #{range}"
+        ret += ")" if type == "list"
+        l10n(ret)
+      end
+
+      include Init
+    end
+  end
+end

data/lib/isodoc/bsi/sts_convert.rb

@@ -0,0 +1,30 @@
+require "isodoc"
+require "mn2sts"
+
+module IsoDoc
+  module BSI
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class StsConvert < IsoDoc::XslfoPdfConvert
+      def initialize(options)
+        @libdir = File.dirname(__FILE__)
+        @format = :isosts
+        @suffix = "isosts.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
+        end
+        FileUtils.rm_rf dir
+        Mn2sts.convert(input_filename, output_filename || "#{filename}.#{@suffix}", iso: true)
+      end
+    end
+  end
+end

data/lib/isodoc/bsi/xref.rb

@@ -0,0 +1,134 @@
+module IsoDoc
+  module BSI
+    class Xref < IsoDoc::Iso::Xref
+      def parse(docxml)
+        super
+        commentary_anchor_names(docxml)
+      end
+
+      def commentary_anchor_names(docxml)
+        commentary_anchors(docxml).each do |target, comms|
+          link = commentary_link(target, docxml)
+          comms.each_with_index do |id, i|
+            idx = comms.size == 1 ? "" : " #{i + 1}"
+            label = @labels["commentary"].sub(/ %1/, idx).sub(/%2/, link)
+            xref = @labels["commentary_xref"].sub(/ %1/, idx).sub(/%2/, link)
+            @anchors[id] = { type: "commentary", label: label, xref: xref }
+          end
+        end
+      end
+
+      def commentary_link(target, docxml)
+        link = @anchors.dig(target, :xref) || "???"
+        if @anchors.dig(target, :type) == "clause" ||
+            docxml.at(ns("//clause[@id = '#{target}']"))
+          link = "#{@labels['clause']} #{@anchors[target][:label]}"
+        end
+        link
+      end
+
+      def commentary_anchors(docxml)
+        docxml.xpath(ns("//admonition[@type = 'commentary']"))
+          .each_with_object({}) do |a, m|
+          m[a["target"]] ||= []
+          m[a["target"]] << a["id"]
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        obl = if clause["obligation"] == "normative"
+                l10n("(#{@labels['norm_annex']})")
+              else
+                l10n("(#{@labels['inform_annex']})")
+              end
+        l10n("<strong>#{@labels['annex']} #{num}</strong><br/>#{obl}")
+      end
+
+      def termnote_anchor_names(docxml)
+        docxml.xpath(ns("//term[descendant::termnote]")).each do |t|
+          c = ::IsoDoc::XrefGen::Counter.new
+          notes = t.xpath(ns(".//termnote"))
+          notes.each do |n|
+            next if n["id"].nil? || n["id"].empty?
+
+            idx =
+              notes.size == 1 && !n["number"] ? "" : " #{c.increment(n).print}"
+            @anchors[n["id"]] = anchor_struct(idx, n, @labels["note_xref"],
+                                              "note", false)
+          end
+        end
+      end
+
+      def section_names(clause, num, lvl)
+        return num if clause.nil?
+
+        num.increment(clause)
+        @anchors[clause["id"]] =
+          { label: num.print, level: lvl, type: "clause",
+            xref: l10n("#{@labels['clause']} <strong>#{num.print}</strong>") }
+        i = ::IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns(SUBCLAUSES)).each do |c|
+          i.increment(c)
+          section_names1(c, "#{num.print}.#{i.print}", lvl + 1)
+        end
+        num
+      end
+
+      def section_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { xref: "<strong>#{num}</strong>", level: level, label: num }
+        # subclauses are not prefixed with "Clause"
+        i = ::IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns("./clause | ./terms | ./term | ./definitions | "\
+                        "./references"))
+          .each do |c|
+          i.increment(c)
+          section_names1(c, "#{num}.#{i.print}", level + 1)
+        end
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] =
+          { xref: "<strong>#{num}</strong>", label: num, level: level }
+        i = ::IsoDoc::XrefGen::Counter.new
+        clause.xpath(ns("./clause | ./references")).each do |c|
+          i.increment(c)
+          annex_names1(c, "#{num}.#{i.print}", level + 1)
+        end
+      end
+
+      def list_anchor_names(sections)
+        sections.each do |s|
+          notes = s.xpath(ns(".//ol")) - s.xpath(ns(".//clause//ol")) -
+            s.xpath(ns(".//appendix//ol")) - s.xpath(ns(".//ol//ol"))
+          c = ::IsoDoc::XrefGen::Counter.new
+          notes.each do |n|
+            next if n["id"].nil? || n["id"].empty?
+
+            idx = notes.size == 1 && !n["number"] ? "" : " #{c.increment(n).print}"
+            @anchors[n["id"]] = anchor_struct(idx, n, @labels["list"], "list",
+                                              false)
+            list_item_anchor_names(n, @anchors[n["id"]], 1, "", notes.size > 3)
+          end
+          list_anchor_names(s.xpath(ns(CHILD_SECTIONS)))
+        end
+      end
+
+      def list_item_anchor_names(list, list_anchor, depth, prev_label, refer_list)
+        c = ::IsoDoc::XrefGen::Counter
+          .new(list["start"] ? list["start"].to_i - 1 : 0)
+        list.xpath(ns("./li")).each do |li|
+          label = c.increment(li).listlabel(list, depth)
+          label = "#{prev_label}.#{label}" unless prev_label.empty?
+          label = "#{list_anchor[:xref]} #{label}" if refer_list
+          li["id"] and @anchors[li["id"]] =
+            { xref: "#{label})", type: "listitem",
+              container: @klass.get_clause_id(li) }
+          li.xpath(ns("./ol")).each do |ol|
+            list_item_anchor_names(ol, list_anchor, depth + 1, label, false)
+          end
+        end
+      end
+    end
+  end
+end