metanorma-jis 0.5.3 → 0.5.4

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

@@ -1701,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">

data/lib/metanorma/jis/isodoc.rng

@@ -1,24 +1,27 @@
 <?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.
--->
-<!-- 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">
+<!-- VERSION v2.0.3 -->
+
+  <!--
+    ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
+    
+    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.
+  -->
   <include href="reqt.rng"/>
   <include href="basicdoc.rng">
     <define name="amend">
@@ -33,15 +36,6 @@
         </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>
@@ -423,20 +417,12 @@ 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>
+      <optional>
+        <attribute name="style">
+          <a:documentation>CSS style: only background-color supported</a:documentation>
+        </attribute>
+      </optional>
     </define>
     <define name="table-note">
       <element name="note">
@@ -500,6 +486,22 @@ gives an explicit page orientation</a:documentation>
     </define>
   </include>
   <!-- end overrides -->
+  <define name="FnAttributes" 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="TdAttributes" combine="interleave">
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color supported</a:documentation>
+      </attribute>
+    </optional>
+  </define>
   <define name="NumberingAttributes" combine="interleave">
     <optional>
       <attribute name="number">
@@ -678,6 +680,13 @@ titlecase, or lowercase</a:documentation>
       </attribute>
     </optional>
   </define>
+  <define name="Basic-Section-Attributes" combine="interleave">
+    <optional>
+      <attribute name="obligation">
+        <ref name="ObligationType"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="ObligationType">
     <a:documentation>The force of a clause in a standard document: whether it has normative or informative effect</a:documentation>
     <choice>
@@ -1192,13 +1201,6 @@ numbers</a:documentation>
       </attribute>
     </optional>
   </define>
-  <define name="Basic-Section-Attributes" combine="interleave">
-    <optional>
-      <attribute name="obligation">
-        <ref name="ObligationType"/>
-      </attribute>
-    </optional>
-  </define>
   <define name="reference-clause">
     <a:documentation>References clause with recursive nesting</a:documentation>
     <element name="clause">
@@ -1239,7 +1241,7 @@ numbers</a:documentation>
       </choice>
     </attribute>
     <attribute name="flavor">
-      <a:documentation>Metanorma flavor, indicating SDO whose requiremnts the realisation aligns to</a:documentation>
+      <a:documentation>Metanorma flavor, indicating SDO whose requirements the realisation aligns to</a:documentation>
     </attribute>
   </define>
   <define name="standard-document">
@@ -1249,6 +1251,11 @@ numbers</a:documentation>
       <ref name="bibdata">
         <a:documentation>Bibliographic description of the document itself, expressed in the Relaton model</a:documentation>
       </ref>
+      <zeroOrMore>
+        <ref name="termdocsource">
+          <a:documentation>Source for term definitions in the document</a:documentation>
+        </ref>
+      </zeroOrMore>
       <optional>
         <ref name="misccontainer">
           <a:documentation>Extension point for extraneous elements that need to be added to standards document as data</a:documentation>
@@ -1259,34 +1266,7 @@ numbers</a:documentation>
           <a:documentation>Front matter that is repeated at the start of documents issued from an SDO, with content not specific to the document</a:documentation>
         </ref>
       </optional>
-      <optional>
-        <ref name="preface">
-          <a:documentation>Prefatory sections</a:documentation>
-        </ref>
-      </optional>
-      <ref name="sections">
-        <a:documentation>Main body of document</a:documentation>
-      </ref>
-      <zeroOrMore>
-        <ref name="annex">
-          <a:documentation>Annex sections</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="bibliography">
-          <a:documentation>Bibliographic sections</a:documentation>
-        </ref>
-      </optional>
-      <zeroOrMore>
-        <ref name="indexsect">
-          <a:documentation>Index of the document</a:documentation>
-        </ref>
-      </zeroOrMore>
-      <optional>
-        <ref name="colophon">
-          <a:documentation>Colophon or postface material</a:documentation>
-        </ref>
-      </optional>
+      <ref name="DocumentBody"/>
       <optional>
         <ref name="review-container">
           <a:documentation>Annotations to the document</a:documentation>
@@ -1294,6 +1274,36 @@ numbers</a:documentation>
       </optional>
     </element>
   </define>
+  <define name="DocumentBody">
+    <optional>
+      <ref name="preface">
+        <a:documentation>Prefatory sections</a:documentation>
+      </ref>
+    </optional>
+    <ref name="sections">
+      <a:documentation>Main body of document</a:documentation>
+    </ref>
+    <zeroOrMore>
+      <ref name="annex">
+        <a:documentation>Annex sections</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="bibliography">
+        <a:documentation>Bibliographic sections</a:documentation>
+      </ref>
+    </optional>
+    <zeroOrMore>
+      <ref name="indexsect">
+        <a:documentation>Index of the document</a:documentation>
+      </ref>
+    </zeroOrMore>
+    <optional>
+      <ref name="colophon">
+        <a:documentation>Colophon or postface material</a:documentation>
+      </ref>
+    </optional>
+  </define>
   <define name="misccontainer">
     <a:documentation>Elements added to metanorma-extension are open-ended, and constitute source data</a:documentation>
     <element name="metanorma-extension">
@@ -1608,9 +1618,7 @@ used in document amendments</a:documentation>
   <define name="term">
     <a:documentation>Terminology entry with its definition</a:documentation>
     <element name="term">
-      <ref name="OptionalId"/>
-      <ref name="LocalizedStringAttributes"/>
-      <ref name="BlockAttributes"/>
+      <ref name="TermAttributes"/>
       <oneOrMore>
         <ref name="preferred">
           <a:documentation>One or more names under which the term being defined is canonically known</a:documentation>
@@ -1662,6 +1670,11 @@ used in document amendments</a:documentation>
       </ref>
     </element>
   </define>
+  <define name="TermAttributes">
+    <ref name="OptionalId"/>
+    <ref name="LocalizedStringAttributes"/>
+    <ref name="BlockAttributes"/>
+  </define>
   <define name="preferred">
     <element name="preferred">
       <ref name="Designation"/>
@@ -2323,26 +2336,32 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
     </element>
   </define>
   <define name="ul_li">
-    <a:documentation>Unorderd list item for standards documents</a:documentation>
+    <a:documentation>Unordered list item for standards documents</a:documentation>
     <element name="li">
       <ref name="OptionalId"/>
-      <optional>
-        <attribute name="uncheckedcheckbox">
-          <a:documentation>Include a checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <optional>
-        <attribute name="checkedcheckbox">
-          <a:documentation>Check the checkbox for the list item</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
-      <oneOrMore>
-        <ref name="BasicBlock"/>
-      </oneOrMore>
+      <ref name="UlLiAttributes"/>
+      <ref name="UlLiBody"/>
     </element>
   </define>
+  <define name="UlLiBody">
+    <oneOrMore>
+      <ref name="BasicBlock"/>
+    </oneOrMore>
+  </define>
+  <define name="UlLiAttributes">
+    <optional>
+      <attribute name="uncheckedcheckbox">
+        <a:documentation>Include a checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+    <optional>
+      <attribute name="checkedcheckbox">
+        <a:documentation>Check the checkbox for the list item</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
+  </define>
   <define name="floating-title">
     <a:documentation>A floating title, outside of the clause hierarchy of the document</a:documentation>
     <element name="floating-title">