metanorma-jis 0.5.2 → 0.5.4

data/lib/isodoc/jis/presentation_list.rb

@@ -0,0 +1,72 @@
+module IsoDoc
+  module Jis
+    class PresentationXMLConvert < IsoDoc::Iso::PresentationXMLConvert
+      def ol_depth(node)
+        depth == 1 and return :alphabet
+        :arabic
+      end
+
+         def ol_depth(node)
+      depth = node.ancestors("ol").size + 1
+      @counter.ol_type(node, depth) # defined in Xref::Counter
+    end
+
+         def ul_label_list(_elem)
+      %w(&#xFF0D; &#x30FB;)
+    end
+
+    def ul_label_value(elem)
+      depth = elem.ancestors("ul").size
+      val = ul_label_list(elem)
+      val[(depth - 1) % val.size]
+    end
+
+      # TODO: move the table/figure key processing to Word, not Presentation XML
+      def dl(docxml)
+        super
+        docxml.xpath(ns("//table//dl | //figure//dl")).each do |l|
+          l.at(ns("./dl")) || l.at("./ancestor::xmlns:dl") and next
+          dl_to_para(l)
+        end
+      end
+
+      def dt_dd?(node)
+        %w{dt dd}.include? node.name
+      end
+
+      def dl_to_para(node)
+        ret = dl_to_para_name(node)
+        ret += dl_to_para_terms(node)
+        node.elements.reject { |n| %w(dt dd name fmt-name).include?(n.name) }
+          .each do |x|
+          ret += x.to_xml
+        end
+        dl_id_insert(node, ret)
+      end
+
+      def dl_id_insert(node, ret)
+        a = node.replace(ret)
+        p = a.at("./descendant-or-self::xmlns:p")
+        node["id"] and p << "<bookmark id='#{node['id']}'/>"
+        a.xpath("./descendant-or-self::*[@id = '']").each { |x| x.delete("id") }
+      end
+
+      def dl_to_para_name(node)
+        e = node.at(ns("./fmt-name")) or return ""
+        node.parent.parent["type"] == "participants" and return ""
+        "<p class='ListTitle'>#{e.children.to_xml}</p>"
+      end
+
+      def dl_to_para_terms(node)
+        ret = ""
+        node.elements.select { |n| dt_dd?(n) }.each_slice(2) do |dt, dd|
+          term = strip_para(dt)
+          defn = strip_para(dd)
+          bkmk = dd["id"] ? "<bookmark id='#{dd['id']}'/>" : ""
+          ret += "<p class='dl' id='#{dt['id']}'>#{term}: #{bkmk}#{defn}</p>"
+        end
+        ret
+      end
+    end
+  end
+end

data/lib/isodoc/jis/presentation_xml_convert.rb

@@ -1,6 +1,7 @@
 require_relative "init"
 require "isodoc"
 require_relative "presentation_section"
+require_relative "presentation_list"
 require_relative "../../relaton/render-jis/general"
 
 module IsoDoc
@@ -35,65 +36,12 @@ module IsoDoc
         ret
       end
 
-      def ol_depth(node)
-        depth = node.ancestors("ol").size + 1
-        depth == 1 and return :alphabet
-        :arabic
-      end
-
       def admits(elem)
         elem.xpath(ns(".//semx[@element = 'admitted']")).each do |t|
           t.previous = @i18n.l10n("#{@i18n.admitted}: ")
         end
       end
 
-      # TODO: move the table/figure key processing to Word, not Presentation XML
-      def dl(docxml)
-        super
-        docxml.xpath(ns("//table//dl | //figure//dl")).each do |l|
-          l.at(ns("./dl")) || l.at("./ancestor::xmlns:dl") and next
-          dl_to_para(l)
-        end
-      end
-
-      def dt_dd?(node)
-        %w{dt dd}.include? node.name
-      end
-
-      def dl_to_para(node)
-        ret = dl_to_para_name(node)
-        ret += dl_to_para_terms(node)
-        node.elements.reject { |n| %w(dt dd name fmt-name).include?(n.name) }
-          .each do |x|
-          ret += x.to_xml
-        end
-        dl_id_insert(node, ret)
-      end
-
-      def dl_id_insert(node, ret)
-        a = node.replace(ret)
-        p = a.at("./descendant-or-self::xmlns:p")
-        node["id"] and p << "<bookmark id='#{node['id']}'/>"
-        a.xpath("./descendant-or-self::*[@id = '']").each { |x| x.delete("id") }
-      end
-
-      def dl_to_para_name(node)
-        e = node.at(ns("./fmt-name")) or return ""
-        node.parent.parent["type"] == "participants" and return ""
-        "<p class='ListTitle'>#{e.children.to_xml}</p>"
-      end
-
-      def dl_to_para_terms(node)
-        ret = ""
-        node.elements.select { |n| dt_dd?(n) }.each_slice(2) do |dt, dd|
-          term = strip_para(dt)
-          defn = strip_para(dd)
-          bkmk = dd["id"] ? "<bookmark id='#{dd['id']}'/>" : ""
-          ret += "<p class='dl' id='#{dt['id']}'>#{term}: #{bkmk}#{defn}</p>"
-        end
-        ret
-      end
-
       def strip_para(node)
         node.children.to_xml.gsub(%r{</?p( [^>]*)?>}, "")
       end

data/lib/isodoc/jis/table.rb

@@ -1,18 +1,6 @@
 module IsoDoc
   module Jis
     class WordConvert < IsoDoc::Iso::WordConvert
-      # KILL
-      def make_table_footnote_targetx(out, fnid, fnref)
-        attrs = { id: fnid, class: "TableFootnoteRef" }
-        out.span do |s|
-          s << @i18n.table_footnote
-          out.span **attrs do |a|
-            a << fnref.sub(/(?!<\))$/, ")") # TODO TO Presentation XML
-          end
-          insert_tab(s, 1)
-        end
-      end
-
       def table_title_parse(node, out); end
 
       def table_attrs(node)

data/lib/isodoc/jis/word_convert.rb

@@ -109,26 +109,6 @@ module IsoDoc
         end
       end
 
-      # KILL
-      def footnote_parsex(node, out)
-        return table_footnote_parse(node, out) if @in_table || @in_figure # &&
-
-        fn = node["reference"] || UUIDTools::UUID.random_create.to_s
-        return seen_footnote_parse(node, out, fn) if @seen_footnote.include?(fn)
-
-        @fn_bookmarks[fn] = bookmarkid
-        out.span style: "mso-bookmark:_Ref#{@fn_bookmarks[fn]}" do |s|
-          s.a class: "FootnoteRef", "epub:type": "footnote",
-              href: "#ftn#{fn}" do |a|
-            a.sup { |sup| sup << fn }
-          end
-        end
-        @in_footnote = true
-        @footnotes << make_generic_footnote_text(node, fn)
-        @in_footnote = false
-        @seen_footnote << fn
-      end
-
       def annex(node, out)
         node["commentary"] == "true" and return commentary(node, out)
         amd?(node.document.root) and

data/lib/isodoc/jis/xref.rb

@@ -1,13 +1,16 @@
 module IsoDoc
-  module Jis
-    class Counter < IsoDoc::XrefGen::Counter
+  module XrefGen
+    module OlTypeProvider
       def ol_type(list, depth)
         return list["type"].to_sym if list["type"]
         return :alphabet if depth == 1
-
         @style == :japanese ? :japanese : :arabic
       end
+    end
+  end
 
+  module Jis
+    class Counter < IsoDoc::XrefGen::Counter
       def listlabel(_list, depth)
         case depth
         when 1 then (96 + @num).chr.to_s
@@ -48,13 +51,6 @@ module IsoDoc
         @lang == "ja" ? "の" : super
       end
 
-      # KILL
-      def subfigure_labelx(subfignum)
-        subfignum.zero? and return ""
-        sep = @lang == "ja" ? "の" : " "
-        "#{sep}#{(subfignum + 96).chr})"
-      end
-
       def subfigure_label(subfignum)
         subfignum.zero? and return
         (subfignum + 96).chr
@@ -65,7 +61,7 @@ module IsoDoc
       end
 
       # taken from isodoc to override ISO
-def subfigure_anchor(elem, sublabel, label, klass, container: false)
+      def subfigure_anchor(elem, sublabel, label, klass, container: false)
         figlabel = fig_subfig_label(label, sublabel)
         @anchors[elem["id"]] = anchor_struct(
           figlabel, elem, @labels[klass] || klass.capitalize, klass,
@@ -79,26 +75,16 @@ def subfigure_anchor(elem, sublabel, label, klass, container: false)
         end
       end 
 
-      # KILL
-      def annex_name_lblx(clause, num)
-        obl = "(#{@labels['inform_annex']})"
-        clause["obligation"] == "normative" and
-          obl = "(#{@labels['norm_annex']})"
-        title = Common::case_with_markup(@labels["annex"], "capital",
-                                         @script)
-        "#{title} #{num}<br/>#{obl}"
-      end
-
       def annex_name_lbl(clause, num)
         super.gsub(%r{</?strong>}, "")
       end
 
-def annex_name_anchors1(clause, num, level)
-  super
-  # undo ISO "Clause A.2" in favour of "A.2"
-  level == 2 and
-            @anchors[clause["id"]][:xref] =  semx(clause, num)
-end
+      def annex_name_anchors1(clause, num, level)
+        super
+        # undo ISO "Clause A.2" in favour of "A.2"
+        level == 2 and
+          @anchors[clause["id"]][:xref] =  semx(clause, num)
+      end
 
       def clause_order_main(docxml)
         [
@@ -106,10 +92,10 @@ end
           { path: "//clause[@type = 'scope']" },
           { path: @klass.norm_ref_xpath },
           { path: "//sections/terms | " \
-                  "//sections/clause[descendant::terms]" },
-          { path: "//sections/definitions | " \
-                  "//sections/clause[descendant::definitions][not(descendant::terms)]" },
-          { path: @klass.middle_clause(docxml), multi: true },
+            "//sections/clause[descendant::terms]" },
+        { path: "//sections/definitions | " \
+          "//sections/clause[descendant::definitions][not(descendant::terms)]" },
+        { path: @klass.middle_clause(docxml), multi: true },
         ]
       end
 
@@ -155,12 +141,11 @@ end
       end
 
       def commentary_names(clause)
-        #require "debug" ; binding.b
         preface_name_anchors(clause, 1, clause_title(clause))
         clause.xpath(ns(SUBCLAUSES))
           .each_with_object(clause_counter(0, {})) do |c, i|
-          commentary_names1(c, clause["id"], nil, i.increment(c).print, 2)
-        end
+            commentary_names1(c, clause["id"], nil, i.increment(c).print, 2)
+          end
       end
 
       def commentary_names1(clause, root, parentnum, num, level)
@@ -168,9 +153,9 @@ end
         commentary_name_anchors(clause, lbl, root, level)
         clause.xpath(ns(SUBCLAUSES))
           .each_with_object(clause_counter(0)) do |c, i|
-          commentary_names1(c, root, lbl, i.increment(c).print,
-                            level + 1)
-        end
+            commentary_names1(c, root, lbl, i.increment(c).print,
+                              level + 1)
+          end
       end
 
       def commentary_name_anchors(clause, num, root, level)
@@ -181,44 +166,12 @@ end
             elem: @labels["clause"] }
       end
 
-      # KILL ?
-      def list_item_anchor_namesx(list, list_anchor, depth, prev_label,
-refer_list)
-        c = list_counter(list["start"] ? list["start"].to_i - 1 : 0, {})
-        list.xpath(ns("./li")).each do |li|
-          bare_label, label =
-            list_item_value(li, c, depth,
-                            { list_anchor: list_anchor,
-                              prev_label: prev_label,
-                              refer_list: depth == 1 ? refer_list : nil })
-          li["id"] ||= "_#{UUIDTools::UUID.random_create}"
-          @anchors[li["id"]] =
-                         { label: bare_label,
-                           bare_xref: "#{bare_label})",
-                           xref: "#{label}#{list_item_delim}", type: "listitem",
-                           refer_list: refer_list,
-                           container: list_anchor[:container] }
-          (li.xpath(ns(".//ol")) - li.xpath(ns(".//ol//ol"))).each do |ol|
-            list_item_anchor_names(ol, list_anchor, depth + 1, label,
-                                   refer_list)
-          end
-        end
-      end
-
-      # KILL
-      def list_anchor_names(s)
-        super
-        #require "debug"; binding.b
-      end
-
       def list_item_value(entry, counter, depth, opts)
         if depth > 2
-#          require 'debug'; binding.b
-        label = counter.increment(entry).listlabel(entry.parent, depth)
-        s = semx(entry, label)
+          label = counter.increment(entry).listlabel(entry.parent, depth)
+          s = semx(entry, label)
           base = @c.decode(opts[:prev_label].gsub(%r{<[^>]+>}, "")).split(/\)\s*/) # List a) 1.1.1
           label = "#{base[-1].sub(/^の/,'')}#{clausesep}#{label}"
-          #[label, J=list_item_anchor_label(opts[:prev_label] + delim_wrap(clause_sep) + s, opts[:list_anchor], base[0].sub(/[\p{Zs})]+$/, ""), opts[:refer_list])]
           [label, opts[:prev_label] + delim_wrap(clausesep) + s]
         else
           super

data/lib/metanorma/jis/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">
@@ -1694,16 +1701,22 @@ which can be bookmarks as well as block or section references</a:documentation>
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as a footnote.
 The target of a footnote is the location it is embedded in within the text</a:documentation>
     <element name="fn">
-      <attribute name="reference">
-        <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
-      </attribute>
-      <oneOrMore>
-        <ref name="paragraph">
-          <a:documentation>The content of the footnote</a:documentation>
-        </ref>
-      </oneOrMore>
+      <ref name="FnAttributes"/>
+      <ref name="FnBody"/>
     </element>
   </define>
+  <define name="FnBody">
+    <oneOrMore>
+      <ref name="paragraph">
+        <a:documentation>The content of the footnote</a:documentation>
+      </ref>
+    </oneOrMore>
+  </define>
+  <define name="FnAttributes">
+    <attribute name="reference">
+      <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
+    </attribute>
+  </define>
   <define name="callout">
     <a:documentation>Inline reference to a paragraph or paragraphs, appearing as annotation of source code</a:documentation>
     <element name="callout">

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

@@ -1,13 +1,14 @@
 <?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">
-  <!--
-    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">
+    <!-- ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix -->
+    <!--
+      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)
+    -->
     <define name="BibData">
       <a:documentation>The bibliographic description of a standardisation document</a:documentation>
       <ref name="StandardBibliographicItem"/>
@@ -91,6 +92,9 @@ a standards definition organization</a:documentation>
         <a:documentation>Representation of the identifier for the standardisation document, giving its individual semantic components</a:documentation>
       </ref>
     </zeroOrMore>
+    <ref name="DocumentImages">
+      <a:documentation>Coverpage and other images to be rendered with document</a:documentation>
+    </ref>
   </define>
   <define name="doctype">
     <a:documentation>Classification of the standardisation document</a:documentation>
@@ -268,6 +272,32 @@ and not those document components</a:documentation>
       </optional>
     </element>
   </define>
+  <define name="DocumentImages">
+    <zeroOrMore>
+      <element name="coverpage-image">
+        <a:documentation>Images to be displayed on the coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="innercoverpage-image">
+        <a:documentation>Images to be displayed on the inner coverpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="tocside-image">
+        <a:documentation>Images to be displayed on the Table of Contents page of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+    <zeroOrMore>
+      <element name="backpage-image">
+        <a:documentation>Images to be displayed on the backpage of the document</a:documentation>
+        <ref name="image-no-id"/>
+      </element>
+    </zeroOrMore>
+  </define>
   <define name="StandardBibliographicItem">
     <ref name="BibliographicItem"/>
     <zeroOrMore>

data/lib/metanorma/jis/biblio.rng

@@ -1,23 +1,25 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<!--
-  instantiations of this grammar may replace leaf strings
-  with more elaborated types; e.g. title (text) replaced with
-  title-main, title-intro, title-part; type replaced with
-  enum.
-  
-  some renaming at leaf nodes is permissible
-  
-  obligations can change both from optional to mandatory,
-  and from mandatory to optional; optional elements may
-  be omitted; freely positioned alternatives may be replaced
-  with strict ordering
-  
-  DO NOT introduce a namespace here. We do not want a distinct namespace
-  for these elements, and a distinct namespace for any grammar inheriting
-  these elements; we just want one namespace for any child grammars
-  of this.
--->
 <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">
+  <!--
+    ALERT: we cannot have comments on root element, as they intervene with https://github.com/metanorma/metanorma/issues/437 fix
+    
+    Instantiations of this grammar may replace leaf strings
+    with more elaborated types; e.g. title (text) replaced with
+    title-main, title-intro, title-part; type replaced with
+    enum.
+    
+    Some renaming at leaf nodes is permissible
+    
+    Obligations can change both from optional to mandatory,
+    and from mandatory to optional; optional elements may
+    be omitted; freely positioned alternatives may be replaced
+    with strict ordering
+    
+    DO NOT introduce a namespace here. We do not want a distinct namespace
+    for these elements, and a distinct namespace for any grammar inheriting
+    these elements; we just want one namespace for any child grammars
+    of this.
+  -->
   <!--
     https://www.myintervals.com/blog/2009/05/20/iso-8601-date-validation-that-doesnt-suck/
     iso8601date = xsd:string { pattern = "([\+-]?\d{4}(?!\d{2}\b))((-?)((0[1-9]|1[0-2])(\3([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])))([T\s]((([01]\d|2[0-3])((:?)[0-5]\d)?|24\:?00)([\.,]\d+(?!:))?)?(\17[0-5]\d([\.,]\d+)?)?([zZ]|([\+-])([01]\d|2[0-3]):?([0-5]\d)?)?)?)?" }
@@ -1241,6 +1243,11 @@ Refer to `BibliographicItem` for definitions</a:documentation>
   </define>
   <define name="formattedref">
     <element name="formattedref">
+      <optional>
+        <attribute name="format">
+          <a:documentation>format of formatted reference; Metanorma assumes references are formatted as Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <oneOrMore>
         <ref name="TextElement"/>
       </oneOrMore>
@@ -1812,6 +1819,11 @@ May be used to differentiate rendering of notes in bibliographies</a:documentati
     <a:documentation>Abstract of bibliographic item</a:documentation>
     <element name="abstract">
       <ref name="LocalizedStringAttributes"/>
+      <optional>
+        <attribute name="format">
+          <a:documentation>What format the formatted abstract is in. In Metanorma, assumed to be Metanorma XML</a:documentation>
+        </attribute>
+      </optional>
       <choice>
         <oneOrMore>
           <ref name="BasicBlockNoId">