metanorma-mpfd 0.0.2

data/lib/isodoc/mpfd/html_convert.rb

@@ -0,0 +1,370 @@
+require "isodoc"
+require_relative "metadata"
+
+module IsoDoc
+  module Mpfd
+
+    # A {Converter} implementation that generates HTML output, and a document
+    # schema encapsulation of the document for validation
+    #
+    class HtmlConvert < IsoDoc::HtmlConvert
+      def rsd_html_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      end
+
+      def initialize(options)
+        super
+        @htmlstylesheet = generate_css(rsd_html_path("htmlstyle.scss"), true, default_fonts(options))
+        @htmlcoverpage = rsd_html_path("html_rsd_titlepage.html")
+        @htmlintropage = rsd_html_path("html_rsd_intro.html")
+        @scripts = rsd_html_path("scripts.html")
+        system "cp #{rsd_html_path('logo.jpg')} logo.jpg"
+        system "cp #{rsd_html_path('mpfa-logo-no-text@4x.png')} mpfa-logo-no-text@4x.png"
+        @files_to_delete << "logo.jpg"
+        @files_to_delete << "mpfa-logo-no-text@4x.png"
+      end
+
+      def default_fonts(options)
+        b = options[:bodyfont] ||
+          (options[:script] == "Hans" ? '"SimSun",serif' :
+           '"Titillium Web",sans-serif')
+        h = options[:headerfont] ||
+          (options[:script] == "Hans" ? '"SimHei",sans-serif' :
+           '"Titillium Web",sans-serif')
+        m = options[:monospacefont] || '"Space Mono",monospace'
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n"
+      end
+
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+      end
+
+      def html_head
+        <<~HEAD.freeze
+    <script type="text/javascript" src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+
+    <!--TOC script import-->
+    <script type="text/javascript" src="https://cdn.rawgit.com/jgallen23/toc/0.3.2/dist/toc.min.js"></script>
+
+    <!--Google fonts-->
+    <link href="https://fonts.googleapis.com/css?family=Open+Sans:300,300i,400,400i,600,600i|Space+Mono:400,700" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Overpass:300,300i,600,900" rel="stylesheet">
+    <link href="https://fonts.googleapis.com/css?family=Titillium+Web:400,400i,700,700i" rel="stylesheet">
+    <!--Font awesome import for the link icon-->
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/solid.css" integrity="sha384-v2Tw72dyUXeU3y4aM2Y0tBJQkGfplr39mxZqlTBDUZAb9BGoC40+rdFCG0m10lXk" crossorigin="anonymous">
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.0.8/css/fontawesome.css" integrity="sha384-q3jl8XQu1OpdLgGFvNRnPdj5VIlCvgsDQTQB6owSOHWlAurxul7f+JpUOVdAiJ5P" crossorigin="anonymous">
+    <style class="anchorjs"></style>
+        HEAD
+      end
+
+      def make_body(xml, docxml)
+        body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72", "xml:lang": "EN-US", class: "container" }
+        xml.body **body_attr do |body|
+          make_body1(body, docxml)
+          make_body2(body, docxml)
+          make_body3(body, docxml)
+        end
+      end
+
+      def html_toc(docxml)
+        docxml
+      end
+
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]} "
+          t << "<b>#{name.text}</b>"
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        obl = l10n("(#{@inform_annex_lbl})")
+        obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
+        l10n("<b>#{@annex_lbl} #{num}</b> #{obl}")
+      end
+
+      def pre_parse(node, out)
+        out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def i18n_init(lang, script)
+        super
+        @annex_lbl = "Appendix"
+      end
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "pre"
+          pre_parse(node, out)
+        when "keyword"
+          out.span node.text, **{ class: "keyword" }
+        else
+          super
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def info(isoxml, out)
+        @meta.security isoxml, out
+        super
+      end
+
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]} "
+          t << "<b>#{name.text}</b>"
+        end
+      end
+
+      def annex_name_lbl(clause, num)
+        obl = l10n("(#{@inform_annex_lbl})")
+        obl = l10n("(#{@norm_annex_lbl})") if clause["obligation"] == "normative"
+        l10n("<b>#{@annex_lbl} #{num}</b> #{obl}")
+      end
+
+      def pre_parse(node, out)
+        out.pre node.text # content.gsub(/</, "&lt;").gsub(/>/, "&gt;")
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        if source.empty? && term.nil?
+          div << @no_terms_boilerplate
+        else
+          div << term_defs_boilerplate_cont(source, term)
+        end
+      end
+
+      def i18n_init(lang, script)
+        super
+        @annex_lbl = "Appendix"
+      end
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "pre"
+          pre_parse(node, out)
+        when "keyword"
+          out.span node.text, **{ class: "keyword" }
+        else
+          super
+        end
+      end
+
+      def fileloc(loc)
+        File.join(File.dirname(__FILE__), loc)
+      end
+
+      def i18n_init(lang, script)
+        super
+        y = if lang == "en"
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-en.yaml"))
+            elsif lang == "zh" && script == "Hans"
+              YAML.load_file(File.join(File.dirname(__FILE__),
+                                       "i18n-zh-Hans.yaml"))
+            else
+              YAML.load_file(File.join(File.dirname(__FILE__), "i18n-zh-Hans.yaml"))
+            end
+        @labels = @labels.merge(y)
+        @clause_lbl = y["clause"]
+      end
+
+      def terms_defs_title(f)
+        return f&.at(ns("./title"))&.content
+      end
+
+      TERM_CLAUSE = "//preface/terms | "\
+        "//preface/clause[descendant::terms]".freeze
+
+      def terms_defs(isoxml, out, num)
+        f = isoxml.at(ns(TERM_CLAUSE)) or return num
+        out.div **attr_code(id: f["id"]) do |div|
+          clause_name(nil, terms_defs_title(f), div, nil)
+          f.elements.each do |e|
+            parse(e, div) unless %w{title source}.include? e.name
+          end
+        end
+        num
+      end
+
+      FRONT_CLAUSE = "//*[parent::preface]".freeze
+
+      def preface(isoxml, out)
+        isoxml.xpath(ns(FRONT_CLAUSE)).each do |c|
+          if c.name == "terms" then  terms_defs isoxml, out, 0
+          else
+            out.div **attr_code(id: c["id"]) do |s|
+              clause_name(get_anchors[c['id']][:label],
+                          c&.at(ns("./title"))&.content, s, nil)
+              c.elements.reject { |c1| c1.name == "title" }.each do |c1|
+                parse(c1, s)
+              end
+            end
+          end
+        end
+      end
+
+      def make_body3(body, docxml)
+        body.div **{ class: "main-section" } do |div3|
+          preface docxml, div3
+          middle docxml, div3
+          footnotes div3
+          comments div3
+        end
+      end
+
+      def middle(isoxml, out)
+        middle_title(out)
+        clause isoxml, out
+        annex isoxml, out
+        bibliography isoxml, out
+      end
+
+      def termdef_parse(node, out)
+        set_termdomain("")
+        node.children.each { |n| parse(n, out) }
+      end
+
+      def initial_anchor_names(d)
+        d.xpath(ns(FRONT_CLAUSE)).each do |c|
+          preface_names(c) 
+          sequential_asset_names(c)
+        end
+        middle_section_asset_names(d)
+        clause_names(d, 0)
+        termnote_anchor_names(d)
+        termexample_anchor_names(d)
+      end
+
+      def annex_name_lbl(clause, num)
+        l10n("<b>#{@annex_lbl} #{num}</b>")
+      end
+
+      def xclause_names(docxml, _sect_num)
+        q = "//clause[parent::sections]"
+        @topnum = nil
+        docxml.xpath(ns(q)).each do |c|
+          section_names(c, @topnum, 1)
+        end
+      end
+
+      def clause_names(docxml, sect_num)
+        q = "//clause[parent::sections]"
+        @topnum = nil
+        lvl = 0
+        docxml.xpath(ns(q)).each do |c|
+          container_names(c, 0)
+          sect_num, lvl = sect_names(c, nil, sect_num, 0, lvl)
+        end
+      end
+
+      def container_names(clause, lvl)
+        if clause["container"]
+          @anchors[clause["id"]] = 
+            { label: nil, xref: clause.at(ns("./title"))&.text, level: lvl+1 }
+        end
+        clause.xpath(ns("./clause | ./term  | ./terms | "\
+                        "./definitions")).each do |c|
+          container_names(c, clause["container"] ? lvl+1 : lvl)
+        end
+      end
+
+      def sect_names(clause, num, i, lvl, prev_lvl)
+        return i if clause.nil?
+        curr = i
+        if clause["container"]
+          retlvl = lvl+1
+        else  
+          retlvl = lvl
+          i+=1
+          curr = i
+          name = num.nil? ? i.to_s : "#{num}.#{i}"
+          @anchors[clause["id"]] = { label: name, xref: l10n("#{@clause_lbl} #{name}"), level: lvl+1 }
+        end
+        prev = lvl
+        j = 0
+        clause.xpath(ns("./clause | ./term  | ./terms | "\
+                        "./definitions")).each do |c|
+          if clause["container"]
+            i, lvl = sect_names(c, num, i, lvl, lvl)
+          else
+            j, prev = sect_names(c, name, j, lvl+1, prev)
+          end
+        end
+        i = j if j >0
+        i = curr if lvl < prev
+        [i, prev]
+      end
+
+      def annex_naming(c, num, lvl, i)
+        if c["guidance"] then annex_names1(c, "#{num}E", lvl + 1)
+        else
+          i+= 1
+          annex_names1(c, "#{num}.#{i}", lvl + 1)
+        end
+        i
+      end
+
+      def annex_names(clause, num)
+        @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
+                                   xref: "#{@annex_lbl} #{num}", level: 1 }
+        i = 0
+        clause.xpath(ns("./clause")).each do |c|
+          i = annex_naming(c, num, 1, i)
+        end
+        hierarchical_asset_names(clause, num)
+      end
+
+      def annex_names1(clause, num, level)
+        @anchors[clause["id"]] = { label: num, xref: "#{@annex_lbl} #{num}",
+                                   level: level }
+        i = 0
+        clause.xpath(ns("./clause")).each do |c|
+          i = annex_naming(c, num, level, i)
+        end
+      end
+
+      def clause(isoxml, out)
+        isoxml.xpath(ns(MIDDLE_CLAUSE)).each do |c|
+          out.div **attr_code(id: c["id"]) do |s|
+            clause_name(get_anchors[c['id']][:label],
+                        c&.at(ns("./title"))&.content, s, class: c["container"] ? "containerhdr" : nil )
+            c.elements.reject { |c1| c1.name == "title" }.each do |c1|
+              parse(c1, s)
+            end
+          end
+        end
+      end
+
+      def clause_parse_title(node, div, c1, out)
+        if node["inline-header"] == "true"
+          inline_header_title(out, node, c1)
+        else
+          attrs = { class: node["container"] ? "containerhdr" : nil }
+          div.send "h#{get_anchors[node['id']][:level]}", **attr_code(attrs) do |h|
+            lbl = get_anchors[node['id']][:label]
+            h << "#{lbl}. " if lbl
+            c1&.children&.each { |c2| parse(c2, h) }
+          end
+        end
+      end
+
+      def ol_depth(node)
+        ol_style(node["type"])
+      end
+    end
+  end
+end
+

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

@@ -0,0 +1 @@
+clause: Paragraph

data/lib/isodoc/mpfd/metadata.rb

@@ -0,0 +1,98 @@
+require "isodoc"
+require "twitter_cldr"
+
+module IsoDoc
+  module Mpfd
+
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
+        super
+        set(:status, "XXX")
+      end
+
+      def title(isoxml, _out)
+        main = isoxml&.at(ns("//title[@language='en']"))&.text
+        set(:doctitle, main)
+      end
+
+      def subtitle(_isoxml, _out)
+        nil
+      end
+
+      def author(isoxml, _out)
+        tc = isoxml.at(ns("//editorialgroup/committee"))
+        set(:tc, tc.text) if tc
+      end
+
+      def docid(isoxml, _out)
+        docnumber = isoxml.at(ns("//bibdata/docidentifier"))
+        docstatus = isoxml.at(ns("//bibdata/status"))
+        dn = docnumber&.text
+        if docstatus
+          set(:status, status_print(docstatus.text))
+          abbr = status_abbr(docstatus.text)
+          dn = "#{dn}(#{abbr})" unless abbr.empty?
+        end
+        set(:docnumber, dn)
+      end
+
+      def doctype(isoxml, _out)
+        b = isoxml.at(ns("//bibdata")) || return
+        return unless b["type"]
+        t = b["type"].split(/[- ]/).
+          map{ |w| w.capitalize unless w == "MPF" }.join(" ")
+        set(:doctype, t)
+      end
+
+      def status_print(status)
+        status.split(/-/).map{ |w| w.capitalize }.join(" ")
+      end
+
+      def status_abbr(status)
+        case status
+        when "working-draft" then "wd"
+        when "committee-draft" then "cd"
+        when "draft-standard" then "d"
+        else
+          ""
+        end
+      end
+
+      def version(isoxml, _out)
+        super
+        revdate = get[:revdate]
+        set(:revdate_monthyear, monthyr(revdate))
+        edition = isoxml.at(ns("//version/edition")) and
+          set(:edition, edition.text.to_i.localize.
+              to_rbnf_s("SpelloutRules", "spellout-ordinal").
+              split(/(\W)/).map(&:capitalize).join)
+      end
+
+      MONTHS = {
+        "01": "January",
+        "02": "February",
+        "03": "March",
+        "04": "April",
+        "05": "May",
+        "06": "June",
+        "07": "July",
+        "08": "August",
+        "09": "September",
+        "10": "October",
+        "11": "November",
+        "12": "December",
+      }.freeze
+
+      def monthyr(isodate)
+        m = /(?<yr>\d\d\d\d)-(?<mo>\d\d)/.match isodate
+        return isodate unless m && m[:yr] && m[:mo]
+        return "#{MONTHS[m[:mo].to_sym]} #{m[:yr]}"
+      end
+
+      def security(isoxml, _out)
+        security = isoxml.at(ns("//bibdata/security")) || return
+        set(:security, security.text)
+      end
+    end
+  end
+end