metanorma-generic 3.0.4 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5424d73a9cc722807659e46d7270dda1f24903f66adbea7032900727b54ad66b
-  data.tar.gz: 79552d897c0464b21c9dd5d70b57a83f2a3926780c60721a44b06b4dc86bf16b
+  metadata.gz: 3f80f76fbe32fa0cd4ccb9eafce213a60096b15026f5b6a7abd728426f26a99a
+  data.tar.gz: '018891763c69c03a2025acbf55b12ad0035a8b448e3dd9de50cd73145efbe9bd'
 SHA512:
-  metadata.gz: f15bb6bcab803c56fe35456cdf03eae535ea8ac9f98eb362010ae8fc85b47766fe90720c7603b7bbe29dd327cdfea6140dd1b48ab6d0b4dd2d8aff59d85e68ac
-  data.tar.gz: 0dbb13b2cd90a9a529c062a69bc9fe0303b282dcfa8055fd9d94c005398d0250fd336c043633051a4eee5f3f5a4c8680489df0eb76ffa38aac025cced8fd4aa3
+  metadata.gz: 1e7c49c95103081c07f6d8a5f74480118eebae36e0a9897236335a1f93138237448348737c533b92c1fb4a1f11bdaefbb9b5701843e4f0fe9ceb654d0090c3fb
+  data.tar.gz: 9ce7d22da17427586d6aa90ab860b7aa41cfa61ea5f8f0605ebdbe79d42393bcf8da18d7c1b8b7446b98faeec3312c0f1889a6053421b1bf82978102e1ce2d18

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>
@@ -1291,13 +1291,13 @@ Restricted recursively to contain only other such inline elements with no identi
       <ref name="pure_strike"/>
       <ref name="pure_smallcap"/>
       <ref name="br"/>
+      <ref name="stem"/>
     </choice>
   </define>
   <define name="NestedTextElement">
     <a:documentation>Contents of TextElement tags: leaves out tags that should occur only at top level of block: bookmark image hr pagebreak</a:documentation>
     <choice>
       <ref name="PureTextElement"/>
-      <ref name="stem"/>
       <ref name="eref"/>
       <ref name="xref"/>
       <ref name="hyperlink"/>

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.7 -->
+<!-- VERSION v2.1.0 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -42,33 +42,43 @@ All IdRefType instances point not to `@id` in Semantic XML, which is the Content
 but to `@anchor`, the user-supplied cross-reference</a:documentation>
       <text/>
     </define>
-    <define name="index-primary">
-      <element name="primary">
+    <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>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
+          <ref name="paragraph">
+            <a:documentation>Reviewer comments content</a:documentation>
+          </ref>
         </oneOrMore>
       </element>
     </define>
-    <define name="index-secondary">
-      <element name="secondary">
-        <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </oneOrMore>
+    <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="index-tertiary">
-      <element name="tertiary">
+    <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>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
+          <ref name="paragraph"/>
         </oneOrMore>
       </element>
     </define>
@@ -540,7 +550,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>
@@ -552,28 +562,6 @@ normative or informative references, some split references into sections organiz
         </oneOrMore>
       </element>
     </define>
-    <define name="sub">
-      <a:documentation>Subscript text. Corresponds to HTML `sub</a:documentation>
-      <element name="sub">
-        <zeroOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </zeroOrMore>
-      </element>
-    </define>
-    <define name="sup">
-      <a:documentation>Superscript text. Corresponds to HTML `sup`</a:documentation>
-      <element name="sup">
-        <zeroOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
-        </zeroOrMore>
-      </element>
-    </define>
     <define name="pagebreak">
       <a:documentation>Page break. Only applicable in paged layouts (e.g. PDF, Word), and not flow layouts (e.g. HTML)</a:documentation>
       <element name="pagebreak">
@@ -620,7 +608,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>
@@ -695,11 +683,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">
@@ -1043,7 +1042,6 @@ That concept may be defined as a term within the current document, or it may be
           <zeroOrMore>
             <choice>
               <ref name="PureTextElement"/>
-              <ref name="stem"/>
               <ref name="index"/>
               <ref name="index-xref"/>
             </choice>
@@ -1056,7 +1054,6 @@ That concept may be defined as a term within the current document, or it may be
           <zeroOrMore>
             <choice>
               <ref name="PureTextElement"/>
-              <ref name="stem"/>
               <ref name="index"/>
               <ref name="index-xref"/>
             </choice>
@@ -1417,7 +1414,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 +1458,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>
@@ -1974,10 +1971,7 @@ used in document amendments</a:documentation>
       <element name="name">
         <a:documentation>The symbolic form of the designation</a:documentation>
         <oneOrMore>
-          <choice>
-            <ref name="PureTextElement"/>
-            <ref name="stem"/>
-          </choice>
+          <ref name="PureTextElement"/>
         </oneOrMore>
       </element>
     </element>
@@ -2030,7 +2024,6 @@ used in document amendments</a:documentation>
         <zeroOrMore>
           <choice>
             <ref name="PureTextElement"/>
-            <ref name="stem"/>
             <ref name="index"/>
             <ref name="index-xref"/>
           </choice>

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "3.0.4".freeze
+    VERSION = "3.1.1".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-generic
 version: !ruby/object:Gem::Version
-  version: 3.0.4
+  version: 3.1.1
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-23 00:00:00.000000000 Z
+date: 2025-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: metanorma-standoc
@@ -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