metanorma-generic 3.2.2 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 142ff668c810de695105351da5b83f38d1c50d5d97889389fd91c9aa85748443
-  data.tar.gz: 9fc97bedaaae979ed280274b9faa0d3cb777a7380a01c8ed00a7dad5483a081a
+  metadata.gz: 02f1cd5aac4e8c8d7fb67bfb1c3b2afd2e6bc62f96bc6b337f8b90232bccbad5
+  data.tar.gz: dbed9ba5a3184cc5892847ef330f2534b9802a1e1dc3479f4795f9467d70e016
 SHA512:
-  metadata.gz: e014e23fd479eee366d9fa16954e482dd2d7a34e3e52a9fcfa62fa41e3ccf1f4bd0421b57b357db15828c241c1f53fa4b7fb30b7774ecdb4a8a8014e32910383
-  data.tar.gz: 50c472c1c2ad288c7845b9a38af6c9de9022fa9b2a641f5104066c0869e03f3f9c42bcc570a3f868b7e3e59e6b88277c0dbc95afac4067343db5d1491c5f2df3
+  metadata.gz: 5c538904aa8c350cf8f92961db2fdab7ac9270444773b4a2ca7323cc55299a6fbc02ef21750c5373729a130ecb893dd63f1a7398c61d3cf016e2981972183d95
+  data.tar.gz: 0de729ab75eff484b7c599cc5259c6dc676504a4828a4542ebc0974bbf2578653b0a5de0e67ce7d192869d6bb7f04e8f71d13ea1778c9927a438d972f9fbc658

data/lib/isodoc/generic/base_convert.rb

@@ -21,7 +21,7 @@ module IsoDoc
       def make_body(xml, docxml)
         body_attr = { lang: "EN-US", link: "blue", vlink: "#954F72",
                       "xml:lang": "EN-US", class: "container" }
-        xml.body **body_attr do |body|
+        xml.body(**body_attr) do |body|
           make_body1(body, docxml)
           make_body2(body, docxml)
           make_body3(body, docxml)

data/lib/isodoc/generic/html/generic.scss

@@ -668,6 +668,10 @@ table.MsoISOTable td, table.MsoISOTableBig td
     {border:solid windowtext 1pt;
     mso-border-alt:solid windowtext 1pt;
     padding:0cm 2.85pt 0cm 2.85pt;}
+table.MsoNormalTable th, table.MsoNormalTable td {
+  border: none;
+  mso-border-alt: none;
+} 
 table.MsoISOTable p, table.MsoISOTableBig p
 {font-size:10.0pt; }
 table.MsoTableGrid

data/lib/isodoc/generic/html/htmlstyle.scss

@@ -78,11 +78,11 @@ nav {
   }
 }
 
-div.figure {
+figure {
   @include figureBlock();
 }
 
-table div.figure {
+table figure {
   padding: 0;
   margin: 0;
 }
@@ -323,16 +323,20 @@ ol ul > li:first-child {
     3.5 Bibliograhy
 */
 
-p.Biblio, p.NormRef {
+p.Biblio, p.NormRef, div.Biblio, div.NormRef {
     margin-top: 1em;
     margin-left: 2em;
 }
 
+.Biblio.note, .Biblio.Note, .NormRef.note, .NormRef.Note {
+  margin-left: 3em;
+}
+
 /*
     3.6 Source Code + figures
 */
 
-.figure, pre, .pseudocode {
+figure, pre, .pseudocode {
   @include pseudocodeBlock(#f7f7f7);
 }
 
@@ -344,7 +348,7 @@ pre {
 @include recommendationBlock();
 @include listBlock();
 
-.FigureTitle, .SourceTitle {
+figcaption, .SourceTitle {
   @include blockTitle()
 }
 
@@ -399,7 +403,7 @@ table {
   @include table(1px solid black);
 }
 
-p.TableTitle {
+table > caption {
   text-align: center;
   margin-top: 2.5em;
   font-weight: 400;
@@ -658,7 +662,7 @@ To top button
     margin-top: 1.2em;
   }
 
-  .note, .figure, pre, .pseudocode, table {
+  .note, figure, pre, .pseudocode, table {
     page-break-inside: avoid;
   }
 

data/lib/isodoc/generic/metadata.rb

@@ -1,6 +1,5 @@
 require "isodoc"
 require "nokogiri"
-require_relative "init"
 require_relative "utils"
 
 class Nokogiri::XML::Node
@@ -41,7 +40,8 @@ module IsoDoc
 
       def images(isoxml, out)
         default_logo_path =
-          File.expand_path(File.join(File.dirname(__FILE__), "html", "logo.jpg"))
+          File.expand_path(File.join(File.dirname(__FILE__), "html",
+                                     "logo.jpg"))
         set(:logo, baselocation(configuration.logo_path) || default_logo_path)
         unless configuration.logo_paths.nil?
           set(:logo_paths,

data/lib/isodoc/generic/pdf_convert.rb

@@ -1,5 +1,4 @@
 require_relative "base_convert"
-require "metanorma-generic"
 require "isodoc"
 
 module IsoDoc

data/lib/metanorma/generic/basicdoc.rng

@@ -208,11 +208,15 @@ Applicable to modify and delete</a:documentation>
     </zeroOrMore>
     <optional>
       <element name="newcontent">
-        <a:documentation>New content to be added to the document; applicable to add and modify</a:documentation>
+        <a:documentation>New content to be added to the document; applicable to add and modify.
+Can be blocks and/or sections</a:documentation>
         <ref name="OptionalId"/>
         <zeroOrMore>
           <ref name="BasicBlock"/>
         </zeroOrMore>
+        <zeroOrMore>
+          <ref name="section"/>
+        </zeroOrMore>
       </element>
     </optional>
     <zeroOrMore>

data/lib/metanorma/generic/cleanup.rb

@@ -0,0 +1,47 @@
+module Metanorma
+  module Generic
+    class Cleanup < Standoc::Cleanup
+      extend Forwardable
+
+      def sections_cleanup(xml)
+        super
+        xml.xpath("//*[@inline-header]").each do |h|
+          h.delete("inline-header")
+        end
+      end
+
+      def boilerplate_isodoc(xmldoc)
+        conv = super or return nil
+        Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
+          conv.meta.set(a, configuration.send(a))
+        end
+        # conv.meta.set(:bibdata, bibdata_hash(xmldoc))
+        @isodoc = conv
+        @isodoc
+      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
+        f.is_a? String and return @conv.baselocation(f)
+        f.is_a? Hash and f[@lang] and return @conv.baselocation(f[@lang])
+        super
+      end
+
+      def published?(status, _xmldoc)
+        stages = configuration&.published_stages || ["published"]
+        (Array(stages).map(&:downcase).include? status.downcase)
+      end
+
+      def configuration
+        @conv.configuration
+      end
+    end
+  end
+end

data/lib/metanorma/generic/converter.rb

@@ -1,5 +1,5 @@
 require "asciidoctor"
-require "metanorma/standoc/converter"
+require "metanorma-standoc"
 require "fileutils"
 require_relative "front"
 require_relative "bibdata_config"
@@ -16,20 +16,6 @@ module Metanorma
         loc
       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 ||
-          "{{ agency }} {{ docnumeric }}"
-        b.populate_template(template, nil)
-      end
-
       def doctype(node)
         d = super
         node.attr("doctype") == "article" and d = "article"
@@ -89,50 +75,6 @@ module Metanorma
                                      nil, false, "#{@filename}.pdf")
       end
 
-      def schema_location
-        baselocation(configuration.validate_rng_file) ||
-          File.join(File.dirname(__FILE__), "generic.rng")
-      end
-
-      def schema_file
-        configuration.validate_rng_file || "generic.rng"
-      end
-
-      def content_validate(doc)
-        super
-        bibdata_validate(doc.root)
-      end
-
-      def bibdata_validate(doc)
-        stage_validate(doc)
-        committee_validate(doc)
-      end
-
-      def stage_validate(xmldoc)
-        stages = configuration.stage_abbreviations&.keys || return
-        stages.empty? and return
-        stage = xmldoc.at("//bibdata/status/stage")&.text
-        stages.include? stage or
-          @log.add("GENERIC_2", nil, params: [stage])
-      end
-
-      def committee_validate(xmldoc)
-        committees = Array(configuration&.committees) || return
-        committees.empty? and return
-        xmldoc.xpath("//bibdata/contributor[role/description = 'committee']/" \
-            "organization/subdivision/name").each do |c|
-          committees.include? c.text or
-            @log.add("GENERIC_3", nil, params: [c.text])
-        end
-      end
-
-      def sections_cleanup(xml)
-        super
-        xml.xpath("//*[@inline-header]").each do |h|
-          h.delete("inline-header")
-        end
-      end
-
       def blank_method(*args); end
 
       def html_converter(node)
@@ -143,7 +85,7 @@ module Metanorma
         IsoDoc::Generic::PresentationXMLConvert
           .new(html_extract_attributes(node)
           .merge(output_formats: ::Metanorma::Generic::Processor.new
-          .output_formats))
+            .output_formats))
       end
 
       alias_method :pdf_converter, :html_converter
@@ -157,35 +99,6 @@ module Metanorma
       def configuration
         Metanorma::Generic.configuration
       end
-
-      def boilerplate_isodoc(xmldoc)
-        conv = super or return nil
-        Metanorma::Generic::Configuration::CONFIG_ATTRS.each do |a|
-          conv.meta.set(a, configuration.send(a))
-        end
-        # conv.meta.set(:bibdata, bibdata_hash(xmldoc))
-        @isodoc = conv
-        @isodoc
-      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
-        f.is_a? String and return baselocation(f)
-        f.is_a? Hash and f[@lang] and return baselocation(f[@lang])
-        super
-      end
-
-      def published?(status, _xmldoc)
-        stages = configuration&.published_stages || ["published"]
-        (Array(stages).map(&:downcase).include? status.downcase)
-      end
     end
   end
 end

data/lib/metanorma/generic/front.rb

@@ -27,25 +27,31 @@ module Metanorma
 
       def metadata_status(node, xml)
         xml.status do |s|
-          add_noko_elem(s, "stage", node.attr("status") || node.attr("docstage") ||
-                   configuration.default_stage || "published")
-          # s.stage ( node.attr("status") || node.attr("docstage") ||
-          # configuration.default_stage || "published")
+          add_noko_elem(s, "stage", node.attr("status") ||
+                        node.attr("docstage") ||
+                   configuration.default_stage || "published",
+                        abbreviation: node.attr("docstage-abbrev"))
           add_noko_elem(s, "substage", node.attr("substage"))
-          # x = node.attr("substage") and s.substage x
           add_noko_elem(s, "iteration", node.attr("iteration"))
-          # x = node.attr("iteration") and s.iteration x
         end
       end
 
       def metadata_id(node, xml)
-        id_type = node.attr("publisher_abbr") || node.attr("publisher") ||
-          configuration.organization_name_short
-        xml.docidentifier primary: "true", type: id_type do |i|
-          i << (node.attr("docidentifier") || "")
+        if id = node.attr("docidentifier") || configuration.docid_template ||
+            "{{ agency }} {{ docnumeric }}"
+          add_noko_elem(xml, "docidentifier",
+                        id, primary: "true", boilerplate: true,
+                            type: metadata_id_primary_type(node))
+        else
+          metadata_id_primary(node, xml)
         end
       end
 
+      def metadata_id_primary_type(node)
+        node.attr("publisher_abbr") || node.attr("publisher") ||
+          configuration.organization_name_short
+      end
+
       def metadata_ext(node, ext)
         super
         if configuration.metadata_extensions.is_a? Hash
@@ -75,8 +81,8 @@ module Metanorma
       def metadata_doctype(node, xml)
         d = doctype(node)
         add_noko_elem(xml, "doctype", d,
-                      abbreviation: configuration&.doctypes&.dig(d))
-        # xml.doctype d, attr_code(abbreviation: configuration&.doctypes&.dig(d))
+                      abbreviation: node.attr("doctype-abbrev") ||
+                      configuration&.doctypes&.dig(d))
       end
 
       EXT_STRUCT = %w(_output _attribute _list).freeze

data/lib/metanorma/generic/isodoc.rng

@@ -167,12 +167,6 @@ Sources are currently only rendered in metanorma-plateau</a:documentation>
     </define>
     <define name="DlAttributes">
       <ref name="BlockAttributes"/>
-      <optional>
-        <attribute name="key">
-          <a:documentation>This definition list is the key of a figure or formula</a:documentation>
-          <data type="boolean"/>
-        </attribute>
-      </optional>
     </define>
     <define name="DlBody">
       <optional>
@@ -311,7 +305,7 @@ and is intended to be referenced by a callout within the source code</a:document
         </ref>
       </optional>
       <choice>
-        <a:documentation>Content of the figure     </a:documentation>
+        <a:documentation>Content of the figure</a:documentation>
         <ref name="image">
           <a:documentation>by default the content of a figure is a media file</a:documentation>
         </ref>
@@ -340,8 +334,8 @@ and is intended to be referenced by a callout within the source code</a:document
         </ref>
       </zeroOrMore>
       <optional>
-        <ref name="dl">
-          <a:documentation>An optional definitions list defining any symbols used in the figure</a:documentation>
+        <ref name="key">
+          <a:documentation>An key defining any symbols used in the figure</a:documentation>
         </ref>
       </optional>
       <zeroOrMore>
@@ -365,7 +359,7 @@ and is intended to be referenced by a callout within the source code</a:document
         </ref>
       </optional>
       <choice>
-        <a:documentation>Content of the figure     </a:documentation>
+        <a:documentation>Content of the figure</a:documentation>
         <ref name="image-no-id">
           <a:documentation>by default the content of a figure is a media file</a:documentation>
         </ref>
@@ -429,7 +423,7 @@ in order to be applicable in this standardisation document</a:documentation>
       </element>
     </define>
     <define name="sourcecodebody">
-      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string. 
+      <a:documentation>The computer code or other such text presented in the block, as a single unformatted string.
 (The string should be treated as pre-formatted text, with whitespace treated as significant)</a:documentation>
       <element name="body">
         <oneOrMore>
@@ -549,7 +543,7 @@ normative or informative references, some split references into sections organiz
           <choice>
             <a:documentation>Table cell contains a block</a:documentation>
             <ref name="paragraph-with-footnote"/>
-            <ref name="dl"/>
+            <ref name="key"/>
             <ref name="ul"/>
             <ref name="ol"/>
             <ref name="figure"/>
@@ -632,8 +626,40 @@ This is done if the footnote reference is already presented in some other form,
         <a:documentation>The number of the footnote, used to identify it visually</a:documentation>
       </attribute>
     </define>
+    <define name="FormulaBody">
+      <ref name="stem">
+        <a:documentation>The content of the formula, as a mathematical expression</a:documentation>
+      </ref>
+      <optional>
+        <ref name="key">
+          <a:documentation>A key defining any symbols used in the formula</a:documentation>
+        </ref>
+      </optional>
+      <zeroOrMore>
+        <ref name="note">
+          <a:documentation>Notes whose scope is the current block</a:documentation>
+        </ref>
+      </zeroOrMore>
+    </define>
   </include>
   <!-- end overrides -->
+  <define name="key">
+    <a:documentation>Key to a table, figure, or formula</a:documentation>
+    <element name="key">
+      <optional>
+        <ref name="tname">
+          <a:documentation>optional title of key</a:documentation>
+        </ref>
+      </optional>
+      <oneOrMore>
+        <choice>
+          <a:documentation>Definition list and/or paragraph content</a:documentation>
+          <ref name="dl"/>
+          <ref name="paragraph"/>
+        </choice>
+      </oneOrMore>
+    </element>
+  </define>
   <define name="TdAttributes" combine="interleave">
     <ref name="RequiredId"/>
     <optional>
@@ -1042,7 +1068,7 @@ parargaph sources are currently only rendered in metanorma-plateau</a:documentat
       </optional>
       <optional>
         <attribute name="custom-charset">
-          <a:documentation>Character set that the contained text belongs to; 
+          <a:documentation>Character set that the contained text belongs to;
 is used in particular to capture mutually agreed definitions of codepoints in Unicode Private Use Area</a:documentation>
         </attribute>
       </optional>
@@ -1623,7 +1649,7 @@ numbers</a:documentation>
   <define name="definitions">
     <a:documentation>One or more definition lists, used to define symbols and abbreviations used in the remainder of the document.
 These can also be used as glossaries, with simple definitions, in contrast to the more elaborate definitions given in
-terms sections </a:documentation>
+terms sections</a:documentation>
     <element name="definitions">
       <ref name="OptionalId"/>
       <ref name="LocalizedStringAttributes"/>
@@ -1864,7 +1890,7 @@ used in document amendments</a:documentation>
       </zeroOrMore>
       <zeroOrMore>
         <ref name="related">
-          <a:documentation>Zero or more names which are related to the term being defined. </a:documentation>
+          <a:documentation>Zero or more names which are related to the term being defined.</a:documentation>
         </ref>
       </zeroOrMore>
       <optional>
@@ -2025,7 +2051,7 @@ used in document amendments</a:documentation>
     <element name="letter-symbol">
       <optional>
         <attribute name="isInternational">
-          <a:documentation>Whether the designation is the same across languages, or language-specific   </a:documentation>
+          <a:documentation>Whether the designation is the same across languages, or language-specific</a:documentation>
           <data type="boolean"/>
         </attribute>
       </optional>
@@ -2632,6 +2658,11 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
         <a:documentation>Connective linking this location to its predecessor. _from/to_ are presumed to nest more closely than _and_ or _or_</a:documentation>
         <ref name="XrefConnectiveType"/>
       </attribute>
+      <optional>
+        <attribute name="custom-connective">
+          <a:documentation>Custom wording for connnective linking this location to its predecessor, custom wording. If provided, is treated as equivalent semantically to connective value</a:documentation>
+        </attribute>
+      </optional>
     </element>
   </define>
   <define name="XrefStyleType">
@@ -2658,6 +2689,11 @@ links within an SVG file, so that the SVG file can hyperlink to anchors within t
         <ref name="XrefConnectiveType"/>
       </attribute>
     </optional>
+    <optional>
+      <attribute name="custom-connective">
+        <a:documentation>Custom wording for connnective linking this location to its predecessor, custom wording. If provided, is treated as equivalent semantically to connective value</a:documentation>
+      </attribute>
+    </optional>
     <ref name="erefType"/>
   </define>
   <define name="erefstack">

data/lib/metanorma/generic/validate.rb

@@ -0,0 +1,46 @@
+module Metanorma
+  module Generic
+    class Validate < Standoc::Validate
+      def schema_location
+        @conv.baselocation(configuration.validate_rng_file) ||
+          File.join(File.dirname(__FILE__), "generic.rng")
+      end
+
+      def schema_file
+        configuration.validate_rng_file || "generic.rng"
+      end
+
+      def content_validate(doc)
+        super
+        bibdata_validate(doc.root)
+      end
+
+      def bibdata_validate(doc)
+        stage_validate(doc)
+        committee_validate(doc)
+      end
+
+      def stage_validate(xmldoc)
+        stages = configuration.stage_abbreviations&.keys || return
+        stages.empty? and return
+        stage = xmldoc.at("//bibdata/status/stage")&.text
+        stages.include? stage or
+          @log.add("GENERIC_2", nil, params: [stage])
+      end
+
+      def committee_validate(xmldoc)
+        committees = Array(configuration&.committees) || return
+        committees.empty? and return
+        xmldoc.xpath("//bibdata/contributor[role/description = 'committee']/" \
+            "organization/subdivision/name").each do |c|
+          committees.include? c.text or
+            @log.add("GENERIC_3", nil, params: [c.text])
+        end
+      end
+
+      def configuration
+        @conv.configuration
+      end
+    end
+  end
+end

data/lib/metanorma/generic/version.rb

@@ -1,5 +1,5 @@
 module Metanorma
   module Generic
-    VERSION = "3.2.2".freeze
+    VERSION = "3.3.0".freeze
   end
 end

data/lib/metanorma-generic.rb

@@ -1,6 +1,8 @@
 require "metanorma/generic"
 require "asciidoctor"
 require "metanorma/generic/converter"
+require "metanorma/generic/validate"
+require "metanorma/generic/cleanup"
 require "isodoc/generic"
 require "metanorma"
 

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.2.0"
+  spec.add_dependency "metanorma-standoc", "~> 3.3.1"
 
   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.2.2
+  version: 3.3.0
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-01 00:00:00.000000000 Z
+date: 2026-03-02 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.2.0
+        version: 3.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.3.1
 - !ruby/object:Gem::Dependency
   name: debug
   requirement: !ruby/object:Gem::Requirement
@@ -240,6 +240,7 @@ files:
 - lib/metanorma/generic/bibdata_config.rb
 - lib/metanorma/generic/biblio-standoc.rng
 - lib/metanorma/generic/biblio.rng
+- lib/metanorma/generic/cleanup.rb
 - lib/metanorma/generic/converter.rb
 - lib/metanorma/generic/fonts_manifest.yaml
 - lib/metanorma/generic/front.rb
@@ -249,6 +250,7 @@ files:
 - lib/metanorma/generic/processor.rb
 - lib/metanorma/generic/reqt.rng
 - lib/metanorma/generic/rsd.rng
+- lib/metanorma/generic/validate.rb
 - lib/metanorma/generic/version.rb
 - metanorma-generic.gemspec
 - metanorma.yml.example