metanorma-standoc 3.1.10 → 3.2.1

data/lib/metanorma/standoc/front.rb

@@ -9,7 +9,7 @@ module Metanorma
     module Front
       def metadata_id(node, xml)
         id = node.attr("docidentifier") || metadata_id_build(node)
-        xml.docidentifier id, primary: "true"
+        add_noko_elem(xml, "docidentifier", id, primary: "true")
       end
 
       def metadata_id_build(node)
@@ -21,21 +21,23 @@ module Metanorma
       end
 
       def metadata_other_id(node, xml)
-        a = node.attr("isbn") and xml.docidentifier a, type: "ISBN"
-        a = node.attr("isbn10") and xml.docidentifier a, type: "ISBN10"
+        a = node.attr("isbn") and
+          add_noko_elem(xml, "docidentifier", a, type: "ISBN")
+        a = node.attr("isbn10") and
+          add_noko_elem(xml, "docidentifier", a, type: "ISBN10")
         csv_split(node.attr("docidentifier-additional"), ",")&.each do |n|
           t, v = n.split(":", 2)
-          xml.docidentifier v, type: t
+          add_noko_elem(xml, "docidentifier", v, type: t)
         end
-        xml.docnumber node.attr("docnumber")
+        add_noko_elem(xml, "docnumber", node.attr("docnumber"))
       end
 
       def metadata_version(node, xml)
         draft = metadata_version_value(node)
-        xml.edition node.attr("edition") if node.attr("edition")
+        add_noko_elem(xml, "edition", node.attr("edition"))
         xml.version do |v|
-          v.revision_date node.attr("revdate") if node.attr("revdate")
-          v.draft draft if draft
+          add_noko_elem(v, "revision_date", node.attr("revdate"))
+          add_noko_elem(v, "draft", draft)
         end
       end
 
@@ -48,23 +50,24 @@ module Metanorma
 
       def metadata_status(node, xml)
         xml.status do |s|
-          s.stage (node.attr("status") || node.attr("docstage") || "published")
-          node.attr("docsubstage") and s.substage node.attr("docsubstage")
-          node.attr("iteration") and s.iteration node.attr("iteration")
+          add_noko_elem(s, "stage",
+                        node.attr("status") || node.attr("docstage") || "published")
+          add_noko_elem(s, "substage", node.attr("docsubstage"))
+          add_noko_elem(s, "iteration", node.attr("iteration"))
         end
       end
 
       def metadata_source(node, xml)
-        node.attr("uri") && xml.uri(node.attr("uri"))
+        add_noko_elem(xml, "uri", node.attr("uri"))
         %w(xml html pdf doc relaton).each do |t|
-          node.attr("#{t}-uri") && xml.uri(node.attr("#{t}-uri"), type: t)
+          add_noko_elem(xml, "uri", node.attr("#{t}-uri"), type: t)
         end
       end
 
       def metadata_date1(node, xml, type)
         date = node.attr("#{type}-date")
         date and xml.date(type:) do |d|
-          d.on date
+          add_noko_elem(d, "on", date)
         end
       end
 
@@ -80,17 +83,17 @@ module Metanorma
           a == "date" || /^date_\d+$/.match(a) or next
           type, date = node.attr(a).split(/ /, 2)
           type or next
-          xml.date(type:) { |d| d.on date }
+          xml.date(type:) { |d| add_noko_elem(d, "on", date) }
         end
       end
 
       def metadata_language(node, xml)
-        xml.language (node.attr("language") || "en")
-        l = node.attr("locale") and xml.locale l
+        add_noko_elem(xml, "language", node.attr("language") || "en")
+        add_noko_elem(xml, "locale", node.attr("locale"))
       end
 
       def metadata_script(node, xml)
-        xml.script (node.attr("script") ||
+        add_noko_elem(xml, "script", node.attr("script") ||
                     Metanorma::Utils.default_script(node.attr("language")))
       end
 
@@ -128,8 +131,8 @@ module Metanorma
         xml.relation type: relation_normalise(type) do |r|
           desc.nil? or r.description desc.tr("-", " ")
           fetch_ref(r, doc, nil, **{}) or r.bibitem do |b|
-            b.title id[1] || "--"
-            b.docidentifier id[0]
+            add_noko_elem(b, "title", id[1] || "--")
+            add_noko_elem(b, "docidentifier", id[0])
           end
         end
       end
@@ -137,7 +140,7 @@ module Metanorma
       def metadata_keywords(node, xml)
         node.attr("keywords") or return
         node.attr("keywords").split(/,\s*/).each do |kw|
-          xml.keyword kw
+          add_noko_elem(xml, "keyword", kw)
         end
       end
 
@@ -145,7 +148,7 @@ module Metanorma
         csv_split(node.attr("classification"), ",")&.each do |c|
           vals = c.split(/:/, 2)
           vals.size == 1 and vals = ["default", vals[0]]
-          xml.classification vals[1], type: vals[0]
+          add_noko_elem(xml, "classification", vals[1], type: vals[0])
         end
       end
 
@@ -204,9 +207,8 @@ module Metanorma
       end
 
       def add_title_xml(xml, content, language, type)
-        xml.title **attr_code(language: language, type: type) do |t|
-          t << Metanorma::Utils::asciidoc_sub(content)
-        end
+        add_noko_elem(xml, "title", Metanorma::Utils::asciidoc_sub(content),
+                      language: language, type: type)
       end
 
       def title_fallback(node, xml)

data/lib/metanorma/standoc/front_committee.rb

@@ -46,13 +46,13 @@ module Metanorma
           committee[:agency_abbrev] = agency
           agency = name
         end
-        xml.name agency
+        add_noko_elem(xml, "name", agency)
         s = committee
         loop do
           contrib_committee_subdiv(xml, s)
           s = s[:subdiv] or break
         end
-        abbr = committee[:agency_abbrev] and xml.abbreviation abbr
+        add_noko_elem(xml, "abbreviation", committee[:agency_abbrev])
         full_committee_id(xml.parent)
       end
 
@@ -60,9 +60,9 @@ module Metanorma
         contributors_committees_filter_empty?(committee) and return
         xml.subdivision **attr_code(type: committee[:subdivtype],
                                     subtype: committee[:type]) do |o|
-          o.name committee[:name]
-          committee[:abbr] and o.abbreviation committee[:abbr]
-          committee[:ident] and o.identifier committee[:ident]
+          add_noko_elem(o, "name", committee[:name])
+          add_noko_elem(o, "abbreviation", committee[:abbr])
+          add_noko_elem(o, "identifier", committee[:ident])
         end
       end
 

data/lib/metanorma/standoc/front_contributor.rb

@@ -37,19 +37,19 @@ module Metanorma
         type = node.attr("role#{suffix}")&.downcase || "author"
         desc = node.attr("role-description#{suffix}")
         contrib.role type: type do |r|
-          desc and r.description do |d|
-            d << desc
-          end
+          add_noko_elem(r, "description", desc)
         end
       end
 
       def personal_contact(node, suffix, person)
-        node.attr("phone#{suffix}") and person.phone node.attr("phone#{suffix}")
+        node.attr("phone#{suffix}") and
+          add_noko_elem(person, "phone", node.attr("phone#{suffix}"))
         node.attr("fax#{suffix}") and
-          person.phone node.attr("fax#{suffix}"), type: "fax"
-        node.attr("email#{suffix}") and person.email node.attr("email#{suffix}")
+          add_noko_elem(person, "phone", node.attr("fax#{suffix}"), type: "fax")
+        node.attr("email#{suffix}") and
+          add_noko_elem(person, "email", node.attr("email#{suffix}"))
         node.attr("contributor-uri#{suffix}") and
-          person.uri node.attr("contributor-uri#{suffix}")
+          add_noko_elem(person, "uri", node.attr("contributor-uri#{suffix}"))
       end
 
       def personal_author1(node, xml, suffix)
@@ -67,25 +67,25 @@ module Metanorma
       def person_name(node, _xml, suffix, person)
         person.name do |n|
           if node.attr("fullname#{suffix}")
-            n.completename node.attr("fullname#{suffix}")
+            add_noko_elem(n, "completename", node.attr("fullname#{suffix}"))
           else
-            n.forename node.attr("givenname#{suffix}")
-            n.initial node.attr("initials#{suffix}")
-            n.surname node.attr("surname#{suffix}")
+            add_noko_elem(n, "forename", node.attr("givenname#{suffix}"))
+            add_noko_elem(n, "initial", node.attr("initials#{suffix}"))
+            add_noko_elem(n, "surname", node.attr("surname#{suffix}"))
           end
         end
       end
 
       def person_credentials(node, _xml, suffix, person)
-        c = node.attr("contributor-credentials#{suffix}") and
-          person.credentials c
+        add_noko_elem(person, "credentials",
+                      node.attr("contributor-credentials#{suffix}"))
       end
 
       def person_affiliation(node, _xml, suffix, person)
         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 }
+          add_noko_elem(a, "name", pos)
           aff and a.organization do |o|
             person_organization(node, suffix, o)
           end

data/lib/metanorma/standoc/front_ext.rb

@@ -5,7 +5,7 @@ module Metanorma
         ics = node.attr("library-ics")
         ics&.split(/,\s*/)&.each do |i|
           xml.ics do |elem|
-            elem.code i
+            add_noko_elem(elem, "code", i)
             icsdata = Isoics.fetch i
             elem.text_ icsdata.description
           end
@@ -24,15 +24,15 @@ module Metanorma
       def structured_id(node, xml); end
 
       def metadata_doctype(node, xml)
-        xml.doctype doctype(node)
+        add_noko_elem(xml, "doctype", doctype(node))
       end
 
       def metadata_subdoctype(node, xml)
-        s = node.attr("docsubtype") and xml.subdoctype s
+        add_noko_elem(xml, "subdoctype", node.attr("docsubtype"))
       end
 
       def metadata_flavor(_node, ext)
-        ext.flavor processor.new.asciidoctor_backend
+        add_noko_elem(ext, "flavor", processor.new.asciidoctor_backend.to_s)
       end
 
       def metadata_coverpage_images(node, xml)
@@ -40,7 +40,9 @@ module Metanorma
            backpage-image).each do |n|
           if a = node.attr(n)
             xml.send n do |c|
-              a.split(",").each { |x| c.image src: x }
+              a.split(",").each do |x|
+                c.image src: x
+              end
             end
           end
         end

data/lib/metanorma/standoc/front_organisation.rb

@@ -3,11 +3,11 @@ module Metanorma
     module Front
       def organization(org, orgname, node = nil, default_org = nil, attrs = {})
         orgname, abbr = org_name_and_abbrev(attrs, orgname)
-        org.name orgname
+        add_noko_elem(org, "name", orgname)
         default_org && (a = node&.attr("subdivision")) && !attrs[:subdiv] and
           subdivision(a, node&.attr("subdivision-abbr"), org)
         a = attrs[:subdiv] and subdivision(a, nil, org)
-        abbr and org.abbreviation abbr
+        add_noko_elem(org, "abbreviation", abbr)
       end
 
       def org_name_and_abbrev(org, orgname)
@@ -45,32 +45,30 @@ module Metanorma
       def subdiv_build(list, org)
         list.empty? and return
         org.subdivision **attr_code(type: list[0][:type]) do |s|
-          s.name { |n| n << list[0][:value] }
+          add_noko_elem(s, "name", list[0][:value])
           subdiv_build(list[1..], s)
-          a = list[0][:abbr] and s.abbreviation { |n| n << a }
+          add_noko_elem(s, "abbreviation", list[0][:abbr])
         end
       end
 
       def org_address(org, xml)
         p = org[:address] and xml.address do |ad|
-          ad.formattedAddress do |f|
-            f << p.gsub(/ \+\n/, "<br/>")
-          end
+          add_noko_elem(ad, "formattedAddress", p.gsub(/ \+\n/, "<br/>"))
         end
         org_contact(org, xml)
       end
 
       def org_contact(org, xml)
-        p = org[:phone] and xml.phone p
-        p = org[:fax] and xml.phone p, type: "fax"
-        p = org[:email] and xml.email p
-        p = org[:uri] and xml.uri p
+        add_noko_elem(xml, "phone", org[:phone])
+        add_noko_elem(xml, "phone", org[:fax], type: "fax")
+        add_noko_elem(xml, "email", org[:email])
+        add_noko_elem(xml, "uri", org[:uri])
       end
 
       def person_organization(node, suffix, xml)
-        xml.name node.attr("affiliation#{suffix}")
-        abbr = node.attr("affiliation_abbrev#{suffix}") and
-          xml.abbreviation abbr
+        add_noko_elem(xml, "name", node.attr("affiliation#{suffix}"))
+        add_noko_elem(xml, "abbreviation",
+                      node.attr("affiliation_abbrev#{suffix}"))
         a = node.attr("affiliation_subdiv#{suffix}") and
           subdivision(a, nil, xml)
         person_address(node, suffix, xml)
@@ -80,9 +78,8 @@ module Metanorma
       def person_address(node, suffix, xml)
         if node.attr("address#{suffix}")
           xml.address do |ad|
-            ad.formattedAddress do |f|
-              f << node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>")
-            end
+            add_noko_elem(ad, "formattedAddress",
+                          node.attr("address#{suffix}").gsub(/ \+\n/, "<br/>"))
           end
         elsif node.attr("country#{suffix}") || node.attr("city#{suffix}")
           person_address_components(node, suffix, xml)
@@ -92,7 +89,7 @@ module Metanorma
       def person_address_components(node, suffix, xml)
         xml.address do |ad|
           %w(street city state country postcode).each do |k|
-            s = node.attr("#{k}#{suffix}") and ad.send k, s
+            add_noko_elem(ad, k, node.attr("#{k}#{suffix}"))
           end
         end
       end
@@ -128,9 +125,7 @@ module Metanorma
 
       def org_contributor_role(xml, org)
         xml.role type: org[:role] do |r|
-          org[:desc] and r.description do |d|
-            d << org[:desc]
-          end
+          add_noko_elem(r, "description", org[:desc])
         end
       end
 

data/lib/metanorma/standoc/init.rb

@@ -1,5 +1,6 @@
 require_relative "utils"
 require_relative "regex"
+require "json"
 
 module Metanorma
   module Standoc
@@ -41,6 +42,7 @@ module Metanorma
         @embed_id = node.attr("embed_id")
         @document_scheme = document_scheme(node)
         @source_linenums = node.attr("source-linenums-option") == "true"
+        # feeds log
         @semantic_headless = node.attr("semantic-metadata-headless") == "true"
         @default_doctype = "standard"
       end
@@ -53,22 +55,46 @@ module Metanorma
         @smartquotes = node.attr("smartquotes") != "false"
         @sourcecode_markup_start = node.attr("sourcecode-markup-start") || "{{{"
         @sourcecode_markup_end = node.attr("sourcecode-markup-end") || "}}}"
-        @blockunnumbered = (node.attr("block-unnumbered") || "").split(",")
-          .map(&:strip)
+        @blockunnumbered = csv_split(node.attr("block-unnumbered"), ",")
       end
 
       def init_log(node)
         @log or return
+        @semantic_headless and return
         severity = node.attr("log-filter-severity")&.to_i || 4
-        category = node.attr("log-filter-category") || ""
-        category = category.split(",").map(&:strip)
-        @log.suppress_log = { severity:, category: }
+        category = csv_split(node.attr("log-filter-category"), ",")
+        error_ids = csv_split(node.attr("log-filter-error-ids"), ",")
+        locations = cleanup_log_filter_error_log(
+          extract_log_filter_error_loc(node),
+        )
+        @log.suppress_log = { severity:, category:, error_ids:, locations: }
+      end
+
+      def extract_log_filter_error_loc(node)
+        locations = JSON.parse(node.attr("log-filter-error-loc") || "[]")
+        locations = [locations] unless locations.is_a?(Array)
+        locations.map { |loc| loc.transform_keys(&:to_sym) }
+      end
+
+      def cleanup_log_filter_error_log(locations)
+        locations.each do |loc|
+          loc[:to] ||= loc[:from]
+          loc[:error_ids] ||= []
+          loc[:error_ids] &&= Array(loc[:error_ids])
+        end
       end
 
       def init_image(node)
         @datauriimage = node.attr("data-uri-image") != "false"
         @datauriattachment = node.attr("data-uri-attachment") != "false"
         @dataurimaxsize = node.attr("data-uri-maxsize")&.to_i || 13981013
+        @svg_conform_profile =
+          node.attr("svg-conform-profile")&.sub(/^:/, "") ||
+          default_svg_conform_profile
+      end
+
+      def default_svg_conform_profile
+        :metanorma
       end
 
       def init_reqt(node)

data/lib/metanorma/standoc/inline.rb

@@ -34,9 +34,7 @@ module Metanorma
         results = Plurimath::Math.parse(lxm_input, "latex")
           .to_mathml(display_style: block)
         if results.nil?
-          @log.add("Maths", nil,
-                   "latexmlmath failed to process equation:\n#{lxm_input}",
-                   severity: 1)
+          @log.add("STANDOC_51", nil, params: [lxm_input])
           return
         end
         results.sub(%r{<math ([^>]+ )?display="block"}, "<math \\1")
@@ -51,7 +49,8 @@ module Metanorma
           end
         elsif style == :latexmath then latex_parse(text, xml, attrs)
         else
-          xml.stem text&.gsub("&amp;#", "&#"), **attrs.merge(type: "AsciiMath")
+          xml.stem text&.gsub("&amp;#", "&#") || "",
+                   **attrs.merge(type: "AsciiMath")
         end
       end
 
@@ -81,9 +80,7 @@ module Metanorma
       end
 
       def highlight_parse(text, xml)
-        xml.span **{ class: "fmt-hi" } do |s|
-          s << text
-        end
+        add_noko_elem(xml, "span", text, class: "fmt-hi")
       end
 
       def inline_quoted(node)
@@ -181,16 +178,38 @@ module Metanorma
       def inline_indexterm(node)
         noko do |xml|
           node.type == :visible and xml << node.text
-          terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
-          inline_indexterm1(xml, terms)
+          terms, see, also = inline_indexterm_extract(node)
+          (see || also) or inline_indexterm1(xml, terms)
+          also and
+            inline_indexterm_see(xml, terms, also, true)
+          see and
+            inline_indexterm_see(xml, terms, [see], false)
         end
       end
 
+      def inline_indexterm_extract(node)
+        terms = (node.attr("terms") || [node.text]).map { |x| xml_encode(x) }
+        see = node.attr("see")
+        also = node.attr("see-also")
+        [terms, see, also]
+      end
+
       def inline_indexterm1(xml, terms)
         xml.index do |i|
-          i.primary { |x| x << terms[0] }
-          a = terms[1] and i.secondary { |x| x << a }
-          a = terms[2] and i.tertiary { |x| x << a }
+          add_noko_elem(i, "primary", terms[0])
+          add_noko_elem(i, "secondary", terms[1])
+          add_noko_elem(i, "tertiary", terms[2])
+        end
+      end
+
+      def inline_indexterm_see(xml, terms, ref, also)
+        ref.each do |r|
+          xml.index_xref also: also do |i|
+            add_noko_elem(i, "primary", terms[0])
+            add_noko_elem(i, "secondary", terms[1])
+            add_noko_elem(i, "tertiary", terms[2])
+            add_noko_elem(i, "target", r)
+          end
         end
       end
     end

data/lib/metanorma/standoc/isodoc.rng

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.1.3 -->
+<!-- VERSION v2.1.4 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -905,15 +905,32 @@ titlecase, or lowercase</a:documentation>
     </element>
   </define>
   <define name="image" combine="choice">
-    <element name="svg">
-      <a:documentation>Add svg mark up to image</a:documentation>
-      <oneOrMore>
-        <choice>
-          <text/>
-          <ref name="AnyElement"/>
-        </choice>
-      </oneOrMore>
-    </element>
+    <choice>
+      <element name="image">
+        <ref name="RequiredId"/>
+        <ref name="ImageAttributes"/>
+        <optional>
+          <element name="svg">
+            <a:documentation>Allow svg in image/svg, for consistency</a:documentation>
+            <oneOrMore>
+              <choice>
+                <text/>
+                <ref name="AnyElement"/>
+              </choice>
+            </oneOrMore>
+          </element>
+        </optional>
+      </element>
+      <element name="svg">
+        <a:documentation>Add svg mark up to image</a:documentation>
+        <oneOrMore>
+          <choice>
+            <text/>
+            <ref name="AnyElement"/>
+          </choice>
+        </oneOrMore>
+      </element>
+    </choice>
   </define>
   <define name="ParagraphFnBody" combine="interleave">
     <ref name="BlockSource">

data/lib/metanorma/standoc/lists.rb

@@ -7,7 +7,7 @@ module Metanorma
             xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
             xml_li << item.content
           else
-            xml_li.p(**attr_code(id_attr(item))) { |p| p << item.text }
+            xml_li.p(**attr_code(id_attr(item))) { |t| t << item.text }
           end
         end
       end

data/lib/metanorma/standoc/localbib.rb

@@ -48,24 +48,20 @@ module Metanorma
       end
 
       def file_error(config)
-        msg = "Cannot process file #{config['file']} for local relaton " \
-              "data source #{config['key']}"
-        @parent.log.add("Bibliography", nil, msg, severity: 0)
+        @parent.log.add("STANDOC_54", nil,
+                        params: [config["file"], config["key"]])
         ""
       end
 
       def format_error(config)
-        msg = "Cannot process format #{config['format']} for local relaton " \
-              "data source #{config['key']}"
-        @parent.log.add("Bibliography", nil, msg, severity: 0)
+        @parent.log.add("STANDOC_37", nil,
+                        params: [config["format"], config["key"]])
         {}
       end
 
       def get(id, file = default)
         ret = @file_bibdb.dig(file, id) and return ret
-        msg = "Cannot find reference #{id} for local relaton " \
-              "data source #{file}"
-        @parent.log.add("Bibliography", nil, msg, severity: 0)
+        @parent.log.add("STANDOC_19", nil, params: [id, file])
         Nokogiri::XML("<bibitem/>")
       end
     end