asciidoctor-gb 0.2.4 → 0.2.5

data/lib/isodoc/gb/gbwordconvert.rb

@@ -1,18 +1,43 @@
 require "isodoc"
-require_relative "./gbconvert"
+require_relative "gbconvert"
+require_relative "gbcleanup"
+require_relative "agencies"
+require_relative "metadata"
+require_relative "gbwordrender"
 
 module IsoDoc
   module Gb
     # A {Converter} implementation that generates GB output, and a document
     # schema encapsulation of the document for validation
 
-    class WordConvert < IsoDoc::Gb::Convert
-      include IsoDoc::WordConvertModule
+    class WordConvert < IsoDoc::WordConvert
+      def default_fonts(options)
+        script = options[:script] || "Hans"
+        b = options[:bodyfont] ||
+          (script == "Hans" ? '"SimSun",serif' :
+           script == "Latn" ? '"Cambria",serif' : '"SimSun",serif' )
+        h = options[:headerfont] ||
+          (script == "Hans" ? '"SimHei",sans-serif' :
+           script == "Latn" ? '"Calibri",sans-serif' : '"SimHei",sans-serif' )
+        m = options[:monospacefont] || '"Courier New",monospace'
+        scope = options[:scope] || "national"
+        t = options[:titlefont] ||
+          (scope == "national" ? (script != "Hans" ? '"Cambria",serif' : '"SimSun",serif' ) :
+           (script == "Hans" ? '"SimHei",sans-serif' : '"Calibri",sans-serif' ))
+        "$bodyfont: #{b};\n$headerfont: #{h};\n$monospacefont: #{m};\n$titlefont: #{t};\n"
+      end
+
+      def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+                @common = IsoDoc::Gb::Common.new(meta: @meta)
+      end
+
       def html_doc_path(file)
         File.join(File.dirname(__FILE__), File.join("html", file))
       end
 
       def initialize(options)
+        @common = IsoDoc::Gb::Common.new(options)
         super
         @wordstylesheet = generate_css(html_doc_path("wordstyle.scss"), false, default_fonts(options))
         @standardstylesheet = generate_css(html_doc_path("gb.scss"), false, default_fonts(options))
@@ -23,6 +48,40 @@ module IsoDoc
         @olstyle = "l10"
       end
 
+            def metadata_init(lang, script, labels)
+        @meta = Metadata.new(lang, script, labels)
+        @common = IsoDoc::Gb::Common.new(meta: @meta)
+      end
+
+            def cleanup(docxml)
+        @cleanup = Cleanup.new(@script, @deprecated_lbl)
+        super
+        @cleanup.cleanup(docxml)
+        docxml
+      end
+
+      def example_cleanup(docxml)
+        super
+        @cleanup.example_cleanup(docxml)
+      end
+
+      def html_doc_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      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)
+      end
+
       ENDLINE = <<~END.freeze
       <v:line id="_x0000_s1026"
  alt="" style='position:absolute;left:0;text-align:left;z-index:251662848;
@@ -39,11 +98,11 @@ module IsoDoc
       def generate_header(filename, dir)
         return unless @header
         template = Liquid::Template.parse(File.read(@header, encoding: "UTF-8"))
-        meta = get_metadata
+        meta = @meta.get
         meta[:filename] = filename
         params = meta.map { |k, v| [k.to_s, v] }.to_h
         File.open("header.html", "w") { |f| f.write(template.render(params)) }
-        system "cp #{fileloc(File.join('html', 'blank.png'))} blank.png"
+        system "cp #{@common.fileloc(File.join('html', 'blank.png'))} blank.png"
         @files_to_delete << "blank.png"
         @files_to_delete << "header.html"
       end
@@ -64,7 +123,7 @@ module IsoDoc
       def word_cleanup(docxml)
         word_preface(docxml)
         word_annex_cleanup(docxml)
-        title_cleanup(docxml.at('//div[@class="WordSection2"]'))
+        @cleanup.title_cleanup(docxml.at('//div[@class="WordSection2"]'))
         docxml
       end
 
@@ -84,6 +143,10 @@ module IsoDoc
                          liststyles: {ul: "l7", ol: "l10"})
       end
 =end
+
+      def html_doc_path(file)
+        File.join(File.dirname(__FILE__), File.join("html", file))
+      end
     end
   end
 end

data/lib/isodoc/gb/gbwordrender.rb

@@ -0,0 +1,206 @@
+module IsoDoc
+  module Gb
+    # A {Converter} implementation that generates GB output, and a document
+    # schema encapsulation of the document for validation
+    class WordConvert < IsoDoc::WordConvert
+      def formula_parse(node, out)
+        out.div **attr_code(id: node["id"], class: "formula") do |div|
+          insert_tab(div, 1)
+          parse(node.at(ns("./stem")), out)
+          insert_tab(div, 1)
+          div << "(#{get_anchors[node['id']][:label]})"
+        end
+        formula_where(node.at(ns("./dl")), out)
+      end
+
+      def formula_where(dl, out)
+        return unless dl
+        out.p { |p| p << @where_lbl }
+        formula_dl_parse(dl, out)
+      end
+
+      def formula_dl_parse(node, out)
+        out.table **{ class: "dl" } do |v|
+          node.elements.each_slice(2) do |dt, dd|
+            v.tr do |tr|
+              tr.td **{ valign: "top", align: "left" } do |term|
+                dt_parse(dt, term)
+              end
+              tr.td(**{ valign: "top" }) { |td| td << "&mdash;" }
+              tr.td **{ valign: "top" } do |listitem|
+                dd.children.each { |n| parse(n, listitem) }
+              end
+            end
+          end
+        end
+      end
+
+      EXAMPLE_TBL_ATTR =
+        { valign: "top", class: "example_label",
+          style: "padding:2pt 2pt 2pt 2pt" }.freeze
+
+      def example_parse(node, out)
+        out.table **attr_code(id: node["id"], class: "example") do |t|
+          t.tr do |tr|
+            tr.td **EXAMPLE_TBL_ATTR do |td|
+              td << l10n(example_label(node) + ":")
+            end
+            tr.td **{ valign: "top", class: "example" } do |td|
+              node.children.each { |n| parse(n, td) }
+            end
+          end
+        end
+      end
+
+      def note_parse(node, out)
+        @note = true
+        out.table **attr_code(id: node["id"], class: "Note") do |t|
+          t.tr do |tr|
+            tr.td **EXAMPLE_TBL_ATTR do |td|
+              td << l10n(note_label(node) + ":")
+            end
+            tr.td **{ valign: "top", class: "Note" } do |td|
+              node.children.each { |n| parse(n, td) }
+            end
+          end
+        end
+        @note = false
+      end
+
+      def termnote_parse(node, out)
+        @note = true
+        out.table **attr_code(id: node["id"], class: "Note") do |t|
+          t.tr do |tr|
+            tr.td **EXAMPLE_TBL_ATTR do |td|
+              td << l10n("#{get_anchors[node['id']][:label]}:")
+            end
+            tr.td **{ valign: "top", class: "Note" } do |td|
+              node.children.each { |n| parse(n, td) }
+            end
+          end
+        end
+        @note = false
+      end
+
+      def middle(isoxml, out)
+        super
+        end_line(isoxml, out)
+      end
+
+      def end_line(_isoxml, out)
+        out.hr **{ width: "25%" }
+      end 
+
+      def error_parse(node, out)
+        # catch elements not defined in ISO
+        case node.name
+        when "string" then string_parse(node, out)
+        else
+          super
+        end
+      end
+
+      def string_parse(node, out)
+        if node["script"] == "Hant"
+          out.span **{ class: "Hant" } do |s|
+            node.children.each { |c| parse(c, s) }
+          end
+        else
+          node.children.each { |c| parse(c, out) }
+        end
+      end
+
+      def deprecated_term_parse(node, out) 
+        out.p **{ class: "DeprecatedTerms" } do |p|
+          p << l10n("#{@deprecated_lbl}: ")
+          node.children.each { |c| parse(c, p) }
+        end
+      end
+
+      def termref_render(x)
+        parts = x.split(%r{(\s*\[MODIFICATION\]|,)}m)
+        parts[1] = l10n(", #{@source_lbl}") if parts.size > 1 && parts[1] == ","
+        parts.map do |p|
+          /\s*\[MODIFICATION\]/.match?(p) ? l10n(", #{@modified_lbl} &mdash; ") : p
+        end.join.sub(/\A\s*/m, l10n("[")).sub(/\s*\z/m, l10n("]"))
+      end
+
+      def termref_resolve(docxml)
+        docxml.split(%r{(\[TERMREF\]|\[/TERMREF\])}).each_slice(4).
+          map do |a|
+          a.size < 3 ? a[0] : a[0] + termref_render(a[2])
+        end.join
+      end
+
+      def populate_template(docxml, format)
+        meta = @meta.get.merge(@labels)
+        logo = @common.format_logo(meta[:gbprefix], meta[:gbscope], format)
+        logofile = @meta.standard_logo(meta[:gbprefix])
+        @files_to_delete << logofile + ".gif" unless logofile.nil?
+        docxml = termref_resolve(docxml)
+        meta[:standard_agency_formatted] =
+          @common.format_agency(meta[:standard_agency], format)
+        meta[:standard_logo] = logo
+        template = Liquid::Template.parse(docxml)
+        template.render(meta.map { |k, v| [k.to_s, v] }.to_h)
+      end
+
+      def foreword(isoxml, out)
+        f = isoxml.at(ns("//foreword")) || return
+        page_break(out)
+        out.div do |s|
+          s.h1 **{ class: "ForewordTitle" } do |h1|
+            h1 << "#{@foreword_lbl}&nbsp;"
+            # insert_tab(h1, 1)
+          end
+          f.elements.each { |e| parse(e, s) unless e.name == "title" }
+        end
+      end
+
+      def clause_name(num, title, div, header_class)
+        header_class = {} if header_class.nil?
+        div.h1 **attr_code(header_class) do |h1|
+          if num
+            h1 << num
+            h1 << "&#x3000;"
+          end
+          h1 << title
+        end
+        div.parent.at(".//h1")
+      end
+
+      def clause_parse_title(node, div, c1, out)
+        if node["inline-header"] == "true"
+          inline_header_title(out, node, c1)
+        else
+          div.send "h#{get_anchors[node['id']][:level]}" do |h|
+            h << "#{get_anchors[node['id']][:label]}.&#x3000;"
+            c1.children.each { |c2| parse(c2, h) }
+          end
+        end
+      end
+
+      def annex_name(annex, name, div)
+        div.h1 **{ class: "Annex" } do |t|
+          t << "#{get_anchors[annex['id']][:label]}<br/><br/>"
+          t << name.text
+        end
+      end
+
+      def term_defs_boilerplate(div, source, term, preface)
+        (source.empty? && term.nil?) and div << @no_terms_boilerplate or
+          div << term_defs_boilerplate_cont(source, term)
+        div << @term_def_boilerplate unless preface
+      end
+
+      def reference_names(ref)
+        isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
+        docid = ref.at(ns("./docidentifier"))
+        date = ref.at(ns("./date[@type = 'published']"))
+        reference = format_ref(docid.text, isopub, date)
+        @anchors[ref["id"]] = { xref: reference }
+      end
+    end
+  end
+end
+

data/lib/isodoc/gb/html/htmlstyle.scss

@@ -30,7 +30,7 @@ h3 {
 }
 
 
-.WordSection2, .WordSection3 {
+.prefatory-section, .main-section {
   margin: 0 1.5em;
 }
 

data/lib/isodoc/gb/metadata.rb

@@ -5,21 +5,21 @@ module IsoDoc
   module Gb
     # A {Converter} implementation that generates GB output, and a document
     # schema encapsulation of the document for validation
-    class Convert < IsoDoc::Convert
-      def init_metadata
+    class Metadata < IsoDoc::Metadata
+      def initialize(lang, script, labels)
         super
-        set_metadata(:docmaintitlezh, "")
-        set_metadata(:docsubtitlezh, "XXXX")
-        set_metadata(:docparttitlezh, "")
-        set_metadata(:docmaintitleen, "")
-        set_metadata(:docsubtitleen, "XXXX")
-        set_metadata(:docparttitleen, "")
-        set_metadata(:gbequivalence, "")
-        set_metadata(:isostandard, nil)
-        set_metadata(:isostandardtitle, "")
-        set_metadata(:doctitle, "XXXX")
-        set_metadata(:obsoletes, nil)
-        set_metadata(:obsoletes_part, nil)
+        set(:docmaintitlezh, "")
+        set(:docsubtitlezh, "XXXX")
+        set(:docparttitlezh, "")
+        set(:docmaintitleen, "")
+        set(:docsubtitleen, "XXXX")
+        set(:docparttitleen, "")
+        set(:gbequivalence, "")
+        set(:isostandard, nil)
+        set(:isostandardtitle, "")
+        set(:doctitle, "XXXX")
+        set(:obsoletes, nil)
+        set(:obsoletes_part, nil)
       end
 
       def title(isoxml, _out)
@@ -27,22 +27,22 @@ module IsoDoc
         main = isoxml.at(ns("//title-main[@language='zh']"))
         part = isoxml.at(ns("//title-part[@language='zh']"))
         partnumber = isoxml.at(ns("//project-number/@part"))
-        intro.nil? || set_metadata(:docmaintitlezh, intro.text + "&nbsp;")
-        main.nil? || set_metadata(:docsubtitlezh, main.text)
+        intro.nil? || set(:docmaintitlezh, intro.text + "&nbsp;")
+        main.nil? || set(:docsubtitlezh, main.text)
         partnum = partnumber ? "#{part_label(partnumber, 'zh')}:" : ""
-        part.nil? || set_metadata(:docparttitlezh,
+        part.nil? || set(:docparttitlezh,
                                   "&nbsp;#{partnum}#{part.text}")
       end
 
       def set_doctitle
         if @lang == "zh"
-          set_metadata(:doctitle, get_metadata[:docmaintitlezh] + 
-                       get_metadata[:docsubtitlezh] +
-                       get_metadata[:docparttitlezh])
+          set(:doctitle, get[:docmaintitlezh] + 
+                       get[:docsubtitlezh] +
+                       get[:docparttitlezh])
         else
-          set_metadata(:doctitle, get_metadata[:docmaintitleen] + 
-                       get_metadata[:docsubtitleen] +
-                       get_metadata[:docparttitleen])
+          set(:doctitle, get[:docmaintitleen] + 
+                       get[:docsubtitleen] +
+                       get[:docparttitleen])
         end
       end
 
@@ -51,17 +51,17 @@ module IsoDoc
         main = isoxml.at(ns("//title-main[@language='en']"))
         part = isoxml.at(ns("//title-part[@language='en']"))
         partnumber = isoxml.at(ns("//project-number/@part"))
-        intro.nil? || set_metadata(:docmaintitleen, intro.text + "&mdash;")
-        main.nil? || set_metadata(:docsubtitleen, main.text)
+        intro.nil? || set(:docmaintitleen, intro.text + "&mdash;")
+        main.nil? || set(:docsubtitleen, main.text)
         partnum = partnumber ? "#{part_label(partnumber, 'en')}: " : ""
-        part.nil? || set_metadata(:docparttitleen,
+        part.nil? || set(:docparttitleen,
                                   "&mdash;#{partnum} #{part.text}")
         set_doctitle
       end
 
       def author(isoxml, _out)
         gbcommittee = isoxml.at(ns("//bibdata/gbcommittee"))
-        set_metadata(:committee, gbcommittee&.text)
+        set(:committee, gbcommittee&.text)
       end
 
       STAGE_ABBRS_CN = {
@@ -87,22 +87,22 @@ module IsoDoc
       def docstatus(isoxml, _out)
         docstatus = isoxml.at(ns("//status/stage"))
         if docstatus
-          set_metadata(:stage, docstatus.text.to_i)
+          set(:stage, docstatus.text.to_i)
           abbr = stage_abbrev_cn(docstatus.text, isoxml.at(ns("//status/iteration")),
                                  isoxml.at(ns("//version/draft")))
-          set_metadata(:stageabbr, abbr)
+          set(:stageabbr, abbr)
         end
       end
 
       def docid1(isoxml, _out)
         dn = docnumber(isoxml)
-        docstatus = get_metadata[:stage]
+        docstatus = get[:stage]
         if docstatus
           abbr = stage_abbrev(docstatus.to_s, isoxml.at(ns("//status/iteration")),
                               isoxml.at(ns("//version/draft")))
           (docstatus.to_i < 60) && dn = abbr + " " + dn
         end
-        set_metadata(:docnumber, dn)
+        set(:docnumber, dn)
       end
 
       def docid(isoxml, _out)
@@ -117,14 +117,14 @@ module IsoDoc
 
       def gb_equivalence(isoxml)
         isostdid = isoxml.at(ns("#{ISO_STD_XPATH}/docidentifier")) || return
-        set_metadata(:isostandard, isostdid.text)
+        set(:isostandard, isostdid.text)
         isostdtitle = isoxml.at(ns("#{ISO_STD_XPATH}/title"))
-        set_metadata(:isostandardtitle, isostdtitle.text) if isostdtitle
+        set(:isostandardtitle, isostdtitle.text) if isostdtitle
         eq = isoxml.at(ns("//bibdata/relation/@type"))
         case eq.text
-        when "equivalent" then set_metadata(:gbequivalence, "MOD")
-        when "nonequivalent" then set_metadata(:gbequivalence, "NEQ")
-        when "identical" then set_metadata(:gbequivalence, "IDT")
+        when "equivalent" then set(:gbequivalence, "MOD")
+        when "nonequivalent" then set(:gbequivalence, "NEQ")
+        when "identical" then set(:gbequivalence, "IDT")
         end
       end
 
@@ -135,19 +135,19 @@ module IsoDoc
       }.freeze
 
       def docidentifier(scope, prefix, mandate, docyear)
-        docnum = get_metadata[:docnumber]
+        docnum = get[:docnumber]
         dn = case scope 
              when "local"
-               "#{SCOPEPFX[scope.to_sym]}#{mandate_suffix(prefix, mandate)}/"\
+               "#{SCOPEPFX[scope.to_sym]}#{@agencies.mandate_suffix(prefix, mandate)}/"\
                  "#{docnum}".gsub(%r{/([TZ])/}, "/\\1 ")
              when "social-group", "enterprise"
-               "#{mandate_suffix(SCOPEPFX[scope.to_sym], mandate)}/"\
+               "#{@agencies.mandate_suffix(SCOPEPFX[scope.to_sym], mandate)}/"\
                  "#{prefix} #{docnum}"
              else
-               "#{mandate_suffix(prefix, mandate)}&#x2002;#{docnum}"
+               "#{@agencies.mandate_suffix(prefix, mandate)}&#x2002;#{docnum}"
              end
         dn += "&mdash;#{docyear}" if docyear
-        set_metadata(:docidentifier, dn)
+        set(:docidentifier, dn)
       end
 
       def gb_identifier(isoxml)
@@ -155,14 +155,15 @@ module IsoDoc
         mandate = isoxml.at(ns("//gbmandate"))&.text || "mandatory"
         prefix = isoxml.at(ns("//gbprefix"))&.text || "XXX"
         docyear = isoxml&.at(ns("//copyright/from"))&.text
-        docidentifier(scope, prefix, mandate, docyear)
         issuer = isoxml&.at(ns("//bibdata/contributor[role/@type = 'issuer']/"\
                                "organization/name"))&.text || "GB"
-        set_metadata(:issuer, issuer)
-        set_metadata(:standard_class, standard_class(scope, prefix, mandate))
-        set_metadata(:standard_agency, standard_agency(scope, prefix, mandate))
-        set_metadata(:gbprefix, scope == "local" ? "DB" : prefix)
-        set_metadata(:gbscope, scope)
+        @agencies = Agencies.new(@lang, @labels, issuer)
+        docidentifier(scope, prefix, mandate, docyear)
+        set(:issuer, issuer)
+        set(:standard_class, @agencies.standard_class(scope, prefix, mandate))
+        set(:standard_agency, @agencies.standard_agency(scope, prefix, mandate))
+        set(:gbprefix, scope == "local" ? "DB" : prefix)
+        set(:gbscope, scope)
       end
 
       def standard_logo(gbprefix)
@@ -180,12 +181,12 @@ module IsoDoc
       def gb_library_identifier(isoxml)
         ics = []
         ccs = []
-        isoxml.xpath(ns("//bibdata/ics")).each { |i| ics << i.text }
+        isoxml.xpath(ns("//bibdata/ics/code")).each { |i| ics << i.text }
         isoxml.xpath(ns("//bibdata/ccs")).each { |i| ccs << i.text }
         p = isoxml.at(ns("//bibdata/plannumber"))
-        set_metadata(:libraryid_ics, ics.empty? ? "XXX" : ics.join(", "))
-        set_metadata(:libraryid_ccs, ccs.empty? ? "XXX" : ccs.join(", "))
-        set_metadata(:libraryid_plan, p ? p.text : "XXX")
+        set(:libraryid_ics, ics.empty? ? "XXX" : ics.join(", "))
+        set(:libraryid_ccs, ccs.empty? ? "XXX" : ccs.join(", "))
+        set(:libraryid_plan, p ? p.text : "XXX")
       end
 
       def part_label(partnumber, lang)
@@ -197,16 +198,16 @@ module IsoDoc
 
       def bibdate(isoxml, _out)
         super
-        m = get_metadata
+        m = get
         if @lang == "zh"
-          set_metadata(:labelled_publisheddate, m[:publisheddate] + " " +
+          set(:labelled_publisheddate, m[:publisheddate] + " " +
                        @labels["publicationdate_lbl"])
-          set_metadata(:labelled_implementeddate, m[:implementeddate] + " " +
+          set(:labelled_implementeddate, m[:implementeddate] + " " +
                        @labels["implementationdate_lbl"])
         else
-          set_metadata(:labelled_publisheddate, @labels["publicationdate_lbl"] +
+          set(:labelled_publisheddate, @labels["publicationdate_lbl"] +
                        ": " + m[:publisheddate])
-          set_metadata(:labelled_implementeddate,
+          set(:labelled_implementeddate,
                        @labels["implementationdate_lbl"] + ": " +
                        m[:implementeddate])
         end