metanorma-document 0.5.1 → 0.5.2.pre.alpha.1

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Rendered counterpart of `<origin>` (a quote-attribution eref):
+        # the normalised reference text. Identical grammar shape to
+        # eref — the shared ErefContract declares and maps it.
+        class FmtOriginElement < Lutaml::Model::Serializable
+          include Inline::Vocabulary
+          include RenderedDisplay
+
+          ErefContract.declare_attributes(self)
+
+          xml do
+            element "fmt-origin"
+            ErefContract.apply_mapping(self)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -9,10 +9,13 @@ module Metanorma
 
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
+          attribute :semx, "Metanorma::Document::Components::Inline::SemxElement",
+                    collection: true
 
           xml do
             element "fmt-preferred"
             map_element "p", to: :p
+            map_element "semx", to: :semx
           end
         end
       end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Rendered counterpart of a quote `<source>`: the formatted
+        # attribution (author, source, modification) as a single semx
+        # slice. Rendered to the exclusion of the semantic source
+        # content when present.
+        class FmtSourceElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
+          attribute :status, :string
+          attribute :source_type, :string
+          attribute :text, :string, collection: true
+          attribute :semx, SemxElement, collection: true
+
+          xml do
+            element "fmt-source"
+            mixed_content
+            map_attribute "status", to: :status
+            map_attribute "type", to: :source_type
+            map_content to: :text
+            map_element "semx", to: :semx
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -6,6 +6,7 @@ module Metanorma
       module Inline
         class FnElement < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :anchor, :string
           attribute :reference, :string
           attribute :hiddenref, :boolean
           attribute :target, :string
@@ -13,17 +14,27 @@ module Metanorma
           attribute :original_reference, :string
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
+          attribute :ul, "Metanorma::Document::Components::Lists::UnorderedList",
+                    collection: true
+          attribute :ol, "Metanorma::Document::Components::Lists::OrderedList",
+                    collection: true
+          attribute :table, "Metanorma::Document::Components::Tables::TableBlock",
+                    collection: true
           attribute :fmt_fn_label, "Metanorma::Document::Components::Inline::FmtFnLabelElement"
 
           xml do
             element "fn"
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_attribute "reference", to: :reference
             map_attribute "hiddenref", to: :hiddenref
             map_attribute "target", to: :target
             map_attribute "semx-id", to: :semx_id
             map_attribute "original-reference", to: :original_reference
             map_element "p", to: :p
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "table", to: :table
             map_element "fmt-fn-label", to: :fmt_fn_label
           end
         end

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

@@ -5,6 +5,8 @@ module Metanorma
     module Components
       module Inline
         class LinkElement < Lutaml::Model::Serializable
+          include Metanorma::Document::Components::Inline::Vocabulary
+
           attribute :id, :string
           attribute :target, :string
           attribute :update_type, :string
@@ -21,6 +23,12 @@ module Metanorma
             map_attribute "style", to: :style
             map_content to: :content
             map_element "link", to: :link
+
+            # Presentation XML states formatted link text as inline
+            # children (<link><em>Title</em></link>): accept the full
+            # inline vocabulary so it is not dropped at parse time.
+            Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+              .apply_inline_mappings(self)
           end
         end
       end

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

@@ -6,6 +6,7 @@ module Metanorma
       module Inline
         class NameWithIdElement < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :anchor, :string
           attribute :semx_id, :string
           attribute :text, :string
           attribute :stem, TextElements::StemElement, collection: true
@@ -13,6 +14,7 @@ module Metanorma
           xml do
             element "name"
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id
             map_content to: :text
             map_element "stem", to: :stem

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # <refterm> outside a <concept> (e.g. inside a related-term semx
+        # whose lookup failed): the native renderer serializes the element
+        # itself as escaped text ("&lt;refterm&gt;…&lt;/refterm&gt;").
+        class ReftermElement < Lutaml::Model::Serializable
+          attribute :text, :string
+
+          xml do
+            element "refterm"
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,6 +19,12 @@ module Metanorma
           attribute :text, :string, collection: true
           attribute :fmt_xref, "Metanorma::Document::Components::Inline::FmtXrefElement",
                     collection: true
+          attribute :fmt_eref,
+                    "Metanorma::Document::Components::Inline::FmtErefElement",
+                    collection: true
+          attribute :fmt_origin,
+                    "Metanorma::Document::Components::Inline::FmtOriginElement",
+                    collection: true
           attribute :fmt_concept, "Metanorma::Document::Components::Inline::FmtConceptElement",
                     collection: true
           attribute :asciimath, AsciimathElement, collection: true
@@ -30,12 +36,21 @@ module Metanorma
           attribute :strong, StrongRawElement, collection: true
           attribute :origin, ErefElement, collection: true
           attribute :em, EmRawElement, collection: true
+          attribute :ruby, "Metanorma::Document::Components::TextElements::RubyElement", collection: true
           attribute :fmt_link, LinkElement, collection: true
           attribute :sup, SupElement, collection: true
           attribute :span, "Metanorma::Document::Components::Inline::SpanElement",
                     collection: true
           attribute :xref, XrefElement, collection: true
           attribute :eref, ErefElement, collection: true
+          attribute :refterm, ReftermElement, collection: true
+          attribute :ol, "Metanorma::Document::Components::Lists::OrderedList",
+                    collection: true
+          attribute :ul, "Metanorma::Document::Components::Lists::UnorderedList",
+                    collection: true
+          attribute :fmt_preferred,
+                    "Metanorma::Document::Components::Inline::FmtPreferredElement",
+                    collection: true
 
           # Term/metadata child elements
           attribute :title_child, SemxChildElement, collection: true
@@ -79,6 +94,8 @@ module Metanorma
             map_attribute "source", to: :source
             map_content to: :text
             map_element "fmt-xref", to: :fmt_xref
+            map_element "fmt-eref", to: :fmt_eref
+            map_element "fmt-origin", to: :fmt_origin
             map_element "fmt-concept", to: :fmt_concept
             map_element "asciimath", to: :asciimath
             map_element "math", to: :math
@@ -87,11 +104,16 @@ module Metanorma
             map_element "strong", to: :strong
             map_element "origin", to: :origin
             map_element "em", to: :em
+            map_element "ruby", to: :ruby
             map_element "fmt-link", to: :fmt_link
             map_element "sup", to: :sup
             map_element "span", to: :span
             map_element "xref", to: :xref
             map_element "eref", to: :eref
+            map_element "refterm", to: :refterm
+            map_element "ol", to: :ol
+            map_element "ul", to: :ul
+            map_element "fmt-preferred", to: :fmt_preferred
             # Term/metadata children
             map_element "title", to: :title_child
             map_element "name", to: :name_child

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # A stack of source localities — the rendered form of the
+        # localities a quote source cites (mirrors localityStack for
+        # sources). The overlay references a `sourcelocality` child
+        # pattern that no grammar defines (standoc-models dangling
+        # reference); text parses today, the child maps once the
+        # grammar defines it.
+        class SourcelocalityStackElement < Lutaml::Model::Serializable
+          include RenderedDisplay
+
+          attribute :text, :string, collection: true
+
+          xml do
+            element "sourcelocalityStack"
+            mixed_content
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,7 @@ module Metanorma
 
           attribute :class_attr, :string
           attribute :style, :string
+          attribute :anchor, :string
           attribute :callout,
                     Metanorma::Document::Components::ReferenceElements::Callout,
                     collection: true
@@ -21,6 +22,7 @@ module Metanorma
             mixed_content
             map_attribute "class", to: :class_attr
             map_attribute "style", to: :style
+            map_attribute "anchor", to: :anchor
             map_content to: :text
             map_element "callout", to: :callout
             Vocabulary::VocabularyXmlMapping.apply_inline_mappings(self)

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

@@ -14,6 +14,7 @@ module Metanorma
           attribute :stem_type, :string
           attribute :asciimath, AsciimathElement, collection: true
           attribute :math, SemanticMathElement, collection: true
+          attribute :latexmath, TextElements::LatexmathElement, collection: true
 
           xml do
             element "stem"
@@ -22,6 +23,7 @@ module Metanorma
             map_attribute "type", to: :stem_type
             map_element "asciimath", to: :asciimath
             map_element "math", to: :math
+            map_element "latexmath", to: :latexmath
           end
         end
       end

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

@@ -4,21 +4,18 @@ module Metanorma
   module Document
     module Components
       module Inline
+        # Strongly emphasised raw text: accepts the full inline
+        # vocabulary as children so no inline payload inside <strong>
+        # is dropped at parse time.
         class StrongRawElement < Lutaml::Model::Serializable
-          attribute :text, :string, collection: true
-          attribute :semx, "Metanorma::Document::Components::Inline::SemxElement",
-                    collection: true
-          attribute :span, "Metanorma::Document::Components::Inline::SpanElement",
-                    collection: true
-          attribute :br, BrElement, collection: true
+          include Metanorma::Document::Components::Inline::Vocabulary
 
           xml do
             element "strong"
             mixed_content
             map_content to: :text
-            map_element "semx", to: :semx
-            map_element "span", to: :span
-            map_element "br", to: :br
+            Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+              .apply_inline_mappings(self)
           end
         end
       end

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

@@ -6,9 +6,11 @@ module Metanorma
       module Inline
         class SubElement < Lutaml::Model::Serializable
           attribute :content, :string
+          attribute :sub, SubElement, collection: true
           xml do
             element "sub"
             map_content to: :content
+            map_element "sub", to: :sub
           end
         end
       end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Cross-reference to a term defined within a termbase.
+        class TermrefElement < Lutaml::Model::Serializable
+          attribute :base, :string
+          attribute :target, :string
+          attribute :text, :string, collection: true
+
+          xml do
+            element "termref"
+            mixed_content
+            map_attribute "base", to: :base
+            map_attribute "target", to: :target
+            map_content to: :text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,48 +5,27 @@ module Metanorma
     module Components
       module Inline
         class TitleWithAnnotationElement < Lutaml::Model::Serializable
+          include Metanorma::Document::Components::Inline::Vocabulary
+
           attribute :id, :string
+          attribute :anchor, :string
           attribute :semx_id, :string
-          attribute :text, :string, collection: true
           attribute :fmt_annotation_end, FmtAnnotationBodyElement
 
-          # Inline elements
-          attribute :em, EmRawElement, collection: true
-          attribute :strong, StrongRawElement, collection: true
-          attribute :sub, SubElement, collection: true
-          attribute :sup, SupElement, collection: true
-          attribute :tt, TtElement, collection: true
-          attribute :underline, "Metanorma::Document::Components::TextElements::UnderlineElement",
-                    collection: true
-          attribute :strike, "Metanorma::Document::Components::TextElements::StrikeElement",
-                    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
-
           xml do
             element "title"
             mixed_content
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id
             map_content to: :text
-            map_element "em", to: :em
-            map_element "strong", to: :strong
-            map_element "sub", to: :sub
-            map_element "sup", to: :sup
-            map_element "tt", to: :tt
-            map_element "underline", to: :underline
-            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
             map_element "fmt-annotation-end", to: :fmt_annotation_end
+
+            # Titles carry the full inline vocabulary (footnotes on
+            # clause titles, formatted links, math); including the
+            # shared vocabulary keeps every child at parse time.
+            Metanorma::Document::Components::Inline::Vocabulary::VocabularyXmlMapping
+              .apply_inline_mappings(self)
           end
         end
       end

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

@@ -7,6 +7,7 @@ module Metanorma
         class VariantTitleElement < Lutaml::Model::Serializable
           attribute :type, :string
           attribute :id, :string
+          attribute :anchor, :string
           attribute :text, :string, collection: true
           attribute :span, SpanElement, collection: true
           attribute :semx, SemxElement, collection: true
@@ -17,6 +18,7 @@ module Metanorma
             mixed_content
             map_attribute "type", to: :type
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_content to: :text
             map_element "span", to: :span
             map_element "semx", to: :semx

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

@@ -110,12 +110,39 @@ module Metanorma
               base.attribute :input,
                              Metanorma::Document::Elements::Input,
                              collection: true
+              base.attribute :passthrough,
+                             Metanorma::Document::Components::Blocks::Passthrough,
+                             collection: true
+              base.attribute :date,
+                             Metanorma::Document::Components::Inline::DateElement,
+                             collection: true
+              base.attribute :fmt_date,
+                             Metanorma::Document::Components::Inline::FmtDateElement,
+                             collection: true
+              base.attribute :erefstack,
+                             Metanorma::Document::Components::Inline::ErefStack,
+                             collection: true
             end
 
             def declare_rendered_display_attributes_on(base)
               base.attribute :fmt_stem,
                              Metanorma::Document::Components::Inline::FmtStemElement,
                              collection: true
+              base.attribute :fmt_eref,
+                             Metanorma::Document::Components::Inline::FmtErefElement,
+                             collection: true
+              base.attribute :fmt_link,
+                             Metanorma::Document::Components::Inline::LinkElement,
+                             collection: true
+              base.attribute :fmt_origin,
+                             Metanorma::Document::Components::Inline::FmtOriginElement,
+                             collection: true
+              base.attribute :fmt_source,
+                             Metanorma::Document::Components::Inline::FmtSourceElement,
+                             collection: true
+              base.attribute :fmt_date_inline,
+                             Metanorma::Document::Components::Inline::FmtDateInlineElement,
+                             collection: true
               base.attribute :fmt_concept,
                              Metanorma::Document::Components::Inline::FmtConceptElement,
                              collection: true
@@ -168,7 +195,16 @@ module Metanorma
               "add" => :add,
               "del" => :del,
               "input" => :input,
+              "passthrough" => :passthrough,
+              "date" => :date,
+              "fmt-date" => :fmt_date,
+              "erefstack" => :erefstack,
               "fmt-stem" => :fmt_stem,
+              "fmt-eref" => :fmt_eref,
+              "fmt-link" => :fmt_link,
+              "fmt-origin" => :fmt_origin,
+              "fmt-source" => :fmt_source,
+              "fmt-date-inline" => :fmt_date_inline,
               "fmt-concept" => :fmt_concept,
               "fmt-fn-label" => :fmt_fn_label,
               "fmt-annotation-start" => :fmt_annotation_start,

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

@@ -20,6 +20,7 @@ module Metanorma
                  "metanorma/document/components/inline/link_element"
         autoload :BrElement, "metanorma/document/components/inline/br_element"
         autoload :TabElement, "metanorma/document/components/inline/tab_element"
+        autoload :ColumnbreakElement, "metanorma/document/components/inline/columnbreak_element"
         autoload :AsciimathElement,
                  "metanorma/document/components/inline/asciimath_element"
         autoload :MathElement,
@@ -36,6 +37,8 @@ module Metanorma
         autoload :ConceptElement,
                  "metanorma/document/components/inline/concept_element"
         autoload :FnElement, "metanorma/document/components/inline/fn_element"
+        autoload :ReftermElement,
+                 "metanorma/document/components/inline/refterm_element"
         autoload :SemxChildElement,
                  "metanorma/document/components/inline/semx_child_element"
         autoload :SemxElement,
@@ -44,6 +47,16 @@ module Metanorma
                  "metanorma/document/components/inline/span_element"
         autoload :FmtStemElement,
                  "metanorma/document/components/inline/fmt_stem_element"
+        autoload :FmtErefElement,
+                 "metanorma/document/components/inline/fmt_eref_element"
+        autoload :FmtOriginElement,
+                 "metanorma/document/components/inline/fmt_origin_element"
+        autoload :FmtSourceElement,
+                 "metanorma/document/components/inline/fmt_source_element"
+        autoload :FmtDateInlineElement,
+                 "metanorma/document/components/inline/fmt_date_inline_element"
+        autoload :SourcelocalityStackElement,
+                 "metanorma/document/components/inline/sourcelocality_stack_element"
         autoload :FmtFnLabelElement,
                  "metanorma/document/components/inline/fmt_fn_label_element"
         autoload :FmtConceptElement,
@@ -102,6 +115,16 @@ module Metanorma
                  "metanorma/document/components/inline/semantic_content"
         autoload :LocationElement,
                  "metanorma/document/components/inline/location_element"
+        autoload :DateElement,
+                 "metanorma/document/components/inline/date_element"
+        autoload :FmtDateElement,
+                 "metanorma/document/components/inline/fmt_date_element"
+        autoload :ErefStack,
+                 "metanorma/document/components/inline/eref_stack"
+        autoload :ErrorMessage,
+                 "metanorma/document/components/inline/error_message"
+        autoload :TermrefElement,
+                 "metanorma/document/components/inline/termref_element"
         autoload :SemanticMathElement,
                  "metanorma/document/components/inline/semantic_math_element"
         autoload :RenderedMathElement,

data/lib/metanorma/document/components/lists/dd_element.rb

@@ -7,6 +7,7 @@ module Metanorma
         # Definition description element, containing paragraphs.
         class DdElement < Lutaml::Model::Serializable
           attribute :id, :string
+          attribute :anchor, :string
           attribute :semx_id, :string
           attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
                     collection: true
@@ -34,8 +35,12 @@ module Metanorma
           attribute :fmt_fn_body, "Metanorma::Document::Components::Inline::FmtFnBodyElement"
 
           xml do
-            element "dd"
+            # Order-aware dd: the IETF transformer rebuilds children in
+            # source order (p, dl, p interleave), which requires the
+            # parse to capture element_order for this model.
+            root "dd", ordered: true
             map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
             map_attribute "semx-id", to: :semx_id
             map_element "p", to: :p
             map_element "ul", to: :ul

data/lib/metanorma/document/components/lists/definition.rb

@@ -6,6 +6,7 @@ module Metanorma
       module Lists
         # Definition used to constitute a definition list.
         class Definition < Lutaml::Model::Serializable
+          attribute :anchor, :string
           attribute :item, "Metanorma::Document::Components::TextElements::TextElement",
                     collection: true
           attribute :definition,
@@ -18,6 +19,7 @@ module Metanorma
 
           xml do
             element "dd"
+            map_attribute "anchor", to: :anchor
             map_element "item", to: :item
             map_element "definition", to: :definition
             map_element "p", to: :p

data/lib/metanorma/document/components/lists/definition_list.rb

@@ -15,6 +15,8 @@ module Metanorma
           attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
           attribute :dt, DtElement, collection: true
           attribute :dd, DdElement, collection: true
+          attribute :note, "Metanorma::Document::Components::Blocks::NoteBlock",
+                    collection: true
           attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
           attribute :json_type, :string
 
@@ -41,6 +43,7 @@ module Metanorma
             map_element "name", to: :name
             map_element "dt", to: :dt
             map_element "dd", to: :dd
+            map_element "note", to: :note
             map_element "fmt-name", to: :fmt_name
           end
         end

data/lib/metanorma/document/components/lists/dt_element.rb

@@ -19,6 +19,8 @@ module Metanorma
                     collection: true
           attribute :em, "Metanorma::Document::Components::Inline::EmRawElement",
                     collection: true
+          attribute :ruby, "Metanorma::Document::Components::TextElements::RubyElement",
+                    collection: true
           attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
                     collection: true
           attribute :sub, :string, collection: true
@@ -52,6 +54,7 @@ module Metanorma
             map_element "span", to: :span
             map_element "tt", to: :tt
             map_element "em", to: :em
+            map_element "ruby", to: :ruby
             map_element "strong", to: :strong
             map_element "sub", to: :sub
             map_element "sup", to: :sup