isodoc 1.0.23 → 1.0.28

data/lib/isodoc/function/inline_simple.rb

@@ -0,0 +1,72 @@
+module IsoDoc::Function
+  module Inline
+    def section_break(body)
+      body.br
+    end
+
+    def page_break(out)
+      out.br
+    end
+
+    def pagebreak_parse(_node, out)
+      out.br
+    end
+
+    def hr_parse(node, out)
+      out.hr
+    end
+
+    def br_parse(node, out)
+      out.br
+    end
+
+    def index_parse(node, out)
+    end
+
+        def bookmark_parse(node, out)
+      out.a **attr_code(id: node["id"])
+    end
+
+    def keyword_parse(node, out)
+      out.span **{ class: "keyword" } do |s|
+        node.children.each { |n| parse(n, s) }
+      end
+    end
+
+    def em_parse(node, out)
+      out.i do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
+    def strong_parse(node, out)
+      out.b do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
+    def sup_parse(node, out)
+      out.sup do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
+    def sub_parse(node, out)
+      out.sub do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
+    def tt_parse(node, out)
+      out.tt do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+
+    def strike_parse(node, out)
+      out.s do |e|
+        node.children.each { |n| parse(n, e) }
+      end
+    end
+  end
+end

data/lib/isodoc/function/references.rb

@@ -5,30 +5,30 @@ module IsoDoc::Function
     # references anyway; keeping here instead of in IsoDoc::Iso for now
     def docid_l10n(x)
       return x if x.nil?
-      x.gsub(/All Parts/i, @all_parts_lbl.downcase)
+      x.gsub(/All Parts/i, @all_parts_lbl.downcase) if @all_parts_lbl
     end
 
     # TODO generate formatted ref if not present
-    def nonstd_bibitem(list, b, ordinal, bibliography)
-      list.p **attr_code(iso_bibitem_entry_attrs(b, bibliography)) do |r|
-        id = bibitem_ref_code(b)
-        identifier = render_identifier(id)
-        if bibliography then ref_entry_code(r, ordinal, identifier, id)
+    def nonstd_bibitem(list, b, ordinal, biblio)
+      list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+        ids = bibitem_ref_code(b)
+        identifiers = render_identifier(ids)
+        if biblio then ref_entry_code(ref, ordinal, identifiers, ids)
         else
-          identifier = "[#{identifier}]" if id["type"] == "metanorma"
-          r << "#{identifier}, "
+          ref << "#{identifiers[0] || identifiers[1]}, "
+          ref << "#{identifiers[1]}, " if identifiers[0] && identifiers[1]
         end
-        reference_format(b, r)
+        reference_format(b, ref)
       end
     end
 
     def std_bibitem_entry(list, b, ordinal, biblio)
       list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
-        prefix_bracketed_ref(ref, ordinal) if biblio
-        id = bibitem_ref_code(b)
-        identifier = render_identifier(id)
-        identifier = "[#{identifier}]" if id["type"] == "metanorma" && !biblio
-        ref << identifier
+        ids = bibitem_ref_code(b)
+        identifiers = render_identifier(ids)
+        prefix_bracketed_ref(ref, "[#{ordinal}]") if biblio
+        ref << "#{identifiers[0] || identifiers[1]}"
+        ref << ", #{identifiers[1]}" if identifiers[0] && identifiers[1]
         date_note_process(b, ref)
         ref << ", "
         reference_format(b, ref)
@@ -38,29 +38,43 @@ module IsoDoc::Function
     # if t is just a number, only use that ([1] Non-Standard)
     # else, use both ordinal, as prefix, and t
     def ref_entry_code(r, ordinal, t, id)
-      if id["type"] == "metanorma"
-        prefix_bracketed_ref(r, t)
-      else
-        prefix_bracketed_ref(r, ordinal)
-        if !t.empty? && !%w(DOI ISSN ISBN).include?(id["type"])
-          r << "#{t}, "
-        end
+      prefix_bracketed_ref(r, t[0] || "[#{ordinal}]")
+      if t[1]
+        r << "#{t[1]}, "
       end
     end
 
+    def pref_ref_code(b)
+      b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
+              "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
+    end
+
+    # returns [metanorma, non-metanorma, DOI/ISSN/ISBN] identifiers
     def bibitem_ref_code(b)
       id = b.at(ns("./docidentifier[@type = 'metanorma']"))
-      id ||= b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
-                   "or @type = 'ISSN' or @type = 'ISBN')]"))
-      id ||= b.at(ns("./docidentifier")) 
-      return id if id
+      id1 = pref_ref_code(b)
+      id2 = b.at(ns("./docidentifier[@type = 'DOI' or @type = 'ISSN' or @type = 'ISBN']")) 
+      return [id, id1, id2] if id || id1 || id2
       id = Nokogiri::XML::Node.new("docidentifier", b.document)
       id << "(NO ID)"
-      id
+      [nil, id, nil]
+    end
+
+    def bracket_if_num(x)
+      return nil if x.nil?
+      x = x.text.sub(/^\[/, "").sub(/\]$/, "")
+      return "[#{x}]" if /^\d+$/.match(x)
+      x
     end
 
     def render_identifier(id)
-      docid_prefix(id["type"], id.text.sub(/^\[/, "").sub(/\]$/, ""))
+      [
+        bracket_if_num(id[0]),
+        id[1].nil? ? nil :
+        docid_prefix(id[1]["type"], id[1].text.sub(/^\[/, "").sub(/\]$/, "")),
+        id[2].nil? ? nil :
+        docid_prefix(id[2]["type"], id[2].text.sub(/^\[/, "").sub(/\]$/, "")),
+      ]
     end
 
     def docid_prefix(prefix, docid)
@@ -70,7 +84,7 @@ module IsoDoc::Function
 
     def omit_docid_prefix(prefix)
       return true if prefix.nil? || prefix.empty?
-      return %w(ISO IEC ITU metanorma).include? prefix
+      return %w(ISO IEC ITU W3C metanorma).include? prefix
     end
 
     def date_note_process(b, ref)
@@ -100,7 +114,7 @@ module IsoDoc::Function
     end
 
     def prefix_bracketed_ref(ref, text)
-      ref << "[#{text}]"
+      ref << text.to_s
       insert_tab(ref, 1)
     end
 
@@ -146,8 +160,7 @@ module IsoDoc::Function
     end
 
     def norm_ref(isoxml, out, num)
-      q = "//bibliography/references[title = 'Normative References' or "\
-        "title = 'Normative references']"
+      q = "//bibliography/references[@normative = 'true']"
       f = isoxml.at(ns(q)) or return num
       out.div do |div|
         num = num + 1
@@ -157,8 +170,8 @@ module IsoDoc::Function
       num
     end
 
-    BIBLIOGRAPHY_XPATH = "//bibliography/clause[title = 'Bibliography'] | "\
-      "//bibliography/references[title = 'Bibliography']".freeze
+    BIBLIOGRAPHY_XPATH = "//bibliography/clause[.//references[@normative = 'false']] | "\
+      "//bibliography/references[@normative = 'false']".freeze
 
     def bibliography(isoxml, out)
       f = isoxml.at(ns(BIBLIOGRAPHY_XPATH)) || return
@@ -188,12 +201,11 @@ module IsoDoc::Function
 
     def reference_names(ref)
       isopub = ref.at(ns(ISO_PUBLISHER_XPATH))
-      docid = bibitem_ref_code(ref)
-      prefix = docid["type"]
+      ids = bibitem_ref_code(ref)
+      identifiers = render_identifier(ids)
       date = ref.at(ns("./date[@type = 'published']"))
       allparts = ref.at(ns("./extent[@type='part'][referenceFrom='all']"))
-      reference = format_ref(docid_l10n(docid.text), prefix, isopub, date,
-                             allparts)
+      reference = docid_l10n(identifiers[0] || identifiers[1])
       @anchors[ref["id"]] = { xref: reference }
     end
 

data/lib/isodoc/function/section.rb

@@ -16,6 +16,7 @@ module IsoDoc::Function
             clausedelimspace(out)
           end
           c1&.children&.each { |c2| parse(c2, b) }
+          clausedelimspace(out) if /\S/.match(c1&.text)
         end
       end
     end
@@ -109,20 +110,29 @@ module IsoDoc::Function
       num
     end
 
-    def terms_defs_title(f)
-      symbols = f.at(ns(".//definitions"))
-      return @termsdefsymbols_lbl if symbols
-      @termsdef_lbl
-    end
-
     TERM_CLAUSE = "//sections/terms | "\
       "//sections/clause[descendant::terms]".freeze
 
+    def term_def_title(title)
+      case title&.text
+      when "Terms, definitions, symbols and abbreviated terms"
+        @labels["termsdefsymbolsabbrev"]
+      when "Terms, definitions and symbols"
+        @labels["termsdefsymbols"]
+      when "Terms, definitions and abbreviated terms"
+        @labels["termsdefabbrev"]
+      when "Terms and definitions"
+        @labels["termsdef"]
+      else
+        title
+      end
+    end
+
     def terms_defs(isoxml, out, num)
       f = isoxml.at(ns(TERM_CLAUSE)) or return num
       out.div **attr_code(id: f["id"]) do |div|
         num = num + 1
-        clause_name(num, terms_defs_title(f), div, nil)
+        clause_name(num, term_def_title(f&.at(ns("./title"))), div, nil)
         f.elements.each do |e|
           parse(e, div) unless %w{title source}.include? e.name
         end
@@ -198,7 +208,8 @@ module IsoDoc::Function
 
     def preface(isoxml, out)
       title_attr = { class: "IntroTitle" }
-      isoxml.xpath(ns("//preface/clause")).each do |f|
+      isoxml.xpath(ns("//preface/clause | //preface/terms | //preface/definitions | "\
+                      "//preface/references")).each do |f|
         page_break(out)
         out.div **{ class: "Section3", id: f["id"] } do |div|
           clause_name(nil, f&.at(ns("./title")), div, title_attr)

data/lib/isodoc/function/table.rb

@@ -91,7 +91,6 @@ module IsoDoc::Function
       style += <<~STYLE
         border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
         border-bottom:#{SW} #{rowmax == totalrows ? '1.5' : '1.0'}pt;
-        padding:0;
       STYLE
       header and scope = (td["colspan"] ? "colgroup" : "col")
       !header and td.name == "th" and scope =

data/lib/isodoc/function/to_word_html.rb

@@ -21,7 +21,7 @@ module IsoDoc::Function
       filename = filepath.sub_ext('').to_s
       dir = "#{filename}_files"
       unless debug
-        Dir.mkdir(dir) unless File.exists?(dir)
+        Dir.mkdir(dir, 0777) unless File.exists?(dir)
         FileUtils.rm_rf "#{dir}/*"
       end
       @filename = filename
@@ -79,7 +79,7 @@ module IsoDoc::Function
 
     def make_body3(body, docxml)
       body.div **{ class: "main-section" } do |div3|
-                  boilerplate docxml, div3
+        boilerplate docxml, div3
         abstract docxml, div3
         foreword docxml, div3
         introduction docxml, div3
@@ -102,6 +102,7 @@ module IsoDoc::Function
       @meta.relations isoxml, out
       @meta.version isoxml, out
       @meta.url isoxml, out
+      @meta.keywords isoxml, out
       @meta.get
     end
 
@@ -109,8 +110,15 @@ module IsoDoc::Function
       out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
     end
 
+    def middle_admonitions(isoxml, out)
+      isoxml.xpath(ns("//sections/note | //sections/admonition")).each do |x|
+        parse(x, out)
+      end
+    end
+
     def middle(isoxml, out)
       middle_title(out)
+      middle_admonitions(isoxml, out)
       i = scope isoxml, out, 0
       i = norm_ref isoxml, out, i
       i = terms_defs isoxml, out, i
@@ -120,20 +128,20 @@ module IsoDoc::Function
       bibliography isoxml, out
     end
 
-      def boilerplate(node, out)
-        boilerplate = node.at(ns("//boilerplate")) or return
-        out.div **{class: "authority"} do |s|
-          boilerplate.children.each do |n|
-            if n.name == "title"
-              s.h1 do |h|
-                n.children.each { |nn| parse(nn, h) }
-              end
-            else
-              parse(n, s)
+    def boilerplate(node, out)
+      boilerplate = node.at(ns("//boilerplate")) or return
+      out.div **{class: "authority"} do |s|
+        boilerplate.children.each do |n|
+          if n.name == "title"
+            s.h1 do |h|
+              n.children.each { |nn| parse(nn, h) }
             end
+          else
+            parse(n, s)
           end
         end
       end
+    end
 
     def parse(node, out)
       if node.text?
@@ -157,7 +165,7 @@ module IsoDoc::Function
         when "clause" then clause_parse(node, out)
         when "xref" then xref_parse(node, out)
         when "eref" then eref_parse(node, out)
-        when "origin" then eref_parse(node, out)
+        when "origin" then origin_parse(node, out)
         when "link" then link_parse(node, out)
         when "ul" then ul_parse(node, out)
         when "ol" then ol_parse(node, out)
@@ -210,6 +218,8 @@ module IsoDoc::Function
         when "license-statement" then license_parse(node, out)
         when "legal-statement" then legal_parse(node, out)
         when "feedback-statement" then feedback_parse(node, out)
+        when "passthrough" then passthrough_parse(node, out)
+        when "variant" then variant_parse(node, out)
         else
           error_parse(node, out)
         end

data/lib/isodoc/function/utils.rb

@@ -49,7 +49,12 @@ module IsoDoc::Function
         /^(\&[^ \t\r\n#;]+;)/.match(t) ? 
           HTMLEntities.new.encode(HTMLEntities.new.decode(t), :hexadecimal) : t
       end.join("")
-      Nokogiri::XML.parse(xml)
+      begin
+        Nokogiri::XML.parse(xml) { |config| config.strict }
+      rescue Nokogiri::XML::SyntaxError => e
+        File.open("#{@filename}.#{@format}.err", "w:UTF-8") { |f| f.write xml }
+        abort "Malformed Output XML for #{@format}: #{e} (see #{@filename}.#{@format}.err)"
+      end
     end
 
     def to_xhtml_fragment(xml)
@@ -64,7 +69,7 @@ module IsoDoc::Function
 
     CLAUSE_ANCESTOR =
       ".//ancestor::*[local-name() = 'annex' or "\
-      "local-name() = 'acknowledgements' or "\
+      "local-name() = 'acknowledgements' or local-name() = 'term' or "\
       "local-name() = 'appendix' or local-name() = 'foreword' or "\
       "local-name() = 'introduction' or local-name() = 'terms' or "\
       "local-name() = 'clause' or local-name() = 'references']/@id".freeze
@@ -78,7 +83,7 @@ module IsoDoc::Function
       ".//ancestor::*[local-name() = 'annex' or "\
       "local-name() = 'foreword' or local-name() = 'appendix' or "\
       "local-name() = 'introduction' or local-name() = 'terms' or "\
-      "local-name() = 'acknowledgements' or "\
+      "local-name() = 'acknowledgements' or local-name() = 'term' or "\
       "local-name() = 'clause' or local-name() = 'references' or "\
       "local-name() = 'figure' or local-name() = 'formula' or "\
       "local-name() = 'table' or local-name() = 'example']/@id".freeze
@@ -110,12 +115,13 @@ module IsoDoc::Function
     end
 
     def header_strip(h)
-      h = h.to_s.gsub(%r{<br/>}, " ").sub(/<\/?h[123456][^>]*>/, "")
+      h = h.to_s.gsub(%r{<br\s*/>}, " ").gsub(/<\/?h[123456][^>]*>/, "").
+        gsub(/<\/?b[^>]*>/, "")
       h1 = to_xhtml_fragment(h.dup)
       h1.traverse do |x|
         x.replace(" ") if x.name == "span" && /mso-tab-count/.match(x["style"])
         x.remove if x.name == "span" && x["class"] == "MsoCommentReference"
-        x.remove if x.name == "a" && x["epub:type"] == "footnote"
+        x.remove if x.name == "a" && x["class"] == "FootnoteRef"
         x.remove if x.name == "span" && /mso-bookmark/.match(x["style"])
         x.replace(x.children) if x.name == "a"
       end

data/lib/isodoc/function/xref_gen.rb

@@ -40,6 +40,7 @@ module IsoDoc::Function
 
     SECTIONS_XPATH =
       "//foreword | //introduction | //acknowledgements | //preface/clause | "\
+      "//preface/terms | preface/definitions | preface/references | "\
       "//sections/terms | //annex | "\
       "//sections/clause | //sections/definitions | "\
       "//bibliography/references | //bibliography/clause".freeze
@@ -68,7 +69,7 @@ module IsoDoc::Function
       "not(self::xmlns:terms) and not(self::xmlns:definitions)]//"\
       "xmlns:example | ./xmlns:example".freeze
 
-    CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions"
+    CHILD_SECTIONS = "./clause | ./appendix | ./terms | ./definitions | ./references"
 
     def example_anchor_names(sections)
       sections.each do |s|

data/lib/isodoc/function/xref_sect_gen.rb

@@ -5,10 +5,9 @@ module IsoDoc::Function
         annex_names(c, (65 + i).chr.to_s)
       end
       docxml.xpath(
-        ns("//bibliography/clause[not(xmlns:title = 'Normative References' or "\
-           "xmlns:title = 'Normative references')] |"\
-           "//bibliography/references[not(xmlns:title = 'Normative References'"\
-           " or xmlns:title = 'Normative references')]")).each do |b|
+           ns("//bibliography/clause[.//references[@normative = 'false']] | "\
+           "//bibliography/references[@normative = 'false']"
+           )).each do |b|
         preface_names(b)
       end
       docxml.xpath(ns("//bibitem[not(ancestor::bibitem)]")).each do |ref|
@@ -17,23 +16,13 @@ module IsoDoc::Function
     end
 
     def initial_anchor_names(d)
-      preface_names(d.at(ns("//preface/abstract")))
-      preface_names(d.at(ns("//foreword")))
-      preface_names(d.at(ns("//introduction")))
-      d.xpath(ns("//preface/clause")).each do |c|
-      preface_names(c)
-      end
-      preface_names(d.at(ns("//acknowledgements")))
+      d.xpath(ns("//preface/*")).each { |c| c.element? and preface_names(c) }
       # potentially overridden in middle_section_asset_names()
-      sequential_asset_names(
-        d.xpath(ns("//preface/abstract | //foreword | //introduction | "\
-                   "//preface/clause | //acknowledgements")))
+      sequential_asset_names(d.xpath(ns("//preface/*")))
       n = section_names(d.at(ns("//clause[title = 'Scope']")), 0, 1)
       n = section_names(d.at(ns(
-        "//bibliography/clause[title = 'Normative References' or "\
-        "title = 'Normative references'] |"\
-        "//bibliography/references[title = 'Normative References' or "\
-        "title = 'Normative references']")), n, 1)
+        "//bibliography/clause[.//references[@normative = 'true']] | "\
+        "//bibliography/references[@normative = 'true']")), n, 1)
       n = section_names(d.at(ns("//sections/terms | "\
                                 "//sections/clause[descendant::terms]")), n, 1)
       n = section_names(d.at(ns("//sections/definitions")), n, 1)
@@ -76,10 +65,8 @@ module IsoDoc::Function
 
     def middle_section_asset_names(d)
       middle_sections = "//clause[title = 'Scope'] | "\
-        "//references[title = 'Normative References' or title = "\
-        "'Normative references'] | "\
-        "//sections/terms | //preface/abstract | //foreword | "\
-        "//introduction | //preface/clause | //acknowledgements "\
+        "//references[@normative = 'true'] | "\
+        "//sections/terms | //preface/* | "\
         "//sections/definitions | //clause[parent::sections]"
       sequential_asset_names(d.xpath(ns(middle_sections)))
     end
@@ -120,12 +107,25 @@ module IsoDoc::Function
       l10n("<b>#{@annex_lbl} #{num}</b><br/>#{obl}")
     end
 
+    def single_annex_special_section(clause)
+      a = clause.xpath(ns("./references | ./terms | ./definitions"))
+      a.size == 1 or return nil
+      clause.xpath(ns("./clause | ./p | ./table | ./ol | ./ul | ./dl | "\
+                      "./note | ./admonition | ./figure")).size == 0 or
+                     return nil
+      a[0]
+    end
+
     def annex_names(clause, num)
       @anchors[clause["id"]] = { label: annex_name_lbl(clause, num),
                                  type: "clause",
                                  xref: "#{@annex_lbl} #{num}", level: 1 }
-      clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
-        annex_names1(c, "#{num}.#{i + 1}", 2)
+      if a = single_annex_special_section(clause)
+        annex_names1(a, "#{num}", 1)
+      else
+        clause.xpath(ns(SUBCLAUSES)).each_with_index do |c, i|
+          annex_names1(c, "#{num}.#{i + 1}", 2)
+        end
       end
       hierarchical_asset_names(clause, num)
     end