isodoc 2.10.0 → 3.0.0

data/lib/isodoc/function/references.rb

@@ -1,16 +1,7 @@
 module IsoDoc
   module Function
     module References
-      # This is highly specific to ISO, but it's not a bad precedent for
-      # references anyway; keeping here instead of in IsoDoc::Iso for now
-      def docid_l10n(text)
-        text.nil? and return text
-        @i18n.all_parts and text.gsub!(/All Parts/i, @i18n.all_parts.downcase)
-        text.size < 20 and text.gsub!(/ /, "&#xa0;")
-        text
-      end
-
-      def nonstd_bibitem(list, bib, _ordinal, biblio)
+      def bibitem_entry(list, bib, _ordinal, biblio)
         list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
           tag = bib.at(ns("./biblio-tag"))
           tag&.children&.each { |n| parse(n, ref) }
@@ -18,132 +9,24 @@ module IsoDoc
         end
       end
 
-      def std_bibitem_entry(list, bib, _ordinal, biblio)
-        list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
-          tag = bib.at(ns("./biblio-tag"))
-          tag&.children&.each { |n| parse(n, ref) }
-          reference_format(bib, ref)
-        end
-      end
-
-      SKIP_DOCID = <<~XPATH.strip.freeze
-        @type = 'DOI' or @type = 'doi' or @type = 'ISSN' or @type = 'issn' or @type = 'ISBN' or @type = 'isbn' or starts-with(@type, 'ISSN.') or starts-with(@type, 'ISBN.') or starts-with(@type, 'issn.') or starts-with(@type, 'isbn.')
-      XPATH
-
-      def pref_ref_code(bib)
-        bib["suppress_identifier"] == "true" and return nil
-        ret = bib.xpath(ns("./docidentifier[@scope = 'biblio-tag']"))
-        ret.empty? or return ret.map(&:text)
-        ret = pref_ref_code_parse(bib) or return nil
-        ins = bib.at(ns("./docidentifier[last()]"))
-        ret.reverse.each do |r|
-          ins.next = "<docidentifier scope='biblio-tag'>#{docid_l10n(r)}</docidentifier>"
-        end
-        ret
-      end
-
-      def pref_ref_code_parse(bib)
-        data, = @bibrender.parse(bib)
-        ret = data[:authoritative_identifier] or return nil
-        ret.empty? and return nil
-        ret
-      end
-
-      # returns [metanorma, non-metanorma, DOI/ISSN/ISBN] identifiers
-      def bibitem_ref_code(bib)
-        id = bib.at(ns("./docidentifier[@type = 'metanorma']"))
-        id1 = pref_ref_code(bib)
-        id2 = bib.at(ns("./docidentifier[#{SKIP_DOCID}]"))
-        id3 = bib.at(ns("./docidentifier[@type = 'metanorma-ordinal']"))
-        return [id, id1, id2, id3] if id || id1 || id2 || id3
-        return [nil, nil, nil, nil] if bib["suppress_identifier"] == "true"
-
-        id = Nokogiri::XML::Node.new("docidentifier", bib.document)
-        id << "(NO ID)"
-        [nil, id, nil, nil]
-      end
-
-      def bracket_if_num(num)
-        return nil if num.nil?
-
-        num = num.text.sub(/^\[/, "").sub(/\]$/, "")
-        return "[#{num}]" if /^\d+$/.match?(num)
-
-        num
-      end
-
-      def unbracket1(ident)
-        ident.nil? and return nil
-        ident.is_a?(String) or ident = ident.text
-        ident.sub(/^\[/, "").sub(/\]$/, "")
-      end
-
-      def unbracket(ident)
-        if ident.respond_to?(:size)
-          ident.map { |x| unbracket1(x) }.join("&#xA0;/ ")
-        else
-          unbracket1(ident)
-        end
-      end
-
-      def render_identifier(ident)
-        { metanorma: bracket_if_num(ident[0]),
-          sdo: unbracket(ident[1]),
-          doi: unbracket(ident[2]),
-          ordinal: bracket_if_num(ident[3]) }
-      end
-
-      def docid_prefix(prefix, docid)
-        docid = "#{prefix} #{docid}" if prefix && !omit_docid_prefix(prefix) &&
-          !/^#{prefix}\b/.match(docid)
-        docid_l10n(docid)
-      end
-
-      def omit_docid_prefix(prefix)
-        return true if prefix.nil? || prefix.empty?
-
-        %w(ISO IEC IEV ITU W3C BIPM csd metanorma repository metanorma-ordinal)
-          .include? prefix
-      end
-
       def iso_bibitem_entry_attrs(bib, biblio)
         { id: bib["id"], class: biblio ? "Biblio" : "NormRef" }
       end
 
-      # reference not to be rendered because it is deemed implicit
-      # in the standards environment
-      def implicit_reference(bib)
-        bib["hidden"] == "true"
-      end
-
       def reference_format(bib, out)
         ftitle = bib.at(ns("./formattedref"))
         ftitle&.children&.each { |n| parse(n, out) }
       end
 
-      def standard?(bib)
-        ret = false
-        bib.xpath(ns("./docidentifier")).each do |id|
-          next if id["type"].nil? ||
-            id.at(".//self::*[#{SKIP_DOCID} or @type = 'metanorma']")
-
-          ret = true
-        end
-        ret
-      end
-
       def biblio_list(refs, div, biblio)
         i = 0
         refs.children.each do |b|
           if b.name == "bibitem"
-            next if implicit_reference(b)
-
-            i += 1 unless b["hidden"]
-            if standard?(b) then std_bibitem_entry(div, b, i, biblio)
-            else nonstd_bibitem(div, b, i, biblio)
-            end
+            b["hidden"] == "true" and next
+            i += 1
+            bibitem_entry(div, b, i, biblio)
           else
-            parse(b, div) unless %w(title).include? b.name
+            parse(b, div) unless %w(fmt-title).include? b.name
           end
         end
       end
@@ -158,9 +41,9 @@ module IsoDoc
       def norm_ref(node, out)
         node["hidden"] != "true" or return
         out.div do |div|
-          clause_name(node, node.at(ns("./title")), div, nil)
+          clause_name(node, node.at(ns("./fmt-title")), div, nil)
           if node.name == "clause"
-            node.elements.each { |e| parse(e, div) unless e.name == "title" }
+            node.elements.each { |e| parse(e, div) unless e.name == "fmt-title" }
           else biblio_list(node, div, false)
           end
         end
@@ -177,7 +60,7 @@ module IsoDoc
         page_break(out)
         out.div do |div|
           div.h1 class: "Section3" do |h1|
-            node.at(ns("./title"))&.children&.each { |c2| parse(c2, h1) }
+            node.at(ns("./fmt-title"))&.children&.each { |c2| parse(c2, h1) }
           end
           biblio_list(node, div, true)
         end
@@ -186,7 +69,7 @@ module IsoDoc
       def bibliography_parse(node, out)
         node["hidden"] != true or return
         out.div do |div|
-          clause_parse_title(node, div, node.at(ns("./title")), out,
+          clause_parse_title(node, div, node.at(ns("./fmt-title")), out,
                              { class: "Section3" })
           biblio_list(node, div, true)
         end

data/lib/isodoc/function/reqt.rb

@@ -20,9 +20,10 @@ module IsoDoc
       end
 
       def recommendation_parse1(node, out)
-        recommendation_name(node.at(ns("./name")), out)
-        node.children.each do |n|
-          parse(n, out) unless n.name == "name"
+        p = node.at(ns("./fmt-provision")) or return
+        recommendation_name(node.at(ns("./fmt-name")), out)
+        p.children.each do |n|
+          parse(n, out)
         end
       end
 

data/lib/isodoc/function/section.rb

@@ -10,8 +10,8 @@ module IsoDoc
       # used for subclauses
       def clause_parse(node, out)
         out.div **attr_code(clause_attrs(node)) do |div|
-          clause_parse_title(node, div, node.at(ns("./title")), out)
-          node.children.reject { |c1| c1.name == "title" }.each do |c1|
+          clause_parse_title(node, div, node.at(ns("./fmt-title")), out)
+          node.children.reject { |c1| c1.name == "fmt-title" }.each do |c1|
             parse(c1, div)
           end
         end
@@ -19,8 +19,8 @@ module IsoDoc
 
       def clause(node, out)
         out.div **attr_code(clause_attrs(node)) do |s|
-          clause_name(node, node.at(ns("./title")), s, nil)
-          node.elements.reject { |c1| c1.name == "title" }.each do |c1|
+          clause_name(node, node.at(ns("./fmt-title")), s, nil)
+          node.elements.reject { |c1| c1.name == "fmt-title" }.each do |c1|
             parse(c1, s)
           end
         end
@@ -34,7 +34,7 @@ module IsoDoc
         page_break(out)
         out.div **attr_code(annex_attrs(node)) do |s|
           node.elements.each do |c1|
-            if c1.name == "title" then annex_name(node, c1, s)
+            if c1.name == "fmt-title" then annex_name(node, c1, s)
             else parse(c1, s)
             end
           end
@@ -47,9 +47,9 @@ module IsoDoc
 
       def scope(node, out)
         out.div **attr_code(id: node["id"]) do |div|
-          clause_name(node, node.at(ns("./title")), div, nil)
+          clause_name(node, node.at(ns("./fmt-title")), div, nil)
           node.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
@@ -59,9 +59,9 @@ module IsoDoc
 
       def terms_defs(node, out)
         out.div **attr_code(id: node["id"]) do |div|
-          clause_name(node, node.at(ns("./title")), div, nil)
+          clause_name(node, node.at(ns("./fmt-title")), div, nil)
           node.elements.each do |e|
-            parse(e, div) unless %w{title source}.include? e.name
+            parse(e, div) unless %w{fmt-title source}.include? e.name
           end
         end
       end
@@ -73,27 +73,25 @@ module IsoDoc
 
       def symbols_abbrevs(node, out)
         out.div **attr_code(id: node["id"], class: "Symbols") do |div|
-          clause_name(node, node.at(ns("./title")), div, nil)
+          clause_name(node, node.at(ns("./fmt-title")), div, nil)
           node.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
 
       # subclause
       def symbols_parse(isoxml, out)
-        isoxml.at(ns("./title")) or
-          isoxml.children.first.previous = "<title>#{@i18n.symbols}</title>"
         clause_parse(isoxml, out)
       end
 
       def introduction(clause, out)
         page_break(out)
         out.div class: "Section3", id: clause["id"] do |div|
-          clause_name(clause, clause.at(ns("./title")), div,
+          clause_name(clause, clause.at(ns("./fmt-title")), div,
                       { class: "IntroTitle" })
           clause.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
@@ -101,9 +99,9 @@ module IsoDoc
       def foreword(clause, out)
         page_break(out)
         out.div **attr_code(id: clause["id"]) do |s|
-          clause_name(clause, clause.at(ns("./title")) || @i18n.foreword, s,
+          clause_name(clause, clause.at(ns("./fmt-title")), s,
                       { class: "ForewordTitle" })
-          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
+          clause.elements.each { |e| parse(e, s) unless e.name == "fmt-title" }
         end
       end
 
@@ -111,9 +109,9 @@ module IsoDoc
         title_attr = { class: "IntroTitle" }
         page_break(out)
         out.div class: "Section3", id: clause["id"] do |div|
-          clause_name(clause, clause.at(ns("./title")), div, title_attr)
+          clause_name(clause, clause.at(ns("./fmt-title")), div, title_attr)
           clause.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
@@ -121,9 +119,9 @@ module IsoDoc
       def abstract(clause, out)
         page_break(out)
         out.div **attr_code(id: clause["id"]) do |s|
-          clause_name(clause, clause.at(ns("./title")), s,
+          clause_name(clause, clause.at(ns("./fmt-title")), s,
                       { class: "AbstractTitle" })
-          clause.elements.each { |e| parse(e, s) unless e.name == "title" }
+          clause.elements.each { |e| parse(e, s) unless e.name == "fmt-title" }
         end
       end
 
@@ -143,21 +141,22 @@ module IsoDoc
       def preface_normal(clause, out)
         page_break(out)
         out.div **attr_code(preface_attrs(clause)) do |div|
-          clause_name(clause, clause.at(ns("./title")), div,
+          clause_name(clause, clause.at(ns("./fmt-title")), div,
                       { class: "IntroTitle" })
           clause.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
 
       def table_of_contents(clause, out)
+        @bare and return
         page_break(out)
         out.div **attr_code(preface_attrs(clause)) do |div|
-          clause_name(clause, clause.at(ns("./title")), div,
+          clause_name(clause, clause.at(ns("./fmt-title")), div,
                       { class: "IntroTitle" })
           clause.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
@@ -166,10 +165,10 @@ module IsoDoc
         @seen_colophon or page_break(out)
         @seen_colophon = true
         out.div class: "Section3", id: node["id"] do |div|
-          clause_name(node, node.at(ns("./title")), div,
+          clause_name(node, node.at(ns("./fmt-title")), div,
                       { class: "IntroTitle" })
           node.elements.each do |e|
-            parse(e, div) unless e.name == "title"
+            parse(e, div) unless e.name == "fmt-title"
           end
         end
       end
@@ -194,32 +193,28 @@ module IsoDoc
       end
 
       def copyright_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-copyright" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def license_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-license" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def legal_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-legal" do |div|
           node.children.each { |n| parse(n, div) }
         end
       end
 
       def feedback_parse(node, out)
-        return if @bare
-
+        @bare and return
         out.div class: "boilerplate-feedback" do |div|
           node.children.each { |n| parse(n, div) }
         end

data/lib/isodoc/function/section_titles.rb

@@ -10,7 +10,7 @@ module IsoDoc
       end
 
       def inline_header_title(out, node, title)
-        out.span class: "zzMoveToFollowing" do |s|
+        out.span class: "zzMoveToFollowing inline-header" do |s|
           s.b do |b|
             title&.children&.each { |c2| parse(c2, b) }
             clausedelimspace(node, out) if /\S/.match?(title&.text)
@@ -18,10 +18,24 @@ module IsoDoc
         end
       end
 
+      def sections_names
+        %w[clause annex terms references definitions
+           acknowledgements introduction abstract foreword appendix]
+      end
+
+      def freestanding_title(node, out)
+        # node.parent.at(ns("./fmt-title[@source = '#{node['id']}']")) and
+        # return # this title is already being rendered as fmt-title
+        # For testing convenience, let's just go by parent
+        sections_names.include?(node.parent.name) and return
+        parents = node.ancestors(sections_names.join(", "))
+        clause_parse_title(parents.empty? ? node : parents.first,
+                           out, node, out)
+      end
+
       # used for subclauses
       def clause_parse_title(node, div, title, out, header_class = {})
-        return if title.nil?
-
+        title.nil? and return
         if node["inline-header"] == "true"
           inline_header_title(out, node, title)
         else
@@ -38,9 +52,7 @@ module IsoDoc
       end
 
       def clause_title_depth(node, title)
-        depth = node.ancestors("clause, annex, terms, references, " \
-                               "definitions, acknowledgements, introduction, " \
-                               "foreword").size + 1
+        depth = node.ancestors(sections_names.join(", ")).size + 1
         depth = title["depth"] if title && title["depth"]
         depth
       end
@@ -55,12 +67,12 @@ module IsoDoc
       end
 
       # top level clause names
-      def clause_name(node, title, div, header_class)
+      def clause_name(_node, title, div, header_class)
         header_class = {} if header_class.nil?
         div.h1 **attr_code(header_class) do |h1|
           if title.is_a?(String) then h1 << title
-          else
-            title&.children&.each { |c2| parse(c2, h1) }
+          elsif title
+            children_parse(title, h1)
             clause_parse_subtitle(title, h1)
           end
         end
@@ -68,8 +80,7 @@ module IsoDoc
       end
 
       def annex_name(_annex, name, div)
-        return if name.nil?
-
+        name.nil? and return
         div.h1 class: "Annex" do |t|
           name.children.each { |c2| parse(c2, t) }
           clause_parse_subtitle(name, t)

data/lib/isodoc/function/table.rb

@@ -2,7 +2,7 @@ module IsoDoc
   module Function
     module Table
       def table_title_parse(node, out)
-        name = node.at(ns("./name")) or return
+        name = node.at(ns("./fmt-name")) or return
         out.p class: "TableTitle", style: "text-align:center;" do |p|
           name&.children&.each { |n| parse(n, p) }
         end
@@ -112,12 +112,12 @@ module IsoDoc
         !header && cell.name == "th" and
           scope = (cell["rowspan"] ? "rowgroup" : "row")
         { rowspan: cell["rowspan"], colspan: cell["colspan"],
-          style: style.gsub(/\n/, ""), scope: scope, class: cell["class"] }
+          style: style.delete("\n"), scope: scope, class: cell["class"] }
       end
 
       def make_tr_attr_style(row, rowmax, totalrows, _header, bordered)
         bordered or return ""
-        <<~STYLE.gsub(/\n/, "")
+        <<~STYLE.delete("\n")
           border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
           border-bottom:#{SW} #{rowmax >= totalrows ? '1.5' : '1.0'}pt;
         STYLE

data/lib/isodoc/function/terms.rb

@@ -10,62 +10,85 @@ module IsoDoc
         para.children.each { |n| parse(n, out) }
       end
 
+      def semx_deprecated_term_parse(node, out); end
+
       def deprecated_term_parse(node, out)
-        out.p class: "DeprecatedTerms", style: "text-align:left;" do |p|
-          node.children.each { |c| parse(c, p) }
+        node.children.each do |c|
+          if c.name == "p"
+            out.p class: "DeprecatedTerms", style: "text-align:left;" do |p|
+              c.children.each { |c1| parse(c1, p) }
+            end
+          else parse(c, out)
+          end
         end
       end
 
+      def semx_admitted_term_parse(node, out); end
+
       def admitted_term_parse(node, out)
-        out.p class: "AltTerms", style: "text-align:left;" do |p|
-          node.children.each { |c| parse(c, p) }
+                node.children.each do |c|
+          if c.name == "p"
+            out.p class: "AltTerms", style: "text-align:left;" do |p|
+              c.children.each { |c1| parse(c1, p) }
+            end
+          else parse(c, out)
+          end
         end
       end
 
-      def term_parse(node, out)
-        out.p class: "Terms", style: "text-align:left;" do |p|
-          node.children.each { |c| parse(c, p) }
-        end
-      end
+      def semx_term_parse(node, out); end
+
+      def semx_related_parse(node, out); end
 
-      def para_then_remainder(first, node, para, div)
-        if first.name == "p"
-          first.children.each { |n| parse(n, para) }
-          node.elements.drop(1).each { |n| parse(n, div) }
-        else
-          node.elements.each { |n| parse(n, div) }
+      def term_parse(node, out)
+        node.children.each do |c|
+          if c.name == "p"
+            out.p class: "Terms", style: "text-align:left;" do |p|
+              c.children.each { |c1| parse(c1, p) }
+            end
+          else parse(c, out)
+          end
         end
       end
 
-      def termnote_delim
-        l10n(": ")
+      def termnote_p_class
+        nil
       end
 
       def termnote_parse(node, out)
-        name = node&.at(ns("./name"))&.remove
+        para = block_body_first_elem(node)
         out.div **note_attrs(node) do |div|
-          div.p do |p|
-            if name
-              name.children.each { |n| parse(n, p) }
-              p << termnote_delim
+          termnote_parse1(node, para, div)
+          para&.xpath("./following-sibling::*")&.each { |n| parse(n, div) }
+        end
+      end
+
+      def termnote_parse1(node, para, div)
+        div.p **attr_code(class: termnote_p_class) do |p|
+          name = node.at(ns("./fmt-name")) and
+            p.span class: "termnote_label" do |s|
+              children_parse(name, s)
             end
-            para_then_remainder(node.first_element_child, node, p, div)
-          end
+          para&.name == "p" and children_parse(para, p)
         end
+        para&.name != "p" and parse(para, div)
       end
 
+      def semx_termref_parse(node, out); end
+
       def termref_parse(node, out)
         out.p do |p|
           node.children.each { |n| parse(n, p) }
         end
       end
 
+      def termdomain_parse(node, out); end
+
       def termdef_parse(node, out)
-        name = node&.at(ns("./name"))&.remove
+        name = node.at(ns("./fmt-name"))&.remove
         out.p class: "TermNum", id: node["id"] do |p|
           name&.children&.each { |n| parse(n, p) }
         end
-        set_termdomain("")
         node.children.each { |n| parse(n, out) }
       end