isodoc 2.3.6 → 2.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa570f1c978671ee699be488fae2f0fe3835db689bfa7c5c0c1183e0a87f1854
-  data.tar.gz: 2ae14cde9d26714858c4240012d29e4483b22044d8112256627a709bc2704aee
+  metadata.gz: ba10d3ff61b6c99d2251fd1d8e868bf09aea5dde1da505bc1745003778f8750d
+  data.tar.gz: b758cac0f031d6a16c95ba8dd05c963bf227438d64d63f1f3146dd745d5c42e9
 SHA512:
-  metadata.gz: 39d02fd071cd42d4e3771e1d6c6ed938024a2fd0842820d775b35cd5494371c31c09232b39c5526a921b81d660f9e2d9d3222e35c347b899d09c2fab8e35fed1
-  data.tar.gz: 3da1407baf7cd7a36e414925755436fbf4547f8f64da8c739c2e53edcda4e7a3d72a40efd5bb9be93bc9f9f28c626f59903b802e58b764f68e571e5172455398
+  metadata.gz: 1ba1187b3202d8b8ef7d8c0376ba6cd100230a0cbe889cfaa729510f174cdbfba884b2ca2b5607525b53391b83a007313e21427539aa8c42d604d295b90feb3b
+  data.tar.gz: 0b15b2d4bee5c08e2a0989eba6909d37827f67943eb8f0e86f9815f202ca7f408955b1905c7d041e32ae1433ddc1fa99e7fdecf4bf49c0174ee194731104135f

data/isodoc.gemspec

@@ -39,10 +39,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency "mathml2asciimath"
   spec.add_dependency "metanorma-utils", "~> 1.4.5"
   spec.add_dependency "mn2pdf"
-  spec.add_dependency "mn-requirements", "~> 0.2.0"
+  spec.add_dependency "mn-requirements", "~> 0.3.1"
   spec.add_dependency "relaton-cli"
   spec.add_dependency "relaton-render", "~> 0.5.2"
   spec.add_dependency "roman-numerals"
+  spec.add_dependency "rouge", "~> 4.0"
   spec.add_dependency "thread_safe"
   spec.add_dependency "twitter_cldr", ">= 6.6.0"
   spec.add_dependency "uuidtools"

data/lib/isodoc/base_style/typography.scss

@@ -24,8 +24,11 @@
     background: $colorHighlightBg;
     box-shadow: 3px 0 0 $colorHighlightBg, -3px 0 0 $colorHighlightBg;
   }
-  ::selection,
-  ::-moz-selection {
+  *::selection {
+    background: $colorHighlightBg;
+    color: $colorHighlightFg;
+  }
+  *::-moz-selection {
     background: $colorHighlightBg;
     color: $colorHighlightFg;
   }

data/lib/isodoc/class_utils.rb

@@ -47,6 +47,11 @@ module IsoDoc
       end
     end
 
+    def to_xml(node)
+      node&.to_xml(encoding: "UTF-8", indent: 0,
+                   save_with: Nokogiri::XML::Node::SaveOptions::AS_XML)
+    end
+
     def case_with_markup(linkend, casing, script, firstonly: true)
       seen = false
       xml = Nokogiri::XML("<root>#{linkend}</root>")
@@ -57,7 +62,7 @@ module IsoDoc
                                       firstonly: firstonly))
         seen = true if firstonly
       end
-      xml.root.children.to_xml
+      to_xml(xml.root.children)
     end
 
     def nearest_block_parent(node)

data/lib/isodoc/convert.rb

@@ -11,7 +11,8 @@ require "mn-requirements"
 
 module IsoDoc
   class Convert < ::IsoDoc::Common
-    attr_accessor :options, :i18n, :meta, :xrefs, :reqt_models, :requirements_processor
+    attr_accessor :options, :i18n, :meta, :xrefs, :reqt_models,
+                  :requirements_processor
 
     # htmlstylesheet: Generic stylesheet for HTML
     # htmlstylesheet_override: Override stylesheet for HTML
@@ -48,6 +49,7 @@ module IsoDoc
     # fonts: fontist fonts to install
     # fontlicenseagreement: fontist font license agreement
     # modspecidentifierbase: base prefix for any Modspec identifiers
+    # sourcehighlighter: whether to apply sourcecode highlighting
     def initialize(options) # rubocop:disable Lint/MissingSuper
       @options = options_preprocess(options)
       init_stylesheets(@options)
@@ -76,10 +78,11 @@ module IsoDoc
       @suppressheadingnumbers = options[:suppressheadingnumbers]
       @break_up_urls_in_tables = options[:breakupurlsintables]
       @sectionsplit = options[:sectionsplit] == "true"
-      @suppressasciimathdup = options[:suppressasciimathdup] == "true"
+      @suppressasciimathdup = options[:suppressasciimathdup]
       @bare = options[:bare]
       @aligncrosselements = options[:aligncrosselements]
       @modspecidentifierbase = options[:modspecidentifierbase]
+      @sourcehighlighter = options[:sourcehighlighter]
     end
 
     def init_i18n(options)
@@ -207,7 +210,7 @@ module IsoDoc
       docxml.root.default_namespace = ""
       convert_i18n_init(docxml)
       metadata_init(@lang, @script, @locale, @i18n)
-      xref_init(@lang, @script, self, @i18n, {locale: @locale})
+      xref_init(@lang, @script, self, @i18n, { locale: @locale })
       [docxml, filename, dir]
     end
 
@@ -235,7 +238,7 @@ module IsoDoc
     end
 
     def middle_clause(_docxml = nil)
-      "//clause[parent::sections][not(@type = 'scope')]"\
+      "//clause[parent::sections][not(@type = 'scope')]" \
         "[not(descendant::terms)]"
     end
 

data/lib/isodoc/function/blocks.rb

@@ -75,7 +75,7 @@ module IsoDoc
       def sourcecode_parse(node, out)
         name = node.at(ns("./name"))
         out.p **sourcecode_attrs(node) do |div|
-          @sourcecode = true
+          @sourcecode = true unless node.at(ns(".//sourcecode"))
           node.children.each { |n| parse(n, div) unless n.name == "name" }
           @sourcecode = false
         end

data/lib/isodoc/function/inline.rb

@@ -17,12 +17,12 @@ module IsoDoc
       def location_parse(node, out); end
 
       def span_parse(node, out)
-        if node["style"]
-          out.span **{ style: node["style"] } do |s|
+        if node["style"] || node["class"]
+          out.span **attr_code(style: node["style"],
+                               class: node["class"]) do |s|
             node.children.each { |n| parse(n, s) }
           end
-        else
-          node.children.each { |n| parse(n, out) }
+        else node.children.each { |n| parse(n, out) }
         end
       end
 

data/lib/isodoc/function/inline_simple.rb

@@ -72,7 +72,8 @@ module IsoDoc
       end
 
       def underline_parse(node, out)
-        out.u do |e|
+        node["style"] and style = "text-decoration: #{node['style']}"
+        out.u **attr_code(style: style) do |e|
           node.children.each { |n| parse(n, e) }
         end
       end

data/lib/isodoc/function/references.rb

@@ -10,60 +10,59 @@ module IsoDoc
         text
       end
 
-      def nonstd_bibitem(list, bib, ordinal, biblio)
+      def nonstd_bibitem(list, bib, _ordinal, biblio) # %%%
         list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
-          ids = bibitem_ref_code(bib)
-          idents = render_identifier(ids)
-          if biblio then ref_entry_code(ref, ordinal, idents, ids)
-          else
-            ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
-            ref << ", #{idents[sdo]}" if idents[:ordinal] && idents[:sdo]
-          end
-          ref << "," if idents[:sdo]
-          ref << " "
+          #           ids = bibitem_ref_code(bib)
+          #           idents = render_identifier(ids)
+          #           if biblio then ref_entry_code(ref, ordinal, idents, ids)
+          #           else
+          #             ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
+          #             ref << ", #{idents[sdo]}" if idents[:ordinal] && idents[:sdo]
+          #           end
+          #           ref << "," if idents[:sdo]
+          tag = bib.at(ns("./biblio-tag"))
+          tag&.children&.each { |n| parse(n, ref) }
           reference_format(bib, ref)
         end
       end
 
-      def std_bibitem_entry(list, bib, ordinal, biblio)
+      def std_bibitem_entry(list, bib, _ordinal, biblio) # %%%
         list.p **attr_code(iso_bibitem_entry_attrs(bib, biblio)) do |ref|
-          idents = render_identifier(bibitem_ref_code(bib))
-          if biblio then ref_entry_code(ref, ordinal, idents, nil)
-          else
-            ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
-            ref << ", #{idents[:sdo]}" if (idents[:ordinal] ||
-                                          idents[:metanorma]) && idents[:sdo]
-          end
-          date_note_process(bib, ref)
-          ref << "," if idents[:sdo]
-          ref << " "
+          #           idents = render_identifier(bibitem_ref_code(bib))
+          #           if biblio then ref_entry_code(ref, ordinal, idents, nil)
+          #           else
+          #             ref << (idents[:ordinal] || idents[:metanorma] || idents[:sdo]).to_s
+          #             ref << ", #{idents[:sdo]}" if (idents[:ordinal] ||
+          #                                           idents[:metanorma]) && idents[:sdo]
+          #           end
+          #           date_note_process(bib, ref)
+          #           ref << "," if idents[:sdo]
+          tag = bib.at(ns("./biblio-tag"))
+          tag&.children&.each { |n| parse(n, ref) }
           reference_format(bib, ref)
         end
       end
 
-      # if ids is just a number, only use that ([1] Non-Standard)
-      # else, use both ordinal, as prefix, and ids
-      def ref_entry_code(ref, ordinal, ids, _id)
-        prefix_bracketed_ref(ref, ids[:ordinal] || ids[:metanorma] ||
-                             "[#{ordinal}]")
-        ids[:sdo] and ref << (ids[:sdo]).to_s
-      end
+      #       # if ids is just a number, only use that ([1] Non-Standard)
+      #       # else, use both ordinal, as prefix, and ids
+      #       def ref_entry_code(ref, ordinal, ids, _id) #%%%
+      #         prefix_bracketed_ref(ref, ids[:ordinal] || ids[:metanorma] ||
+      #                              "[#{ordinal}]")
+      #         ids[:sdo] and ref << (ids[:sdo]).to_s
+      #       end
 
-      def pref_ref_code(bib)
-        return nil if bib["suppress_identifier"] == "true"
+      SKIP_DOCID = "@type = 'DOI' or @type = 'metanorma' or @type = 'ISSN' or " \
+                   "@type = 'metanorma-ordinal' or @type = 'ISBN'".freeze
 
-        ret = bib.xpath(ns("./docidentifier[@primary = 'true'][@language = '#{@lang}']"))
+      def pref_ref_code(bib)
+        bib["suppress_identifier"] == "true" and return nil
+        lang = "[@language = '#{@lang}']"
+        ret = bib.xpath(ns("./docidentifier[@primary = 'true']#{lang}"))
         ret.empty? and
           ret = bib.xpath(ns("./docidentifier[@primary = 'true']"))
         ret.empty? and
-          ret = bib.at(ns(<<~XPATH,
-            ./docidentifier[not(@type = 'DOI' or @type = 'metanorma' or @type = 'metanorma-ordinal' or @type = 'ISSN' or @type = 'ISBN')][@language = '#{@lang}']
-          XPATH
-                         )) ||
-            bib.at(ns(<<~XPATH,
-              ./docidentifier[not(@type = 'DOI' or @type = 'metanorma' or @type = 'metanorma-ordinal' or @type = 'ISSN' or @type = 'ISBN')]
-            XPATH
-                     ))
+          ret = bib.at(ns("./docidentifier[not(#{SKIP_DOCID})]#{lang}")) ||
+            bib.at(ns("./docidentifier[not(#{SKIP_DOCID})]"))
         ret
       end
 
@@ -123,14 +122,6 @@ module IsoDoc
           .include? prefix
       end
 
-      def date_note_process(bib, ref)
-        date_note = bib.at(ns("./note[@type = 'Unpublished-Status']"))
-        return if date_note.nil?
-
-        date_note.children = "<p>#{date_note.content}</p>"
-        footnote_parse(date_note, ref)
-      end
-
       def iso_bibitem_entry_attrs(bib, biblio)
         { id: bib["id"], class: biblio ? "Biblio" : "NormRef" }
       end
@@ -141,11 +132,6 @@ module IsoDoc
         bib["hidden"] == "true"
       end
 
-      def prefix_bracketed_ref(ref, text)
-        ref << text.to_s
-        insert_tab(ref, 1)
-      end
-
       def reference_format(bib, out)
         ftitle = bib.at(ns("./formattedref"))
         ftitle&.children&.each { |n| parse(n, out) }

data/lib/isodoc/function/table.rb

@@ -13,7 +13,7 @@ module IsoDoc
         if thead
           table.thead do |h|
             thead.element_children.each_with_index do |n, i|
-              tr_parse(n, h, i, thead.element_children.size, true)
+              tr_parse(n, h, i, thead.xpath(ns("./tr")).size, true)
             end
           end
         end
@@ -23,7 +23,7 @@ module IsoDoc
         tbody = node.at(ns("./tbody")) || return
         table.tbody do |h|
           tbody.element_children.each_with_index do |n, i|
-            tr_parse(n, h, i, tbody.element_children.size, false)
+            tr_parse(n, h, i, tbody.xpath(ns("./tr")).size, false)
           end
         end
       end
@@ -33,7 +33,7 @@ module IsoDoc
         if tfoot
           table.tfoot do |h|
             tfoot.element_children.each_with_index do |n, i|
-              tr_parse(n, h, i, tfoot.element_children.size, false)
+              tr_parse(n, h, i, tfoot.xpath(ns("./tr")).size, false)
             end
           end
         end
@@ -41,11 +41,13 @@ module IsoDoc
 
       def table_attrs(node)
         width = node["width"] ? "width:#{node['width']};" : nil
+        c = node["class"]
+        bordered = "border-width:1px;border-spacing:0;"
+        (%w(modspec).include?(c) || !c) or bordered = ""
         attr_code(
           id: node["id"],
-          class: node["class"] || "MsoISOTable",
-          style: "border-width:1px;border-spacing:0;"\
-                 "#{width}#{keep_style(node)}",
+          class: c || "MsoISOTable",
+          style: "#{bordered}#{width}#{keep_style(node)}",
           title: node["alt"],
         )
       end
@@ -91,15 +93,12 @@ module IsoDoc
       # border-left:#{col.zero? ? "#{SW} 1.5pt;" : "none;"}
       # border-right:#{SW} #{col == totalcols && !header ? "1.5" : "1.0"}pt;
 
-      def make_tr_attr(cell, row, totalrows, header)
+      def make_tr_attr(cell, row, totalrows, header, bordered)
         style = cell.name == "th" ? "font-weight:bold;" : ""
         cell["align"] and style += "text-align:#{cell['align']};"
         cell["valign"] and style += "vertical-align:#{cell['valign']};"
         rowmax = cell["rowspan"] ? row + cell["rowspan"].to_i - 1 : row
-        style += <<~STYLE
-          border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
-          border-bottom:#{SW} #{rowmax == totalrows ? '1.5' : '1.0'}pt;
-        STYLE
+        style += make_tr_attr_style(row, rowmax, totalrows, header, bordered)
         header and scope = (cell["colspan"] ? "colgroup" : "col")
         !header && cell.name == "th" and
           scope = (cell["rowspan"] ? "rowgroup" : "row")
@@ -107,10 +106,20 @@ module IsoDoc
           style: style.gsub(/\n/, ""), scope: scope }
       end
 
+      def make_tr_attr_style(row, rowmax, totalrows, _header, bordered)
+        bordered or return ""
+        <<~STYLE.gsub(/\n/, "")
+          border-top:#{row.zero? ? "#{SW} 1.5pt;" : 'none;'}
+          border-bottom:#{SW} #{rowmax >= totalrows ? '1.5' : '1.0'}pt;
+        STYLE
+      end
+
       def tr_parse(node, out, ord, totalrows, header)
+        c = node.parent.parent["class"]
+        bordered = %w(modspec).include?(c) || !c
         out.tr do |r|
           node.elements.each do |td|
-            attrs = make_tr_attr(td, ord, totalrows - 1, header)
+            attrs = make_tr_attr(td, ord, totalrows - 1, header, bordered)
             r.send td.name, **attr_code(attrs) do |entry|
               td.children.each { |n| parse(n, entry) }
             end

data/lib/isodoc/function/to_word_html.rb

@@ -101,6 +101,7 @@ module IsoDoc
       end
 
       def info(isoxml, out)
+        @meta.code_css isoxml, out
         @meta.title isoxml, out
         @meta.subtitle isoxml, out
         @meta.docstatus isoxml, out

data/lib/isodoc/function/utils.rb

@@ -3,6 +3,10 @@ require "metanorma-utils"
 module IsoDoc
   module Function
     module Utils
+      def to_xml(node)
+        self.class.to_xml(node)
+      end
+
       def date_range(date)
         self.class.date_range(date)
       end

data/lib/isodoc/html_function/html.rb

@@ -78,7 +78,7 @@ module IsoDoc
       def html_button
         return "" if @bare
 
-        '<button onclick="topFunction()" id="myBtn" '\
+        '<button onclick="topFunction()" id="myBtn" ' \
         'title="Go to top">Top</button>'.freeze
       end
 
@@ -89,31 +89,10 @@ module IsoDoc
         d.children.empty? or d.children.first.previous = html_button
       end
 
-      def sourcecodelang(lang)
-        return unless lang
-
-        case lang.downcase
-        when "javascript" then "lang-js"
-        when "c" then "lang-c"
-        when "c+" then "lang-cpp"
-        when "console" then "lang-bsh"
-        when "ruby" then "lang-rb"
-        when "html" then "lang-html"
-        when "java" then "lang-java"
-        when "xml" then "lang-xml"
-        when "perl" then "lang-perl"
-        when "python" then "lang-py"
-        when "xsl" then "lang-xsl"
-        else
-          ""
-        end
-      end
-
       def sourcecode_parse(node, out)
         name = node.at(ns("./name"))
-        class1 = "prettyprint #{sourcecodelang(node&.at(ns('./@lang'))&.value)}"
-        out.pre **sourcecode_attrs(node).merge(class: class1) do |div|
-          @sourcecode = true
+        out.pre **sourcecode_attrs(node).merge(class: "sourcecode") do |div|
+          @sourcecode = true unless node.at(ns(".//sourcecode"))
           node.children.each { |n| parse(n, div) unless n.name == "name" }
           @sourcecode = false
         end
@@ -121,7 +100,9 @@ module IsoDoc
       end
 
       def underline_parse(node, out)
-        out.span **{ style: "text-decoration: underline;" } do |e|
+        style = node["style"] ? " #{node['style']}" : ""
+        attr = { style: "text-decoration: underline#{style}" }
+        out.span **attr do |e|
           node.children.each { |n| parse(n, e) }
         end
       end

data/lib/isodoc/html_function/postprocess_cover.rb

@@ -31,6 +31,9 @@ module IsoDoc
         head = docxml.at("//*[local-name() = 'head']")
         head << htmlstylesheet(@htmlstylesheet)
         s = htmlstylesheet(@htmlstylesheet_override) and head << s
+        s = @meta.get[:code_css] and
+          head << "<style><!--#{s.gsub(/sourcecode/,
+                                       'pre.sourcecode')}--></style>"
         @bare and
           head << "<style>body {margin-left: 2em; margin-right: 2em;}</style>"
         docxml
@@ -40,7 +43,6 @@ module IsoDoc
         html_cover(docxml) if @htmlcoverpage && !@bare
         html_intro(docxml) if @htmlintropage && !@bare
         docxml.at("//body") << mathjax(@openmathdelim, @closemathdelim)
-        docxml.at("//body") << sourcecode_highlighter
         html_main(docxml)
         authority_cleanup(docxml)
         docxml
@@ -48,7 +50,7 @@ module IsoDoc
 
       def authority_cleanup1(docxml, klass)
         dest = docxml.at("//div[@id = 'boilerplate-#{klass}-destination']")
-        auth = docxml.at("//div[@id = 'boilerplate-#{klass}' or "\
+        auth = docxml.at("//div[@id = 'boilerplate-#{klass}' or " \
                          "@class = 'boilerplate-#{klass}']")
         auth&.xpath(".//h1[not(text())] | .//h2[not(text())]")&.each(&:remove)
         auth&.xpath(".//h1 | .//h2")&.each { |h| h["class"] = "IntroTitle" }
@@ -92,7 +94,7 @@ module IsoDoc
       end
 
       def html_toc_entry(level, header)
-        content = header.at("./following-sibling::p"\
+        content = header.at("./following-sibling::p" \
                             "[@class = 'variant-title-toc']") || header
         %(<li class="#{level}"><a href="##{header['id']}">\
       #{header_strip(content)}</a></li>)
@@ -127,7 +129,7 @@ module IsoDoc
       end
 
       def toc_exclude_class
-        "[not(@class = 'TermNum')][not(@class = 'noTOC')]"\
+        "[not(@class = 'TermNum')][not(@class = 'noTOC')]" \
           "[string-length(normalize-space(.))>0]"
       end
 
@@ -142,11 +144,6 @@ module IsoDoc
         "#{a[0]}#{scripts}#{scripts_override}</body>#{a[1]}"
       end
 
-      def sourcecode_highlighter
-        '<script src="https://cdn.rawgit.com/google/code-prettify/master/'\
-          'loader/run_prettify.js"></script>'
-      end
-
       MATHJAX_ADDR =
         "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/latest.js".freeze
       MATHJAX = <<~"MATHJAX".freeze

data/lib/isodoc/metadata.rb

@@ -168,5 +168,10 @@ module IsoDoc
       end
       set(:title_footnote, ret)
     end
+
+    def code_css(isoxml, _out)
+      c = isoxml.at(ns("//misc-container/source-highlighter-css")) or return
+      set(:code_css, c.text)
+    end
   end
 end

data/lib/isodoc/presentation_function/bibdata.rb

@@ -10,7 +10,7 @@ module IsoDoc
       address_precompose(a)
       bibdata_i18n(a)
       a.next =
-        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join}"\
+        "<localized-strings>#{i8n_name(trim_hash(@i18n.get), '').join}" \
         "</localized-strings>"
     end
 
@@ -24,7 +24,7 @@ module IsoDoc
       @toctables and
         ins << "<toc type='table'><title>#{@i18n.toc_tables}</title></toc>"
       @tocfigures and
-        ins << "<toc type='recommendation'><title>#{@i18n.toc_recommendations}"\
+        ins << "<toc type='recommendation'><title>#{@i18n.toc_recommendations}" \
                "</title></toc>"
     end
 
@@ -50,17 +50,17 @@ module IsoDoc
     end
 
     def presmeta(name, value)
-      "<presentation-metadata><name>#{name}</name><value>#{value}</value>"\
+      "<presentation-metadata><name>#{name}</name><value>#{value}</value>" \
         "</presentation-metadata>"
     end
 
     def address_precompose1(addr)
       ret = []
-      addr.xpath(ns("./street")).each { |s| ret << s.children.to_xml }
-      a = addr.at(ns("./city")) and ret << a.children.to_xml
-      addr.xpath(ns("./state")).each { |s| ret << s.children.to_xml }
-      a = addr.at(ns("./country")) and ret << a.children.to_xml
-      a = addr.at(ns("./postcode")) and ret[-1] += " #{a.children.to_xml}"
+      addr.xpath(ns("./street")).each { |s| ret << to_xml(s.children) }
+      a = addr.at(ns("./city")) and ret << to_xml(a.children)
+      addr.xpath(ns("./state")).each { |s| ret << to_xml(s.children) }
+      a = addr.at(ns("./country")) and ret << to_xml(a.children)
+      a = addr.at(ns("./postcode")) and ret[-1] += " #{to_xml a.children}"
       ret.join("<br/>")
     end
 
@@ -118,7 +118,7 @@ module IsoDoc
     end
 
     def i18n_tag(key, value)
-      "<localized-string key='#{key}' language='#{@lang}'>#{value}"\
+      "<localized-string key='#{key}' language='#{@lang}'>#{value}" \
         "</localized-string>"
     end