metanorma-standoc 2.3.8 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00ae5b84e04807e4d13ce97c2be80f47fc46a0004c8a1630d59f041597627f9e
-  data.tar.gz: 1e67f2c42a5b84081e44a6ad63b0cce70d980cc8478014de53355cf4b74e5e24
+  metadata.gz: 11179b51c3de0cefbd6cd55d2cd3e6945e0d72cb379ec9a32ed792b1239444fd
+  data.tar.gz: e3c6231ecd99e4f631da9173b1c89f10213428c331147b54efa1eccf8833a017
 SHA512:
-  metadata.gz: 65608377bcc5b0b06e6895f6d9ed842c956def5cf77e28e25d4db3ae554b062f0e798afa2a964a18265396c22243d6aeebea98e913b4c269ddf09c04e3f06f92
-  data.tar.gz: 01aff668829eb7d52cec2e94e9b9da8b06353b56847a615b543e6fa2cfefad4fe8e9a9cc0f72e266b74e4f7535671f23ed34b31da43b6cddffe14ba189165e4c
+  metadata.gz: d000c768270a37dacc417c3d29cab591a708bf7e7b47c51bbded56120c711c6bc82257335a44f34401cfb06d96dd8c64cb410d1664064534147fee3bf7525d85
+  data.tar.gz: 11799198a90c8b67a358365115cebf4594bfd1be0d58cbc193db94fa95096f98cbbd5974fb65f8b6dbc07349d6a76080591ed6703979d448ee768cd8e5f1ceae

data/lib/isodoc/html/htmlstyle.css

@@ -125,6 +125,10 @@ a.FootnoteRef + a.FootnoteRef:before {
   content: ", ";
   vertical-align: super; }
 
+a.TableFootnoteRef + a.TableFootnoteRef:before {
+  content: ", ";
+  vertical-align: super; }
+
 .addition {
   color: blue; }
 

data/lib/metanorma/standoc/base.rb

@@ -59,6 +59,7 @@ module Metanorma
         @index_terms = node.attr("index-terms")
         @boilerplateauthority = node.attr("boilerplate-authority")
         @embed_hdr = node.attr("embed_hdr")
+        @embed_id = node.attr("embed_id")
         @document_scheme = node.attr("document-scheme")
         @xrefstyle = node.attr("xrefstyle")
         @source_linenums = node.attr("source-linenums-option") == "true"
@@ -82,14 +83,20 @@ module Metanorma
       end
 
       def init_toc(node)
-        @htmltoclevels = node.attr("htmltoclevels")
-        @doctoclevels = node.attr("doctoclevels")
-        @toclevels = node.attr("toclevels")
+        @htmltoclevels = node.attr("htmltoclevels") ||
+          node.attr("toclevels") || toc_default[:html_levels]
+        @doctoclevels = node.attr("doctoclevels") ||
+          node.attr("toclevels") || toc_default[:word_levels]
+        @toclevels = node.attr("toclevels") || toc_default[:word_levels]
         @tocfigures = node.attr("toc-figures")
         @toctables = node.attr("toc-tables")
         @tocrecommendations = node.attr("toc-recommendations")
       end
 
+      def toc_default
+        { word_levels: 2, html_levels: 2 }
+      end
+
       def init_output(node)
         @fontheader = default_fonts(node)
         @log = Metanorma::Utils::Log.new

data/lib/metanorma/standoc/biblio.rng

@@ -216,6 +216,9 @@
       <optional>
         <ref name="fullname"/>
       </optional>
+      <zeroOrMore>
+        <ref name="credential"/>
+      </zeroOrMore>
       <zeroOrMore>
         <ref name="affiliation"/>
       </zeroOrMore>
@@ -232,6 +235,11 @@
       <ref name="FullNameType"/>
     </element>
   </define>
+  <define name="credential">
+    <element name="credential">
+      <text/>
+    </element>
+  </define>
   <define name="FullNameType">
     <choice>
       <group>
@@ -305,7 +313,9 @@
       <zeroOrMore>
         <ref name="affiliationdescription"/>
       </zeroOrMore>
-      <ref name="organization"/>
+      <optional>
+        <ref name="organization"/>
+      </optional>
     </element>
   </define>
   <define name="affiliationname">

data/lib/metanorma/standoc/blocks.rb

@@ -1,4 +1,3 @@
-require "htmlentities"
 require "uri" if /^2\./.match?(RUBY_VERSION)
 require_relative "./blocks_notes"
 
@@ -8,6 +7,7 @@ module Metanorma
       def id_attr(node = nil)
         { id: Metanorma::Utils::anchor_or_uuid(node),
           tag: node&.attr("tag"),
+          columns: node&.attr("columns"),
           "multilingual-rendering": node&.attr("multilingual-rendering") }
       end
 
@@ -43,11 +43,15 @@ module Metanorma
         result
       end
 
+      def form_attrs(node)
+        attr_code(id_attr(node)
+          .merge(class: node.attr("class"),
+                 name: node.attr("name"), action: node.attr("action")))
+      end
+
       def form(node)
         noko do |xml|
-          xml.form **attr_code(id_attr(node)
-            .merge(class: node.attr("class"),
-                   name: node.attr("name"), action: node.attr("action"))) do |f|
+          xml.form **form_attrs(node) do |f|
             f << node.content
           end
         end
@@ -108,8 +112,7 @@ module Metanorma
       end
 
       def example_to_requirement(node, role)
-        return unless @reqt_models.requirement_roles.key?(role&.to_sym)
-
+        @reqt_models.requirement_roles.key?(role&.to_sym) or return
         # need to call here for proper recursion ordering
         select_requirement_model(node)
         requirement(node,
@@ -169,8 +172,7 @@ module Metanorma
       end
 
       def figure_title(node, out)
-        return if node.title.nil?
-
+        node.title.nil? and return
         out.name { |name| name << node.title }
       end
 
@@ -196,8 +198,7 @@ module Metanorma
       end
 
       def paragraph(node)
-        return termsource(node) if node.role == "source"
-
+        node.role == "source" and return termsource(node)
         noko do |xml|
           xml.p **para_attrs(node) do |xml_t|
             xml_t << node.content

data/lib/metanorma/standoc/cleanup.rb

@@ -26,7 +26,8 @@ module Metanorma
       def cleanup(xmldoc)
         element_name_cleanup(xmldoc)
         passthrough_cleanup(xmldoc)
-        sections_cleanup(xmldoc) # feeds: obligations_cleanup, toc_cleanup
+        sections_cleanup(xmldoc) # feeds: obligations_cleanup, toc_cleanup,
+        # floatingtitle_cleanup
         obligations_cleanup(xmldoc)
         para_index_cleanup(xmldoc)
         block_index_cleanup(xmldoc)
@@ -60,6 +61,7 @@ module Metanorma
         quotesource_cleanup(xmldoc)
         callout_cleanup(xmldoc)
         footnote_cleanup(xmldoc)
+        ol_cleanup(xmldoc)
         mathml_cleanup(xmldoc)
         script_cleanup(xmldoc)
         docidentifier_cleanup(xmldoc) # feeds: bibdata_cleanup

data/lib/metanorma/standoc/cleanup_block.rb

@@ -100,8 +100,7 @@ module Metanorma
       # it is moved inside its preceding block if it is not delimited
       # (so there was no way of making that block include the note)
       def note_cleanup(xmldoc)
-        q = "//note[following-sibling::*[not(local-name() = 'note')]]"
-        xmldoc.xpath(q).each do |n|
+        xmldoc.xpath("//note").each do |n|
           next if n["keep-separate"] == "true" || !n.ancestors("table").empty?
 
           prev = n.previous_element || next
@@ -221,6 +220,14 @@ module Metanorma
           foll.children.first.previous = para.remove.children
         end
       end
+
+      def ol_cleanup(doc)
+        doc.xpath("//ol[@explicit-type]").each do |x|
+          x.delete("explicit-type")
+          @log.add("Bibliography", x,
+                   "Style override set for ordered list")
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_boilerplate.rb

@@ -22,10 +22,8 @@ module Metanorma
             @log.add("Crossreferences", nil,
                      "term source #{s['bibitemid']} not referenced")
         end
-        a = if source.empty? && term.nil?
-              @i18n.no_terms_boilerplate
-            else
-              term_defs_boilerplate_cont(source, term, isodoc)
+        a = if source.empty? && term.nil? then @i18n.no_terms_boilerplate
+            else term_defs_boilerplate_cont(source, term, isodoc)
             end
         a and div.next = a
       end
@@ -81,7 +79,7 @@ module Metanorma
         xmldoc.xpath(xpath).each do |f|
           f.xpath(".//clause[@type = 'boilerplate'] | " \
                   ".//note[@type = 'boilerplate']").each do |c|
-            c&.at("./title")&.remove
+            c.at("./title")&.remove
             c.replace(c.children)
           end
         end
@@ -89,13 +87,12 @@ module Metanorma
 
       def termdef_boilerplate_insert(xmldoc, isodoc, once = false)
         xmldoc.xpath(self.class::TERM_CLAUSE).each do |f|
-          next if f.at("./clause[@type = 'boilerplate'] | " \
-                       "./note[@type = 'boilerplate']")
-
+          f.at("./clause[@type = 'boilerplate'] | " \
+               "./note[@type = 'boilerplate']") and next
           term_defs_boilerplate(f.at("./title"),
                                 xmldoc.xpath(".//termdocsource"),
                                 f.at(".//term"), f.at(".//p"), isodoc)
-          break if once
+          once and break
         end
       end
 
@@ -109,8 +106,7 @@ module Metanorma
       end
 
       def initial_boilerplate(xml, isodoc)
-        return if xml.at("//boilerplate")
-
+        xml.at("//boilerplate") and return
         preface = xml.at("//preface") || xml.at("//sections") ||
           xml.at("//annex") || xml.at("//references") or return
         b = boilerplate(xml, isodoc) or return
@@ -123,10 +119,8 @@ module Metanorma
 
       def boilerplate(xml, conv)
         file = boilerplate_file(xml)
-        if @boilerplateauthority
-          file = File.join(@localdir,
-                           @boilerplateauthority)
-        end
+        @boilerplateauthority and
+          file = File.join(@localdir, @boilerplateauthority)
         (!file.nil? and File.exist?(file)) or return
         conv.populate_template(File.read(file, encoding: "UTF-8"), nil)
       end
@@ -134,7 +128,8 @@ module Metanorma
       def bibdata_cleanup(xmldoc)
         bibdata_anchor_cleanup(xmldoc)
         bibdata_docidentifier_cleanup(xmldoc)
-        bibdata_embed_hdr_cleanup(xmldoc)
+        bibdata_embed_hdr_cleanup(xmldoc) # feeds bibdata_embed_id_cleanup
+        bibdata_embed_id_cleanup(xmldoc)
         biblio_indirect_erefs(xmldoc, @internal_eref_namespaces&.uniq)
       end
 
@@ -147,8 +142,7 @@ module Metanorma
       def bibdata_docidentifier_cleanup(xmldoc)
         ins = xmldoc.at("//bibdata/docidentifier")
         xmldoc.xpath("//bibdata/docidentifier").each_with_index do |b, i|
-          next if i.zero?
-
+          i.zero? and next
           ins.next = b.remove
           ins = ins.next
         end
@@ -212,8 +206,7 @@ module Metanorma
       end
 
       def bibdata_embed_hdr_cleanup(xmldoc)
-        return if @embed_hdr.nil? || @embed_hdr.empty?
-
+        (@embed_hdr.nil? || @embed_hdr.empty?) and return
         xmldoc.at("//bibdata") << "<relation type='derivedFrom'>" \
                                   "#{hdr2bibitem(@embed_hdr.first)}</relation>"
       end
@@ -241,6 +234,19 @@ module Metanorma
           bibitem << "<relation type='derivedFrom'>#{x}</relation>"
         end
       end
+
+      def bibdata_embed_id_cleanup(xmldoc)
+        @embed_id.nil? and return
+        bibdata = xmldoc.at("//bibdata")
+        #require "debug"; binding.b
+        @embed_id.each do |d|
+          bibdata = bibdata.at("./relation[@type = 'derivedFrom']/bibitem")
+          ident = bibdata.at("./docidentifier[@primary = 'true']") ||
+            bibdata.at("./docidentifier")
+          xmldoc.xpath("//xref[@target = '#{d}'][normalize-space(text()) = '']")
+            .each { |x| x << ident.text }
+        end
+      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_image.rb

@@ -80,7 +80,7 @@ module Metanorma
         types = MIME::Types.type_for(path) or return false
         types.first == "image/svg+xml" or return false
         svg = File.read(path, encoding: "utf-8") or return false
-        img.replace(Nokogiri::XML(svg).root.to_xml)
+        img.replace(Nokogiri::XML(svg).root)
         true
       end
 

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -13,20 +13,31 @@ module Metanorma
       end
 
       def strip_initial_space(elem)
-        return unless elem.children[0].text?
-
+        elem.children[0].text? or return
         if /\S/.match?(elem.children[0].text)
-          elem.children[0].content = elem.children[0].text.gsub(/^ /, "")
+          elem.children[0].content = elem.children[0].text.lstrip
         else
           elem.children[0].remove
         end
       end
 
       def bookmark_cleanup(xmldoc)
+        redundant_bookmark_cleanup(xmldoc)
         li_bookmark_cleanup(xmldoc)
         dt_bookmark_cleanup(xmldoc)
       end
 
+      def redundant_bookmark_cleanup(xmldoc)
+        xmldoc.xpath("//bookmark").each do |b|
+          p = b
+          while !p.xml? && p = p.parent
+            p["id"] == b["id"] or next
+            b.remove
+            break
+          end
+        end
+      end
+
       def bookmark_to_id(elem, bookmark)
         parent = bookmark.parent
         elem["id"] = bookmark.remove["id"]
@@ -103,8 +114,8 @@ module Metanorma
       end
 
       def concept_eref_cleanup(elem)
-        t = elem&.at("./xrefrender")&.remove&.children&.to_xml
-        l = elem&.at("./locality")&.remove&.children&.to_xml
+        t = elem.at("./xrefrender")&.remove&.children&.to_xml
+        l = elem.at("./locality")&.remove&.children&.to_xml
         elem.add_child "<eref bibitemid='#{elem['key']}'>#{l}</eref>"
         extract_localities(elem.elements[-1])
         elem.elements[-1].add_child(t) if t

data/lib/metanorma/standoc/cleanup_section.rb

@@ -11,18 +11,31 @@ module Metanorma
         if xml.at("//foreword | //introduction | //acknowledgements | " \
                   "//*[@preface]")
           preface = sect.add_previous_sibling("<preface/>").first
-          f = xml.at("//foreword") and preface.add_child f.remove
-          f = xml.at("//introduction") and preface.add_child f.remove
+          f = xml.at("//foreword") and to_preface(preface, f)
+          f = xml.at("//introduction") and to_preface(preface, f)
           move_clauses_into_preface(xml, preface)
-          f = xml.at("//acknowledgements") and preface.add_child f.remove
+          f = xml.at("//acknowledgements") and to_preface(preface, f)
         end
         make_abstract(xml, sect)
       end
 
       def move_clauses_into_preface(xml, preface)
         xml.xpath("//*[@preface]").each do |c|
-          c.delete("preface")
-          preface.add_child c.remove
+          to_preface(preface, c)
+        end
+      end
+
+      def to_preface(preface, clause)
+        clause.delete("preface")
+        preface.add_child clause.remove
+      end
+
+      def make_colophon(xml)
+        xml.at("//clause[@colophon]") or return
+        colophon = xml.root.add_child("<colophon/>").first
+        xml.xpath("//*[@colophon]").each do |c|
+          c.delete("colophon")
+          colophon.add_child c.remove
         end
       end
 
@@ -73,10 +86,12 @@ module Metanorma
 
       def sections_order_cleanup(xml)
         s = xml.at("//sections")
+        pop_floating_title(xml)
         make_preface(xml, s)
         make_annexes(xml)
         make_indexsect(xml, s)
         make_bibliography(xml, s)
+        make_colophon(xml)
         xml.xpath("//sections/annex").reverse_each { |r| s.next = r.remove }
       end
 
@@ -200,7 +215,6 @@ module Metanorma
       end
 
       def floatingtitle_cleanup(xmldoc)
-        pop_floating_title(xmldoc)
         floating_title_preface2sections(xmldoc)
       end
 

data/lib/metanorma/standoc/cleanup_section_names.rb

@@ -17,7 +17,7 @@ module Metanorma
         doc.xpath(xpath).each_with_index do |node, i|
           first && !i.zero? and next
           title = get_or_make_title(node)
-          fn = title.xpath("./fn")
+          fn = title.xpath("./fn | ./bookmark")
           fn.each(&:remove)
           title.children = text
           fn.each { |n| title << n }

data/lib/metanorma/standoc/cleanup_symbols.rb

@@ -4,11 +4,14 @@ module Metanorma
       # Indices sort after letter but before any following
       # letter (x, x_m, x_1, xa); we use colon to force that sort order.
       # Numbers sort *after* letters; we use thorn to force that sort order.
+      # Capitals sort before their corresponding lowercase.
       def symbol_key(sym)
-        @c.decode(asciimath_key(sym).text.downcase)
+        @c.decode(asciimath_key(sym).text)
           .gsub(/[\[\]{}<>()]/, "").gsub(/\s/m, "")
           .gsub(/[[:punct:]]|[_^]/, ":\\0").gsub(/`/, "")
           .gsub(/[0-9]+/, "þ\\0")
+          .tr("AaBbCcDdEeFfGgHhIiJjKkLlMmNnOoPpQqRrSsTtUuVvWwXxYyZz",
+              "ABCFEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz")
       end
 
       def asciimath_key(sym)

data/lib/metanorma/standoc/cleanup_terms.rb

@@ -74,7 +74,7 @@ module Metanorma
       end
 
       def term_children_cleanup(xmldoc)
-        xmldoc.xpath("//terms[terms]").each { |t| t.name = "clause" }
+        xmldoc.xpath("//terms[terms][not(term)]").each { |t| t.name = "clause" }
         xmldoc.xpath("//term").each do |t|
           %w(termnote termexample termsource term).each do |w|
             t.xpath("./#{w}").each { |n| t << n.remove }

data/lib/metanorma/standoc/cleanup_toc.rb

@@ -86,9 +86,9 @@ module Metanorma
 
       def toc_metadata1(ins)
         [[@toclevels, "TOC Heading Levels"],
-         [@toclevels, "TOC Heading Levels"],
-         [@toclevels, "TOC Heading Levels"]].each do |n|
-          n[0] and ins << "<presentation-metadata><name>#{n[1]}</name>"\
+         [@htmltoclevels, "HTML TOC Heading Levels"],
+         [@doctoclevels, "DOC TOC Heading Levels"]].each do |n|
+          n[0] and ins << "<presentation-metadata><name>#{n[1]}</name>" \
                           "<value>#{n[0]}</value></presentation-metadata>"
         end
       end

data/lib/metanorma/standoc/front.rb

@@ -9,12 +9,17 @@ module Metanorma
   module Standoc
     module Front
       def metadata_id(node, xml)
+        id = node.attr("docidentifier") || metadata_id_build(node)
+        xml.docidentifier id
+        xml.docnumber node.attr("docnumber")
+      end
+
+      def metadata_id_build(node)
         part, subpart = node&.attr("partnumber")&.split(/-/)
         id = node.attr("docnumber") || ""
         id += "-#{part}" if part
         id += "-#{subpart}" if subpart
-        xml.docidentifier id
-        xml.docnumber node.attr("docnumber")
+        id
       end
 
       def metadata_other_id(node, xml)
@@ -69,7 +74,7 @@ module Metanorma
 
       def metadata_date1(node, xml, type)
         date = node.attr("#{type}-date")
-        date and xml.date **{ type: type } do |d|
+        date and xml.date type: type do |d|
           d.on date
         end
       end
@@ -87,7 +92,7 @@ module Metanorma
 
           type, date = node.attr(a).split(/ /, 2)
           type or next
-          xml.date **{ type: type } do |d|
+          xml.date type: type do |d|
             d.on date
           end
         end
@@ -134,7 +139,7 @@ module Metanorma
 
       def metadata_getrelation1(doc, xml, type, desc)
         id = doc.split(/,\s*/)
-        xml.relation **{ type: relation_normalise(type) } do |r|
+        xml.relation type: relation_normalise(type) do |r|
           desc.nil? or r.description desc.gsub(/-/, " ")
           fetch_ref(r, doc, nil, **{}) or r.bibitem do |b|
             b.title id[1] || "--"

data/lib/metanorma/standoc/front_contributor.rb

@@ -86,6 +86,7 @@ module Metanorma
           personal_role(node, c, suffix)
           c.person do |p|
             person_name(node, xml, suffix, p)
+            person_credentials(node, xml, suffix, p)
             person_affiliation(node, xml, suffix, p)
             personal_contact(node, suffix, p)
           end
@@ -104,9 +105,17 @@ module Metanorma
         end
       end
 
+      def person_credentials(node, _xml, suffix, person)
+        c = node.attr("contributor-credentials#{suffix}") and
+          person.credentials c
+      end
+
       def person_affiliation(node, _xml, suffix, person)
-        node.attr("affiliation#{suffix}") and person.affiliation do |a|
-          a.organization do |o|
+        aff = node.attr("affiliation#{suffix}")
+        pos = node.attr("contributor-position#{suffix}")
+        (aff || pos) and person.affiliation do |a|
+          pos and a.name { |n| n << pos }
+          aff and a.organization do |o|
             person_organization(node, suffix, o)
           end
         end

data/lib/metanorma/standoc/inline.rb

@@ -1,5 +1,4 @@
 require "asciidoctor/extensions"
-require "htmlentities"
 require "unicode2latex"
 require "mime/types"
 require "base64"
@@ -139,13 +138,6 @@ module Metanorma
         noko { |xml| xml.hr }.join
       end
 
-      def xml_encode(text)
-        @c.encode(text, :basic, :hexadecimal)
-          .gsub(/&amp;gt;/, ">").gsub(/&amp;lt;/, "<").gsub(/&amp;amp;/, "&")
-          .gsub(/&gt;/, ">").gsub(/&lt;/, "<").gsub(/&amp;/, "&")
-          .gsub(/&quot;/, '"').gsub(/&#xa;/, "\n").gsub(/&amp;#/, "&#")
-      end
-
       def latex_parse1(text)
         lxm_input = Unicode2LaTeX.unicode2latex(@c.decode(text))
         results = Latexmath.parse(lxm_input).to_mathml