metanorma-standoc 2.8.8 → 2.8.10

data/lib/metanorma/standoc/biblio.rng

@@ -122,6 +122,23 @@
       </oneOrMore>
     </choice>
   </define>
+  <define name="LocalizedMarkedUpString1">
+    <!-- multiple languages and scripts possible: comma delimit them if so -->
+    <ref name="LocalizedStringAttrs"/>
+    <oneOrMore>
+      <ref name="TextElement"/>
+    </oneOrMore>
+  </define>
+  <define name="LocalizedMarkedUpString">
+    <choice>
+      <ref name="LocalizedMarkedUpString1"/>
+      <oneOrMore>
+        <element name="variant">
+          <ref name="LocalizedMarkedUpString1"/>
+        </element>
+      </oneOrMore>
+    </choice>
+  </define>
   <!--
     Unlike UML, change type to format: type is overloaded
     Would be need if plain were default value and could omit the attribute
@@ -204,10 +221,7 @@
   </define>
   <define name="roledescription">
     <element name="description">
-      <ref name="LocalizedStringAttrs"/>
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
   <define name="person">
@@ -332,10 +346,7 @@
   </define>
   <define name="affiliationdescription">
     <element name="description">
-      <ref name="LocalizedStringAttrs"/>
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
   <define name="organization">
@@ -384,7 +395,7 @@
   </define>
   <define name="logo">
     <element name="logo">
-      <ref name="image"/>
+      <ref name="image-no-id"/>
     </element>
   </define>
   <define name="depiction">
@@ -393,7 +404,7 @@
         <attribute name="scope"/>
       </optional>
       <zeroOrMore>
-        <ref name="image"/>
+        <ref name="image-no-id"/>
       </zeroOrMore>
     </element>
   </define>
@@ -946,10 +957,7 @@
     <optional>
       <attribute name="type"/>
     </optional>
-    <ref name="LocalizedStringAttrs"/>
-    <zeroOrMore>
-      <ref name="TextElement"/>
-    </zeroOrMore>
+    <ref name="LocalizedMarkedUpString"/>
   </define>
   <!-- TitleType = ( "alternative" | "original" | "unofficial" | "subtitle" | "main" ) -->
   <define name="TypedUri">
@@ -1040,10 +1048,7 @@
           <data type="boolean"/>
         </attribute>
       </optional>
-      <ref name="LocalizedStringAttrs"/>
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
   <define name="docnumber">
@@ -1268,10 +1273,7 @@
       <optional>
         <attribute name="type"/>
       </optional>
-      <ref name="LocalizedStringAttrs"/>
-      <oneOrMore>
-        <ref name="TextElement"/>
-      </oneOrMore>
+      <ref name="LocalizedMarkedUpString"/>
     </element>
   </define>
   <define name="bibabstract">
@@ -1279,7 +1281,7 @@
       <ref name="LocalizedStringAttrs"/>
       <choice>
         <oneOrMore>
-          <ref name="BasicBlock"/>
+          <ref name="BasicBlockNoId"/>
         </oneOrMore>
         <oneOrMore>
           <ref name="TextElement"/>
@@ -1389,10 +1391,7 @@
       </attribute>
       <optional>
         <element name="description">
-          <ref name="LocalizedStringAttrs"/>
-          <oneOrMore>
-            <ref name="TextElement"/>
-          </oneOrMore>
+          <ref name="LocalizedMarkedUpString"/>
         </element>
       </optional>
       <element name="bibitem">

data/lib/metanorma/standoc/cleanup.rb

@@ -19,6 +19,7 @@ require_relative "cleanup_image"
 require_relative "cleanup_reqt"
 require_relative "cleanup_text"
 require_relative "cleanup_toc"
+require_relative "cleanup_dochistory"
 require "relaton_iev"
 
 module Metanorma

data/lib/metanorma/standoc/cleanup_bibdata.rb

@@ -149,90 +149,6 @@ module Metanorma
           ins.next = c
         end
       end
-
-      def bib_relation_insert_pt(xmldoc)
-        ins = nil
-        %w(relation copyright status abstract script language note version
-           edition contributor).each do |x|
-          ins = xmldoc.at("//bibdata/#{x}[last()]") and break
-        end
-        ins
-      end
-
-      def ext_dochistory_cleanup(xmldoc)
-        t = xmldoc.xpath("//metanorma-extension/clause/title").detect do |x|
-          x.text.strip.casecmp("document history").zero?
-        end or return
-        a = t.at("../sourcecode") or return
-        ins = bib_relation_insert_pt(xmldoc) or return
-        docid = xmldoc.at("//bibdata/docidentifier")
-        yaml = YAML.safe_load(a.text, permitted_classes: [Date])
-        ext_dochistory_process(yaml, ins, docid)
-      end
-
-      def ext_dochistory_process(yaml, ins, docid)
-        yaml.is_a?(Hash) and yaml = [yaml]
-        yaml.reverse.each do |y|
-          type = y["relation.type"] || "updatedBy"
-          docid and
-            y["docid"] ||= [{ "type" => docid["type"], "id" => docid.text }]
-          r = yaml2relaton(y, amend_hash2mn(y["amend"]))
-          ins.next = "<relation type='#{type}'>#{r}</relation>"
-        end
-      end
-
-      def amend_hash2mn(yaml)
-        yaml.nil? and return ""
-        yaml.is_a?(Hash) and yaml = [yaml]
-        yaml.map { |x| amend_hash2mn1(x) }.join("\n")
-      end
-
-      def amend_attrs(yaml)
-        ret = ""
-        yaml["change"] ||= "modify"
-        %w(change path path_end title).each do |x|
-          a = yaml[x] and ret += " #{x}='#{a}'"
-        end
-        ret = "<amend#{ret}>"
-      end
-
-      def amend_hash2mn1(yaml)
-        ret = amend_attrs(yaml)
-        ret += amend_description(yaml)
-        ret += amend_location(yaml)
-        ret += amend_classification(yaml)
-        "#{ret}</amend>"
-      end
-
-      def amend_location(yaml)
-        a = yaml["location"] or return ""
-        a.is_a?(Array) or a = [a]
-        ret = a.map do |x|
-          elem = Nokogiri::XML("<location>#{x}</location>").root
-          extract_localities(elem)
-          elem.children.to_xml
-        end.join("\n")
-        "<location>#{ret}</location>"
-      end
-
-      def amend_description(yaml)
-        a = yaml["description"] or return ""
-        out = adoc2xml(a, backend.to_sym)
-        "<description>#{out.children.to_xml}</description>"
-      end
-
-      def amend_classification(yaml)
-        a = yaml["classification"] or return ""
-        a.is_a?(Array) or a = [a]
-        a.map { |x| amend_classification1(x) }.join("\n")
-      end
-
-      def amend_classification1(yaml)
-        yaml.is_a?(Hash) or yaml = { "tag" => "default", "value" => yaml }
-        <<~OUT
-          <classification><tag>#{yaml['tag']}</tag><value>#{yaml['value']}</value></classification>
-        OUT
-      end
     end
   end
 end

data/lib/metanorma/standoc/cleanup_bibitem.rb

@@ -133,11 +133,58 @@ module Metanorma
         end
       end
 
+      def attachment_cleanup(xmldoc)
+        xmldoc.xpath("//bibitem[uri/@type = 'attachment']").each do |b|
+          b["hidden"] = "true"
+          u = b.at("./uri[@type = 'attachment']")
+          c = b.at("./uri[@type = 'citation']") ||
+            u.after("<uri type='citation'/>")
+          uri = save_attachment(u.text, b)
+          u.children = uri
+          c.children = uri
+        end
+      end
+
+      def save_attachment(path, bib)
+        init_attachments
+        valid_attachment?(path, bib) or return ""
+        f = File.basename(path)
+        File.exist?(File.join(@attachmentsdir, f)) and
+          f += "_#{UUIDTools::UUID.random_create}"
+        ret = File.join(@attachmentsdir, f)
+        FileUtils.cp(path, ret)
+        datauri_attachment(ret, bib.document)
+        ret
+      end
+
+      def datauri_attachment(path, doc)
+        @datauriattachment or return
+        n = add_misc_container(doc)
+        f = File.basename(path)
+        d = Vectory::Utils.datauri(path)
+        n << "<attachment name='#{f}'>#{d}</attachment>"
+      end
+
+      def valid_attachment?(path, bib)
+        File.exist?(path) and return true
+        @log.add("Bibliography", bib, "Attachment #{path} does not exist",
+                 severity: 0)
+        false
+      end
+
+      def init_attachments
+        @attachmentsdir and return
+        @attachmentsdir = File.join(@output_dir, "_#{@filename}_attachments")
+        FileUtils.rm_rf(@attachmentsdir)
+        FileUtils.mkdir_p(@attachmentsdir)
+      end
+
       def bibitem_cleanup(xmldoc)
         bibitem_nested_id(xmldoc)
         ref_dl_cleanup(xmldoc)
         formattedref_spans(xmldoc)
         fetch_local_bibitem(xmldoc)
+        attachment_cleanup(xmldoc)
       end
     end
   end

data/lib/metanorma/standoc/cleanup_dochistory.rb

@@ -0,0 +1,89 @@
+module Metanorma
+  module Standoc
+    module Cleanup
+      def bib_relation_insert_pt(xmldoc)
+        ins = nil
+        %w(relation copyright status abstract script language note version
+           edition contributor).each do |x|
+          ins = xmldoc.at("//bibdata/#{x}[last()]") and break
+        end
+        ins
+      end
+
+      def ext_dochistory_cleanup(xmldoc)
+        t = xmldoc.xpath("//metanorma-extension/clause/title").detect do |x|
+          x.text.strip.casecmp("document history").zero?
+        end or return
+        a = t.at("../sourcecode") or return
+        ins = bib_relation_insert_pt(xmldoc) or return
+        docid = xmldoc.at("//bibdata/docidentifier")
+        yaml = YAML.safe_load(a.text, permitted_classes: [Date])
+        ext_dochistory_process(yaml, ins, docid)
+      end
+
+      def ext_dochistory_process(yaml, ins, docid)
+        yaml.is_a?(Hash) and yaml = [yaml]
+        yaml.reverse.each do |y|
+          type = y["relation.type"] || "updatedBy"
+          docid and
+            y["docid"] ||= [{ "type" => docid["type"], "id" => docid.text }]
+          r = yaml2relaton(y, amend_hash2mn(y["amend"]))
+          ins.next = "<relation type='#{type}'>#{r}</relation>"
+        end
+      end
+
+      def amend_hash2mn(yaml)
+        yaml.nil? and return ""
+        yaml.is_a?(Hash) and yaml = [yaml]
+        yaml.map { |x| amend_hash2mn1(x) }.join("\n")
+      end
+
+      def amend_attrs(yaml)
+        ret = ""
+        yaml["change"] ||= "modify"
+        %w(change path path_end title).each do |x|
+          a = yaml[x] and ret += " #{x}='#{a}'"
+        end
+        ret = "<amend#{ret}>"
+      end
+
+      def amend_hash2mn1(yaml)
+        ret = amend_attrs(yaml)
+        ret += amend_description(yaml)
+        ret += amend_location(yaml)
+        ret += amend_classification(yaml)
+        "#{ret}</amend>"
+      end
+
+      def amend_location(yaml)
+        a = yaml["location"] or return ""
+        a.is_a?(Array) or a = [a]
+        ret = a.map do |x|
+          elem = Nokogiri::XML("<location>#{x}</location>").root
+          extract_localities(elem)
+          elem.children.to_xml
+        end.join("\n")
+        "<location>#{ret}</location>"
+      end
+
+      def amend_description(yaml)
+        a = yaml["description"] or return ""
+        out = adoc2xml(a, backend.to_sym)
+        "<description>#{out.children.to_xml}</description>"
+      end
+
+      def amend_classification(yaml)
+        a = yaml["classification"] or return ""
+        a.is_a?(Array) or a = [a]
+        a.map { |x| amend_classification1(x) }.join("\n")
+      end
+
+      def amend_classification1(yaml)
+        yaml.is_a?(Hash) or yaml = { "tag" => "default", "value" => yaml }
+        <<~OUT
+          <classification><tag>#{yaml['tag']}</tag><value>#{yaml['value']}</value></classification>
+        OUT
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/cleanup_image.rb

@@ -10,17 +10,12 @@ module Metanorma
         Vectory::SvgMapping.new(xmldoc, @localdir).call
       end
 
-      def guid?(str)
-        /^_[0-9A-F]{8}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{4}-[0-9A-F]{12}$/i
-          .match(str)
-      end
-
       def svgmap_moveattrs(xmldoc)
         xmldoc.xpath("//svgmap").each do |s|
           f = s.at(".//figure") or next
           (t = s.at("./name")) && !f.at("./name") and
             f.children.first.previous = t.remove
-          if s["id"] && guid?(f["id"])
+          if s["id"] && Metanorma::Utils::guid_anchor?(f["id"])
             f["id"] = s["id"]
             s.delete("id")
           end

data/lib/metanorma/standoc/cleanup_inline.rb

@@ -165,11 +165,6 @@ module Metanorma
         end
       end
 
-      def guid?(str)
-        /^_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
-          .match?(str)
-      end
-
       def contenthash_id_cleanup(doc)
         ids = contenthash_id_make(doc)
         contenthash_id_update_refs(doc, ids)
@@ -177,7 +172,7 @@ module Metanorma
 
       def contenthash_id_make(doc)
         doc.xpath("//*[@id]").each_with_object({}) do |x, m|
-          next unless guid?(x["id"])
+          next unless Metanorma::Utils::guid_anchor?(x["id"])
 
           m[x["id"]] = contenthash(x)
           x["id"] = m[x["id"]]

data/lib/metanorma/standoc/cleanup_maths.rb

@@ -101,8 +101,7 @@ module Metanorma
       end
 
       def mi_italicise?(char)
-        return false if char.length > 1
-
+        char.length > 1 and return false
         case char
         when /\p{Greek}/
           (/\p{Lower}/.match(char) && !mathml_mi_italics[:lowergreek]) ||

data/lib/metanorma/standoc/init.rb

@@ -36,6 +36,7 @@ module Metanorma
         @document_scheme = document_scheme(node)
         @xrefstyle = node.attr("xrefstyle")
         @source_linenums = node.attr("source-linenums-option") == "true"
+        @default_doctype = "standard"
       end
 
       def init_processing(node)
@@ -46,6 +47,7 @@ module Metanorma
         @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
         @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
         @datauriimage = node.attr("data-uri-image") != "false"
+        @datauriattachment = node.attr("data-uri-attachment") != "false"
         @blockunnumbered = (node.attr("block-unnumbered") || "").split(",")
           .map(&:strip)
       end

data/lib/metanorma/standoc/inline.rb

@@ -22,7 +22,8 @@ module Metanorma
       end
 
       def thematic_break(_node)
-        noko { |xml| xml.hr }.join
+        # noko(&:hr).join # Do not do this, noko blows up
+        noko { |xml| xml.hr }.join # rubocop:disable Style/SymbolProc
       end
 
       def latex_parse1(text, block)