metanorma-iho 0.1.1 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47844a0e7c0680b1e260971b20e74cf78647e298ae1dafa62e9f0d5f73c0c1e6
-  data.tar.gz: 9406345dfb41ecd1b383494bdc1080685c698243bf471a930d5a338752386a39
+  metadata.gz: 1d513e582275fa2fbac4716c2367a85aefd6f5b26dd8e4f2f7d10608d98c6c96
+  data.tar.gz: 3e9150114684366020f5c8516cb737931c07c5973a0abe5a08120d9867c97f19
 SHA512:
-  metadata.gz: 40e039e131d89bc23de65209d87d5ee8e0a32bd4bf7dba3393edfcc5bccf644b8d5d21755358a99617e012e6991e15e1b04581c3313d39d5db8fe92c5ff72510
-  data.tar.gz: de44f7fe405ef2ef18b84691facd5722b1db7f626da67c94620d836ca45755709690efa00c315da93b8b036a1d8513d6fda1efc8bb9bd2dc44332bd3a6150f22
+  metadata.gz: e7c802926f806a98b5a9da05b1553c46ae56d827a11d0336afeb5faa87c029eb33f997dbfd4fc9c7d9f407d9e24075c85a6d0d6b5ddae2e61ec2385af47b5554
+  data.tar.gz: 0c9fe3c49478aa81331e460d5d2b1375c49c38c26ce647b3bec270c0f6b87fb79502d147790ba51c6ec608c6736a3203935f087698cb5745de4c3257c3cabd4a

data/.github/workflows/ubuntu.yml

@@ -39,7 +39,7 @@ jobs:
           polling_interval_seconds: 5
           timeout_minutes: 5
           max_attempts: 3
-          command: sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
+          command: sudo apt-get update -y && sudo bash -c "curl -L https://github.com/metanorma/plantuml-install/raw/master/ubuntu.sh | bash"
       - name: Run specs
         run: |
           bundle exec rake

data/lib/asciidoctor/iho/basicdoc.rng

@@ -158,7 +158,17 @@
         <data type="ID"/>
       </attribute>
       <oneOrMore>
-        <ref name="paragraph"/>
+        <choice>
+          <ref name="formula"/>
+          <ref name="ul"/>
+          <ref name="ol"/>
+          <ref name="dl"/>
+          <ref name="quote"/>
+          <ref name="sourcecode"/>
+          <ref name="paragraph"/>
+          <ref name="table"/>
+          <ref name="figure"/>
+        </choice>
       </oneOrMore>
     </element>
   </define>
@@ -402,6 +412,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>
@@ -429,6 +449,16 @@
           </choice>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="valign">
+          <choice>
+            <value>top</value>
+            <value>middle</value>
+            <value>bottom</value>
+            <value>baseline</value>
+          </choice>
+        </attribute>
+      </optional>
       <choice>
         <zeroOrMore>
           <ref name="TextElement"/>

data/lib/asciidoctor/iho/converter.rb

@@ -67,14 +67,22 @@ module Asciidoctor
 
       def metadata_committee1(node, xml)
         xml.editorialgroup do |a|
-          a.committee node.attr("committee")
-          a.workgroup node.attr("workgroup")
+          a.committee do |n|
+            n.abbreviation node.attr("committee").upcase
+          end
+          a.workgroup do |n|
+            n.abbreviation node.attr("workgroup").upcase
+          end
         end
         i = 2
         while node.attr("workgroup_#{i}") do
           xml.editorialgroup do |a|
-            a.committee node.attr("committee_#{i}")
-            a.workgroup node.attr("workgroup_#{i}")
+            a.committee do |n|
+              n.abbreviation node.attr("committee_#{i}").upcase
+            end
+            a.workgroup do |n|
+              n.abbreviation node.attr("workgroup_#{i}").upcase
+            end
           end
           i += 1
         end

data/lib/asciidoctor/iho/iho.rng

@@ -23,8 +23,13 @@
     </define>
     <define name="editorialgroup">
       <element name="editorialgroup">
-        <ref name="committee"/>
-        <ref name="workgroup"/>
+        <oneOrMore>
+          <choice>
+            <ref name="committee"/>
+            <ref name="workgroup"/>
+            <ref name="commission"/>
+          </choice>
+        </oneOrMore>
       </element>
     </define>
     <define name="BibDataExtensionType">
@@ -94,16 +99,35 @@
   </include>
   <define name="committee">
     <element name="committee">
-      <choice>
-        <value>hssc</value>
-        <value>ircc</value>
-      </choice>
+      <ref name="IHO_Group"/>
     </element>
   </define>
   <define name="workgroup">
     <element name="workgroup">
+      <ref name="IHO_Group"/>
+    </element>
+  </define>
+  <define name="commission">
+    <element name="commission">
+      <ref name="IHO_Group"/>
+    </element>
+  </define>
+  <define name="IHO_Group">
+    <optional>
+      <element name="name">
+        <text/>
+      </element>
+    </optional>
+    <element name="abbreviation">
       <text/>
     </element>
+    <optional>
+      <choice>
+        <ref name="committee"/>
+        <ref name="workgroup"/>
+        <ref name="commission"/>
+      </choice>
+    </optional>
   </define>
   <define name="annex-appendix">
     <element name="appendix">

data/lib/asciidoctor/iho/isodoc.rng

@@ -42,8 +42,11 @@
     </define>
     <define name="xref">
       <element name="xref">
+        <!-- attribute target { xsd:IDREF }, -->
         <attribute name="target">
-          <data type="IDREF"/>
+          <data type="string">
+            <param name="pattern">\i\c*|\c+#\c+</param>
+          </data>
         </attribute>
         <optional>
           <attribute name="type">
@@ -578,6 +581,8 @@
             <ref name="ol"/>
             <ref name="dl"/>
             <ref name="formula"/>
+            <ref name="quote"/>
+            <ref name="sourcecode"/>
           </choice>
         </oneOrMore>
       </element>
@@ -661,6 +666,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -697,6 +712,16 @@
             </choice>
           </attribute>
         </optional>
+        <optional>
+          <attribute name="valign">
+            <choice>
+              <value>top</value>
+              <value>middle</value>
+              <value>bottom</value>
+              <value>baseline</value>
+            </choice>
+          </attribute>
+        </optional>
         <choice>
           <zeroOrMore>
             <choice>
@@ -922,6 +947,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -961,9 +989,6 @@
   </define>
   <define name="content-subsection">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Content-Section"/>
     </element>
   </define>
@@ -992,6 +1017,9 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
@@ -1011,9 +1039,6 @@
   </define>
   <define name="clause">
     <element name="clause">
-      <optional>
-        <attribute name="type"/>
-      </optional>
       <ref name="Clause-Section"/>
     </element>
   </define>
@@ -1042,18 +1067,24 @@
         </choice>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="type"/>
+    </optional>
     <optional>
       <ref name="section-title"/>
     </optional>
     <group>
-      <group>
-        <zeroOrMore>
-          <ref name="BasicBlock"/>
-        </zeroOrMore>
-        <zeroOrMore>
-          <ref name="note"/>
-        </zeroOrMore>
-      </group>
+      <choice>
+        <group>
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="note"/>
+          </zeroOrMore>
+        </group>
+        <ref name="amend"/>
+      </choice>
       <zeroOrMore>
         <choice>
           <ref name="clause-subsection"/>
@@ -1180,6 +1211,9 @@
       <optional>
         <attribute name="script"/>
       </optional>
+      <optional>
+        <attribute name="type"/>
+      </optional>
       <optional>
         <attribute name="obligation">
           <choice>
@@ -1501,4 +1535,79 @@
       <ref name="CitationType"/>
     </element>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <optional>
+        <attribute name="id">
+          <data type="ID"/>
+        </attribute>
+      </optional>
+      <attribute name="change">
+        <choice>
+          <value>add</value>
+          <value>modify</value>
+          <value>delete</value>
+        </choice>
+      </attribute>
+      <optional>
+        <attribute name="path"/>
+      </optional>
+      <optional>
+        <attribute name="path_end"/>
+      </optional>
+      <optional>
+        <attribute name="title"/>
+      </optional>
+      <optional>
+        <element name="location">
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <zeroOrMore>
+        <ref name="autonumber"/>
+      </zeroOrMore>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="newcontent">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+      <optional>
+        <element name="description">
+          <zeroOrMore>
+            <ref name="BasicBlock"/>
+          </zeroOrMore>
+        </element>
+      </optional>
+    </element>
+  </define>
+  <define name="autonumber">
+    <element name="autonumber">
+      <attribute name="type">
+        <choice>
+          <value>requirement</value>
+          <value>recommendation</value>
+          <value>permission</value>
+          <value>table</value>
+          <value>figure</value>
+          <value>admonition</value>
+          <value>formula</value>
+          <value>sourcecode</value>
+          <value>example</value>
+          <value>note</value>
+        </choice>
+      </attribute>
+      <text/>
+    </element>
+  </define>
 </grammar>

data/lib/isodoc/iho/base_convert.rb

@@ -1,16 +1,6 @@
-require_relative "xref"
-
 module IsoDoc
   module IHO
     module BaseConvert
-      def metadata_init(lang, script, labels)
-        @meta = Metadata.new(lang, script, labels)
-      end
-
-      def xref_init(lang, script, klass, labels, options)
-        @xrefs = Xref.new(lang, script, klass, labels, options)
-      end
-
       # terms not defined in standoc
       def error_parse(node, out)
         case node.name
@@ -25,6 +15,127 @@ module IsoDoc
         @meta.commentperiod isoxml, out
         super
       end
+
+      def std_bibitem_entry(list, b, ordinal, biblio)
+        list.p **attr_code(iso_bibitem_entry_attrs(b, biblio)) do |ref|
+          prefix_bracketed_ref(ref, "[#{ordinal}]")
+          standard_citation(ref, b)
+        end
+      end
+
+      def nodes_to_span(n)
+        noko do |xml|
+          xml.span do |s|
+            n&.children&.each { |x| parse(x, s) }
+          end
+        end.join("")
+      end
+
+      def multiplenames_and(names)
+        return "" if names.length == 0
+        return names[0] if names.length == 1
+        return "#{names[0]} and #{names[1]}" if names.length == 2
+        names[0..-2].join(", ") + " and #{names[-1]}"
+      end
+
+      def extract_publisher(b)
+        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
+        abbrs = []
+        names = []
+        c&.each do |c1|
+          n = c1.at(ns("./organization/name")) or next
+          abbrs << (c1.at(ns("./organization/abbreviation")) || n)
+          names << nodes_to_span(n)
+        end
+        return [nil, nil] if names.empty?
+        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
+      end
+
+      def inline_bibitem_ref_code(b)
+        id = b.at(ns("./docidentifier[not(@type = 'DOI' or @type = 'metanorma' "\
+                     "or @type = 'ISSN' or @type = 'ISBN' or @type = 'rfc-anchor')]"))
+        id ||= b.at(ns("./docidentifier[not(@type = 'metanorma')]"))
+        return [nil, id, nil] if id
+        id = Nokogiri::XML::Node.new("docidentifier", b.document)
+        id << "(NO ID)"
+        [nil, id, nil]
+      end
+
+      def extract_edition(b)
+        b&.at(ns("./edition"))&.text
+      end
+
+      def extract_uri(b)
+        b.at(ns("./uri"))
+      end
+
+      def omit_docid_prefix(prefix)
+        return true if prefix == "IHO"
+        super
+      end
+
+      def render_identifier(id)
+        if !id[1].nil? and id[1]["type"] == "IHO"
+          id[1].children = id[1].text.sub(/^IHO /, "")
+        end
+        super
+      end
+
+      def extract_publisher(b)
+        c = b.xpath(ns("./contributor[role/@type = 'publisher'][organization]"))
+        abbrs = []
+        names = []
+        c&.each do |c1|
+          n = c1.at(ns("./organization/name")) or next
+          abbrs << (c1.at(ns("./organization/abbreviation")) || n)
+          names << nodes_to_span(n)
+        end
+        return [nil, nil] if names.empty?
+        return [multiplenames_and(names), (abbrs.map { |x| x.text }).join("/")]
+      end
+
+      def extract_author(b)
+        c = b.xpath(ns("./contributor[role/@type = 'author']"))
+        c = b.xpath(ns("./contributor[role/@type = 'editor']")) if c.empty?
+        return extract_publisher(b)[0] if c.empty?
+        c.map do |c1|
+          c1&.at(ns("./organization/name"))&.text || extract_person_name(c1)
+        end.reject { |e| e.nil? || e.empty? }.join(", ")
+      end
+
+      def extract_person_name(b)
+        p = b.at(ns("./person/name")) or return
+        c = p.at(ns("./completename")) and return c.text
+        s = p&.at(ns("./surname"))&.text or return
+        i = p.xpath(ns("./initial")) and
+          front = i.map { |e| e.text.gsub(/[^[:upper:]]/, "") }.join("")
+        i.empty? and f = p.xpath(ns("./forename")) and
+          front = f.map { |e| e.text[0].upcase }.join("")
+        front ? "#{s} #{front}" : s
+      end
+
+      def is_iho?(b)
+        extract_publisher(b)[1] == "IHO"
+      end
+
+      # [{number}] {docID} edition {edition}: {title}, {author/organization}
+      def standard_citation(out, b)
+        if ftitle = b.at(ns("./formattedref"))
+          ftitle&.children&.each { |n| parse(n, out) }
+        else
+          id = render_identifier(inline_bibitem_ref_code(b))
+          out << id[1] if id[1]
+          ed = extract_edition(b) if is_iho?(b)
+          out << " edition #{ed}" if ed
+          out << ": " if id[1] || ed
+          iso_title(b)&.children&.each { |n| parse(n, out) }
+          out << ", "
+          author = extract_author(b)
+          out << author
+          u = extract_uri(b)
+          out << " (<a href='#{u.text}'>#{u.text}</a>)" if u
+        end
+      end
     end
   end
 end