isodoc 2.4.0 → 2.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a7c100c4751a8d8bfe69eeaf31614c74bfeec4c56d188fd0d4a6a16c09d3257
-  data.tar.gz: '0858086207425a9c38bb6f12fba1a219599c4c7e469aea40e4f29255f152333b'
+  metadata.gz: 5f122ad0105340afb41607b8639eb00b7205328f9bddad0a5a3726e9644c912e
+  data.tar.gz: 04b386a592680a3315ed3d55e7c6716bc177fd628a8d67f520e224b1a4d4de5f
 SHA512:
-  metadata.gz: bc74e409e73b0b63f5a609e44b0a90a88cf4e83253604cbf6634f62b9c6ff12cccdc40fa2399acd4c373c44d3748ff311828890f319fc508c35e4993c88ff800
-  data.tar.gz: b6f7d0abe389ee3c0342fbdd862f0671bc94959eb9f7b3755e51c7aac1aad74e65127b8819f5b3f310a8e2c2ede29dd663642f9a16e12b5fdf563dd9e2e9bb4f
+  metadata.gz: 6fef982e2095471e35cc7235a3bc5712066845fd4302131e9760e8d10da548ec73b40f344816077b915b63d93d32cb5b459507ad2133ac52da257a6230e99353
+  data.tar.gz: cbbaa050b52517cf272d7d0da4d875075e094b3dcda074a89c55945ceedb6c357914f9e9be0cd09e45ac9d6ace9f61f71b8f9d2ccb5c8d3ebb5ba4fd9251e632

data/isodoc.gemspec

@@ -43,6 +43,7 @@ Gem::Specification.new do |spec|
   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/all.css

@@ -124,6 +124,35 @@ a.FootnoteRef + a.FootnoteRef:before {
   color: red;
   text-decoration: line-through; }
 
+/* code highlighting with line numbers */
+table.rouge-line-table td.rouge-gutter {
+  -moz-user-select: none;
+  -ms-user-select: none;
+  -webkit-user-select: none;
+  user-select: none;
+  padding-right: 1em; }
+
+table.rouge-line-table td.rouge-code {
+  -moz-user-select: all;
+  -ms-user-select: all;
+  -webkit-user-select: all;
+  user-select: all; }
+
+table.rouge-line-table,
+table.rouge-line-table th,
+table.rouge-line-table td {
+  width: auto;
+  border: none;
+  margin: 0;
+  padding: 0;
+  font-size: 100%; }
+
+table.rouge-line-table pre {
+  margin: 0;
+  padding: 0;
+  overflow-x: visible;
+  font-size: 100%; }
+
 #standard-band {
   background-color: #0AC442; }
 

data/lib/isodoc/base_style/metanorma_word.css

@@ -45,3 +45,12 @@ span.addition {
 span.deletion {
   color: red;
   text-decoration: line-through; }
+
+table.rouge-line-table {
+  border: none;
+  mso-border-alt: none;
+  mso-border-insideh: none;
+  mso-border-insidev: none; }
+
+td.rouge-code p.Sourcecode {
+  margin: 0px; }

data/lib/isodoc/base_style/metanorma_word.scss

@@ -42,3 +42,14 @@ span.deletion {
         color: red;
         text-decoration: line-through;
 }
+
+table.rouge-line-table {
+  border:none;
+  mso-border-alt:none;
+  mso-border-insideh:none;
+  mso-border-insidev:none;
+}
+
+td.rouge-code p.Sourcecode {
+  margin: 0px;
+}

data/lib/isodoc/base_style/reset.css

@@ -123,3 +123,32 @@ a.FootnoteRef + a.FootnoteRef:before {
 .deletion {
   color: red;
   text-decoration: line-through; }
+
+/* code highlighting with line numbers */
+table.rouge-line-table td.rouge-gutter {
+  -moz-user-select: none;
+  -ms-user-select: none;
+  -webkit-user-select: none;
+  user-select: none;
+  padding-right: 1em; }
+
+table.rouge-line-table td.rouge-code {
+  -moz-user-select: all;
+  -ms-user-select: all;
+  -webkit-user-select: all;
+  user-select: all; }
+
+table.rouge-line-table,
+table.rouge-line-table th,
+table.rouge-line-table td {
+  width: auto;
+  border: none;
+  margin: 0;
+  padding: 0;
+  font-size: 100%; }
+
+table.rouge-line-table pre {
+  margin: 0;
+  padding: 0;
+  overflow-x: visible;
+  font-size: 100%; }

data/lib/isodoc/base_style/reset.scss

@@ -152,3 +152,37 @@ a.FootnoteRef + a.FootnoteRef:before {
   color: red;
   text-decoration: line-through;
 }
+
+/* code highlighting with line numbers */
+
+table.rouge-line-table td.rouge-gutter {
+  -moz-user-select: none;
+  -ms-user-select: none;
+  -webkit-user-select: none;
+  user-select: none;
+  padding-right: 1em;
+}
+
+table.rouge-line-table td.rouge-code {
+  -moz-user-select: all;
+  -ms-user-select: all;
+  -webkit-user-select: all;
+  user-select: all;
+}
+
+table.rouge-line-table,
+table.rouge-line-table th,
+table.rouge-line-table td {
+  width: auto;
+  border: none;
+  margin: 0;
+  padding: 0;
+  font-size: 100%;
+}
+
+table.rouge-line-table pre {
+  margin: 0;
+  padding: 0;
+  overflow-x: visible;
+  font-size: 100%;
+}

data/lib/isodoc/base_style/rouge.css

@@ -0,0 +1,39 @@
+sourcecode table td { padding: 5px; }
+sourcecode table pre { margin: 0; }
+sourcecode, sourcecode .w {
+  color: #444444;
+}
+sourcecode .cp {
+  color: #CC00A3;
+}
+sourcecode .cs {
+  color: #CC00A3;
+}
+sourcecode .c, sourcecode .ch, sourcecode .cd, sourcecode .cm, sourcecode .cpf, sourcecode .c1 {
+  color: #FF0000;
+}
+sourcecode .kc {
+  color: #C34E00;
+}
+sourcecode .kd {
+  color: #0000FF;
+}
+sourcecode .kr {
+  color: #007575;
+}
+sourcecode .k, sourcecode .kn, sourcecode .kp, sourcecode .kt, sourcecode .kv {
+  color: #0000FF;
+}
+sourcecode .s, sourcecode .sb, sourcecode .sc, sourcecode .ld, sourcecode .sd, sourcecode .s2, sourcecode .se, sourcecode .sh, sourcecode .si, sourcecode .sx, sourcecode .sr, sourcecode .s1, sourcecode .ss {
+  color: #009C00;
+}
+sourcecode .sa {
+  color: #0000FF;
+}
+sourcecode .nb, sourcecode .bp {
+  color: #C34E00;
+}
+sourcecode .nt {
+  color: #0000FF;
+}
+

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;
   }
@@ -62,6 +65,6 @@
     padding: 1em;
   }
   td.header {
-    font-weigth: 400;
+    font-weight: 400;
   }
 }

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

@@ -6,19 +6,19 @@ module IsoDoc
       @annotation = false
 
       def middle_title(_isoxml, out)
-        out.p(**{ class: "zzSTDTitle1" }) { |p| p << @meta.get[:doctitle] }
+        out.p(class: "zzSTDTitle1") { |p| p << @meta.get[:doctitle] }
       end
 
       def figure_name_parse(_node, div, name)
         return if name.nil?
 
-        div.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
+        div.p class: "FigureTitle", style: "text-align:center;" do |p|
           name.children.each { |n| parse(n, p) }
         end
       end
 
       def figure_key(out)
-        out.p **{ style: "page-break-after:avoid;" } do |p|
+        out.p style: "page-break-after:avoid;" do |p|
           p.b { |b| b << @i18n.key }
         end
       end
@@ -63,7 +63,7 @@ module IsoDoc
       def sourcecode_name_parse(_node, div, name)
         return if name.nil?
 
-        div.p **{ class: "SourceTitle", style: "text-align:center;" } do |p|
+        div.p class: "SourceTitle", style: "text-align:center;" do |p|
           name.children.each { |n| parse(n, p) }
         end
       end
@@ -75,13 +75,19 @@ module IsoDoc
       def sourcecode_parse(node, out)
         name = node.at(ns("./name"))
         out.p **sourcecode_attrs(node) do |div|
-          @sourcecode = true
-          node.children.each { |n| parse(n, div) unless n.name == "name" }
-          @sourcecode = false
+          sourcecode_parse1(node, div)
         end
         sourcecode_name_parse(node, out, name)
       end
 
+      def sourcecode_parse1(node, div)
+        @sourcecode = "pre"
+        node.at(ns(".//table")) || !node.ancestors("table").empty? and
+          @sourcecode = "table"
+        node.children.each { |n| parse(n, div) unless n.name == "name" }
+        @sourcecode = false
+      end
+
       def pre_parse(node, out)
         out.pre node.text, **attr_code(id: node["id"])
       end
@@ -89,18 +95,22 @@ module IsoDoc
       def annotation_parse(node, out)
         @sourcecode = false
         @annotation = true
-        node.at("./preceding-sibling::*[local-name() = 'annotation']") or
-          out << "<br/>"
-        callout = node.at(ns("//callout[@target='#{node['id']}']"))
-        out << "<br/>&lt;#{callout.text}&gt; "
-        out << node&.children&.text&.strip
-        @annotation = false
+        out.div class: "annotation" do |div|
+          #node.at("./preceding-sibling::*[local-name() = 'annotation']") or
+          #  div << "<br/>"
+          callout = node.at(ns("//callout[@target='#{node['id']}']"))
+          div << "<span class='c'>&lt;#{callout.text}&gt;</span> "
+          div << "<span class='c'>#{node.children&.text&.strip}</span>"
+          node.at("./following-sibling::*[local-name() = 'annotation']") and
+            div << "<br/>"
+          @annotation = false
+        end
       end
 
       def formula_where(dlist, out)
         return unless dlist
 
-        out.p **{ style: "page-break-after:avoid;" } do |p|
+        out.p style: "page-break-after:avoid;" do |p|
           p << @i18n.where
         end
         parse(dlist, out)
@@ -168,7 +178,7 @@ module IsoDoc
         source = node.at(ns("./source"))
         return if author.nil? && source.nil?
 
-        out.p **{ class: "QuoteAttribution" } do |p|
+        out.p class: "QuoteAttribution" do |p|
           p << "&#x2014; #{author.text}" if author
           p << ", " if author && source
           eref_parse(source, p) if source
@@ -198,7 +208,7 @@ module IsoDoc
       end
 
       def toc_parse(node, out)
-        out.div **{ class: "toc" } do |div|
+        out.div class: "toc" do |div|
           node.children.each { |n| parse(n, div) }
         end
       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
 
@@ -42,7 +42,7 @@ module IsoDoc
                  else
                    "##{node['target']}"
                  end
-        out.a(**{ href: target }) { |l| no_locality_parse(node, l) }
+        out.a(href: target) { |l| no_locality_parse(node, l) }
       end
 
       def suffix_url(url)
@@ -77,10 +77,10 @@ module IsoDoc
         if href = eref_target(node)
           if node["type"] == "footnote"
             out.sup do |s|
-              s.a(**{ href: href }) { |l| no_locality_parse(node, l) }
+              s.a(href: href) { |l| no_locality_parse(node, l) }
             end
           else
-            out.a(**{ href: href }) { |l| no_locality_parse(node, l) }
+            out.a(href: href) { |l| no_locality_parse(node, l) }
           end
         else no_locality_parse(node, out)
         end
@@ -109,7 +109,7 @@ module IsoDoc
                when "LaTeX" then latexmath_parse(node)
                else HTMLEntities.new.encode(node.text)
                end
-        out.span **{ class: "stem" } do |span|
+        out.span class: "stem" do |span|
           span.parent.add_child ooml
         end
       end
@@ -123,7 +123,7 @@ module IsoDoc
       def asciimath_parse(node)
         a = node.at(ns("./asciimath"))&.text || node.text
 
-        "#{@openmathdelim}#{HTMLEntities.new.encode(a)}"\
+        "#{@openmathdelim}#{HTMLEntities.new.encode(a)}" \
           "#{@closemathdelim}"
       end
 
@@ -134,7 +134,7 @@ module IsoDoc
 
       def image_title_parse(out, caption)
         unless caption.nil?
-          out.p **{ class: "FigureTitle", style: "text-align:center;" } do |p|
+          out.p class: "FigureTitle", style: "text-align:center;" do |p|
             p.b { |b| b << caption.to_s }
           end
         end
@@ -151,7 +151,7 @@ module IsoDoc
       end
 
       def smallcap_parse(node, xml)
-        xml.span **{ style: "font-variant:small-caps;" } do |s|
+        xml.span style: "font-variant:small-caps;" do |s|
           node.children.each { |n| parse(n, s) }
         end
       end
@@ -160,21 +160,21 @@ module IsoDoc
         return if node.nil? || node.text.nil?
 
         text = node.to_s
-        if in_sourcecode
+        @sourcecode == "pre" and
           text = text.gsub("\n", "<br/>").gsub("<br/> ", "<br/>&#xa0;")
-            .gsub(/ (?= )/, "&#xa0;")
-        end
+        @sourcecode and
+          text = text.gsub(/ (?= )/, "&#xa0;")
         out << text
       end
 
       def add_parse(node, out)
-        out.span **{ class: "addition" } do |e|
+        out.span class: "addition" do |e|
           node.children.each { |n| parse(n, e) }
         end
       end
 
       def del_parse(node, out)
-        out.span **{ class: "deletion" } do |e|
+        out.span class: "deletion" do |e|
           node.children.each { |n| parse(n, e) }
         end
       end
@@ -182,7 +182,7 @@ module IsoDoc
       def error_parse(node, out)
         text = node.to_xml.gsub(/</, "&lt;").gsub(/>/, "&gt;")
         out.para do |p|
-          p.b(**{ role: "strong" }) { |e| e << text }
+          p.b(role: "strong") { |e| e << text }
         end
       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) }