metanorma-document 0.2.0

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+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
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+          attribute :unnumbered, :boolean
+          attribute :subsequence, :string
+          attribute :alt, :string
+          attribute :summary, :string
+          attribute :uri, :string
+          attribute :semx_id, :string
+          attribute :autonum, :string
+          attribute :displayorder, :integer
+          attribute :thead, TableHeadSection
+          attribute :tbody, TableBodySection
+          attribute :tfoot, TableFootSection
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+          attribute :key, Metanorma::Document::Components::AncillaryBlocks::KeyElement
+          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
+          attribute :fmt_footnote_container, Metanorma::Document::Components::Inline::FmtFootnoteContainerElement,
+                    collection: true
+
+          attribute :width, :string
+          attribute :json_type, :string
+
+          def json_type
+            "table"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "anchor", to: :anchor
+            map "name", to: :name
+          end
+
+          xml do
+            element "table"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_element "name", to: :name
+            map_attribute "unnumbered", to: :unnumbered
+            map_attribute "subsequence", to: :subsequence
+            map_attribute "alt", to: :alt
+            map_attribute "summary", to: :summary
+            map_attribute "uri", to: :uri
+            map_attribute "width", to: :width
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum
+            map_attribute "displayorder", to: :displayorder
+            map_element "thead", to: :thead
+            map_element "tbody", to: :tbody
+            map_element "tfoot", to: :tfoot
+            map_element "note", to: :note
+            map_element "dl", to: :dl
+            map_element "colgroup", to: :colgroup
+            map_element "key", to: :key
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "fmt-footnote-container", to: :fmt_footnote_container
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        # Base class for table cells with common attributes and mixed content.
+        class TableCell < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :colspan, :integer
+          attribute :rowspan, :integer
+          attribute :align, :string
+          attribute :valign, :string
+          attribute :text, :string, collection: true
+
+          # Inline elements
+          attribute :em, Metanorma::Document::Components::Inline::EmRawElement,
+                    collection: true
+          attribute :strong, Metanorma::Document::Components::Inline::StrongRawElement,
+                    collection: true
+          attribute :tt, Metanorma::Document::Components::Inline::TtElement,
+                    collection: true
+          attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                    collection: true
+          attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                    collection: true
+          attribute :smallcap, :string, collection: true
+          attribute :br, Metanorma::Document::Components::Inline::BrElement,
+                    collection: true
+          attribute :xref, Metanorma::Document::Components::Inline::XrefElement,
+                    collection: true
+          attribute :eref, Metanorma::Document::Components::Inline::ErefElement,
+                    collection: true
+          attribute :link, Metanorma::Document::Components::Inline::LinkElement,
+                    collection: true
+          attribute :stem,
+                    Metanorma::Document::Components::Inline::StemInlineElement, collection: true
+          attribute :fn, Metanorma::Document::Components::Inline::FnElement,
+                    collection: true
+          attribute :strike, Metanorma::Document::Components::TextElements::StrikeElement,
+                    collection: true
+          attribute :underline, Metanorma::Document::Components::TextElements::UnderlineElement,
+                    collection: true
+          attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
+                    collection: true
+          attribute :dl, "Metanorma::Document::Components::Lists::DefinitionList",
+                    collection: true
+          attribute :ul, "Metanorma::Document::Components::Lists::UnorderedList",
+                    collection: true
+          attribute :ol, "Metanorma::Document::Components::Lists::OrderedList",
+                    collection: true
+          attribute :figure, "Metanorma::Document::Components::AncillaryBlocks::FigureBlock",
+                    collection: true
+          attribute :formula, "Metanorma::Document::Components::AncillaryBlocks::FormulaBlock",
+                    collection: true
+          attribute :note, "Metanorma::Document::Components::Blocks::NoteBlock",
+                    collection: true
+          attribute :example, "Metanorma::Document::Components::AncillaryBlocks::ExampleBlock",
+                    collection: true
+          attribute :quote, "Metanorma::Document::Components::MultiParagraph::QuoteBlock",
+                    collection: true
+          attribute :sourcecode, "Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock",
+                    collection: true
+          attribute :source, "Metanorma::IsoDocument::Terms::TermSource",
+                    collection: true
+
+          # Nested tables (table inside td/th)
+          attribute :table, TableBlock,
+                    collection: true
+
+          # Key definitions inside table cells
+          attribute :key, "Metanorma::Document::Components::AncillaryBlocks::KeyElement"
+
+          # Presentation-specific elements
+          attribute :semx_id, :string
+          attribute :fmt_stem,
+                    Metanorma::Document::Components::Inline::FmtStemElement, collection: true
+          attribute :fmt_fn_label,
+                    Metanorma::Document::Components::Inline::FmtFnLabelElement, collection: true
+          attribute :semx, Metanorma::Document::Components::Inline::SemxElement,
+                    collection: true
+          attribute :span, Metanorma::Document::Components::Inline::SpanElement,
+                    collection: true
+          attribute :bookmark, Metanorma::Document::Components::IdElements::Bookmark,
+                    collection: true
+          attribute :fmt_annotation_start,
+                    Metanorma::Document::Components::Inline::FmtAnnotationStartElement, collection: true
+          attribute :fmt_annotation_end,
+                    Metanorma::Document::Components::Inline::FmtAnnotationEndElement, collection: true
+
+          xml do
+            mixed_content
+            map_attribute "id", to: :id
+            map_attribute "colspan", to: :colspan
+            map_attribute "rowspan", to: :rowspan
+            map_attribute "align", to: :align
+            map_attribute "valign", to: :valign
+            map_attribute "semx-id", to: :semx_id
+            map_content to: :text
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "tt", to: :tt
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "smallcap", to: :smallcap
+            map_element "br", to: :br
+            map_element "xref", to: :xref
+            map_element "eref", to: :eref
+            map_element "link", to: :link
+            map_element "stem", to: :stem
+            map_element "fn", to: :fn
+            map_element "strike", to: :strike
+            map_element "underline", to: :underline
+            map_element "p", to: :p
+            map_element "dl", to: :dl
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "figure", to: :figure
+            map_element "formula", to: :formula
+            map_element "note", to: :note
+            map_element "example", to: :example
+            map_element "quote", to: :quote
+            map_element "sourcecode", to: :sourcecode
+            map_element "source", to: :source
+            map_element "table", to: :table
+            map_element "key", to: :key
+            map_element "fmt-stem", to: :fmt_stem
+            map_element "fmt-fn-label", to: :fmt_fn_label
+            map_element "semx", to: :semx
+            map_element "span", to: :span
+            map_element "bookmark", to: :bookmark
+            map_element "fmt-annotation-start", to: :fmt_annotation_start
+            map_element "fmt-annotation-end", to: :fmt_annotation_end
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        # Horizontal textual alignment of the cell against the underlying table grid.
+        class TextAlignment < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "text-alignmnent"
+            map_content to: :value
+
+            def self.values
+              %w[left center right]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        # Table cell for <td> and <th> elements with inline content.
+        class TextTableCell < TableCell
+          xml do
+            element "td"
+            mixed_content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        # Sequence of cells to be displayed as a row in a table.
+        class TextTableRow < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :semx_id, :string
+          attribute :td, TextTableCell, collection: true
+          attribute :th, HeaderTableCell, collection: true
+
+          xml do
+            element "tr"
+            map_attribute "id", to: :id
+            map_attribute "semx-id", to: :semx_id
+            map_element "td", to: :td
+            map_element "th", to: :th
+          end
+
+          json do
+            map "td", to: :td
+            map "th", to: :th
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        # Vertical alignment of the cell against the underlying table grid.
+        class VerticalAlignment < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "vertical-alignmnent"
+            map_content to: :value
+
+            def self.values
+              %w[top middle bottom baseline]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Tables
+        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 :TableSection, "#{__dir__}/tables/table_section"
+        autoload :TextAlignment, "#{__dir__}/tables/text_alignment"
+        autoload :TextTableCell, "#{__dir__}/tables/text_table_cell"
+        autoload :TextTableRow, "#{__dir__}/tables/text_table_row"
+        autoload :VerticalAlignment, "#{__dir__}/tables/vertical_alignment"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/asciiml.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Mathematical text formatted in AsciiMath.
+        class Asciiml < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "asciimath"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/emphasis_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Emphasised text. Corresponds to HTML `em`, `i`.
+        class EmphasisElement < TextElement
+          xml do
+            element "emphasis"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/keyword_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Keyword text.
+        class KeywordElement < TextElement
+          xml do
+            element "keyword"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/latex.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Mathematical text formatted in LaTeX.
+        class Latex < StemValue
+          attribute :value, :string
+
+          xml do
+            element "latex"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/latexmath_element.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Mathematical text formatted in LaTeX.
+        class LatexmathElement < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "latexmath"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/monospace_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Monospace text. Corresponds to HTML `tt`, `code`.
+        class MonospaceElement < TextElement
+          xml do
+            element "monospace"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/ruby_element.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Text with Ruby annotations in East Asian languages. Corresponds to HTML `ruby`.
+        class RubyElement < TextElement
+          attribute :ruby_paren, Metanorma::Document::Components::DataTypes::LocalizedString,
+                    collection: true
+          attribute :ruby_text, Metanorma::Document::Components::DataTypes::LocalizedString,
+                    collection: true
+
+          xml do
+            element "ruby"
+            map_element "rp", to: :ruby_paren
+            map_element "rt", to: :ruby_text
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/small_caps_element.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Small caps text.
+        class SmallCapsElement < TextElement
+          xml do
+            element "smallcap"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/stem_element.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "mml"
+require "mml/v3"
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Mathematically formatted text.
+        class StemElement < TextElement
+          attribute :id, :string
+          attribute :stem_type, :string
+          attribute :block_attr, :string
+          attribute :number_format, :string
+          attribute :math, "Mml::V3::Math"
+          attribute :asciimath, Asciiml
+          attribute :latexmath, LatexmathElement
+
+          xml do
+            element "stem"
+            map_attribute "id", to: :id
+            map_attribute "type", to: :stem_type
+            map_attribute "block", to: :block_attr
+            map_attribute "number-format", to: :number_format
+            map_element "math", to: :math
+            map_element "asciimath", to: :asciimath
+            map_element "latexmath", to: :latexmath
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/stem_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # The notation used to mathematically format text.
+        class StemType < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "stem-type"
+            map_content to: :value
+
+            def self.values
+              %w[MathML AsciiML LaTeX]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/stem_value.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # The content of mathematically formatted text.
+        class StemValue < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "stem-value"
+            map_content to: :value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/text_elements/strike_element.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module TextElements
+        # Strikethrough text. Corresponds to HTML 4 `s`.
+        # Contains mixed content with inline elements.
+        class StrikeElement < Lutaml::Model::Serializable
+          attribute :text, :string, collection: true
+          attribute :em, "Metanorma::Document::Components::Inline::EmRawElement",
+                    collection: true
+          attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
+                    collection: true
+          attribute :eref, "Metanorma::Document::Components::Inline::ErefElement",
+                    collection: true
+          attribute :link, "Metanorma::Document::Components::Inline::LinkElement",
+                    collection: true
+
+          xml do
+            element "strike"
+            mixed_content
+            map_content to: :text
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "eref", to: :eref
+            map_element "link", to: :link
+          end
+        end
+      end
+    end
+  end
+end