metanorma-iho 0.8.5 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 605494aaa8ff19ab9e36a002b122d88f23cd6f34126e2706aaad621722ffa7bf
-  data.tar.gz: a175eb6e4e50c49f8d527690a49bedca15e4bb7bb4a98e6f68d5a43320510e78
+  metadata.gz: c4b64c1bec1866b211de1d7843e3c50d366771c5a6e960e50e1a1b26f573b416
+  data.tar.gz: d3e48770e6280f8567d5a6269d84fbf83d4c1a01d51210bb8728494648051ae5
 SHA512:
-  metadata.gz: 475b4726dbbcd9313d161b80f721af157b0ea639fe8e95faf6c3df9d1869cbd68d9a54f7964e0d0160e7c90b1dcf8c43693154ecc109fcd1c533cbbcfc766f99
-  data.tar.gz: 6cebf782f12345e259b11437aa5dc30f54623f0cbebe5179e30ec5f97e2e93418723bb91360e9da4eabd25254cf26c2da569b6d00d514a97fe33670ec9be7351
+  metadata.gz: 7db918b6bebfaff6f3cc206157032322a0da07a6d8e2999d755889a97487592cacf28e6cfb816dc925fd4d03d8a3f58a58af2298e850b5bf503ccd08345f59eb
+  data.tar.gz: f7e68d99c8f96222f0b07aeab5b3f9fc0082d3894fefbace516fc921b78dfe52db9ecfa53e22275a77d5c4a8fb42e6a82c2e81ca48453537761e1c286f757457

data/Gemfile

@@ -4,12 +4,6 @@ Encoding.default_internal = Encoding::UTF_8
 source "https://rubygems.org"
 git_source(:github) { |repo| "https://github.com/#{repo}" }
 
-group :development, :test do
-  gem "rspec"
-end
-
-if File.exist? "Gemfile.devel"
-  eval File.read("Gemfile.devel"), nil, "Gemfile.devel" # rubocop:disable Security/Eval
-end
-
 gemspec
+
+eval_gemfile("Gemfile.devel") rescue nil

data/lib/isodoc/iho/html/htmlstyle.css

@@ -139,6 +139,14 @@ a.FootnoteRef, span.FootnoteRef {
   color: red;
   text-decoration: line-through; }
 
+ruby {
+  ruby-position: over;
+  -webkit-ruby-position: before; }
+
+ruby ruby {
+  ruby-position: under;
+  -webkit-ruby-position: after; }
+
 /* code highlighting with line numbers */
 table.rouge-line-table td.rouge-gutter {
   -moz-user-select: none;

data/lib/isodoc/iho/i18n-en.yaml

@@ -1,3 +1,4 @@
 table_of_contents: Contents
 clause: Chapter
 subclause: Section
+dochistory: Document History

data/lib/isodoc/iho/iho.specification.xsl

@@ -9365,14 +9365,16 @@
 
 	<xsl:template match="*[local-name() = 'annex']">
 		<fo:block break-after="page"/>
-		<fo:block id="{@id}">
+		<fo:block>
 
 			<xsl:call-template name="setBlockSpanAll"/>
 
 			<xsl:call-template name="refine_annex_style"/>
 
 		</fo:block>
-		<xsl:apply-templates/>
+		<fo:block id="{@id}">
+			<xsl:apply-templates/>
+		</fo:block>
 	</xsl:template>
 
 	<xsl:template name="refine_annex_style">
@@ -10286,10 +10288,10 @@
 
 	<xsl:variable name="toc_level">
 		<!-- https://www.metanorma.org/author/ref/document-attributes/ -->
-		<xsl:variable name="htmltoclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'HTML TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- :htmltoclevels  Number of table of contents levels to render in HTML/PDF output; used to override :toclevels:-->
+		<xsl:variable name="pdftoclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'PDF TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- :toclevels-pdf  Number of table of contents levels to render in PDF output; used to override :toclevels:-->
 		<xsl:variable name="toclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- Number of table of contents levels to render -->
 		<xsl:choose>
-			<xsl:when test="$htmltoclevels != ''"><xsl:value-of select="number($htmltoclevels)"/></xsl:when> <!-- if there is value in xml -->
+			<xsl:when test="$pdftoclevels != ''"><xsl:value-of select="number($pdftoclevels)"/></xsl:when> <!-- if there is value in xml -->
 			<xsl:when test="$toclevels != ''"><xsl:value-of select="number($toclevels)"/></xsl:when>  <!-- if there is value in xml -->
 			<xsl:otherwise><!-- default value -->
 				2

data/lib/isodoc/iho/iho.standard.xsl

@@ -9365,14 +9365,16 @@
 
 	<xsl:template match="*[local-name() = 'annex']">
 		<fo:block break-after="page"/>
-		<fo:block id="{@id}">
+		<fo:block>
 
 			<xsl:call-template name="setBlockSpanAll"/>
 
 			<xsl:call-template name="refine_annex_style"/>
 
 		</fo:block>
-		<xsl:apply-templates/>
+		<fo:block id="{@id}">
+			<xsl:apply-templates/>
+		</fo:block>
 	</xsl:template>
 
 	<xsl:template name="refine_annex_style">
@@ -10286,10 +10288,10 @@
 
 	<xsl:variable name="toc_level">
 		<!-- https://www.metanorma.org/author/ref/document-attributes/ -->
-		<xsl:variable name="htmltoclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'HTML TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- :htmltoclevels  Number of table of contents levels to render in HTML/PDF output; used to override :toclevels:-->
+		<xsl:variable name="pdftoclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'PDF TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- :toclevels-pdf  Number of table of contents levels to render in PDF output; used to override :toclevels:-->
 		<xsl:variable name="toclevels" select="normalize-space(//*[local-name() = 'metanorma-extension']/*[local-name() = 'presentation-metadata'][*[local-name() = 'name']/text() = 'TOC Heading Levels']/*[local-name() = 'value'])"/> <!-- Number of table of contents levels to render -->
 		<xsl:choose>
-			<xsl:when test="$htmltoclevels != ''"><xsl:value-of select="number($htmltoclevels)"/></xsl:when> <!-- if there is value in xml -->
+			<xsl:when test="$pdftoclevels != ''"><xsl:value-of select="number($pdftoclevels)"/></xsl:when> <!-- if there is value in xml -->
 			<xsl:when test="$toclevels != ''"><xsl:value-of select="number($toclevels)"/></xsl:when>  <!-- if there is value in xml -->
 			<xsl:otherwise><!-- default value -->
 				2

data/lib/isodoc/iho/presentation_xml_convert.rb

@@ -34,6 +34,93 @@ _bib)
                      %w(), doc)
       end
 
+      def bibdata(docxml)
+        super
+        dochistory(docxml)
+      end
+
+      UPDATE_RELATIONS = <<~XPATH.freeze
+        //bibdata/relation[@type = 'updatedBy' or @type = 'merges' or @type = 'splits' or @type = 'hasDraft']/bibitem
+      XPATH
+
+      def dochistory(docxml)
+        updates = docxml.xpath(ns(UPDATE_RELATIONS))
+        updates.empty? and return
+        pref = preface_insert_point(docxml)
+        generate_dochistory(updates, pref)
+      end
+
+      def preface_insert_point(docxml)
+        docxml.at(ns("//preface")) || docxml.at(ns("//sections"))
+          .add_previous_sibling("<preface> </preface>").first
+      end
+
+      def generate_dochistory(updates, pref)
+        ret = updates.map { |u| generate_dochistory_row(u) }.flatten.join("\n")
+        pref << <<~XML
+          <clause id='_#{UUIDTools::UUID.random_create}'>
+          <title>#{@i18n.dochistory}</title>
+          <table unnumbered="true"><thead>
+          <tr><th>Version Number</th><th>Date</th><th>Author</th><th>Description</th></tr>
+          </thead><tbody>
+          #{ret}
+          </tbody></table></clause>
+        XML
+      end
+
+      def generate_dochistory_row(item)
+        e = item.at(ns("./edition"))&.text
+        date = dochistory_date(item)
+        c = dochistory_contributors(item)
+        desc = dochistory_description(item)
+        "<tr><td>#{e}</td><td>#{date}</td><td>#{c}</td><td>#{desc}</td></tr>"
+      end
+
+      def dochistory_date(item)
+        d = item.at(ns("./date[@type = 'updated']")) ||
+          item.at(ns("./date[@type = 'published']")) ||
+          item.at(ns("./date[@type = 'issued']")) or return ""
+        ddMMMyyyy(d.text.strip)
+      end
+
+      def dochistory_contributors(item)
+        item.xpath(ns("./contributor")).map do |c|
+          dochistory_contributor(c)
+        end.join(", ")
+      end
+
+      def dochistory_contributor(contrib)
+        ret = contrib.at("./organization/abbreviation") ||
+          contrib.at("./organization/subdivision") ||
+          contrib.at("./organization/name") ||
+          contrib.at("./person/name/abbreviation") ||
+          contrib.at("./person/name/completename")
+        ret and return ret.text
+        format_personalname(contrib)
+      end
+
+      def format_personalname(contrib)
+        Relaton::Render::General.new(template: { book: "{{ creatornames }}" })
+          .render("<bibitem type='book'>#{contrib.to_xml}</bibitem>")
+      end
+
+      def dochistory_description(item)
+        d = item.at(ns("./amend/description")) or return ""
+        d.children.to_xml
+      end
+
+      def ddMMMyyyy(isodate)
+        isodate.nil? and return nil
+        arr = isodate.split("-")
+        if arr.size == 1 && (/^\d+$/.match isodate)
+          Date.new(*arr.map(&:to_i)).strftime("%Y")
+        elsif arr.size == 2
+          Date.new(*arr.map(&:to_i)).strftime("%B %Y")
+        else
+          Date.parse(isodate).strftime("%d %B %Y")
+        end
+      end
+
       include Init
     end
   end

data/lib/metanorma/iho/basicdoc.rng

@@ -95,8 +95,89 @@
       <ref name="pagebreak"/>
       <ref name="hr"/>
       <ref name="bookmark"/>
+      <ref name="amend"/>
     </choice>
   </define>
+  <define name="amend">
+    <element name="amend">
+      <ref name="AmendType"/>
+    </element>
+  </define>
+  <define name="AmendType">
+    <optional>
+      <attribute name="id">
+        <data type="ID"/>
+      </attribute>
+    </optional>
+    <attribute name="change">
+      <choice>
+        <value>add</value>
+        <value>modify</value>
+        <value>delete</value>
+        <value>replace</value>
+      </choice>
+    </attribute>
+    <optional>
+      <attribute name="path"/>
+    </optional>
+    <optional>
+      <attribute name="path_end"/>
+    </optional>
+    <optional>
+      <attribute name="title"/>
+    </optional>
+    <optional>
+      <element name="location">
+        <zeroOrMore>
+          <choice>
+            <ref name="locality"/>
+            <ref name="localityStack"/>
+          </choice>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="description">
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <optional>
+      <element name="newcontent">
+        <optional>
+          <attribute name="id">
+            <data type="ID"/>
+          </attribute>
+        </optional>
+        <zeroOrMore>
+          <ref name="BasicBlock"/>
+        </zeroOrMore>
+      </element>
+    </optional>
+    <zeroOrMore>
+      <ref name="classification"/>
+    </zeroOrMore>
+    <zeroOrMore>
+      <ref name="contributor"/>
+    </zeroOrMore>
+  </define>
+  <define name="classification">
+    <element name="classification">
+      <ref name="classification_tag"/>
+      <ref name="classification_value"/>
+    </element>
+  </define>
+  <define name="classification_tag">
+    <element name="tag">
+      <text/>
+    </element>
+  </define>
+  <define name="classification_value">
+    <element name="value">
+      <text/>
+    </element>
+  </define>
   <define name="paragraph">
     <element name="p">
       <ref name="ParagraphType"/>
@@ -715,27 +796,36 @@
   </define>
   <define name="ruby">
     <element name="ruby">
-      <zeroOrMore>
-        <choice>
-          <ref name="PureTextElement"/>
-          <ref name="rp"/>
-          <ref name="rt"/>
-        </choice>
-      </zeroOrMore>
+      <choice>
+        <ref name="ruby_pronunciation"/>
+        <ref name="ruby_annotation"/>
+      </choice>
+      <choice>
+        <text/>
+        <ref name="ruby"/>
+      </choice>
     </element>
   </define>
-  <define name="rp">
-    <element name="rp">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_pronunciation">
+    <element name="pronunciation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
-  <define name="rt">
-    <element name="rt">
-      <zeroOrMore>
-        <ref name="PureTextElement"/>
-      </zeroOrMore>
+  <define name="ruby_annotation">
+    <element name="annotation">
+      <attribute name="value"/>
+      <optional>
+        <attribute name="script"/>
+      </optional>
+      <optional>
+        <attribute name="lang"/>
+      </optional>
     </element>
   </define>
   <define name="br">
@@ -930,18 +1020,12 @@
     </optional>
     <optional>
       <attribute name="width">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
       <attribute name="height">
-        <choice>
-          <data type="int"/>
-          <value>auto</value>
-        </choice>
+        <ref name="ImageSize"/>
       </attribute>
     </optional>
     <optional>
@@ -956,6 +1040,14 @@
       </attribute>
     </optional>
   </define>
+  <define name="ImageSize">
+    <choice>
+      <data type="string">
+        <param name="pattern">\d+([.]\d+)?(%?)</param>
+      </data>
+      <value>auto</value>
+    </choice>
+  </define>
   <define name="video">
     <element name="video">
       <attribute name="id">

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

@@ -9,11 +9,42 @@
   -->
   <include href="biblio.rng">
     <define name="BibData">
-      <ref name="BibliographicItem"/>
+      <ref name="StandardBibliographicItem"/>
       <optional>
         <ref name="ext"/>
       </optional>
     </define>
+    <define name="docrelation">
+      <element name="relation">
+        <attribute name="type">
+          <ref name="DocRelationType"/>
+        </attribute>
+        <optional>
+          <element name="description">
+            <ref name="FormattedString"/>
+          </element>
+        </optional>
+        <element name="bibitem">
+          <ref name="StandardReducedBibliographicItem"/>
+        </element>
+        <choice>
+          <zeroOrMore>
+            <ref name="locality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="localityStack"/>
+          </zeroOrMore>
+        </choice>
+        <choice>
+          <zeroOrMore>
+            <ref name="sourceLocality"/>
+          </zeroOrMore>
+          <zeroOrMore>
+            <ref name="sourceLocalityStack"/>
+          </zeroOrMore>
+        </choice>
+      </element>
+    </define>
   </include>
   <define name="ext">
     <element name="ext">
@@ -161,4 +192,16 @@
       </optional>
     </element>
   </define>
+  <define name="StandardBibliographicItem">
+    <ref name="BibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
+  <define name="StandardReducedBibliographicItem">
+    <ref name="ReducedBibliographicItem"/>
+    <zeroOrMore>
+      <ref name="amend"/>
+    </zeroOrMore>
+  </define>
 </grammar>

data/lib/metanorma/iho/biblio.rng

@@ -241,6 +241,9 @@
     </element>
   </define>
   <define name="FullNameType">
+    <optional>
+      <ref name="name_abbreviation"/>
+    </optional>
     <choice>
       <group>
         <zeroOrMore>
@@ -266,6 +269,11 @@
       <ref name="variantname"/>
     </zeroOrMore>
   </define>
+  <define name="name_abbreviation">
+    <element name="abbreviation">
+      <ref name="LocalizedString"/>
+    </element>
+  </define>
   <define name="prefix">
     <element name="prefix">
       <ref name="LocalizedString"/>
@@ -374,6 +382,16 @@
       <ref name="image"/>
     </element>
   </define>
+  <define name="depiction">
+    <element name="depiction">
+      <optional>
+        <attribute name="scope"/>
+      </optional>
+      <zeroOrMore>
+        <ref name="image"/>
+      </zeroOrMore>
+    </element>
+  </define>
   <define name="NameWithVariants">
     <element name="primary">
       <ref name="LocalizedString"/>
@@ -760,6 +778,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="ReducedBibliographicItem">
     <optional>
@@ -857,6 +878,9 @@
     <optional>
       <ref name="validity"/>
     </optional>
+    <optional>
+      <ref name="depiction"/>
+    </optional>
   </define>
   <define name="btitle">
     <element name="title">

data/lib/metanorma/iho/isodoc.rng

@@ -17,10 +17,19 @@
   these elements; we just want one namespace for any child grammars
   of this.
 -->
-<!-- VERSION v1.2.8 -->
+<!-- VERSION v1.2.12 -->
 <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">
+    <define name="amend">
+      <element name="amend">
+        <ref name="BlockAttributes"/>
+        <ref name="AmendType"/>
+        <zeroOrMore>
+          <ref name="autonumber"/>
+        </zeroOrMore>
+      </element>
+    </define>
     <define name="admonition">
       <element name="admonition">
         <attribute name="type">
@@ -1958,6 +1967,16 @@
           <data type="boolean"/>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="type">
+          <choice>
+            <value>letter</value>
+            <value>symbol</value>
+            <value>formula</value>
+            <value>equation</value>
+          </choice>
+        </attribute>
+      </optional>
       <element name="name">
         <oneOrMore>
           <choice>
@@ -2309,69 +2328,6 @@
       <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>
-          <value>replace</value>
-        </choice>
-      </attribute>
-      <optional>
-        <attribute name="path"/>
-      </optional>
-      <optional>
-        <attribute name="path_end"/>
-      </optional>
-      <optional>
-        <attribute name="title"/>
-      </optional>
-      <ref name="BlockAttributes"/>
-      <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">
-          <optional>
-            <attribute name="id">
-              <data type="ID"/>
-            </attribute>
-          </optional>
-          <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">

data/lib/metanorma/iho/reqt.rng

@@ -207,20 +207,4 @@
       <value>permission</value>
     </choice>
   </define>
-  <define name="classification">
-    <element name="classification">
-      <ref name="classification_tag"/>
-      <ref name="classification_value"/>
-    </element>
-  </define>
-  <define name="classification_tag">
-    <element name="tag">
-      <text/>
-    </element>
-  </define>
-  <define name="classification_value">
-    <element name="value">
-      <text/>
-    </element>
-  </define>
 </grammar>

data/lib/metanorma/iho/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module IHO
-    VERSION = "0.8.5".freeze
+    VERSION = "0.9.0".freeze
   end
 end

data/metanorma-iho.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
-  spec.add_dependency "metanorma-generic", "~> 2.5.4"
+  spec.add_dependency "metanorma-generic", "~> 2.6.0"
 
   spec.add_development_dependency "debug"
   spec.add_development_dependency "equivalent-xml", "~> 0.6"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iho
 version: !ruby/object:Gem::Version
-  version: 0.8.5
+  version: 0.9.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-27 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-generic
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.4
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement