metanorma-document 0.3.0 → 0.5.0

data/lib/metanorma/mirror/model/guide.rb

@@ -4,12 +4,13 @@ module Metanorma
   module Mirror
     module Model
       class Guide
-        attr_reader :content, :meta, :title
+        attr_reader :content, :meta, :title, :document
 
-        def initialize(content:, meta: {}, title: nil)
+        def initialize(content:, meta: {}, title: nil, document: nil)
           @content = content
           @meta = meta
           @title = title
+          @document = document
         end
 
         def to_h

data/lib/metanorma/mirror/output/formats/inline_format.rb

@@ -8,12 +8,42 @@ module Metanorma
     module Output
       module Formats
         class InlineFormat < BaseFormat
+          # Classic content styles inlined for the no-JS SSR body: reset +
+          # typography + block/inline component styles from the classic
+          # asset pipeline. Page chrome (layout, print, transitions, dark,
+          # cover, header, footer, toc, search, progress, shortcuts,
+          # glossary panel, flavor modules) is owned by the SPA and
+          # excluded.
+          CONTENT_CSS_MODULES = %w[
+            base/_reset
+            base/_typography
+            components/section
+            components/note
+            components/example
+            components/sourcecode
+            components/formula
+            components/admonition
+            components/table
+            components/footnote
+            components/figure
+            components/term
+            components/bibliography
+            components/inline
+            components/index
+          ].freeze
+
+          class << self
+            attr_accessor :missing_bundle_warned
+          end
+
           def write(output_path, guide, title: "Metanorma")
             FileUtils.mkdir_p(File.dirname(output_path))
 
-            data_script = "window.METANORMA_DATA = #{safe_json(guide)};"
-            ssr_body = HtmlRenderer.new(guide).render
-            head_parts = []
+            warn_missing_bundle unless iife_bundle_exists?
+
+            data_script = "window.METANORMA_DATA = #{safe_json(guide.to_h)};"
+            ssr_body = render_ssr_body(guide)
+            head_parts = [build_style(classic_content_css)]
             css_inline = read_css_inline
             if css_inline && !css_inline.empty?
               head_parts << build_style(css_inline)
@@ -42,6 +72,37 @@ module Metanorma
 
           private
 
+          # SSR body is the classic renderer's document body: identical to
+          # the static HTML output, embedded as the no-JS / first-paint
+          # placeholder the SPA replaces on mount.
+          def render_ssr_body(guide)
+            document = guide.document
+            unless document
+              raise ArgumentError,
+                    "InlineFormat requires a Guide carrying its source document"
+            end
+
+            renderer = Metanorma::Html::Generator.renderer_for(document).new
+            renderer.generate_body(document)
+          end
+
+          def classic_content_css
+            css_dir = Metanorma::Html::AssetPipeline::CSS_DIR
+            CONTENT_CSS_MODULES.filter_map do |mod|
+              path = File.join(css_dir, "#{mod}.css")
+              File.read(path) if File.exist?(path)
+            end.join("\n")
+          end
+
+          def warn_missing_bundle
+            return if self.class.missing_bundle_warned
+
+            warn "metanorma-document: #{iife_bundle_path} not found — " \
+                 "writing static HTML without the interactive SPA. " \
+                 "Run `rake build_frontend` to build it."
+            self.class.missing_bundle_warned = true
+          end
+
           def build_style(css)
             Nokogiri::HTML5::Builder.new do |doc|
               doc.style { doc.text css }

data/lib/metanorma/mirror/output/pipeline.rb

@@ -23,6 +23,7 @@ id_strategy: nil)
             content: @context.content,
             meta: @context.meta,
             title: @context.title,
+            document: @context.parsed,
           )
         end
 

data/lib/metanorma/mirror/output.rb

@@ -6,8 +6,6 @@ module Metanorma
       autoload :Pipeline, "#{__dir__}/output/pipeline"
       autoload :PipelineContext, "#{__dir__}/output/pipeline_context"
       autoload :Builder, "#{__dir__}/output/builder"
-      autoload :HtmlRenderers, "#{__dir__}/output/html_renderers"
-      autoload :HtmlRenderer, "#{__dir__}/output/html_renderer"
       autoload :Formats, "#{__dir__}/output/formats"
     end
   end

data/lib/metanorma/mirror/rewriter.rb

@@ -6,7 +6,9 @@ module Metanorma
     # per-type customization. Despite living in the reverse-conversion
     # namespace, this class produces a Model graph (not Metanorma XML) —
     # the output is a fully model-driven representation that can be
-    # serialized via Model#to_h or rendered via Output::HtmlRenderer.
+    # serialized via Model#to_h or embedded into HTML output by
+    # Output::Formats::InlineFormat (which renders the source document
+    # through the classic Metanorma::Html renderer).
     #
     # Instance API:
     #   Rewriter.new(skip: Set.new(%w[review footnotes]))

data/lib/metanorma/registers/setup.rb

@@ -38,8 +38,8 @@ module Metanorma
           Lutaml::Model::GlobalRegister.register(reg)
         end
 
-        def setup_oiml_register
-          reg = Lutaml::Model::Register.new(:oiml_document,
+        def setup_csa_register
+          reg = Lutaml::Model::Register.new(:csa_document,
                                             fallback: [:iso_document])
           Lutaml::Model::GlobalRegister.register(reg)
         end
@@ -155,6 +155,10 @@ module Metanorma
             from_type: sd::Sections::Preface,
             to_type: Metanorma::UnDocument::Sections::UnPreface,
           )
+          reg.register_global_type_substitution(
+            from_type: Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
+            to_type: Metanorma::UnDocument::Blocks::UnAdmonitionBlock,
+          )
         end
       end
     end

data/lib/metanorma/standard_document/annotation_container.rb

@@ -10,6 +10,7 @@ module Metanorma
         attribute :to, :string
         attribute :type, :string
         attribute :date, :string
+        attribute :semx_id, :string
         attribute :paragraphs,
                   Metanorma::Document::Components::Paragraphs::ParagraphBlock,
                   collection: true
@@ -22,6 +23,7 @@ module Metanorma
           map_attribute "to", to: :to
           map_attribute "type", to: :type
           map_attribute "date", to: :date
+          map_attribute "semx-id", to: :semx_id
           map_element "p", to: :paragraphs
         end
       end

data/lib/metanorma/standard_document/elements/input.rb

@@ -3,31 +3,10 @@
 module Metanorma
   module StandardDocument
     module Elements
-      # Indication of text added through editorial intervention.
-      class Input < Metanorma::StandardDocument::Elements::FormInput
-        attribute :type, :string
-        attribute :checked, :boolean
-        attribute :disabled, :boolean
-        attribute :readonly, :boolean
-        attribute :maxlength, :integer
-        attribute :minlength, :integer
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-
-        xml do
-          element "input"
-          map_attribute "type", to: :type
-          map_attribute "checked", to: :checked
-          map_attribute "disabled", to: :disabled
-          map_attribute "readonly", to: :readonly
-          map_attribute "maxlength", to: :maxlength
-          map_attribute "minlength", to: :minlength
-
-          map_attribute "semx-id", to: :semx_id
-          map_attribute "original-id", to: :original_id
-        end
-      end
+      # Kept as the StandardDocument-layer alias of the document-layer
+      # Input model (see lib/metanorma/document/elements/input.rb) so
+      # existing StandardDocument references keep working.
+      Input = Metanorma::Document::Elements::Input
     end
   end
 end

data/lib/metanorma/standard_document/metadata/metanorma_extension.rb

@@ -3,12 +3,22 @@
 module Metanorma
   module StandardDocument
     module Metadata
+      # <metanorma-extension> holds processor-generated metadata.
+      # Children, when present, appear in this fixed order:
+      # semantic-metadata, presentation-metadata, UnitsML,
+      # source-highlighter-css.
       class MetanormaExtension < Lutaml::Model::Serializable
-        attribute :content, :string
+        attribute :semantic_metadata, SemanticMetadata
+        attribute :presentation_metadata, PresentationMetadata
+        attribute :unitsml, Unitsml::UnitsmlRoot
+        attribute :source_highlighter_css, :string
 
         xml do
           element "metanorma-extension"
-          map_all_content to: :content
+          map_element "semantic-metadata", to: :semantic_metadata
+          map_element "presentation-metadata", to: :presentation_metadata
+          map_element "UnitsML", to: :unitsml
+          map_element "source-highlighter-css", to: :source_highlighter_css
         end
       end
     end

data/lib/metanorma/standard_document/metadata/presentation_metadata.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # <presentation-metadata> carries rendering hints for the document.
+      #
+      # Current serialization uses typed children (toc-heading-levels,
+      # document-scheme, the OGC color-* family, OIML doctype-alias/fonts,
+      # isodoc html-details-open). The legacy serialization (still emitted
+      # into misc-container by some flavors) uses <name>/<value> pairs
+      # instead. Both shapes are mapped here so either round-trips
+      # losslessly. map_element order matches the order emitted by
+      # metanorma across spec fixtures.
+      class PresentationMetadata < Lutaml::Model::Serializable
+        attribute :doctype_alias, :string
+        attribute :document_scheme, :string
+        attribute :color_admonition_caution, :string
+        attribute :color_admonition_editor, :string
+        attribute :color_admonition_important, :string
+        attribute :color_admonition_note, :string
+        attribute :color_admonition_safety_precaution, :string
+        attribute :color_admonition_tip, :string
+        attribute :color_admonition_todo, :string
+        attribute :color_admonition_warning, :string
+        attribute :color_background_definition_description, :string
+        attribute :color_background_definition_term, :string
+        attribute :color_background_page, :string
+        attribute :color_background_table_header, :string
+        attribute :color_background_table_row_even, :string
+        attribute :color_background_table_row_odd, :string
+        attribute :color_background_term_admitted_label, :string
+        attribute :color_background_term_deprecated_label, :string
+        attribute :color_background_term_preferred_label, :string
+        attribute :color_background_text_label_legacy, :string
+        attribute :color_secondary_shade1, :string
+        attribute :color_secondary_shade2, :string
+        attribute :color_text, :string
+        attribute :color_text_title, :string
+        attribute :toc_heading_levels, :string
+        attribute :html_toc_heading_levels, :string
+        attribute :doc_toc_heading_levels, :string
+        attribute :pdf_toc_heading_levels, :string
+        attribute :html_details_open, :string
+        attribute :fonts, :string, collection: true
+        attribute :name, :string
+        attribute :value, :string
+
+        xml do
+          element "presentation-metadata"
+          map_element "doctype-alias", to: :doctype_alias
+          map_element "document-scheme", to: :document_scheme
+          map_element "color-admonition-caution",
+                      to: :color_admonition_caution
+          map_element "color-admonition-editor",
+                      to: :color_admonition_editor
+          map_element "color-admonition-important",
+                      to: :color_admonition_important
+          map_element "color-admonition-note",
+                      to: :color_admonition_note
+          map_element "color-admonition-safety-precaution",
+                      to: :color_admonition_safety_precaution
+          map_element "color-admonition-tip",
+                      to: :color_admonition_tip
+          map_element "color-admonition-todo",
+                      to: :color_admonition_todo
+          map_element "color-admonition-warning",
+                      to: :color_admonition_warning
+          map_element "color-background-definition-description",
+                      to: :color_background_definition_description
+          map_element "color-background-definition-term",
+                      to: :color_background_definition_term
+          map_element "color-background-page",
+                      to: :color_background_page
+          map_element "color-background-table-header",
+                      to: :color_background_table_header
+          map_element "color-background-table-row-even",
+                      to: :color_background_table_row_even
+          map_element "color-background-table-row-odd",
+                      to: :color_background_table_row_odd
+          map_element "color-background-term-admitted-label",
+                      to: :color_background_term_admitted_label
+          map_element "color-background-term-deprecated-label",
+                      to: :color_background_term_deprecated_label
+          map_element "color-background-term-preferred-label",
+                      to: :color_background_term_preferred_label
+          map_element "color-background-text-label-legacy",
+                      to: :color_background_text_label_legacy
+          map_element "color-secondary-shade-1",
+                      to: :color_secondary_shade1
+          map_element "color-secondary-shade-2",
+                      to: :color_secondary_shade2
+          map_element "color-text", to: :color_text
+          map_element "color-text-title", to: :color_text_title
+          map_element "toc-heading-levels", to: :toc_heading_levels
+          map_element "html-toc-heading-levels", to: :html_toc_heading_levels
+          map_element "doc-toc-heading-levels", to: :doc_toc_heading_levels
+          map_element "pdf-toc-heading-levels", to: :pdf_toc_heading_levels
+          map_element "html-details-open", to: :html_details_open
+          map_element "fonts", to: :fonts
+          map_element "name", to: :name
+          map_element "value", to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/semantic_metadata.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # <semantic-metadata> carries semantic flags about the document
+      # (only <stage-published> has been observed in the wild).
+      class SemanticMetadata < Lutaml::Model::Serializable
+        attribute :stage_published, :string
+
+        xml do
+          element "semantic-metadata"
+          map_element "stage-published", to: :stage_published
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/amount_of_substance.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class AmountOfSubstance < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "AmountOfSubstance"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/base_quantity.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        # Shared attributes for the eight UnitsML base-quantity elements
+        # (Length, Mass, Time, ElectricCurrent, AmountOfSubstance,
+        # ThermodynamicTemperature, LuminousIntensity, PlaneAngle).
+        module BaseQuantityAttributes
+          def self.included(base)
+            base.class_eval do
+              attribute :symbol, :string
+              attribute :power_numerator, :integer
+              attribute :power_denominator, :integer
+            end
+          end
+        end
+
+        # Shared attribute mappings for the base-quantity elements.
+        # lutaml-model does not inherit xml mappings, so each per-tag class
+        # applies this inside its own `xml do` block (same pattern as
+        # StandardDocument::RootXmlMapping).
+        module BaseQuantityXmlMapping
+          def self.apply(mapping)
+            mapping.map_attribute "symbol", to: :symbol
+            mapping.map_attribute "powerNumerator", to: :power_numerator
+            mapping.map_attribute "powerDenominator", to: :power_denominator
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/dimension.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class Dimension < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :semx_id, :string
+
+          attribute :length, Length
+          attribute :mass, Mass
+          attribute :time, Time
+          attribute :electric_current, ElectricCurrent
+          attribute :thermodynamic_temperature, ThermodynamicTemperature
+          attribute :amount_of_substance, AmountOfSubstance
+          attribute :luminous_intensity, LuminousIntensity
+          attribute :plane_angle, PlaneAngle
+
+          xml do
+            element "Dimension"
+            namespace Unitsml::Namespace
+            map_attribute "id", to: :id
+            map_attribute "semx-id", to: :semx_id
+            map_element "Length", to: :length
+            map_element "Mass", to: :mass
+            map_element "Time", to: :time
+            map_element "ElectricCurrent", to: :electric_current
+            map_element "ThermodynamicTemperature",
+                        to: :thermodynamic_temperature
+            map_element "AmountOfSubstance", to: :amount_of_substance
+            map_element "LuminousIntensity", to: :luminous_intensity
+            map_element "PlaneAngle", to: :plane_angle
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/dimension_set.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class DimensionSet < Lutaml::Model::Serializable
+          attribute :dimension, Dimension, collection: true
+
+          xml do
+            element "DimensionSet"
+            namespace Unitsml::Namespace
+            map_element "Dimension", to: :dimension
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/electric_current.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class ElectricCurrent < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "ElectricCurrent"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/enumerated_root_unit.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class EnumeratedRootUnit < Lutaml::Model::Serializable
+          attribute :unit, :string
+          attribute :prefix, :string
+          attribute :power_numerator, :integer
+
+          xml do
+            element "EnumeratedRootUnit"
+            namespace Unitsml::Namespace
+            map_attribute "unit", to: :unit
+            map_attribute "prefix", to: :prefix
+            map_attribute "powerNumerator", to: :power_numerator
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/length.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class Length < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "Length"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/luminous_intensity.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class LuminousIntensity < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "LuminousIntensity"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/mass.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class Mass < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "Mass"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/namespace.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        # UnitsML vocabulary namespace. Fixtures use the default-namespace
+        # form (<UnitsML xmlns="..."> with unprefixed children), so no
+        # prefix_default is declared.
+        class Namespace < Lutaml::Xml::Namespace
+          uri "https://schema.unitsml.org/unitsml/1.0"
+          element_form_default :qualified
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/plane_angle.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class PlaneAngle < Lutaml::Model::Serializable
+          include BaseQuantityAttributes
+
+          xml do
+            element "PlaneAngle"
+            namespace Unitsml::Namespace
+            BaseQuantityXmlMapping.apply(self)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/prefix.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class Prefix < Lutaml::Model::Serializable
+          attribute :prefix_base, :integer
+          attribute :prefix_power, :integer
+          attribute :id, :string
+          attribute :semx_id, :string
+
+          attribute :prefix_name, PrefixName
+          attribute :prefix_symbol, PrefixSymbol, collection: true
+
+          xml do
+            element "Prefix"
+            namespace Unitsml::Namespace
+            map_attribute "prefixBase", to: :prefix_base
+            map_attribute "prefixPower", to: :prefix_power
+            map_attribute "id", to: :id
+            map_attribute "semx-id", to: :semx_id
+            map_element "PrefixName", to: :prefix_name
+            map_element "PrefixSymbol", to: :prefix_symbol
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/unitsml/prefix_name.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      module Unitsml
+        class PrefixName < Lutaml::Model::Serializable
+          attribute :lang, :string
+          attribute :text, :string
+
+          xml do
+            element "PrefixName"
+            namespace Unitsml::Namespace
+            map_attribute "lang", to: :lang
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end