metanorma-document 0.2.8 → 0.2.12

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

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Inline
+        # Shared vocabulary of inline child elements that may appear in any
+        # general-purpose inline-content container. Including this module
+        # in a `Lutaml::Model::Serializable` subclass declares every inline
+        # element type as a collection attribute, so that no inline child
+        # encountered during parsing is silently dropped.
+        #
+        # Use together with `VocabularyXmlMapping.apply_inline_mappings`
+        # inside the class's `xml do ... end` block.
+        #
+        # Restricted child sets (e.g. `XrefElement` with only `<location>`
+        # children) intentionally do NOT include this module — they have
+        # semantic reasons to exclude the general vocabulary.
+        module Vocabulary
+          def self.included(base)
+            declare_text_attributes_on(base)
+            declare_formatting_attributes_on(base)
+            declare_cross_reference_attributes_on(base)
+            declare_structural_attributes_on(base)
+            declare_rendered_display_attributes_on(base)
+          end
+
+          class << self
+            def declare_text_attributes_on(base)
+              base.attribute :text, :string, collection: true
+              base.attribute :semx,
+                             Metanorma::Document::Components::Inline::SemxElement,
+                             collection: true
+            end
+
+            def declare_formatting_attributes_on(base)
+              base.attribute :em,
+                             Metanorma::Document::Components::Inline::EmRawElement,
+                             collection: true
+              base.attribute :strong,
+                             Metanorma::Document::Components::Inline::StrongRawElement,
+                             collection: true
+              base.attribute :sub,
+                             Metanorma::Document::Components::Inline::SubElement,
+                             collection: true
+              base.attribute :sup,
+                             Metanorma::Document::Components::Inline::SupElement,
+                             collection: true
+              base.attribute :tt,
+                             Metanorma::Document::Components::Inline::TtElement,
+                             collection: true
+              base.attribute :underline,
+                             Metanorma::Document::Components::TextElements::UnderlineElement,
+                             collection: true
+              base.attribute :strike,
+                             Metanorma::Document::Components::TextElements::StrikeElement,
+                             collection: true
+              base.attribute :smallcap,
+                             Metanorma::Document::Components::Inline::SmallCapElement,
+                             collection: true
+            end
+
+            def declare_cross_reference_attributes_on(base)
+              base.attribute :xref,
+                             Metanorma::Document::Components::Inline::XrefElement,
+                             collection: true
+              base.attribute :eref,
+                             Metanorma::Document::Components::Inline::ErefElement,
+                             collection: true
+              base.attribute :link,
+                             Metanorma::Document::Components::Inline::LinkElement,
+                             collection: true
+              base.attribute :span,
+                             Metanorma::Document::Components::Inline::SpanElement,
+                             collection: true
+            end
+
+            def declare_structural_attributes_on(base)
+              base.attribute :stem,
+                             Metanorma::Document::Components::Inline::StemInlineElement,
+                             collection: true
+              base.attribute :concept,
+                             Metanorma::Document::Components::Inline::ConceptElement,
+                             collection: true
+              base.attribute :fn,
+                             Metanorma::Document::Components::Inline::FnElement,
+                             collection: true
+              base.attribute :bcp14,
+                             Metanorma::Document::Components::Inline::Bcp14Element,
+                             collection: true
+              base.attribute :br,
+                             Metanorma::Document::Components::Inline::BrElement,
+                             collection: true
+              base.attribute :tab,
+                             Metanorma::Document::Components::Inline::TabElement,
+                             collection: true
+              base.attribute :bookmark,
+                             Metanorma::Document::Components::IdElements::Bookmark,
+                             collection: true
+              base.attribute :image,
+                             Metanorma::Document::Components::IdElements::Image,
+                             collection: true
+              base.attribute :index,
+                             Metanorma::Document::Components::EmptyElements::IndexElement,
+                             collection: true
+              base.attribute :add, "Metanorma::Document::Elements::Add",
+                             collection: true
+              base.attribute :del, "Metanorma::Document::Elements::Del",
+                             collection: true
+            end
+
+            def declare_rendered_display_attributes_on(base)
+              base.attribute :fmt_stem,
+                             Metanorma::Document::Components::Inline::FmtStemElement,
+                             collection: true
+              base.attribute :fmt_concept,
+                             Metanorma::Document::Components::Inline::FmtConceptElement,
+                             collection: true
+              base.attribute :fmt_fn_label,
+                             Metanorma::Document::Components::Inline::FmtFnLabelElement,
+                             collection: true
+              base.attribute :fmt_annotation_start,
+                             Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+                             collection: true
+              base.attribute :fmt_annotation_end,
+                             Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+                             collection: true
+            end
+          end
+
+          # Adds the `map_element` calls corresponding to every vocabulary
+          # attribute. Call inside an `xml do ... end` block:
+          #
+          #   xml do
+          #     element "span"
+          #     mixed_content
+          #     map_attribute "class", to: :class_attr
+          #     map_content to: :text
+          #     VocabularyXmlMapping.apply_inline_mappings(self)
+          #   end
+          module VocabularyXmlMapping
+            INLINE_MAPPINGS = {
+              "semx" => :semx,
+              "em" => :em,
+              "strong" => :strong,
+              "sub" => :sub,
+              "sup" => :sup,
+              "tt" => :tt,
+              "underline" => :underline,
+              "strike" => :strike,
+              "smallcap" => :smallcap,
+              "br" => :br,
+              "tab" => :tab,
+              "xref" => :xref,
+              "eref" => :eref,
+              "link" => :link,
+              "span" => :span,
+              "stem" => :stem,
+              "concept" => :concept,
+              "fn" => :fn,
+              "bcp14" => :bcp14,
+              "bookmark" => :bookmark,
+              "image" => :image,
+              "index" => :index,
+              "add" => :add,
+              "del" => :del,
+              "fmt-stem" => :fmt_stem,
+              "fmt-concept" => :fmt_concept,
+              "fmt-fn-label" => :fmt_fn_label,
+              "fmt-annotation-start" => :fmt_annotation_start,
+              "fmt-annotation-end" => :fmt_annotation_end,
+            }.freeze
+
+            def self.apply_inline_mappings(mapping)
+              INLINE_MAPPINGS.each do |element_name, attr_name|
+                mapping.map_element(element_name, to: attr_name)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,15 @@
+# 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
@@ -12,6 +20,7 @@ module Metanorma
           attribute :nopage, :string
           attribute :alt, :string
           attribute :text, :string, collection: true
+          attribute :location, LocationElement, collection: true
 
           xml do
             element "xref"
@@ -24,6 +33,7 @@ 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,6 +94,18 @@ 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/lists/unordered_list.rb

@@ -9,10 +9,10 @@ module Metanorma
           attribute :id, :string
           attribute :semx_id, :string
           attribute :original_id, :string
-          attribute :nobullet, :string
+          attribute :nobullet, :boolean
           attribute :spacing, :string
           attribute :indent, :string
-          attribute :bare, :string
+          attribute :bare, :boolean
           attribute :json_type, :string
 
           def json_type

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

@@ -10,7 +10,10 @@ module Metanorma
           # Subclass of admonition determining how it is to be rendered; e.g.
           # Warning, Note, Tip.
           # Distinct admonition types are often associated with distinct icons or rendering.
-          attribute :type, :string
+          attribute :type, :string,
+                    values: %w[danger caution warning important
+                               safety\ precautions editorial tip note
+                               commentary]
 
           # Caption of admonition.
           attribute :name, Metanorma::Document::Components::TextElements::TextElement,
@@ -28,7 +31,7 @@ module Metanorma
           attribute :target, :string
 
           # Whether the admonition is excluded from automatic numbering (UN).
-          attribute :unnumbered, :string
+          attribute :unnumbered, :boolean
 
           # Paragraphs within the admonition.
           attribute :paragraphs,

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        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
+      end
+    end
+  end
+end

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

@@ -4,46 +4,17 @@ 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,6 +8,8 @@ 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/paragraphs/paragraph_block.rb

@@ -11,8 +11,8 @@ module Metanorma
           attribute :alignment, :string
           attribute :semx_id, :string
           attribute :original_id, :string
-          attribute :keep_with_next, :string
-          attribute :keep_with_previous, :string
+          attribute :keep_with_next, :boolean
+          attribute :keep_with_previous, :boolean
           attribute :indent, :string
           attribute :class_attr, :string
           attribute :type_attr, :string

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

@@ -4,37 +4,6 @@ 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/source_modification.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        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
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+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
+      end
+    end
+  end
+end

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_element"
+                 "#{__dir__}/reference_elements/source_modification"
         autoload :SourceOrigin,
-                 "#{__dir__}/reference_elements/source_element"
+                 "#{__dir__}/reference_elements/source_origin"
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        class ColElement < Lutaml::Model::Serializable
+          attribute :width, :string
+
+          xml do
+            element "col"
+            map_attribute "width", to: :width
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        class ColGroupElement < Lutaml::Model::Serializable
+          attribute :col, ColElement, collection: true
+
+          xml do
+            element "colgroup"
+            map_element "col", to: :col
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,27 +4,6 @@ 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
@@ -52,7 +31,6 @@ 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_body_section.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        class TableBodySection < TableSection
+          xml do
+            element "tbody"
+            map_element "tr", to: :tr
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        class TableFootSection < TableSection
+          xml do
+            element "tfoot"
+            map_element "tr", to: :tr
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        class TableHeadSection < TableSection
+          xml do
+            element "thead"
+            map_element "tr", to: :tr
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -4,7 +4,6 @@ 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
 
@@ -12,30 +11,6 @@ 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,13 +4,15 @@ 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_section"
-        autoload :TableBodySection, "#{__dir__}/tables/table_section"
-        autoload :TableFootSection, "#{__dir__}/tables/table_section"
+        autoload :TableHeadSection, "#{__dir__}/tables/table_head_section"
+        autoload :TableBodySection, "#{__dir__}/tables/table_body_section"
+        autoload :TableFootSection, "#{__dir__}/tables/table_foot_section"
         autoload :TableSection, "#{__dir__}/tables/table_section"
         autoload :TextAlignment, "#{__dir__}/tables/text_alignment"
         autoload :TextTableCell, "#{__dir__}/tables/text_table_cell"