metanorma-standoc 3.2.3 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28bd8a376c38860e39c6840a844b3fdac0ea8bf45c4c61eeef893fa21e4de049
-  data.tar.gz: 4820f805b27e15cbb35f1bfc77db8eccd43c085dae7b090e2999815648139853
+  metadata.gz: ec17f7140bc90f4bf870ab2ecf47e42adacc489e4e5dfc8802dbbea87a31973f
+  data.tar.gz: 3da2d1e8a995ebc3d5fb5fe10694cd1094343261e58667007250ed07dde5ea1b
 SHA512:
-  metadata.gz: be84017250c088954b72385cb75f181a3ac47dcfb007af7ee3566e7c585241c2b3ac27f1ea898abc2d95d41d86e3b8a1f6f4e8b418b4356f96fbc5c5d8766ab8
-  data.tar.gz: fa245adfa071ae6c1ce0a16c641c019236549b86a44f2e1c934d38f6b7a449cb84dfc73d6c3f639c9fa3a9f489d8080e3c22c6c6f6fae3103309f6b08e8f7a7a
+  metadata.gz: 44afc48d384a6c8685b223feaa5905a56cc1d3ee9b572abd221b839be690698d73bb253539abe8f4ece2810185ebd6dc64321a0aa7335007a6384ad4fbea2f18
+  data.tar.gz: dc1ef34776bca5944dec22bad965498970de309848b4fb9c9370dfe303490d57b5dceedae26bac8f0b5cce7642318a607c613fa0044ba10e5fd6b58972ed9a3e

data/lib/metanorma/standoc/biblio.rng

@@ -466,11 +466,11 @@ Editorial and advisory groups are represented as consecutive subdivisions of the
         <a:documentation>Contact information for the organization, including address, phone number, and email</a:documentation>
       </ref>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="logo">
         <a:documentation>A logo for the organization</a:documentation>
       </ref>
-    </optional>
+    </zeroOrMore>
   </define>
   <define name="orgname">
     <element name="name">
@@ -502,6 +502,11 @@ Editorial and advisory groups are represented as consecutive subdivisions of the
   </define>
   <define name="logo">
     <element name="logo">
+      <optional>
+        <attribute name="type">
+          <a:documentation>The type of logo</a:documentation>
+        </attribute>
+      </optional>
       <ref name="image-no-id"/>
     </element>
   </define>
@@ -513,6 +518,11 @@ Editorial and advisory groups are represented as consecutive subdivisions of the
           <a:documentation>Description of what is being depicted</a:documentation>
         </attribute>
       </optional>
+      <optional>
+        <attribute name="type">
+          <a:documentation>Description of what kind of depiction this</a:documentation>
+        </attribute>
+      </optional>
       <zeroOrMore>
         <ref name="image-no-id">
           <a:documentation>A visual depiction of the bibliographic item</a:documentation>
@@ -1236,9 +1246,9 @@ Refer to `BibliographicItem` for definitions</a:documentation>
     <optional>
       <ref name="validity"/>
     </optional>
-    <optional>
+    <zeroOrMore>
       <ref name="depiction"/>
-    </optional>
+    </zeroOrMore>
   </define>
   <define name="btitle">
     <a:documentation>A title of a bibliographic item, associated with a type of title</a:documentation>

data/lib/metanorma/standoc/init.rb

@@ -134,11 +134,19 @@ module Metanorma
       end
 
       def i18nyaml_path(node)
-        if i18nyaml = node.attr("i18nyaml")
-          (Pathname.new i18nyaml).absolute? or
-            i18nyaml = File.join(@localdir, i18nyaml)
+        if ret = node.attr("i18nyaml")
+          (Pathname.new ret).absolute? or
+            ret = File.join(@localdir, ret)
         end
-        i18nyaml
+        ret
+      end
+
+      def relaton_render_path(node)
+        if ret = node.attr("relaton-render-config")
+          (Pathname.new ret).absolute? or
+            ret = File.join(@localdir, ret)
+        end
+        ret
       end
 
       def init_i18n(node)

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.4 -->
+<!-- VERSION v2.1.5 -->
 
   <!--
     ALERT: cannot have root comments, because of https://github.com/metanorma/metanorma/issues/437

data/lib/metanorma/standoc/log.rb

@@ -180,6 +180,9 @@ module Metanorma
         "STANDOC_58": { category: "Images",
                         error: "Corrupt SVG image detected, fix attempted: %s %s: %s %s, Node: %s",
                         severity: 2 },
+        "STANDOC_59": { category: "Images",
+                        error: "SVG unresolved internal reference: %s line %s",
+                        severity: 3 },
         "RELATON_1": { category: "Relaton",
                        error: "(Error from Relaton) %s",
                        severity: 0 },

data/lib/metanorma/standoc/render.rb

@@ -3,12 +3,14 @@ module Metanorma
     module Base
       def html_extract_attributes(node)
         i18nyaml = i18nyaml_path(node)
+        relaton_render_config = relaton_render_path(node)
         {
           script: node.attr("script"),
           bodyfont: node.attr("body-font"),
           headerfont: node.attr("header-font"),
           monospacefont: node.attr("monospace-font"),
           i18nyaml: i18nyaml,
+          relatonrenderconfig: relaton_render_config,
           scope: node.attr("scope"),
           htmlstylesheet: node.attr("htmlstylesheet") || node.attr("html-stylesheet"),
           htmlstylesheet_override: node.attr("htmlstylesheet-override") || node.attr("html-stylesheet-override"),
@@ -50,12 +52,14 @@ module Metanorma
 
       def doc_extract_attributes(node)
         i18nyaml = i18nyaml_path(node)
+        relaton_render_config = relaton_render_path(node)
         attrs = {
           script: node.attr("script"),
           bodyfont: node.attr("body-font"),
           headerfont: node.attr("header-font"),
           monospacefont: node.attr("monospace-font"),
           i18nyaml: i18nyaml,
+          relatonrenderconfig: relaton_render_config,
           scope: node.attr("scope"),
           wordstylesheet: node.attr("wordstylesheet") || node.attr("word-stylesheet"),
           wordstylesheet_override: node.attr("wordstylesheet-override") || node.attr("word-stylesheet-override"),

data/lib/metanorma/standoc/validate_image.rb

@@ -8,8 +8,7 @@ module Metanorma
         image_exists(doc)
         image_toobig(doc)
         png_validate(doc)
-        # disabled until gem is performant
-        # svg_validate(doc)
+        svg_validate(doc)
       end
 
       def image_exists(doc)
@@ -55,31 +54,62 @@ module Metanorma
         end
       end
 
+      # Use SAX for fast validation
       def svg_validate(doc)
         profile = SvgConform::Profiles.get(@svg_conform_profile)
-        remediatable = profile.remediation_count.positive?
+        validator = SvgConform::Validator.new(mode: :sax)
         engine = SvgConform::RemediationEngine.new(profile)
-        doc.xpath("//m:svg", "m" => SVG_NS).each do |s|
-          d, result = svg_validate1(profile, s)
-          remediatable && !result.valid? and
-            svg_validate_fix(profile, engine, d, s, result)
+        doc.xpath("//m:svg", "m" => SVG_NS).each do |svg_element|
+          result = svg_validate1(validator, profile, svg_element)
+          if profile.remediation_count.positive? && !result.valid?
+            svg_validate_fix(validator, profile, engine, svg_element, result)
+          end
         end
       end
 
-      def svg_validate1(profile, svg)
-        d = SvgConform::Document.from_content(svg.to_xml)
-        r = profile.validate(d)
-        svg_error("STANDOC_55", svg, r.errors)
-        svg_error("STANDOC_57", svg, r.warnings)
-        [d, r]
+      def svg_validate1(validator, profile, svg)
+        # require "debug"; binding.b
+        result = validator.validate(svg, profile: profile)
+        svg_error("STANDOC_55", svg, result.errors)
+        svg_error("STANDOC_57", svg, result.warnings)
+        svg_reference_violations(svg, result)
+        result
+      end
+
+      # we are ignoring external references as out of our scope to resolve;
+      # example code just in case this comes up
+      #
+      #  manifest = result.reference_manifest
+      #  if result.has_external_references?
+      #    puts "External references found: #{result.external_references.size}"
+      #    result.external_references.each do |ref|
+      #      puts "#{ref.class.name}: #{ref.value}"
+      #      puts "  Element: #{ref.element_name} at line #{ref.line_number}"
+      #     end
+      #   end
+      #   puts "IDs defined: #{result.available_ids.map(&:id_value).join(', ')}"
+
+      # Check for unresolved internal references
+      def svg_reference_violations(svg, result)
+        result.unresolved_internal_references&.each do |ref|
+          val = ref.value.sub(/^#/, "")
+          @doc_ids.include?(val) and next
+          @doc_anchors.include?(val) and next
+          @log.add("STANDOC_59", svg, params: [ref.value, ref.line_number])
+        end
       end
 
-      def svg_validate_fix(profile, engine, doc, svg, result)
+      # Apply remediation if needed
+      def svg_validate_fix(validator, profile, engine, svg, result)
+        # Load DOM only for remediation
+        doc = SvgConform::Document.from_content(svg.to_xml)
         remeds = engine.apply_remediations(doc, result)
         svg_remed_log(remeds, svg)
-        result = profile.validate(doc)
+        # Use root to avoid processing instructions that may break SAX parser
+        remediated_xml = doc.root.to_xml
+        result = validator.validate(remediated_xml, profile: profile)
         svg_error("STANDOC_56", svg, result.errors) # we still have errors
-        svg.replace(doc.to_xml)
+        svg.replace(remediated_xml)
       end
 
       def svg_remed_log(remeds, svg)
@@ -94,6 +124,8 @@ module Metanorma
 
       def svg_error(id, svg, errors)
         errors.each do |err|
+          # reference violations are handled separately
+          err.violation_type == :reference_violation and next
           err.respond_to?(:element) && err.element and
             elem = " Element: #{err.element}"
           err.respond_to?(:location) && err.location and

data/lib/metanorma/standoc/validate_schema.rb

@@ -27,12 +27,24 @@ module Metanorma
       def schema_validate1(file, doc, schema)
         file.write(to_xml(doc))
         file.close
-        errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
-        warn "Syntax Valid!" if errors.none?
-        errors.each do |e|
-          @log.add("STANDOC_7",
-                   "XML Line #{'%06d' % e[:line]}:#{e[:column]}",
-                   params: [e[:message]])
+
+        # Force UTF-8 encoding for Java console output to fix Japanese Windows issue
+        # See: https://github.com/metanorma/mn-samples-plateau/issues/248
+        # The -Dsun.jnu.encoding parameter controls Java's native interface encoding (console I/O)
+        old_java_opts = ENV["_JAVA_OPTIONS"]
+        ENV["_JAVA_OPTIONS"] = "-Dfile.encoding=UTF-8 -Dsun.jnu.encoding=UTF-8"
+
+        begin
+          errors = Jing.new(schema, encoding: "UTF-8").validate(file.path)
+          warn "Syntax Valid!" if errors.none?
+          errors.each do |e|
+            @log.add("STANDOC_7",
+                     "XML Line #{'%06d' % e[:line]}:#{e[:column]}",
+                     params: [e[:message]])
+          end
+        ensure
+          # Restore original _JAVA_OPTIONS
+          ENV["_JAVA_OPTIONS"] = old_java_opts
         end
       end
 

data/lib/metanorma/standoc/version.rb

@@ -19,6 +19,6 @@ module Metanorma
   end
 
   module Standoc
-    VERSION = "3.2.3".freeze
+    VERSION = "3.2.4".freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-standoc
 version: !ruby/object:Gem::Version
-  version: 3.2.3
+  version: 3.2.4
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-11-18 00:00:00.000000000 Z
+date: 2025-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable