metanorma-document 0.2.12 → 0.2.13

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

@@ -1,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,24 +1,14 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,12 +1,8 @@
-# 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,5 +1,3 @@
-# frozen_string_literal: true
-
 module Metanorma
   module Document
     module Components

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

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

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

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

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

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

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

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

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Metanorma
   module Document
     module Components
@@ -8,14 +6,12 @@ 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/semx_child_element.rb

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

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

@@ -1,19 +1,7 @@
-# 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
@@ -23,7 +11,7 @@ module Metanorma
           attribute :fmt_concept, "Metanorma::Document::Components::Inline::FmtConceptElement",
                     collection: true
           attribute :asciimath, AsciimathElement, collection: true
-          attribute :math, RenderedMathElement, collection: true
+          attribute :math, MathElement, 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,5 +1,3 @@
-# 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 :callout,
-                    Metanorma::Document::Components::ReferenceElements::Callout,
+          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",
                     collection: true
 
           xml do
@@ -22,8 +22,13 @@ 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,19 +1,13 @@
-# 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, SemanticMathElement, collection: true
+          attribute :math, MathElement, collection: true
 
           xml do
             element "stem"

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

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

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

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

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

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

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

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

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

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Metanorma
   module Document
     module Components
@@ -22,7 +20,6 @@ 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
@@ -42,7 +39,6 @@ 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,5 +1,3 @@
-# frozen_string_literal: true
-
 module Metanorma
   module Document
     module Components

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

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

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

@@ -1,15 +1,7 @@
-# frozen_string_literal: true
-
 module Metanorma
   module Document
     module Components
       module Inline
-        # A cross-reference to another part of the document.
-        #
-        # Multi-target cross-references carry one or more `<location>`
-        # children — secondary targets joined by connectives
-        # (e.g. "see Figure 4, 5.1.6 and 5.1.7"). The primary target is
-        # in the `target` attribute; secondary targets are in `location`.
         class XrefElement < Lutaml::Model::Serializable
           attribute :id, :string
           attribute :target, :string
@@ -20,7 +12,6 @@ module Metanorma
           attribute :nopage, :string
           attribute :alt, :string
           attribute :text, :string, collection: true
-          attribute :location, LocationElement, collection: true
 
           xml do
             element "xref"
@@ -33,7 +24,6 @@ module Metanorma
             map_attribute "nopage", to: :nopage
             map_attribute "alt", to: :alt
             map_content to: :text
-            map_element "location", to: :location
           end
         end
       end

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

@@ -94,18 +94,6 @@ module Metanorma
                  "metanorma/document/components/inline/display_text_element"
         autoload :Bcp14Element,
                  "metanorma/document/components/inline/bcp14_element"
-        autoload :Vocabulary,
-                 "metanorma/document/components/inline/vocabulary"
-        autoload :RenderedDisplay,
-                 "metanorma/document/components/inline/rendered_display"
-        autoload :SemanticContent,
-                 "metanorma/document/components/inline/semantic_content"
-        autoload :LocationElement,
-                 "metanorma/document/components/inline/location_element"
-        autoload :SemanticMathElement,
-                 "metanorma/document/components/inline/semantic_math_element"
-        autoload :RenderedMathElement,
-                 "metanorma/document/components/inline/rendered_math_element"
       end
     end
   end

data/lib/metanorma/document/components/multi_paragraph/quote_block.rb

@@ -4,17 +4,46 @@ module Metanorma
   module Document
     module Components
       module MultiParagraph
+        # Author element inside a quote: <author id="...">text</author>
+        class QuoteAuthorElement < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :text, :string
+
+          xml do
+            element "author"
+            map_attribute "id", to: :id
+            map_content to: :text
+          end
+        end
+
+        # Block quotation, containing extensive textual content originally authored outside of the current
+        # document.
         class QuoteBlock < ParagraphsBlock
+          # Bibliographic citation for the quotation.
           attribute :source, Metanorma::Document::Components::ReferenceElements::ReferenceToCitationElement
+
+          # Author of the quotation. The `author` attribute of the quotation is redundant with the citation,
+          # since it restates information about the author that should be recoverable from the citation itself.
+          # It is included for convenience, in case processing the citation to extract the author is prohibitive
+          # for rendering tools.
           attribute :author, QuoteAuthorElement
+
+          # Paragraphs within the quote.
           attribute :paragraphs,
                     Metanorma::Document::Components::Paragraphs::ParagraphBlock,
                     collection: true
+
+          # Unordered lists within the quote.
           attribute :ul, Metanorma::Document::Components::Lists::UnorderedList,
                     collection: true
+
+          # Ordered lists within the quote.
           attribute :ol, Metanorma::Document::Components::Lists::OrderedList,
                     collection: true
+
+          # Attribution for the quotation (presentation XML).
           attribute :attribution, "Metanorma::Document::Components::Inline::AttributionElement"
+
           attribute :json_type, :string
 
           def json_type

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

@@ -8,8 +8,6 @@ module Metanorma
         autoload :AdmonitionType, "#{__dir__}/multi_paragraph/admonition_type"
         autoload :ParagraphsBlock, "#{__dir__}/multi_paragraph/paragraphs_block"
         autoload :QuoteBlock, "#{__dir__}/multi_paragraph/quote_block"
-        autoload :QuoteAuthorElement,
-                 "#{__dir__}/multi_paragraph/quote_author_element"
         autoload :ReviewBlock, "#{__dir__}/multi_paragraph/review_block"
       end
     end

data/lib/metanorma/document/components/reference_elements/source_element.rb

@@ -4,6 +4,37 @@ module Metanorma
   module Document
     module Components
       module ReferenceElements
+        class SourceOrigin < Lutaml::Model::Serializable
+          attribute :bibitemid, :string
+          attribute :type, :string
+          attribute :citeas, :string
+          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+          attribute :display_text,
+                    Metanorma::Document::Components::Inline::DisplayTextElement
+
+          xml do
+            element "origin"
+            map_attribute "bibitemid", to: :bibitemid
+            map_attribute "type", to: :type
+            map_attribute "citeas", to: :citeas
+            map_element "localityStack", to: :locality_stack
+            map_element "display-text", to: :display_text
+          end
+        end
+
+        class SourceModification < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "modification"
+            map_attribute "id", to: :id
+            map_element "p", to: :p
+          end
+        end
+
         class SourceElement < Lutaml::Model::Serializable
           attribute :id, :string
           attribute :status, :string

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

@@ -24,9 +24,9 @@ module Metanorma
         autoload :SourceElement,
                  "#{__dir__}/reference_elements/source_element"
         autoload :SourceModification,
-                 "#{__dir__}/reference_elements/source_modification"
+                 "#{__dir__}/reference_elements/source_element"
         autoload :SourceOrigin,
-                 "#{__dir__}/reference_elements/source_origin"
+                 "#{__dir__}/reference_elements/source_element"
       end
     end
   end

data/lib/metanorma/document/components/tables/table_block.rb

@@ -4,6 +4,27 @@ module Metanorma
   module Document
     module Components
       module Tables
+        # Column element within colgroup.
+        class ColElement < Lutaml::Model::Serializable
+          attribute :width, :string
+
+          xml do
+            element "col"
+            map_attribute "width", to: :width
+          end
+        end
+
+        # Column group element for table column width specifications.
+        class ColGroupElement < Lutaml::Model::Serializable
+          attribute :col, ColElement, collection: true
+
+          xml do
+            element "colgroup"
+            map_element "col", to: :col
+          end
+        end
+
+        # Tabular arrangement of text
         class TableBlock < Metanorma::Document::Components::Blocks::BasicBlock
           attribute :id, :string
           attribute :anchor, :string
@@ -31,6 +52,7 @@ module Metanorma
                     collection: true
           attribute :colgroup, ColGroupElement
 
+          # Presentation-specific elements
           attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
           attribute :fmt_xref_label,
                     Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true

data/lib/metanorma/document/components/tables/table_section.rb

@@ -4,6 +4,7 @@ module Metanorma
   module Document
     module Components
       module Tables
+        # Base class for table sections (thead, tbody, tfoot) wrapping rows.
         class TableSection < Lutaml::Model::Serializable
           attribute :tr, TextTableRow, collection: true
 
@@ -11,6 +12,30 @@ module Metanorma
             map_element "tr", to: :tr
           end
         end
+
+        # Table header section wrapping <thead> rows.
+        class TableHeadSection < TableSection
+          xml do
+            element "thead"
+            map_element "tr", to: :tr
+          end
+        end
+
+        # Table body section wrapping <tbody> rows.
+        class TableBodySection < TableSection
+          xml do
+            element "tbody"
+            map_element "tr", to: :tr
+          end
+        end
+
+        # Table footer section wrapping <tfoot> rows.
+        class TableFootSection < TableSection
+          xml do
+            element "tfoot"
+            map_element "tr", to: :tr
+          end
+        end
       end
     end
   end

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

@@ -4,15 +4,13 @@ module Metanorma
   module Document
     module Components
       module Tables
-        autoload :ColElement, "#{__dir__}/tables/col_element"
-        autoload :ColGroupElement, "#{__dir__}/tables/col_group_element"
         autoload :HeaderTableCell, "#{__dir__}/tables/header_table_cell"
         autoload :ParagraphTableCell, "#{__dir__}/tables/paragraph_table_cell"
         autoload :TableBlock, "#{__dir__}/tables/table_block"
         autoload :TableCell, "#{__dir__}/tables/table_cell"
-        autoload :TableHeadSection, "#{__dir__}/tables/table_head_section"
-        autoload :TableBodySection, "#{__dir__}/tables/table_body_section"
-        autoload :TableFootSection, "#{__dir__}/tables/table_foot_section"
+        autoload :TableHeadSection, "#{__dir__}/tables/table_section"
+        autoload :TableBodySection, "#{__dir__}/tables/table_section"
+        autoload :TableFootSection, "#{__dir__}/tables/table_section"
         autoload :TableSection, "#{__dir__}/tables/table_section"
         autoload :TextAlignment, "#{__dir__}/tables/text_alignment"
         autoload :TextTableCell, "#{__dir__}/tables/text_table_cell"