metanorma-document 0.2.9 → 0.2.12

data/lib/metanorma/document/components/inline/fmt_concept_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtConceptElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :text, :string, collection: true
           attribute :semx, SemxElement, collection: true
           attribute :eref, ErefElement, collection: true

data/lib/metanorma/document/components/inline/fmt_definition_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtDefinitionElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :semx, SemxElement, collection: true
 

data/lib/metanorma/document/components/inline/fmt_fn_body_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtFnBodyElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :target, :string
           attribute :reference, :string

data/lib/metanorma/document/components/inline/fmt_fn_label_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtFnLabelElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :text, :string, collection: true
           attribute :span, SpanElement, collection: true
           attribute :semx, SemxElement, collection: true

data/lib/metanorma/document/components/inline/fmt_footnote_container_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtFootnoteContainerElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :fmt_fn_body, FmtFnBodyElement, collection: true
 
           xml do

data/lib/metanorma/document/components/inline/fmt_identifier_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtIdentifierElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :tt, TtElement, collection: true
 
           xml do

data/lib/metanorma/document/components/inline/fmt_name_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtNameElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :id, :string
           attribute :text, :string, collection: true
           attribute :span, SpanElement, collection: true

data/lib/metanorma/document/components/inline/fmt_preferred_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtPreferredElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
 

data/lib/metanorma/document/components/inline/fmt_sourcecode_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtSourcecodeElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :lang, :string
           attribute :id, :string
           attribute :semx_id, :string

data/lib/metanorma/document/components/inline/fmt_stem_element.rb

@@ -1,14 +1,24 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
+        # Rendered counterpart of `<stem>`. Produced by presentation XML
+        # transformation. Wraps a `<semx>` carrying the locale-rendered
+        # form of the math (e.g. decimal commas, thousands separators).
         class FmtStemElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :stem_type, :string
+          attribute :text, :string, collection: true
           attribute :semx, SemxElement, collection: true
 
           xml do
             element "fmt-stem"
+            mixed_content
             map_attribute "type", to: :stem_type
+            map_content to: :text
             map_element "semx", to: :semx
           end
         end

data/lib/metanorma/document/components/inline/fmt_termsource_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtTermsourceElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :status, :string
           attribute :type, :string
           attribute :semx, SemxElement

data/lib/metanorma/document/components/inline/fmt_title_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtTitleElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :depth, :string
           attribute :id, :string
           attribute :text, :string, collection: true

data/lib/metanorma/document/components/inline/fmt_xref_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtXrefElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :target, :string
           attribute :type, :string
           attribute :text, :string, collection: true

data/lib/metanorma/document/components/inline/fmt_xref_label_element.rb

@@ -1,8 +1,12 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
         class FmtXrefLabelElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
           attribute :container, :string
           attribute :text, :string, collection: true
           attribute :semx, SemxElement, collection: true

data/lib/metanorma/document/components/inline/fn_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/link_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/localized_string_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/localized_strings_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/location_element.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # A secondary target inside an `<xref>` for multi-target cross
+        # references (e.g. "see Figure 4, 5.1.6 and 5.1.7"). Carries the
+        # target id and the connective used to join it to the previous
+        # target.
+        class LocationElement < Lutaml::Model::Serializable
+          attribute :target, :string
+          attribute :connective, :string
+
+          xml do
+            element "location"
+            map_attribute "target", to: :target
+            map_attribute "connective", to: :connective
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/math_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/name_with_id_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
@@ -6,12 +8,14 @@ module Metanorma
           attribute :id, :string
           attribute :semx_id, :string
           attribute :text, :string
+          attribute :stem, TextElements::StemElement, collection: true
 
           xml do
             element "name"
             map_attribute "id", to: :id
             map_attribute "semx-id", to: :semx_id
             map_content to: :text
+            map_element "stem", to: :stem
           end
         end
       end

data/lib/metanorma/document/components/inline/rendered_display.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Marker module for `fmt-*` element classes — the rendered
+        # counterparts of semantic elements. Including this module marks
+        # a class as a presentation-layer sibling (e.g. `FmtStemElement`
+        # is the rendered counterpart of `StemInlineElement`).
+        #
+        # Used by `SemanticContent#each_semantic_content` to filter out
+        # rendered siblings so consumers iterating semantic content don't
+        # see both forms of the same logical content.
+        #
+        # Adding a new `fmt-*` class means one `include RenderedDisplay`
+        # line — no edits to the filtering logic.
+        module RenderedDisplay
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/rendered_math_element.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Math content inside an `<fmt-stem><semx>` rendered-display
+        # element. Represents the locale-rendered form of the math —
+        # decimal commas, thousands separators, locale-specific
+        # digit grouping.
+        #
+        # Subclass of `MathElement` so consumers that don't care about the
+        # distinction continue to work via the base class. Consumers that
+        # need to distinguish semantic from rendered forms use
+        # `math.is_a?(RenderedMathElement)` vs `math.is_a?(SemanticMathElement)`.
+        class RenderedMathElement < MathElement
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/semantic_content.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Iterator that yields only the semantic (canonical) children of a
+        # mixed-content element, skipping any rendered-display (`fmt-*`)
+        # siblings.
+        #
+        # Background: in Metanorma presentation XML, every semantic
+        # element with locale-sensitive rendering has a `fmt-*` sibling
+        # (e.g. `<stem>` + `<fmt-stem>`). When both are present in the
+        # same parent, `each_mixed_content` yields both — duplicating
+        # the logical content.
+        #
+        # Usage:
+        #
+        #   SemanticContent.each(paragraph) do |node|
+        #     # yields semantic children only; fmt_* skipped
+        #   end
+        #
+        #   SemanticContent.each(paragraph).to_a   # => Enumerator
+        #
+        # Consumers that want the rendered form access it directly via
+        # `node.fmt_*` attributes — no iterator needed.
+        module SemanticContent
+          class << self
+            def each(element, &block)
+              return enum_for(:each, element) unless block
+
+              element.each_mixed_content do |node|
+                next if rendered_display?(node)
+
+                yield node
+              end
+            end
+
+            private
+
+            def rendered_display?(node)
+              return false unless node.is_a?(Lutaml::Model::Serializable)
+
+              node.is_a?(RenderedDisplay)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/semantic_math_element.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Math content inside a semantic `<stem>` element. Represents the
+        # canonical form of the math — decimal periods, no locale-specific
+        # thousands separators.
+        #
+        # Subclass of `MathElement` so consumers that don't care about the
+        # distinction continue to work via the base class. Consumers that
+        # need to distinguish semantic from rendered forms use
+        # `math.is_a?(SemanticMathElement)` vs `math.is_a?(RenderedMathElement)`.
+        class SemanticMathElement < MathElement
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/inline/semx_child_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/semx_element.rb

@@ -1,7 +1,19 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
+        # <semx> wraps a rendered-display slice of an inline element.
+        #
+        # Known limitation (BUGS.sts 06, filed upstream against
+        # lutaml-model): when this element is parsed nested inside
+        # another mixed_content parent, the direct text content of
+        # <semx> may be captured by the parent's text attribute rather
+        # than by SemxElement#text. Standalone parsing works correctly.
+        # See TODO.bugs/06-nested-mixed-content-text-ownership.md and
+        # https://github.com/lutaml/lutaml-model bug
+        # "nested-mixed-content-text-ownership".
         class SemxElement < Lutaml::Model::Serializable
           attribute :element_attr, :string
           attribute :source, :string
@@ -11,7 +23,7 @@ module Metanorma
           attribute :fmt_concept, "Metanorma::Document::Components::Inline::FmtConceptElement",
                     collection: true
           attribute :asciimath, AsciimathElement, collection: true
-          attribute :math, MathElement, collection: true
+          attribute :math, RenderedMathElement, collection: true
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
           attribute :semx, "Metanorma::Document::Components::Inline::SemxElement",

data/lib/metanorma/document/components/inline/small_cap_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/span_element.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
+        # A `<span>` wraps arbitrary inline content for styling or
+        # classification. It accepts the full inline vocabulary — see
+        # `Inline::Vocabulary` for the rationale.
         class SpanElement < Lutaml::Model::Serializable
+          include Inline::Vocabulary
+
           attribute :class_attr, :string
           attribute :style, :string
-          attribute :text, :string, collection: true
-          attribute :semx, SemxElement, collection: true
-          attribute :span, SpanElement, collection: true
-          attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
-                    collection: true
-          attribute :tab, TabElement, collection: true
-          attribute :sup, SupElement, collection: true
-          attribute :br, BrElement, collection: true
-          attribute :callout, "Metanorma::Document::Components::ReferenceElements::Callout",
+          attribute :callout,
+                    Metanorma::Document::Components::ReferenceElements::Callout,
                     collection: true
 
           xml do
@@ -22,13 +22,8 @@ module Metanorma
             map_attribute "class", to: :class_attr
             map_attribute "style", to: :style
             map_content to: :text
-            map_element "semx", to: :semx
-            map_element "span", to: :span
-            map_element "strong", to: :strong
-            map_element "tab", to: :tab
-            map_element "sup", to: :sup
-            map_element "br", to: :br
             map_element "callout", to: :callout
+            Vocabulary::VocabularyXmlMapping.apply_inline_mappings(self)
           end
         end
       end

data/lib/metanorma/document/components/inline/stem_inline_element.rb

@@ -1,13 +1,19 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
       module Inline
+        # Semantic `<stem>` element carrying canonical math content.
+        # The `math` attribute contains `SemanticMathElement` instances
+        # — the canonical form (decimal periods, no locale separators).
+        # For the rendered form, see `FmtStemElement`.
         class StemInlineElement < Lutaml::Model::Serializable
           attribute :id, :string
           attribute :block, :string
           attribute :stem_type, :string
           attribute :asciimath, AsciimathElement, collection: true
-          attribute :math, MathElement, collection: true
+          attribute :math, SemanticMathElement, collection: true
 
           xml do
             element "stem"

data/lib/metanorma/document/components/inline/strong_raw_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/sub_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/sup_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/tab_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/title_with_annotation_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components
@@ -20,6 +22,7 @@ module Metanorma
                     collection: true
           attribute :smallcap, SmallCapElement, collection: true
           attribute :br, BrElement, collection: true
+          attribute :stem, TextElements::StemElement, collection: true
           attribute :xref, XrefElement, collection: true
           attribute :eref, ErefElement, collection: true
           attribute :link, LinkElement, collection: true
@@ -39,6 +42,7 @@ module Metanorma
             map_element "strike", to: :strike
             map_element "smallcap", to: :smallcap
             map_element "br", to: :br
+            map_element "stem", to: :stem
             map_element "xref", to: :xref
             map_element "eref", to: :eref
             map_element "link", to: :link

data/lib/metanorma/document/components/inline/tt_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components

data/lib/metanorma/document/components/inline/variant_title_element.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Metanorma
   module Document
     module Components