metanorma-iho 1.1.9 → 1.2.0

data/lib/isodoc/iho/metadata.rb

@@ -13,6 +13,19 @@ module IsoDoc
         a = xml.at(ns("//bibdata/series[@type = 'main']/abbreviation"))&.text and
           set(:seriesabbr, a)
       end
+
+      def title1(xml, type)
+        xml.at(ns("//bibdata/title[@type='title-#{type}']"))
+          &.children&.to_xml
+      end
+
+      def title(isoxml, _out)
+        set(:doctitle, isoxml.at(ns("//bibdata/title[@type='main']"))
+                                    &.children&.to_xml || "")
+        %w(main appendix annex part supplement).each do |e|
+          t = title1(isoxml, e) and set("#{e}title".to_sym, t)
+        end
+      end
     end
   end
 end

data/lib/metanorma/iho/cleanup.rb

@@ -0,0 +1,46 @@
+module Metanorma
+  module Iho
+    class Converter < Metanorma::Generic::Converter
+      def bibdata_docidentifier_cleanup(isoxml)
+        bibdata_docidentifier_i18n(isoxml)
+        super
+      end
+
+      def bibdata_docidentifier_i18n(isoxml)
+        id, parts = bibdata_docidentifier_i18n_prep(isoxml)
+        parts.empty? and return
+        id_alt = id.dup
+        id.next = id_alt
+        id_alt["type"] = "IHO-parent-document"
+        id_alt.delete("primary")
+        bibdata_docidentifier_enhance(id, parts)
+      end
+
+      def bibdata_docidentifier_i18n_prep(isoxml)
+        id = isoxml.at("//bibdata/docidentifier[@type = 'IHO']")
+        parts = %w(appendixid annexid part supplementid)
+          .each_with_object({}) do |w, m|
+          dn = isoxml.at("//bibdata/ext/structuredidentifier/#{w}") and
+            m[w] = dn.text
+        end
+        [id, parts]
+      end
+
+      ID_LABELS = {
+        appendixid: "Appendix",
+        annexid: "Annex",
+        part: "Part",
+        supplementid: "Supplement",
+      }.freeze
+
+      # not language-specific, just space-delimited
+      def bibdata_docidentifier_enhance(id, parts)
+        ret = %w(part appendixid annexid supplementid)
+          .each_with_object([]) do |w, m|
+          p = parts[w] and m << "#{ID_LABELS[w.to_sym]} #{p}"
+        end
+        id.children = "#{id.text} #{ret.join(' ')}"
+      end
+    end
+  end
+end

data/lib/metanorma/iho/converter.rb

@@ -1,5 +1,7 @@
 require "metanorma/standoc/converter"
 require "metanorma/generic/converter"
+require_relative "cleanup"
+require_relative "front"
 
 module Metanorma
   module Iho
@@ -10,78 +12,6 @@ module Metanorma
         true
       end
 
-      SERIESNAME = {
-        B: "Bathymetric",
-        C: "Capacity Building",
-        M: "Miscellaneous",
-        P: "Periodic",
-        S: "Standards and Specifications",
-      }.freeze
-
-      def metadata_series(node, xml)
-        series = node.attr("series") or return
-        xml.series type: "main" do |s|
-          s.title SERIESNAME[series.to_sym] || "N/A"
-          s.abbreviation series
-        end
-      end
-
-      def metadata_ext(node, ext)
-        super
-        metadata_commentperiod(node, ext)
-      end
-
-      def metadata_commentperiod(node, xml)
-        from = node.attr("comment-from") or return
-        to = node.attr("comment-to")
-        xml.commentperiod do |c|
-          c.from from
-          c.to to if to
-        end
-      end
-
-      def metadata_committee(node, xml)
-        unless node.attr("workgroup")
-          @log.add("AsciiDoc Input", nil,
-                   "Missing workgroup attribute for document")
-          return
-        end
-        metadata_committee1(node, xml)
-      end
-
-      def metadata_committee1(node, xml)
-        xml.editorialgroup do |a|
-          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}")
-          xml.editorialgroup do |a|
-            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
-      end
-
-      def metadata_version(node, xml)
-        if node.attr("edition-major")
-          ed = node.attr("edition-major")
-          e1 = node.attr("edition-minor") and ed += ".#{e1}"
-          (e2 = node.attr("edition-patch")) && e1 and ed += ".#{e2}"
-          node.set_attribute("edition", ed)
-        end
-        super
-      end
-
       def configuration
         Metanorma::Iho.configuration
       end

data/lib/metanorma/iho/front.rb

@@ -0,0 +1,142 @@
+module Metanorma
+  module Iho
+    class Converter < Metanorma::Generic::Converter
+      SERIESNAME = {
+        B: "Bathymetric",
+        C: "Capacity Building",
+        M: "Miscellaneous",
+        P: "Periodic",
+        S: "Standards and Specifications",
+      }.freeze
+
+      def metadata_series(node, xml)
+        series = node.attr("series") or return
+        xml.series type: "main" do |s|
+          s.title SERIESNAME[series.to_sym] || "N/A"
+          s.abbreviation series
+        end
+      end
+
+      def metadata_ext(node, ext)
+        super
+        metadata_commentperiod(node, ext)
+      end
+
+      def metadata_commentperiod(node, xml)
+        from = node.attr("comment-from") or return
+        to = node.attr("comment-to")
+        xml.commentperiod do |c|
+          c.from from
+          c.to to if to
+        end
+      end
+
+      def metadata_committee(node, xml)
+        unless node.attr("workgroup")
+          @log.add("AsciiDoc Input", nil,
+                   "Missing workgroup attribute for document")
+          return
+        end
+        metadata_committee1(node, xml)
+      end
+
+      def metadata_committee1(node, xml)
+        xml.editorialgroup do |a|
+          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}")
+          xml.editorialgroup do |a|
+            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
+      end
+
+      def metadata_version(node, xml)
+        if node.attr("edition-major")
+          ed = node.attr("edition-major")
+          e1 = node.attr("edition-minor") and ed += ".#{e1}"
+          (e2 = node.attr("edition-patch")) && e1 and ed += ".#{e2}"
+          node.set_attribute("edition", ed)
+        end
+        super
+      end
+
+      def title(node, xml)
+        m = full_title_prep(node)
+        full_title(m, xml)
+        title = node.attr("title")
+        xml.title **attr_code(type: "title-main") do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(title)
+        end
+        %i(appendix annex part supplement).each do |w|
+          typed_title(m, xml, w)
+        end
+      end
+
+      def typed_title(metadata, xml, type)
+        metadata[type] or return
+        title = full_title_part(metadata, type, TITLE_COMPONENTS[type][:id],
+                                TITLE_COMPONENTS[type][:info])
+        xml.title **attr_code(type: "title-#{type}") do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(title)
+        end
+      end
+
+      TITLE_COMPONENTS = {
+        main: {},
+        part: { id: :partid },
+        annex: { id: :annexid, info: :infoannex },
+        appendix: { id: :appendixid },
+        supplement: { id: :supplementid },
+      }.freeze
+
+      def full_title(metadata, xml)
+        parts = TITLE_COMPONENTS.keys.each_with_object([]) do |p, acc|
+          acc << full_title_part(metadata, p, TITLE_COMPONENTS[p][:id],
+                                 TITLE_COMPONENTS[p][:info])
+        end
+        xml.title **attr_code(type: "main") do |t1|
+          t1 << Metanorma::Utils::asciidoc_sub(parts.compact.join(", "))
+        end
+      end
+
+      TITLE_ID_LABELS = { main: "", annex: "Annex", appendix: "Appendix",
+                          part: "Part", supplement: "Supplement" }.freeze
+
+      def full_title_part(metadata, type, id, info)
+        metadata[type] or return nil
+        lbl = TITLE_ID_LABELS[type.to_sym]
+        metadata[id] and lbl += " #{metadata[id]}"
+        metadata[info] and lbl += " (Informative)"
+        %i(appendix supplement part).include?(type) and lbl += ":"
+        lbl == :main or lbl += " "
+        lbl + metadata[type]
+      end
+
+      def full_title_prep(node)
+        { main: node.attr("title") || node.title,
+          annex: node.attr("title-annex"),
+          appendix: node.attr("title-appendix"),
+          supplement: node.attr("title-supplement"),
+          part: node.attr("title-part"),
+          partid: node.attr("partnumber"),
+          annexid: node.attr("annex-id"),
+          appendixid: node.attr("appendix-id"),
+          supplementid: node.attr("supplement-id"),
+          infoannex: node.attr("semantic-metadata-annex-informative") == "true" }
+      end
+    end
+  end
+end

data/lib/metanorma/iho/isodoc.rng

@@ -1,6 +1,6 @@
 <?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" datatypeLibrary="http://www.w3.org/2001/XMLSchema-datatypes">
-<!-- VERSION v2.0.7 -->
+<!-- VERSION v2.0.8 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -72,6 +72,46 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
         </oneOrMore>
       </element>
     </define>
+    <define name="review">
+      <a:documentation>Generalise BasicDoc element from just review comments, to general annotations;
+the type attribute defaults to `review` for reviews</a:documentation>
+      <element name="annotation">
+        <ref name="RequiredId"/>
+        <ref name="ReviewAttributes"/>
+        <oneOrMore>
+          <ref name="paragraph">
+            <a:documentation>Reviewer comments content</a:documentation>
+          </ref>
+        </oneOrMore>
+      </element>
+    </define>
+    <define name="ruby_pronunciation">
+      <a:documentation>Ruby annotation giving pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-pronunciation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="ruby_annotation">
+      <a:documentation>Ruby annotation giving information other than pronunciation of text: change tag from BasicDoc for disambiguation</a:documentation>
+      <element name="ruby-annotation">
+        <attribute name="value">
+          <a:documentation>Ruby annotation value</a:documentation>
+        </attribute>
+        <ref name="LocalizedStringAttributes"/>
+      </element>
+    </define>
+    <define name="annotation">
+      <a:documentation>Source code annotation, corresponding to a callout</a:documentation>
+      <element name="callout-annotation">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="paragraph"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="section-title">
       <a:documentation>Title(s) of a clause</a:documentation>
       <element name="title">
@@ -540,7 +580,7 @@ normative or informative references, some split references into sections organiz
       <ref name="OptionalId"/>
       <optional>
         <attribute name="style">
-          <a:documentation>CSS style: only background-color supported</a:documentation>
+          <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
         </attribute>
       </optional>
     </define>
@@ -620,7 +660,7 @@ This is done if the footnote reference is already presented in some other form,
     <ref name="RequiredId"/>
     <optional>
       <attribute name="style">
-        <a:documentation>CSS style: only background-color supported</a:documentation>
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
       </attribute>
     </optional>
   </define>
@@ -700,6 +740,11 @@ titlecase, or lowercase</a:documentation>
         <a:documentation>Width of the table block in rendering</a:documentation>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="style">
+        <a:documentation>CSS style: only background-color, color, border supported</a:documentation>
+      </attribute>
+    </optional>
     <ref name="BlockAttributes"/>
   </define>
   <define name="FigureAttributes" combine="interleave">
@@ -1417,7 +1462,7 @@ numbers</a:documentation>
       </optional>
       <ref name="DocumentBody"/>
       <optional>
-        <ref name="review-container">
+        <ref name="annotation-container">
           <a:documentation>Annotations to the document</a:documentation>
         </ref>
       </optional>
@@ -1461,8 +1506,8 @@ numbers</a:documentation>
       </oneOrMore>
     </element>
   </define>
-  <define name="review-container">
-    <element name="review-container">
+  <define name="annotation-container">
+    <element name="annotation-container">
       <oneOrMore>
         <ref name="review"/>
       </oneOrMore>

data/lib/metanorma/iho/relaton-iho.rng

@@ -27,6 +27,33 @@
         </oneOrMore>
       </element>
     </define>
+    <define name="structuredidentifier">
+      <element name="structuredidentifier">
+        <element name="docnumber">
+          <text/>
+        </element>
+        <optional>
+          <element name="part">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="annexid">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="appendixid">
+            <text/>
+          </element>
+        </optional>
+        <optional>
+          <element name="supplementid">
+            <text/>
+          </element>
+        </optional>
+      </element>
+    </define>
   </include>
   <define name="BibDataExtensionType" combine="interleave">
     <optional>

data/lib/metanorma/iho/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Iho
-    VERSION = "1.1.9".freeze
+    VERSION = "1.2.0".freeze
   end
 end

data/metanorma.yml

@@ -78,3 +78,15 @@ fonts_manifest:
   Source Han Sans:
   Source Han Sans Normal:
   STIX Two Math:
+metadata_extensions:
+  structuredidentifier:
+    docnumber:
+    partnumber:
+     _output: part
+    appendix-id:
+      _output: appendixid
+    annex-id:
+      _output: annexid
+    supplement-id:
+      _output: supplementid
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-iho
 version: !ruby/object:Gem::Version
-  version: 1.1.9
+  version: 1.2.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-generic
@@ -242,7 +242,9 @@ files:
 - lib/metanorma/iho/biblio-standoc.rng
 - lib/metanorma/iho/biblio.rng
 - lib/metanorma/iho/boilerplate.adoc
+- lib/metanorma/iho/cleanup.rb
 - lib/metanorma/iho/converter.rb
+- lib/metanorma/iho/front.rb
 - lib/metanorma/iho/iho.rng
 - lib/metanorma/iho/isodoc.rng
 - lib/metanorma/iho/processor.rb