metanorma-plateau 0.2.2 → 1.0.1

data/lib/isodoc/plateau/presentation_xml_convert.rb

@@ -79,6 +79,88 @@ module IsoDoc
         @iso.ol_depth(node)
       end
 
+      # how many columns in the table?
+      def table_col_count(table)
+        cols = 0
+        table&.at(ns(".//tr"))&.xpath(ns("./td | ./th"))&.each do |td|
+          cols += (td["colspan"] ? td["colspan"].to_i : 1)
+        end
+        cols
+      end
+
+      # if there is already a full-row cell at the start of tfoot, use that to move content into
+      # else create a full-row cell at the start of tfoot
+      def initial_tfoot_cell(node)
+        colspan = table_col_count(node)
+        tfoot_start = node.at(ns("./tfoot/tr/td"))
+        if !tfoot_start
+          node.at(ns("./tbody")).after("<tfoot><tr><td colspan='#{colspan}'> </td></tr></tfoot>").first
+          tfoot_start = node.at(ns("./tfoot/tr/td"))
+        end
+        if tfoot_start["colspan"] != colspan.to_s
+          tfoot_start.parent.previous = "<tr><td colspan='#{colspan}'> </td></tr>"
+          tfoot_start = node.at(ns("./tfoot/tr/td"))
+        end
+        tfoot_start
+      end
+
+      # if there is already a full-row cell at the end of tfoot, use that to move content into
+      # else create a full-row cell at the end of tfoot
+      def final_tfoot_cell(node)
+        colspan = table_col_count(node)
+        tfoot_start = node.at(ns("./tfoot/tr[last()]/td"))
+        if !tfoot_start
+          node.at(ns("./tbody")).after("<tfoot><tr><td colspan='#{colspan}'> </td></tr></tfoot>").first
+          tfoot_start = node.at(ns("./tfoot/tr[last()]/td"))
+        end
+        if tfoot_start["colspan"] != colspan.to_s
+          tfoot_start.parent.next = "<tr><td colspan='#{colspan}'> </td></tr>"
+          tfoot_start = node.at(ns("./tfoot/tr[last()]/td"))
+        end
+        tfoot_start
+      end
+
+      def table1(node)
+        super
+        # move dl, notes, footnotes, source, fmt-footnote-container inside tfoot
+        if node.at(ns("./dl"))
+          tf = initial_tfoot_cell(node)
+          node.xpath(ns("./dl")).reverse_each do |x|
+            tf.children.first.previous = x.remove
+          end
+        end
+        if node.at(ns("./note | ./source | ./example | ./fmt-footnote-container"))
+          tf = final_tfoot_cell(node)
+          node.xpath(ns("./example")).each { |x| tf.children.last.next = x.remove }
+          node.xpath(ns("./note")).each { |x| tf.children.last.next = x.remove }
+          node.xpath(ns("./fmt-footnote-container")).each { |x| tf.children.last.next = x.remove }
+          node.xpath(ns("./source")).each do |x|
+            tf.children.last.next = x.remove
+          end
+        end
+      end
+
+      # Undo JIS encoding of figure and table dl as paragraphs
+      def dl(docxml)
+        docxml.xpath(ns("//dl")).each { |f| dl1(f) }
+        docxml.xpath(ns("//table//dl | //figure//dl")).each do |l|
+          l.at(ns("./dl")) || l.at("./ancestor::xmlns:dl") and next
+          table_key(l)
+        end
+      end
+
+      # Insert localised colon at start of dd in table and figure key,
+      # replacing JIS Word <p class='dl' id='#{dt['id']}'>#{term}: #{bkmk}#{defn}</p>
+      # with <dt>{term}</dt> <dd>: {defn}<dd>; the space should be stripped and
+      # the colon double-width for Japanese text
+      def table_key(node)
+        node.xpath(ns(".//dd")).each do |dd|
+          text_node = dd.xpath(".//text()[normalize-space()]").first or next
+          colon = %w(zh ja ko).include?(@lang) ? "：": ": "
+          text_node.previous = "<span class='fmt-dt-delim'>#{colon}</span>"
+        end
+      end
+
       include Init
     end
   end

data/lib/metanorma/plateau/basicdoc.rng

@@ -382,33 +382,7 @@ in a document (e.g. sourcecode annotations)</a:documentation>
     <a:documentation>Block intended to capture reviewer comments about some text in the document</a:documentation>
     <element name="review">
       <ref name="RequiredId"/>
-      <attribute name="reviewer">
-        <a:documentation>The party who has offered the comment</a:documentation>
-      </attribute>
-      <optional>
-        <attribute name="type">
-          <a:documentation>The type of reviewer comment</a:documentation>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="date">
-          <a:documentation>The date when the comment was made</a:documentation>
-          <data type="dateTime"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="from">
-          <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
-If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="to">
-          <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
-          <data type="IDREF"/>
-        </attribute>
-      </optional>
+      <ref name="ReviewAttributes"/>
       <oneOrMore>
         <ref name="paragraph">
           <a:documentation>Reviewer comments content</a:documentation>
@@ -416,6 +390,35 @@ If not provided, the comment applies in the vicinity of the place it has been in
       </oneOrMore>
     </element>
   </define>
+  <define name="ReviewAttributes">
+    <attribute name="reviewer">
+      <a:documentation>The party who has offered the comment</a:documentation>
+    </attribute>
+    <optional>
+      <attribute name="type">
+        <a:documentation>The type of reviewer comment</a:documentation>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="date">
+        <a:documentation>The date when the comment was made</a:documentation>
+        <data type="dateTime"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="from">
+        <a:documentation>Identifier for the start of the text or point in the text to which the comment applies.
+If not provided, the comment applies in the vicinity of the place it has been inserted into the text</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="to">
+        <a:documentation>Identifier for the end of the text to which the comment applies</a:documentation>
+        <data type="IDREF"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes">
     <optional>
       <attribute name="unnumbered">
@@ -857,6 +860,7 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
   <define name="tr">
     <a:documentation>Sequence of cells to be displayed as a row in a table</a:documentation>
     <element name="tr">
+      <ref name="TrAttributes"/>
       <oneOrMore>
         <choice>
           <ref name="td">
@@ -869,6 +873,9 @@ in case the table cannot be rendered accessibly (HTML 5)</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="TrAttributes">
+    <empty/>
+  </define>
   <define name="tr-no-id">
     <a:documentation>Sequence of cells to be displayed as a row in a table: optional ID attributes recursively (for use in Relaton, metadata)</a:documentation>
     <element name="tr">

data/lib/metanorma/plateau/isodoc.rng

@@ -17,7 +17,7 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v2.0.0 -->
+<!-- VERSION v2.0.2 -->
 <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">
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
@@ -33,6 +33,15 @@
         </zeroOrMore>
       </element>
     </define>
+    <define name="fn" combine="interleave">
+      <optional>
+        <attribute name="hiddenref">
+          <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
+This is done if the footnote reference is already presented in some other form, e.g. within a figure image.</a:documentation>
+          <data type="boolean"/>
+        </attribute>
+      </optional>
+    </define>
     <define name="index-primary">
       <element name="primary">
         <oneOrMore>
@@ -414,6 +423,21 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </choice>
     </define>
+    <define name="TdAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="ThAttributes" combine="interleave">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
+    <define name="TrAttributes">
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </define>
     <define name="table-note">
       <element name="note">
         <ref name="OptionalId"/>
@@ -1263,6 +1287,11 @@ numbers</a:documentation>
           <a:documentation>Colophon or postface material</a:documentation>
         </ref>
       </optional>
+      <optional>
+        <ref name="review-container">
+          <a:documentation>Annotations to the document</a:documentation>
+        </ref>
+      </optional>
     </element>
   </define>
   <define name="misccontainer">
@@ -1273,6 +1302,13 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="review-container">
+    <element name="review-container">
+      <oneOrMore>
+        <ref name="review"/>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="preface">
     <element name="preface">
       <oneOrMore>

data/lib/metanorma/plateau/plateau.rng

@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<grammar ns='https://www.metanorma.org/ns/standoc' xmlns="http://relaxng.org/ns/structure/1.0">
+<grammar ns='https://www.metanorma.org/ns/standoc' xmlns:a="http://relaxng.org/ns/compatibility/annotations/1.0" xmlns="http://relaxng.org/ns/structure/1.0">
   <!--
     VERSION v1.2.1
     default namespace = "https://www.metanorma.com/ns/jis"
@@ -57,6 +57,49 @@
         <ref name="source"/>
       </zeroOrMore>
     </define>
+    <define name="TableBody">
+      <optional>
+        <ref name="colgroup">
+          <a:documentation>The widths of the columns in the table</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="tname">
+          <a:documentation>Caption for the table</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="thead">
+          <a:documentation>Table rows constituting the table header</a:documentation>
+        </ref>
+      </optional>
+      <ref name="tbody">
+        <a:documentation>Table rows constituting the table body</a:documentation>
+      </ref>
+      <optional>
+        <ref name="tfoot">
+          <a:documentation>Table rows constituting the table footer</a:documentation>
+        </ref>
+      </optional>
+      <optional>
+        <ref name="dl">
+          <a:documentation>Definitions list defining any symbols used in the table</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="table-note">
+          <a:documentation>Notes specific to this block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <zeroOrMore>
+        <ref name="example">
+          <a:documentation>Examples specific to this block</a:documentation>
+        </ref>
+      </zeroOrMore>
+      <ref name="TermSource">
+        <a:documentation>A source for the table</a:documentation>
+      </ref>
+    </define>
     <!--
       We display the Normative References between scope and terms; but to keep the
       grammar simple, we keep the references together

data/lib/metanorma/plateau/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Plateau
-    VERSION = "0.2.2".freeze
+    VERSION = "1.0.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plateau
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-03-04 00:00:00.000000000 Z
+date: 2025-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-jis