metanorma-standoc 2.2.4 → 2.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dfe44699d10166a0388cc7ebad8484584eaad6f13ec9777b4ad70484fcd8002
-  data.tar.gz: 13d5367c69704b000b00f676b81c5285ef5dba303db110e1463504c45c0f84f0
+  metadata.gz: '033585c8aaadb0c5672e328edd9c30012ee330cb800cbf8a7f4e2a7e5498a61e'
+  data.tar.gz: 07b1cba33ba7917f68429d91393c8795d787c63e06f60d3f8d00938088e13138
 SHA512:
-  metadata.gz: 7d3f9d03a2e32b41e7a2851eb5ca735800708c90ea21b472b11953a2130e1bdfff63b16d98585b6506857802642f5182fd09add53e022ab32af9e9c6115b7cb7
-  data.tar.gz: 69f79d44f92bc8a2f40769febf4707cf75cdea9be62691b0d39219eb06a7a0dc489896c4914db99244f47f50bf5dd4fb1b64c64848783a53378d4f604ae9dc7a
+  metadata.gz: d163281f43172f6c1be2391bb923245f58270efd2f1eb482412b08e41ebdfeed91f6edeb4df61e4e5056feba0fd7c17b673b8d8d324f9837f93ac310052eda73
+  data.tar.gz: 1a8dbeadcc05872bf5daadebf262204461e75f9e39ffd9a0d2b77ebaec68131cd04786cb22a8adfaccfdaf3cad3db3019a51a85b18d8be1a8d363381c7618045

data/.github/workflows/automerge.yml

@@ -0,0 +1,31 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+# source: https://github.com/marketplace/actions/merge-pull-requests#usage
+name: automerge
+on:
+  pull_request:
+    types:
+      - labeled
+      - unlabeled
+      - synchronize
+      - opened
+      - edited
+      - ready_for_review
+      - reopened
+      - unlocked
+  pull_request_review:
+    types:
+      - submitted
+  check_suite:
+    types:
+      - completed
+  status: {}
+jobs:
+  automerge:
+    runs-on: ubuntu-latest
+    steps:
+      - id: automerge
+        name: automerge
+        uses: "pascalgn/automerge-action@v0.15.3"
+        env:
+          GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"

data/lib/isodoc/html/htmlstyle.css

@@ -368,7 +368,7 @@ div.figure {
     font-weight: 700;
     font-size: 1em;
     text-align: center; }
-  div.figure > img {
+  div.figure > img, div.figure > svg {
     margin-left: auto;
     margin-right: auto;
     display: block;

data/lib/metanorma/standoc/base.rb

@@ -56,6 +56,7 @@ module Metanorma
         @boilerplateauthority = node.attr("boilerplate-authority")
         @embed_hdr = node.attr("embed_hdr")
         @document_scheme = node.attr("document-scheme")
+        @xrefstyle = node.attr("xrefstyle")
       end
 
       def init_processing(node)

data/lib/metanorma/standoc/basicdoc.rng

@@ -1,10 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <grammar xmlns="http://relaxng.org/ns/structure/1.0" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-  <include href="biblio.rng">
-    <start>
-      <ref name="document"/>
-    </start>
-  </include>
   <define name="document">
     <element name="document">
       <optional>
@@ -1125,26 +1120,4 @@
       </zeroOrMore>
     </element>
   </define>
-  <define name="ext">
-    <element name="ext">
-      <ref name="BibDataExtensionType"/>
-    </element>
-  </define>
-  <define name="BibDataExtensionType">
-    <ref name="doctype"/>
-  </define>
-  <define name="doctype">
-    <element name="doctype">
-      <ref name="DocumentType"/>
-    </element>
-  </define>
-  <define name="DocumentType">
-    <value>document</value>
-  </define>
-  <define name="BibData">
-    <ref name="BibliographicItem"/>
-    <optional>
-      <ref name="ext"/>
-    </optional>
-  </define>
 </grammar>

data/lib/metanorma/standoc/biblio-standoc.rng

@@ -0,0 +1,164 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<grammar xmlns="http://relaxng.org/ns/structure/1.0">
+  <!--
+    Add-ons to biblio.rnc for standoc model: defines the extension point BibDataExtensionType
+    of relaton
+    
+    Specialisations as for biblio.rnc. Extension point can be redefined completely for a flavour of standoc
+    (SDO); but other elements in Bibdata can only be extended (more specialised vocabularies for Bibdata)
+  -->
+  <include href="biblio.rng">
+    <define name="BibData">
+      <ref name="BibliographicItem"/>
+      <optional>
+        <ref name="ext"/>
+      </optional>
+    </define>
+  </include>
+  <define name="ext">
+    <element name="ext">
+      <ref name="BibDataExtensionType"/>
+    </element>
+  </define>
+  <define name="BibDataExtensionType">
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
+    <ref name="doctype"/>
+    <optional>
+      <ref name="docsubtype"/>
+    </optional>
+    <optional>
+      <ref name="editorialgroup"/>
+    </optional>
+    <zeroOrMore>
+      <ref name="ics"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="structuredidentifier"/>
+    </zeroOrMore>
+  </define>
+  <define name="doctype">
+    <element name="doctype">
+      <optional>
+        <attribute name="abbreviation"/>
+      </optional>
+      <ref name="DocumentType"/>
+    </element>
+  </define>
+  <define name="DocumentType">
+    <value>document</value>
+  </define>
+  <define name="docsubtype">
+    <element name="subdoctype">
+      <ref name="DocumentSubtype"/>
+    </element>
+  </define>
+  <define name="DocumentSubtype">
+    <text/>
+  </define>
+  <define name="editorialgroup">
+    <element name="editorialgroup">
+      <oneOrMore>
+        <ref name="technical-committee"/>
+      </oneOrMore>
+    </element>
+  </define>
+  <define name="technical-committee">
+    <element name="technical-committee">
+      <ref name="IsoWorkgroup"/>
+    </element>
+  </define>
+  <define name="IsoWorkgroup">
+    <optional>
+      <attribute name="number"/>
+    </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
+    <optional>
+      <attribute name="identifier"/>
+    </optional>
+    <optional>
+      <attribute name="prefix"/>
+    </optional>
+    <text/>
+  </define>
+  <define name="ics">
+    <element name="ics">
+      <element name="code">
+        <text/>
+      </element>
+      <optional>
+        <element name="text">
+          <text/>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="structuredidentifier">
+    <element name="structuredidentifier">
+      <optional>
+        <attribute name="type"/>
+      </optional>
+      <oneOrMore>
+        <element name="agency">
+          <text/>
+        </element>
+      </oneOrMore>
+      <optional>
+        <element name="class">
+          <text/>
+        </element>
+      </optional>
+      <element name="docnumber">
+        <text/>
+      </element>
+      <optional>
+        <element name="partnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="edition">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="version">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementtype">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="supplementnumber">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="amendment">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="corrigendum">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="language">
+          <text/>
+        </element>
+      </optional>
+      <optional>
+        <element name="year">
+          <text/>
+        </element>
+      </optional>
+    </element>
+  </define>
+</grammar>

data/lib/metanorma/standoc/biblio.rng

@@ -33,9 +33,10 @@
       <param name="pattern">([\+\-]?\d{4})((-?)((0[1-9]|1[0-2])((-?)([12]\d|0[1-9]|3[01]))?|W([0-4]\d|5[0-2])(-?[1-7])?|(00[1-9]|0[1-9]\d|[12]\d{2}|3([0-5]\d|6[1-6]))))?</param>
     </data>
   </define>
-  <start>
-    <ref name="bibitem"/>
-  </start>
+  <!-- start = bibitem -->
+  <define name="BibData">
+    <ref name="BibliographicItem"/>
+  </define>
   <define name="status">
     <element name="status">
       <ref name="stage"/>
@@ -170,27 +171,25 @@
   </define>
   <define name="contributor">
     <element name="contributor">
-      <zeroOrMore>
+      <oneOrMore>
         <ref name="role"/>
-      </zeroOrMore>
+      </oneOrMore>
       <ref name="ContributorInfo"/>
     </element>
   </define>
   <define name="role">
     <element name="role">
-      <optional>
-        <attribute name="type">
-          <choice>
-            <value>author</value>
-            <value>performer</value>
-            <value>publisher</value>
-            <value>editor</value>
-            <value>adapter</value>
-            <value>translator</value>
-            <value>distributor</value>
-          </choice>
-        </attribute>
-      </optional>
+      <attribute name="type">
+        <choice>
+          <value>author</value>
+          <value>performer</value>
+          <value>publisher</value>
+          <value>editor</value>
+          <value>adapter</value>
+          <value>translator</value>
+          <value>distributor</value>
+        </choice>
+      </attribute>
       <zeroOrMore>
         <ref name="roledescription"/>
       </zeroOrMore>
@@ -512,6 +511,17 @@
   </define>
   <define name="localityStack">
     <element name="localityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="locality"/>
       </zeroOrMore>
@@ -524,6 +534,17 @@
   </define>
   <define name="sourceLocalityStack">
     <element name="sourceLocalityStack">
+      <optional>
+        <attribute name="connective">
+          <choice>
+            <value>and</value>
+            <value>or</value>
+            <value>from</value>
+            <value>to</value>
+            <value/>
+          </choice>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="sourceLocality"/>
       </zeroOrMore>
@@ -626,6 +647,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>
@@ -720,6 +744,9 @@
         <ref name="BibItemType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="schema-version"/>
+    </optional>
     <optional>
       <ref name="fetched"/>
     </optional>

data/lib/metanorma/standoc/blocks.rb

@@ -174,7 +174,8 @@ module Metanorma
       end
 
       def figure_attrs(node)
-        attr_code(id_unnum_attrs(node).merge(keep_attrs(node)))
+        attr_code(id_unnum_attrs(node).merge(keep_attrs(node))
+          .merge(class: node.attr("class")))
       end
 
       def image(node)

data/lib/metanorma/standoc/cleanup.rb

@@ -5,6 +5,7 @@ require_relative "./cleanup_block"
 require_relative "./cleanup_table"
 require_relative "./cleanup_footnotes"
 require_relative "./cleanup_ref"
+require_relative "./cleanup_asciibib"
 require_relative "./cleanup_biblio"
 require_relative "./cleanup_boilerplate"
 require_relative "./cleanup_section"

data/lib/metanorma/standoc/cleanup_asciibib.rb

@@ -0,0 +1,110 @@
+require "set"
+require "relaton_bib"
+
+module Metanorma
+  module Standoc
+    module Cleanup
+      def ref_dl_cleanup(xmldoc)
+        xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
+          bib = dl_bib_extract(c) or next
+          validate_ref_dl(bib, c)
+          bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
+          bibitem = Nokogiri::XML(bibitemxml)
+          bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
+          c.replace(bibitem.root)
+        end
+      end
+
+      # do not accept implicit id
+      def validate_ref_dl(bib, clause)
+        id = bib["id"]
+        id ||= clause["id"] unless /^_/.match?(clause["id"])
+        unless id
+          @log.add("Anchors", clause,
+                   "The following reference is missing an anchor:\n" \
+                   "#{clause.to_xml}")
+          return
+        end
+        @refids << id
+        validate_ref_dl1(bib, id, clause)
+      end
+
+      def validate_ref_dl1(bib, id, clause)
+        bib["title"] or
+          @log.add("Bibliography", clause, "Reference #{id} is missing a title")
+        bib["docid"] or
+          @log.add("Bibliography", clause,
+                   "Reference #{id} is missing a document identifier (docid)")
+      end
+
+      def extract_from_p(tag, bib, key)
+        return unless bib[tag]
+
+        "<#{key}>#{bib[tag].at('p').children}</#{key}>"
+      end
+
+      # if the content is a single paragraph, replace it with its children
+      # single links replaced with uri
+      def p_unwrap(para)
+        elems = para.elements
+        if elems.size == 1 && elems[0].name == "p"
+          link_unwrap(elems[0]).children.to_xml.strip
+        else
+          para.to_xml.strip
+        end
+      end
+
+      def link_unwrap(para)
+        elems = para.elements
+        if elems.size == 1 && elems[0].name == "link"
+          para.at("./link").replace(elems[0]["target"].strip)
+        end
+        para
+      end
+
+      def dd_bib_extract(dtd)
+        return nil if dtd.children.empty?
+
+        dtd.at("./dl") and return dl_bib_extract(dtd)
+        elems = dtd.remove.elements
+        return p_unwrap(dtd) unless elems.size == 1 &&
+          %w(ol ul).include?(elems[0].name)
+
+        elems[0].xpath("./li").each_with_object([]) do |li, ret|
+          ret << p_unwrap(li)
+        end
+      end
+
+      def add_to_hash(bib, key, val)
+        Metanorma::Utils::set_nested_value(bib, key.split("."), val)
+      end
+
+      # definition list, with at most one level of unordered lists
+      def dl_bib_extract(clause, nested = false)
+        dl = clause.at("./dl") or return
+        key = ""
+        bib = dl.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
+          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) and next
+          add_to_hash(m, key, dd_bib_extract(dtd))
+        end
+        clause.xpath("./clause").each do |c1|
+          key = c1&.at("./title")&.text&.downcase&.strip
+          next unless %w(contributor relation series).include? key
+
+          add_to_hash(bib, key, dl_bib_extract(c1, true))
+        end
+        dl_bib_extract_title(bib, clause, nested)
+      end
+
+      def dl_bib_extract_title(bib, clause, nested)
+        (!nested && clause.at("./title")) or return bib
+        title = clause.at("./title").remove.children.to_xml
+        bib["title"] = [bib["title"]] if bib["title"].is_a?(Hash) ||
+          bib["title"].is_a?(String)
+        bib["title"] ||= []
+        bib["title"] << title if !title.empty?
+        bib
+      end
+    end
+  end
+end

data/lib/metanorma/standoc/cleanup_biblio.rb

@@ -1,113 +1,6 @@
-require "set"
-require "relaton_bib"
-
 module Metanorma
   module Standoc
     module Cleanup
-      def ref_dl_cleanup(xmldoc)
-        xmldoc.xpath("//clause[@bibitem = 'true']").each do |c|
-          bib = dl_bib_extract(c) or next
-          validate_ref_dl(bib, c)
-          bibitemxml = RelatonBib::BibliographicItem.from_hash(bib).to_xml or next
-          bibitem = Nokogiri::XML(bibitemxml)
-          bibitem.root["id"] = c["id"] if c["id"] && !/^_/.match(c["id"])
-          c.replace(bibitem.root)
-        end
-      end
-
-      # do not accept implicit id
-      def validate_ref_dl(bib, clause)
-        id = bib["id"]
-        id ||= clause["id"] unless /^_/.match?(clause["id"])
-        unless id
-          @log.add("Anchors", clause,
-                   "The following reference is missing an anchor:\n"\
-                   "#{clause.to_xml}")
-          return
-        end
-        @refids << id
-        validate_ref_dl1(bib, id, clause)
-      end
-
-      def validate_ref_dl1(bib, id, clause)
-        bib["title"] or
-          @log.add("Bibliography", clause, "Reference #{id} is missing a title")
-        bib["docid"] or
-          @log.add("Bibliography", clause,
-                   "Reference #{id} is missing a document identifier (docid)")
-      end
-
-      def extract_from_p(tag, bib, key)
-        return unless bib[tag]
-
-        "<#{key}>#{bib[tag].at('p').children}</#{key}>"
-      end
-
-      # if the content is a single paragraph, replace it with its children
-      # single links replaced with uri
-      def p_unwrap(para)
-        elems = para.elements
-        if elems.size == 1 && elems[0].name == "p"
-          link_unwrap(elems[0]).children.to_xml.strip
-        else
-          para.to_xml.strip
-        end
-      end
-
-      def link_unwrap(para)
-        elems = para.elements
-        if elems.size == 1 && elems[0].name == "link"
-          para.at("./link").replace(elems[0]["target"].strip)
-        end
-        para
-      end
-
-      def dd_bib_extract(dtd)
-        return nil if dtd.children.empty?
-
-        dtd.at("./dl") and return dl_bib_extract(dtd)
-        elems = dtd.remove.elements
-        return p_unwrap(dtd) unless elems.size == 1 &&
-          %w(ol ul).include?(elems[0].name)
-
-        elems[0].xpath("./li").each_with_object([]) do |li, ret|
-          ret << p_unwrap(li)
-        end
-      end
-
-      def add_to_hash(bib, key, val)
-        Metanorma::Utils::set_nested_value(bib, key.split("."), val)
-      end
-
-      # definition list, with at most one level of unordered lists
-      def dl_bib_extract(clause, nested = false)
-        dl = clause.at("./dl") or return
-        key = ""
-        bib = dl.xpath("./dt | ./dd").each_with_object({}) do |dtd, m|
-          (dtd.name == "dt" and key = dtd.text.sub(/:+$/, "")) and next
-          add_to_hash(m, key, dd_bib_extract(dtd))
-        end
-        clause.xpath("./clause").each do |c1|
-          key = c1&.at("./title")&.text&.downcase&.strip
-          next unless %w(contributor relation series).include? key
-
-          add_to_hash(bib, key, dl_bib_extract(c1, true))
-        end
-        dl_bib_extract_title(bib, clause, nested)
-      end
-
-      def dl_bib_extract_title(bib, clause, nested)
-        (!nested && clause.at("./title")) or return bib
-        title = clause.at("./title").remove.children.to_xml
-        bib["title"] = [bib["title"]] if bib["title"].is_a?(Hash) ||
-          bib["title"].is_a?(String)
-        bib["title"] ||= []
-        bib["title"] << title if !title.empty?
-        bib
-      end
-
-      # ---
-
       def formattedref_spans(xmldoc)
         xmldoc.xpath("//bibitem[formattedref//span]").each do |b|
           spans = spans_preprocess(extract_content(b))
@@ -263,10 +156,11 @@ module Metanorma
 
       def span_to_extent(span, key)
         values = span.split(/[-–]/)
-        ret = "<extent type='#{key}'><referenceFrom>#{values[0]}</referenceFrom>"
+        ret = "<extent type='#{key}'><locality>" \
+              "<referenceFrom>#{values[0]}</referenceFrom>"
         values[1] and
           ret += "<referenceTo>#{values[1]}</referenceTo>"
-        "#{ret}</extent>"
+        "#{ret}</locality></extent>"
       end
 
       def span_to_docid(span, key)
@@ -287,10 +181,10 @@ module Metanorma
 
       def span_to_person(span)
         pre = (span[:"formatted-initials"] and
-                     "<formatted-initials>"\
+                     "<formatted-initials>" \
                      "#{span[:"formatted-initials"]}</formatted-initials>") ||
           "<forename>#{span[:givenname]}</forename>"
-        "<person><name>#{pre}<surname>#{span[:surname]}</surname></name>"\
+        "<person><name>#{pre}<surname>#{span[:surname]}</surname></name>" \
           "</person>"
       end
     end

data/lib/metanorma/standoc/cleanup_block.rb

@@ -7,7 +7,8 @@ module Metanorma
       def para_cleanup(xmldoc)
         ["//p[not(ancestor::bibdata)]", "//ol[not(ancestor::bibdata)]",
          "//ul[not(ancestor::bibdata)]", "//quote[not(ancestor::bibdata)]",
-         "//note[not(ancestor::bibitem or "\
+         "//dl[not(ancestor::bibdata)]",
+         "//note[not(ancestor::bibitem or " \
          "ancestor::table or ancestor::bibdata)]"].each do |w|
           inject_id(xmldoc, w)
         end
@@ -106,7 +107,7 @@ module Metanorma
           prev = n.previous_element || next
           n.parent = prev if ELEMS_ALLOW_NOTES.include? prev.name
         end
-        xmldoc.xpath("//note[@keep-separate] | "\
+        xmldoc.xpath("//note[@keep-separate] | " \
                      "//termnote[@keep-separate]").each do |n|
           n.delete("keep-separate")
         end
@@ -182,10 +183,10 @@ module Metanorma
       end
 
       def block_index_cleanup(xmldoc)
-        xmldoc.xpath("//quote | //td | //th | //formula | //li | //dt | "\
-                     "//dd | //example | //note | //figure | //sourcecode | "\
-                     "//admonition | //termnote | //termexample | //form  | "\
-                     "//requirement | //recommendation | //permission | "\
+        xmldoc.xpath("//quote | //td | //th | //formula | //li | //dt | " \
+                     "//dd | //example | //note | //figure | //sourcecode | " \
+                     "//admonition | //termnote | //termexample | //form  | " \
+                     "//requirement | //recommendation | //permission | " \
                      "//imagemap | //svgmap").each do |b|
           b.xpath("./p[indexterm]").each do |p|
             indexterm_para?(p) or next