metanorma-generic 3.0.3 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84ebc0f57d2adc50481a82940e80e0d2f89972c088df6677744719d717f6495b
-  data.tar.gz: 6e8b384f78ec51468642c1dd0d308a56f5e7f326927a58a0e8ed48800b3d2289
+  metadata.gz: e884aa729dddf661d330c4788cd464554e00ff09c8666e9a86cd96c8da9b627f
+  data.tar.gz: 8502e2a0f09b31126952b0d16e4d919bac0c072806242476365ebb212bfcdba7
 SHA512:
-  metadata.gz: 8f54dde566062f0f1e52dc32764f5dbd288d092acf366ae2279cf74c52b76a584329efd5e6bb666bac4f54e5f7b15c1d70a268c600904ac37d68d35442f6a5dd
-  data.tar.gz: cc4d7755a5eae79d1150e45cae14a87086df65609217fd015e9c2901c8142223c124f2f4512a41eb2bed6ba42a1b081d09126b17785d155e05f73a528418d224
+  metadata.gz: 189f3cb40d41e8e6b0e060baeb47deda8ea4e7eb7db97324f9c85f1d2f930e7f7061c03ee3c2d9827c0d0b95d574a9bc0b86f0e39a9d9f72a8ed0bf901a39707
+  data.tar.gz: 858646781e6f509702a268736a79b7663f47b346adf0cb99b66dc0863542882bdf5cc867ecc827a3be2ccfb42b00e1799dfcccb5438c08a10dbfb1a42088ef1c

data/lib/metanorma/generic/basicdoc.rng

@@ -198,14 +198,14 @@ Applicable to modify and delete</a:documentation>
         </zeroOrMore>
       </element>
     </optional>
-    <optional>
+    <zeroOrMore>
       <element name="description">
-        <a:documentation>Description of the change described in this block</a:documentation>
-        <zeroOrMore>
+        <a:documentation>Description(s) of the change described in this block</a:documentation>
+        <oneOrMore>
           <ref name="BasicBlock"/>
-        </zeroOrMore>
+        </oneOrMore>
       </element>
-    </optional>
+    </zeroOrMore>
     <optional>
       <element name="newcontent">
         <a:documentation>New content to be added to the document; applicable to add and modify</a:documentation>

data/lib/metanorma/generic/bibdata_config.rb

@@ -0,0 +1,24 @@
+module Metanorma
+  module Generic
+    class BibdataConfig < ::Lutaml::Model::Serializable
+      class Bibdata < ::Lutaml::Model::Serializable
+        model ::RelatonBib::BibliographicItem
+      end
+
+      attribute :bibdata, Bibdata
+
+      xml do
+        root "metanorma"
+        map_element "bibdata", to: :bibdata, with: { from: :bibdata_from_xml,
+                                                     to: :bibdata_to_xml }
+      end
+
+      def bibdata_from_xml(model, node)
+        node or return
+        model.bibdata = Relaton::Cli.parse_xml(node.adapter_node)
+      end
+
+      def bibdata_to_xml(model, parent, doc); end
+    end
+  end
+end

data/lib/metanorma/generic/converter.rb

@@ -2,6 +2,7 @@ require "asciidoctor"
 require "metanorma/standoc/converter"
 require "fileutils"
 require_relative "front"
+require_relative "bibdata_config"
 require "metanorma"
 require "pathname"
 
@@ -16,23 +17,25 @@ module Metanorma
       end
 
       def docidentifier_cleanup(xmldoc)
+        docid = xmldoc.at("//bibdata/docidentifier") or return
+        docid.text.empty? or return
+        id = docidentifier_from_template(xmldoc) or return
+        (id.empty? and docid.remove) or docid.children = id
+      end
+
+      def docidentifier_from_template(xmldoc)
         b = boilerplate_isodoc(xmldoc) or return
         template = configuration.docid_template ||
           "{{ organization_name_short }} {{ docnumeric }}"
-        docid = xmldoc.at("//bibdata/docidentifier")
-        docid&.text&.empty? or return
-        id = b.populate_template(template, nil)
-        (id.empty? and docid.remove) or docid.children = id
+        b.populate_template(template, nil)
       end
 
       def doctype(node)
         d = super
         node.attr("doctype") == "article" and d = "article"
         a = configuration.default_doctype and @default_doctype = a
-        unless configuration.doctypes
-          d == "article" and return @default_doctype
-          return d
-        end
+        configuration.doctypes or
+          return d == "article" ? @default_doctype : d
         type = @default_doctype || configuration.doctypes.keys[0]
         if !configuration.doctypes.key?(d)
           node.attr("doctype") && node.attr("doctype") != "article" and # factory default
@@ -162,9 +165,16 @@ module Metanorma
         Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
           conv.meta.set(a, configuration.send(a))
         end
+        conv.meta.set(:bibdata, bibdata_hash(xmldoc))
         conv
       end
 
+      def bibdata_hash(xmldoc)
+        b = xmldoc.at("//bibdata") || xmldoc.at("//xmlns:bibdata")
+        BibdataConfig.from_xml("<metanorma>#{b.to_xml}</metanorma>")
+          .bibdata.to_hash
+      end
+
       def boilerplate_file(xmldoc)
         f = configuration.boilerplate
         f.nil? and return super
@@ -172,18 +182,6 @@ module Metanorma
         f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
         super
       end
-
-      def cleanup(xmldoc)
-        super
-        empty_metadata_cleanup(xmldoc)
-        xmldoc
-      end
-
-      def empty_metadata_cleanup(xmldoc)
-        xmldoc.xpath("//bibdata/ext//*").each do |x|
-          x.remove if x.children.empty?
-        end
-      end
     end
   end
 end

data/lib/metanorma/generic/front.rb

@@ -60,6 +60,22 @@ module Metanorma
             a = node.attr(e) and ext.send e, a
           end
         end
+        empty_metadata_cleanup(ext.parent)
+      end
+
+      # Keep cleaning until no more elements are removed (recursive depth-first)
+      # Process elements in reverse doc order to handle nested removals properly
+      def empty_metadata_cleanup(ext)
+        loop do
+          removed_count = 0
+          ext.xpath(".//*").reverse_each do |element|
+            element.children.empty? && element.attributes.empty? or next
+            element.remove
+            removed_count += 1
+          end
+          removed_count.zero? and break # Stop when no elems removed this pass
+
+        end
       end
 
       def metadata_doctype(node, xml)

data/lib/metanorma/generic/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.6 -->
+<!-- VERSION v2.1.0 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -72,10 +72,51 @@ 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">
         <a:documentation>Title proper for a clause</a:documentation>
+        <ref name="RequiredId"/>
         <zeroOrMore>
           <ref name="TextElement"/>
         </zeroOrMore>
@@ -83,10 +124,19 @@ but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <zeroOrMore>
         <element name="variant-title">
           <a:documentation>Alternate title for a clause</a:documentation>
+          <ref name="RequiredId"/>
           <ref name="TypedTitleString"/>
         </element>
       </zeroOrMore>
     </define>
+    <define name="tname">
+      <element name="name">
+        <ref name="RequiredId"/>
+        <oneOrMore>
+          <ref name="NestedTextElement"/>
+        </oneOrMore>
+      </element>
+    </define>
     <define name="UlBody">
       <optional>
         <ref name="tname">
@@ -475,6 +525,7 @@ normative or informative references, some split references into sections organiz
     <!-- exclude figures? -->
     <define name="dd">
       <element name="dd">
+        <ref name="OptionalId"/>
         <zeroOrMore>
           <!-- exclude figures? -->
           <ref name="BasicBlock"/>
@@ -526,9 +577,10 @@ normative or informative references, some split references into sections organiz
       </choice>
     </define>
     <define name="TrAttributes">
+      <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>
@@ -595,6 +647,7 @@ gives an explicit page orientation</a:documentation>
   </include>
   <!-- end overrides -->
   <define name="FnAttributes" combine="interleave">
+    <ref name="RequiredId"/>
     <optional>
       <attribute name="hiddenref">
         <a:documentation>If true, number the footnote as normal, but suppress display of the footnote reference in the document body.
@@ -604,9 +657,10 @@ This is done if the footnote reference is already presented in some other form,
     </optional>
   </define>
   <define name="TdAttributes" combine="interleave">
+    <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>
@@ -681,11 +735,22 @@ titlecase, or lowercase</a:documentation>
     <ref name="BlockAttributes"/>
   </define>
   <define name="TableAttributes" combine="interleave">
+    <optional>
+      <attribute name="plain">
+        <a:documentation>Render as a plain attribute, with no shading or borders</a:documentation>
+        <data type="boolean"/>
+      </attribute>
+    </optional>
     <optional>
       <attribute name="width">
         <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">
@@ -1403,7 +1468,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>
@@ -1447,8 +1512,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>
@@ -1821,7 +1886,7 @@ used in document amendments</a:documentation>
     </element>
   </define>
   <define name="TermAttributes">
-    <ref name="OptionalId"/>
+    <ref name="RequiredId"/>
     <ref name="LocalizedStringAttributes"/>
     <ref name="BlockAttributes"/>
   </define>
@@ -2164,6 +2229,7 @@ used in document amendments</a:documentation>
   <define name="termdefinition">
     <a:documentation>The definition of a term applied in the current document</a:documentation>
     <element name="definition">
+      <ref name="RequiredId"/>
       <optional>
         <attribute name="type">
           <a:documentation>Type of definition, used to differentiate it from other definitions of the same term if present</a:documentation>
@@ -2185,6 +2251,7 @@ used in document amendments</a:documentation>
   </define>
   <define name="verbaldefinition">
     <element name="verbal-definition">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the verbal representation of the term</a:documentation>
@@ -2205,6 +2272,7 @@ used in document amendments</a:documentation>
   <define name="nonverbalrep">
     <a:documentation>Non-verbal representation of the term</a:documentation>
     <element name="non-verbal-representation">
+      <ref name="RequiredId"/>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the non-verbal representation of the term</a:documentation>

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "3.0.3".freeze
+    VERSION = "3.1.0".freeze
   end
 end

data/metanorma-generic.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.required_ruby_version = Gem::Requirement.new(">= 3.1.0")
 
-  spec.add_dependency "metanorma-standoc", "~> 3.0.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.1.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-generic
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.1.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-05-26 00:00:00.000000000 Z
+date: 2025-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -237,6 +237,7 @@ files:
 - lib/metanorma-generic.rb
 - lib/metanorma/generic.rb
 - lib/metanorma/generic/basicdoc.rng
+- lib/metanorma/generic/bibdata_config.rb
 - lib/metanorma/generic/biblio-standoc.rng
 - lib/metanorma/generic/biblio.rng
 - lib/metanorma/generic/converter.rb