metanorma-standoc 3.1.3 → 3.1.5

data/lib/metanorma/standoc/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.1.0 -->
+<!-- VERSION v2.1.2 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437
@@ -123,6 +123,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlBody">
       <optional>
@@ -140,6 +144,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="OlAttributes">
       <a:documentation>NOTE: `start` attribute is not included by default, because of problems it raises with DOC output</a:documentation>
@@ -188,6 +196,10 @@ the type attribute defaults to `review` for reviews</a:documentation>
           <a:documentation>Notes whose scope is the current block</a:documentation>
         </ref>
       </zeroOrMore>
+      <ref name="BlockSource">
+        <a:documentation>Bibliographic source for the information in the list.
+Sources are currently only rendered in metanorma-plateau</a:documentation>
+      </ref>
     </define>
     <define name="dt">
       <element name="dt">
@@ -871,6 +883,12 @@ titlecase, or lowercase</a:documentation>
       </oneOrMore>
     </element>
   </define>
+  <define name="ParagraphFnBody" combine="interleave">
+    <ref name="BlockSource">
+      <a:documentation>Bibliographic source for the information in the paragraph
+parargaph sources are currently only rendered in metanorma-plateau</a:documentation>
+    </ref>
+  </define>
   <define name="BasicBlock" combine="choice">
     <ref name="columnbreak"/>
   </define>
@@ -2233,6 +2251,11 @@ used in document amendments</a:documentation>
       <ref name="RequiredId"/>
       <ref name="NumberingAttributes"/>
       <ref name="BlockAttributes"/>
+      <optional>
+        <attribute name="type">
+          <a:documentation>Semantic classification of note</a:documentation>
+        </attribute>
+      </optional>
       <oneOrMore>
         <choice>
           <a:documentation>Content of the term note</a:documentation>

data/lib/metanorma/standoc/macros.rb

@@ -2,16 +2,14 @@ require "uuidtools"
 require "yaml"
 require "csv"
 require_relative "macros_inline"
-require_relative "macros_plantuml"
 require_relative "macros_terms"
 require_relative "macros_form"
 require_relative "macros_note"
 require_relative "macros_embed"
 require_relative "macros_link"
-require_relative "datamodel/attributes_table_preprocessor"
-require_relative "datamodel/diagram_preprocessor"
 require "metanorma-plugin-glossarist"
 require "metanorma-plugin-lutaml"
+require "metanorma-plugin-plantuml"
 
 module Metanorma
   module Standoc

data/lib/metanorma/standoc/ref_queue.rb

@@ -131,7 +131,7 @@ module Metanorma
 
       def fetch_ref(xml, code, year, **opts)
         opts[:no_year] and return nil
-        code = code.sub(/^\([^)]+\)/, "")
+        _, code = extract_balanced_parentheses(code)
         hit = fetch_ref1(code, year, opts) or return nil
         xml.parent.add_child(smart_render_xml(hit, code, opts))
         xml

data/lib/metanorma/standoc/ref_utility.rb

@@ -42,7 +42,7 @@ module Metanorma
       end
 
       def docid(bib, code, codetype = nil)
-        type, code1 = if /^\[\d+\]$|^\([^)]+\).*$/.match?(code)
+        type, code1 = if /^\[\d+\]$|^\(.+\).*$/.match?(code)
                         ["metanorma", mn_code(code)]
                       elsif %w(attachment repo path).include?(codetype)
                         [nil, code]
@@ -62,7 +62,10 @@ module Metanorma
       end
 
       def mn_code(code)
-        code.sub(/^\(/, "[").sub(/^([^)]+)\).*$/, "\\1]")
+        # Handle balanced parentheses at the start of the string
+        balance, remainder = extract_balanced_parentheses(code)
+        balance and return "[#{balance}]"
+        remainder
           .sub(/^dropid\((.+)\)$/, "\\1")
           .sub(/^hidden\((.+)\)$/, "\\1")
           .sub(/^nofetch\((.+)\)$/, "\\1")
@@ -218,6 +221,28 @@ module Metanorma
           @type = 'DOI' or @type = 'doi' or @type = 'ISSN' or @type = 'issn' or @type = 'ISBN' or @type = 'isbn' or starts-with(@type, 'ISSN.') or starts-with(@type, 'ISBN.') or starts-with(@type, 'issn.') or starts-with(@type, 'isbn.')
         XPATH
       end
+
+      private
+
+      def extract_balanced_parentheses(code)
+        code.start_with?("(") or return [nil, code]
+        paren_count = 0
+        # Find the matching closing parenthesis
+        code.each_char.with_index do |char, index|
+          case char
+          when "(" then paren_count += 1
+          when ")"
+            paren_count -= 1
+            paren_count.zero? or next
+            # Found the matching closing parenthesis
+            content = code[1...index] # Extract content between parentheses
+            remaining = code[(index + 1)..] || "" # Get remaining string
+            return [content, remaining]
+          end
+        end
+        # If we get here, parentheses are unbalanced - return original
+        [nil, code]
+      end
     end
   end
 end

data/lib/metanorma/standoc/regex.rb

@@ -52,27 +52,28 @@ module Metanorma
 
       ISO_REF =
         %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<usrlbl>\([^)]+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9-]+|IEV)
+      \[(?<usrlbl>\(.+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9-]+|IEV)
       (?::(?<year>[0-9][0-9-]+))?\]</ref>,?\s*(?<text>.*)$}xm
 
       ISO_REF_NO_YEAR =
         %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<usrlbl>\([^)]+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9-]+):
+      \[(?<usrlbl>\(.+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9-]+):
       (?:--|–|—|&\#821[12];)\]</ref>,?\s*
         (?:<fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>)?,?\s?(?<text>.*)$}xm
 
       ISO_REF_ALL_PARTS =
         %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<usrlbl>\([^)]+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9]+)
+      \[(?<usrlbl>\(.+\))?(?<code>(?:ISO|IEC)[^0-9]*\s[0-9]+)
       (?::(?<year>--|–|—|&\#821[12];|[0-9][0-9-]+))?\s
       \(all\sparts\)\]</ref>,?\s*
         (?:<fn[^>]*>\s*<p>(?<fn>[^\]]+)</p>\s*</fn>,?\s?)?(?<text>.*)$}xm
 
+      # These regexes allow () inside usrlbl but not inside code
       NON_ISO_REF = %r{^<ref\sid="(?<anchor>[^"]+)">
-      \[(?<usrlbl>\([^)]+\))?(?<code>.+?)\]</ref>,?\s*(?<text>.*)$}xm
+      \[(?<usrlbl>\(.+\))?(?<code>.+?)\]</ref>,?\s*(?<text>.*)$}xm
 
       NON_ISO_REF1 = %r{^<ref\sid="(?<anchor>[^"]+)">
-      (?<usrlbl>\([^)]+\))?(?<code>.+?)</ref>,?\s*(?<text>.*)$}xm
+      (?<usrlbl>\(.+\))?(?<code>.+?)</ref>,?\s*(?<text>.*)$}xm
     end
   end
 end

data/lib/metanorma/standoc/sectiontype.rb

@@ -73,6 +73,7 @@ module Metanorma
       end
 
       def preface_main_filter(ret, node)
+        node.level > 1 and return ret
         start_main_section(ret, node)
         @preface && self.class::MAIN_CLAUSE_NAMES.include?(ret) and return nil
         !@preface && self.class::PREFACE_CLAUSE_NAMES.include?(ret) and

data/lib/metanorma/standoc/utils.rb

@@ -154,7 +154,17 @@ module Metanorma
           #{text}
         ADOC
         c = Asciidoctor.convert(doc, backend: flavour, header_footer: true)
-        Nokogiri::XML(c).at("//xmlns:sections")
+        ret = Nokogiri::XML(c).at("//xmlns:sections")
+        separate_numbering_footnotes(ret)
+      end
+
+      # separate numbering of externally sourced footnotes
+      # from that of current doc
+      def separate_numbering_footnotes(docxml)
+        docxml.xpath("//xmlns:fn").each do |f|
+          f["reference"] = "_#{UUIDTools::UUID.random_create}_#{f['reference']}"
+        end
+        docxml
       end
 
       def asciimath_key(sym)

data/lib/metanorma/standoc/validate.rb

@@ -28,7 +28,7 @@ module Metanorma
         math_validate(doc)
         fatalerrors = @log.abort_messages
         fatalerrors.empty? or
-          clean_abort("\n\nFATAL ERRROS:\n\n#{fatalerrors.join("\n\n")}", doc)
+          clean_abort("\n\nFATAL ERRORS:\n\n#{fatalerrors.join("\n\n")}", doc)
       end
 
       MATHML_NS = "http://www.w3.org/1998/Math/MathML".freeze

data/lib/metanorma/standoc/validate_section.rb

@@ -31,11 +31,21 @@ module Metanorma
         @log.add("Style", node, w)
       end
 
+      def reject_metanorma_extension
+        ->(node) {
+          node.ancestors.detect do |x|
+            x.name == "metanorma-extension"
+          end
+        }
+      end
+
       def asset_title_style(root)
-        root.xpath("//figure[image][not(name)]").each do |node|
+        root.xpath("//figure[image][not(name)]")
+          .reject(&reject_metanorma_extension).each do |node|
           style_warning(node, "Figure should have title", nil)
         end
-        root.xpath("//table[not(name)]").each do |node|
+        root.xpath("//table[not(name)]")
+          .reject(&reject_metanorma_extension).each do |node|
           style_warning(node, "Table should have title", nil)
         end
       end

data/lib/metanorma/standoc/validate_table.rb

@@ -15,7 +15,8 @@ module Metanorma
       end
 
       def empty_table_validate(doc)
-        doc.xpath("//table[not(.//tr)]").each do |t|
+        doc.xpath("//table[not(.//tr)]").reject(&reject_metanorma_extension)
+          .each do |t|
           @log.add("Table", t, "Empty table", severity: 0)
         end
       end
@@ -30,6 +31,7 @@ module Metanorma
       end
 
       def maxrowcols_validate(table, maxcols, mode: "row_cols")
+        reject_metanorma_extension.call(table) and return
         case mode
         when "row_cols"
           maxrowcols_validate0(table, maxcols, "*", mode)

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.1.3".freeze
+    VERSION = "3.1.5".freeze
   end
 end

data/metanorma-standoc.gemspec

@@ -36,6 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "metanorma", ">= 1.6.0"
   spec.add_dependency "metanorma-plugin-glossarist", "~> 0.2.3"
   spec.add_dependency "metanorma-plugin-lutaml", "~> 0.7.31"
+  spec.add_dependency "metanorma-plugin-plantuml", "~> 1.0.0"
   spec.add_dependency "metanorma-utils", "~> 1.11.0"
   spec.add_dependency "ruby-jing"
   # relaton-cli not just relaton, to avoid circular reference in metanorma

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.1.3
+  version: 3.1.5
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-04 00:00:00.000000000 Z
+date: 2025-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.31
+- !ruby/object:Gem::Dependency
+  name: metanorma-plugin-plantuml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: metanorma-utils
   requirement: !ruby/object:Gem::Requirement
@@ -447,9 +461,6 @@ files:
 - lib/asciidoctor/standoc/cleanup_toc.rb
 - lib/asciidoctor/standoc/cleanup_xref.rb
 - lib/asciidoctor/standoc/converter.rb
-- lib/asciidoctor/standoc/datamodel/attributes_table_preprocessor.rb
-- lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb
-- lib/asciidoctor/standoc/datamodel/plantuml_renderer.rb
 - lib/asciidoctor/standoc/deprecated.rb
 - lib/asciidoctor/standoc/front.rb
 - lib/asciidoctor/standoc/front_contributor.rb
@@ -458,7 +469,6 @@ files:
 - lib/asciidoctor/standoc/macros.rb
 - lib/asciidoctor/standoc/macros_form.rb
 - lib/asciidoctor/standoc/macros_note.rb
-- lib/asciidoctor/standoc/macros_plantuml.rb
 - lib/asciidoctor/standoc/macros_terms.rb
 - lib/asciidoctor/standoc/ref.rb
 - lib/asciidoctor/standoc/ref_sect.rb
@@ -515,10 +525,8 @@ files:
 - lib/metanorma/standoc/cleanup_toc.rb
 - lib/metanorma/standoc/cleanup_xref.rb
 - lib/metanorma/standoc/converter.rb
-- lib/metanorma/standoc/datamodel/attributes_table_preprocessor.rb
-- lib/metanorma/standoc/datamodel/diagram_preprocessor.rb
-- lib/metanorma/standoc/datamodel/plantuml_renderer.rb
 - lib/metanorma/standoc/front.rb
+- lib/metanorma/standoc/front_committee.rb
 - lib/metanorma/standoc/front_contributor.rb
 - lib/metanorma/standoc/front_organisation.rb
 - lib/metanorma/standoc/init.rb
@@ -533,7 +541,6 @@ files:
 - lib/metanorma/standoc/macros_inline.rb
 - lib/metanorma/standoc/macros_link.rb
 - lib/metanorma/standoc/macros_note.rb
-- lib/metanorma/standoc/macros_plantuml.rb
 - lib/metanorma/standoc/macros_terms.rb
 - lib/metanorma/standoc/merge_bibitems.rb
 - lib/metanorma/standoc/processor.rb
@@ -560,8 +567,6 @@ files:
 - lib/metanorma/standoc/validate_table.rb
 - lib/metanorma/standoc/validate_term.rb
 - lib/metanorma/standoc/version.rb
-- lib/metanorma/standoc/views/datamodel/model_representation.adoc.erb
-- lib/metanorma/standoc/views/datamodel/plantuml_representation.adoc.erb
 - metanorma-standoc.gemspec
 homepage: https://github.com/metanorma/metanorma-standoc
 licenses:

data/lib/asciidoctor/standoc/datamodel/attributes_table_preprocessor.rb

@@ -1,3 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/attributes_table_preprocessor"
-

data/lib/asciidoctor/standoc/datamodel/diagram_preprocessor.rb

@@ -1,3 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/diagram_preprocessor"
-

data/lib/asciidoctor/standoc/datamodel/plantuml_renderer.rb

@@ -1,8 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/datamodel/plantuml_renderer"
-
-module Asciidoctor
-  module Datamodel
-    PlantumlRenderer = Metanorma::Datamodel::PlantumlRenderer
-  end
-end

data/lib/asciidoctor/standoc/macros_plantuml.rb

@@ -1,2 +0,0 @@
-require "asciidoctor/standoc/deprecated"
-require "metanorma/standoc/macros_plantuml"

data/lib/metanorma/standoc/datamodel/attributes_table_preprocessor.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-
-module Metanorma
-  module Standoc
-    module Datamodel
-      class AttributesTablePreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/
-        MARCO_REGEXP = /\[datamodel_attributes_table,([^,]+),?(.+)?\]/
-        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
-        # search document for block `datamodel_attributes_table`
-        #  read include derectives that goes after that in block and transform
-        #  into yaml2text blocks
-        def process(document, reader)
-          input_lines = reader.lines.to_enum
-          Asciidoctor::PreprocessorReader.new(document, processed_lines(document, input_lines))
-        end
-
-        private
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(MARCO_REGEXP)
-              yaml_path = match[1]
-              result.push(*parse_marco(yaml_path, document))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_marco(yaml_path, document)
-          model_representation(yaml_relative_path(yaml_path, document))
-            .split("\n")
-        end
-
-        def model_representation(model_path)
-          template = File.read(File.join(
-                                 TEMPLATES_PATH,
-                                 "model_representation.adoc.erb",
-                               ))
-          file_name = File.basename(model_path).gsub(/\.ya?ml/, "")
-          ERB
-            .new(template)
-            .result(binding)
-        end
-
-        def yaml_relative_path(file_path, document)
-          directory = File.dirname(document.attributes["docfile"] || ".")
-          document.path_resolver.system_path(file_path, directory)
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standoc/datamodel/diagram_preprocessor.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require "erb"
-require "metanorma/standoc/datamodel/plantuml_renderer"
-
-module Metanorma
-  module Standoc
-    module Datamodel
-      class DiagramPreprocessor < Asciidoctor::Extensions::Preprocessor
-        BLOCK_START_REGEXP = /\{(.+?)\.\*,(.+),(.+)\}/.freeze
-        BLOCK_END_REGEXP = /\A\{[A-Z]+\}\z/.freeze
-        MARCO_REGEXP = /\[datamodel_diagram,([^,]+),?(.+)?\]/.freeze
-        TEMPLATES_PATH = File.expand_path("../views/datamodel", __dir__).freeze
-        # search document for block `datamodel_diagram`
-        #  read include derectives that goes after that in block and transform
-        #  into plantuml block
-        def process(document, reader)
-          input_lines = reader.lines.to_enum
-          Asciidoctor::PreprocessorReader.new(document, processed_lines(document, input_lines))
-        end
-
-        private
-
-        def processed_lines(document, input_lines)
-          input_lines.each_with_object([]) do |line, result|
-            if match = line.match(MARCO_REGEXP)
-              result
-                .push(*parse_datamodel_marco(match[1], match[2], document))
-            else
-              result.push(line)
-            end
-          end
-        end
-
-        def parse_datamodel_marco(yaml_path, include_path, document)
-          include_path ||= File.join(File.dirname(yaml_path), "..", "models")
-          include_path = yaml_relative_path(include_path, document)
-          yaml_relative_to_doc_path = yaml_relative_path(yaml_path, document)
-          view_hash = YAML.safe_load(File.read(yaml_relative_to_doc_path))
-          plantuml_representations(view_hash,
-                                   yaml_relative_to_doc_path,
-                                   include_path)
-        end
-
-        def yaml_relative_path(file_path, document)
-          docfile = document.attributes["docfile"] || "."
-          docfile_directory = File.dirname(docfile)
-          document.path_resolver.system_path(file_path, docfile_directory)
-        end
-
-        def import_format(include_path, import_name, values)
-          include_content = File.read(File.join(
-                                        include_path,
-                                        "#{import_name}.yml",
-                                      ))
-          content = YAML.safe_load(include_content)
-          if values
-            content["skipSection"] = values["skipSection"]
-          end
-          content
-        end
-
-        def format_import_directives(imports, include_path)
-          imports
-            .each_with_object({}) do |(import_name, values), res|
-              full_model_name = import_name.split("/").join
-              content = import_format(include_path, import_name, values)
-              res[content["name"] || full_model_name] = content
-            end.compact
-        end
-
-        def prepare_view_hash(view_hash, all_imports)
-          view_hash.merge!(
-            "classes" => model_type(all_imports, "class"),
-            "enums" => model_type(all_imports, "enum"),
-            "relations" => view_hash["relations"] || [],
-            "fidelity" => (view_hash["fidelity"] || {})
-                          .merge!("classes" => model_type(all_imports,
-                                                          "class")),
-          )
-        end
-
-        def model_type(imports, type)
-          imports
-            .select do |_name, elem|
-              elem["modelType"] == type
-            end
-        end
-
-        def plantuml_representations(view_hash, view_path, include_path)
-          yaml_directory = File.dirname(view_path)
-          all_imports = format_import_directives(view_hash["imports"],
-                                                 include_path)
-          prepare_view_hash(view_hash, all_imports)
-          Metanorma::Datamodel::PlantumlRenderer
-            .new(view_hash, File.join(yaml_directory, ".."))
-            .render
-            .split("\n")
-        end
-      end
-    end
-  end
-end