metanorma-document 0.2.0

data/lib/metanorma/basic_document/sections/content_section.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Sections
+      # Prefatory sections of text, outside the main flow of text.
+      # In the BasicDocument model these are treated as equivalent to Hierarchical Sections.
+      # (The distinction is currently reserved for downstream models such as Metanorma, which differentiates
+      # structurally between prefatory sections and sections in the main body of the text; differences
+      # between the two may be introduced in the Basic Document model at a later date.)
+      class ContentSection < Metanorma::BasicDocument::Sections::HierarchicalSection
+        xml do
+          element "content-section"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/sections/hierarchical_section.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Sections
+      # Sections: groups of blocks within text, which can also contain other sections.
+      class HierarchicalSection < Metanorma::BasicDocument::Sections::BasicSection
+        attribute :subsections,
+                  Metanorma::BasicDocument::Sections::HierarchicalSection, collection: true
+
+        xml do
+          element "hierarchical-section"
+          map_element "subsections", to: :subsections
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/sections/references_section.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Sections
+      # Sections containing zero or more bibliographical items (as described in Relaton),
+      # along with any prefatory text.
+      class ReferencesSection < Metanorma::BasicDocument::Sections::BasicSection
+        attribute :references,
+                  Metanorma::BasicDocument::BibData::BibliographicItem, collection: true
+
+        xml do
+          element "references-section"
+          map_element "references", to: :references
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/sections.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Sections
+      autoload :BasicSection, "#{__dir__}/sections/basic_section"
+      autoload :ContentSection, "#{__dir__}/sections/content_section"
+      autoload :HierarchicalSection,
+               "#{__dir__}/sections/hierarchical_section"
+      autoload :ReferencesSection,
+               "#{__dir__}/sections/references_section"
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/paragraph_table_cell.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      # Table cells composed of multiple paragraphs.
+      class ParagraphTableCell < Metanorma::BasicDocument::Tables::TableCell
+        attribute :content,
+                  Metanorma::BasicDocument::Paragraphs::ParagraphWithFootnote, collection: true
+
+        xml do
+          element "paragraph-table-cell"
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/table_block.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      # Tabular arrangement of text
+      class TableBlock < Metanorma::BasicDocument::Blocks::BasicBlock
+        attribute :name, Metanorma::BasicDocument::TextElements::TextElement,
+                  collection: true
+        attribute :unnumbered, :boolean
+        attribute :subsequence, :string
+        attribute :alt, :string
+        attribute :summary, :string
+        attribute :uri, :string
+        attribute :head, Metanorma::BasicDocument::Tables::TextTableRow
+        attribute :body, Metanorma::BasicDocument::Tables::TextTableRow,
+                  collection: true
+        attribute :foot, Metanorma::BasicDocument::Tables::TextTableRow
+        attribute :definitions, Metanorma::BasicDocument::Lists::DefinitionList
+
+        xml do
+          element "table"
+          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_element "head", to: :head
+          map_element "body", to: :body
+          map_element "foot", to: :foot
+          map_element "definitions", to: :definitions
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/table_cell.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      # Textual content constituting a basic building block of a table.
+      class TableCell < Lutaml::Model::Serializable
+        attribute :colspan, :integer
+        attribute :rowspan, :integer
+        attribute :align, :string
+        attribute :valign, :string
+
+        xml do
+          element "table-cell"
+          map_attribute "colspan", to: :colspan
+          map_attribute "rowspan", to: :rowspan
+          map_attribute "align", to: :align
+          map_attribute "valign", to: :valign
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/text_alignment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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
+        end
+
+        def self.values
+          %w[left center right]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/text_table_cell.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      # Table cells composed of inline elements, and therefore corresponding to a single block.
+      class TextTableCell < Metanorma::BasicDocument::Tables::TableCell
+        attribute :content,
+                  Metanorma::BasicDocument::TextElements::TextElement, collection: true
+
+        xml do
+          element "td"
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/text_table_row.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      # Sequence of cells to be displayed as a row in a table.
+      class TextTableRow < Lutaml::Model::Serializable
+        attribute :td, Metanorma::BasicDocument::Tables::TableCell,
+                  collection: true
+        attribute :th, Metanorma::BasicDocument::Tables::TableCell,
+                  collection: true
+
+        xml do
+          element "tr"
+          map_element "td", to: :td
+          map_element "th", to: :th
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables/vertical_alignment.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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
+        end
+
+        def self.values
+          %w[top middle bottom baseline]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/tables.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Tables
+      autoload :ParagraphTableCell,
+               "#{__dir__}/tables/paragraph_table_cell"
+      autoload :TableBlock, "#{__dir__}/tables/table_block"
+      autoload :TableCell, "#{__dir__}/tables/table_cell"
+      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

data/lib/metanorma/basic_document/text_elements/asciiml.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Mathematical text formatted in AsciiMath.
+      class Asciiml < Metanorma::BasicDocument::TextElements::StemValue
+        attribute :value, :string
+
+        xml do
+          element "asciiml"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/emphasis_element.rb

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

data/lib/metanorma/basic_document/text_elements/keyword_element.rb

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

data/lib/metanorma/basic_document/text_elements/latex.rb

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

data/lib/metanorma/basic_document/text_elements/mathml.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Mathematical text formatted in MathML.
+      class Mathml < Metanorma::BasicDocument::TextElements::StemValue
+        attribute :value, BasicObject
+
+        xml do
+          element "mathml"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/monospace_element.rb

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

data/lib/metanorma/basic_document/text_elements/ruby_element.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Text with Ruby annotations in East Asian languages. Corresponds to HTML `ruby`.
+      class RubyElement < Metanorma::BasicDocument::TextElements::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

data/lib/metanorma/basic_document/text_elements/small_caps_element.rb

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

data/lib/metanorma/basic_document/text_elements/stem_element.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Mathematically formatted text.
+      class StemElement < Metanorma::BasicDocument::TextElements::TextElement
+        attribute :stem_type, :string
+        attribute :stem_value, :string
+
+        xml do
+          element "stem"
+          map_content to: :stem_value
+          map_attribute "type", to: :stem_type
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/stem_type.rb

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

data/lib/metanorma/basic_document/text_elements/stem_value.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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

data/lib/metanorma/basic_document/text_elements/strike_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Strikethrough text. Corresponds to HTML 4 `s`.
+      class StrikeElement < Metanorma::BasicDocument::TextElements::TextElement
+        xml do
+          element "strike"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/strong_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Strong text. Corresponds to HTML `strong`, `b`.
+      class StrongElement < Metanorma::BasicDocument::TextElements::TextElement
+        xml do
+          element "strong"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/subscript_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Subscript text. Corresponds to HTML `sub`.
+      class SubscriptElement < Metanorma::BasicDocument::TextElements::TextElement
+        xml do
+          element "sub"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/superscript_element.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Superscript text. Corresponds to HTML `sup`.
+      class SuperscriptElement < Metanorma::BasicDocument::TextElements::TextElement
+        xml do
+          element "sup"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/text_element.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Inline element containing text and associated formatting information,
+      # but which does not contain any associated identifiers or references to identifiers.
+      class TextElement < Metanorma::BasicDocument::EmptyElements::BasicElement
+        attribute :content, Metanorma::BasicDocument::TextElements::TextElementType
+
+        xml do
+          element "text-element"
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/text_element_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      # Content of the Text Element.
+      class TextElementType < Lutaml::Model::Serializable
+        attribute :content, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :elements,
+                  Metanorma::BasicDocument::TextElements::TextElement, collection: true
+
+        xml do
+          element "text-element-type"
+          map_element "content", to: :content
+          map_element "elements", to: :elements
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements/underline_element.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      class UnderlineElement < Metanorma::BasicDocument::TextElements::TextElement
+        xml do
+          element "underline"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/text_elements.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module TextElements
+      autoload :Asciiml, "#{__dir__}/text_elements/asciiml"
+      autoload :EmphasisElement,
+               "#{__dir__}/text_elements/emphasis_element"
+      autoload :KeywordElement, "#{__dir__}/text_elements/keyword_element"
+      autoload :Latex, "#{__dir__}/text_elements/latex"
+      autoload :Mathml, "#{__dir__}/text_elements/mathml"
+      autoload :MonospaceElement,
+               "#{__dir__}/text_elements/monospace_element"
+      autoload :RubyElement, "#{__dir__}/text_elements/ruby_element"
+      autoload :SmallCapsElement,
+               "#{__dir__}/text_elements/small_caps_element"
+      autoload :StemElement, "#{__dir__}/text_elements/stem_element"
+      autoload :StemType, "#{__dir__}/text_elements/stem_type"
+      autoload :StemValue, "#{__dir__}/text_elements/stem_value"
+      autoload :StrikeElement, "#{__dir__}/text_elements/strike_element"
+      autoload :StrongElement, "#{__dir__}/text_elements/strong_element"
+      autoload :SubscriptElement,
+               "#{__dir__}/text_elements/subscript_element"
+      autoload :SuperscriptElement,
+               "#{__dir__}/text_elements/superscript_element"
+      autoload :TextElement, "#{__dir__}/text_elements/text_element"
+      autoload :TextElementType,
+               "#{__dir__}/text_elements/text_element_type"
+      autoload :UnderlineElement,
+               "#{__dir__}/text_elements/underline_element"
+    end
+  end
+end

data/lib/metanorma/basic_document.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    # The basic document flavor, containing the most fundamental elements of a
+    # Metanorma document, without any specific structure or semantics.
+    autoload :AncillaryBlocks, "metanorma/basic_document/ancillary_blocks"
+    autoload :BibData, "metanorma/basic_document/bib_data"
+    autoload :Blocks, "metanorma/basic_document/blocks"
+    autoload :Change, "metanorma/basic_document/change"
+    autoload :ContribMetadata, "metanorma/basic_document/contrib_metadata"
+    autoload :DataTypes, "metanorma/basic_document/data_types"
+    autoload :EmptyElements, "metanorma/basic_document/empty_elements"
+    autoload :IdElements, "metanorma/basic_document/id_elements"
+    autoload :Lists, "metanorma/basic_document/lists"
+    autoload :MultiParagraph, "metanorma/basic_document/multi_paragraph"
+    autoload :Paragraphs, "metanorma/basic_document/paragraphs"
+    autoload :ReferenceElements, "metanorma/basic_document/reference_elements"
+    autoload :Sections, "metanorma/basic_document/sections"
+    autoload :Tables, "metanorma/basic_document/tables"
+    autoload :TextElements, "metanorma/basic_document/text_elements"
+  end
+end

data/lib/metanorma/bipm_document/metadata/bipm_bib_data_extension_type.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BipmDocument
+    module Metadata
+      # Extension point for bibliographical definitions of BIPM documents.
+      # Inherits all ISO extension fields; overrides structuredidentifier for BIPM format.
+      class BipmBibDataExtensionType < Metanorma::IsoDocument::Metadata::IsoBibDataExtensionType
+        attribute :structuredidentifier, BipmStructuredIdentifier
+        attribute :si_aspect, :string
+
+        xml do
+          element "ext"
+          map_element "structuredidentifier", to: :structuredidentifier
+          map_element "si-aspect", to: :si_aspect
+        end
+      end
+    end
+  end
+end