metanorma-document 0.2.0

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # Definition term element, supporting inline content like stem, tt, etc.
+        class DtElement < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :stem, "Metanorma::Document::Components::TextElements::StemElement"
+          attribute :fmt_stem, "Metanorma::Document::Components::Inline::FmtStemElement"
+          attribute :p, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
+                    collection: true
+          attribute :span, "Metanorma::Document::Components::Inline::SpanElement",
+                    collection: true
+          attribute :tt, "Metanorma::Document::Components::Inline::TtElement",
+                    collection: true
+          attribute :em, "Metanorma::Document::Components::Inline::EmRawElement",
+                    collection: true
+          attribute :strong, "Metanorma::Document::Components::Inline::StrongRawElement",
+                    collection: true
+          attribute :sub, :string, collection: true
+          attribute :sup, "Metanorma::Document::Components::Inline::SupElement",
+                    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 :strike, "Metanorma::Document::Components::TextElements::StrikeElement",
+                    collection: true
+          attribute :underline, "Metanorma::Document::Components::TextElements::UnderlineElement",
+                    collection: true
+          attribute :br, "Metanorma::Document::Components::Inline::BrElement",
+                    collection: true
+          attribute :fn, "Metanorma::Document::Components::Inline::FnElement",
+                    collection: true
+          attribute :content, :string, collection: true
+
+          xml do
+            element "dt"
+            mixed_content
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_element "stem", to: :stem
+            map_element "fmt-stem", to: :fmt_stem
+            map_element "p", to: :p
+            map_element "span", to: :span
+            map_element "tt", to: :tt
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "xref", to: :xref
+            map_element "eref", to: :eref
+            map_element "link", to: :link
+            map_element "strike", to: :strike
+            map_element "underline", to: :underline
+            map_element "br", to: :br
+            map_element "fn", to: :fn
+            map_content to: :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # List block.
+        class List < Metanorma::Document::Components::Blocks::BasicBlock
+          attribute :listitem, "Metanorma::Document::Components::Lists::ListItem",
+                    collection: true
+          attribute :note,
+                    Metanorma::Document::Components::Blocks::NoteBlock, collection: true
+          attribute :id, :string
+
+          xml do
+            element "list"
+            map_attribute "id", to: :id
+            map_element "li", to: :listitem
+            map_element "note", to: :note
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # List item inside an ordered or unordered list.
+        # Contains text content.
+        class ListItem < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :original_id, :string
+          attribute :text, "Metanorma::Document::Components::TextElements::TextElement",
+                    collection: true
+          attribute :content_text, :string, collection: true
+          attribute :paragraphs, "Metanorma::Document::Components::Paragraphs::ParagraphBlock",
+                    collection: true
+          attribute :formula,
+                    "Metanorma::Document::Components::AncillaryBlocks::FormulaBlock",
+                    collection: true
+          attribute :figure,
+                    "Metanorma::Document::Components::AncillaryBlocks::FigureBlock",
+                    collection: true
+          attribute :unordered_lists,
+                    UnorderedList,
+                    collection: true
+          attribute :ordered_lists,
+                    OrderedList,
+                    collection: true
+          attribute :sourcecode,
+                    "Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock",
+                    collection: true
+          attribute :dl,
+                    "Metanorma::Document::Components::Lists::DefinitionList"
+          attribute :example,
+                    "Metanorma::Document::Components::AncillaryBlocks::ExampleBlock",
+                    collection: true
+          attribute :note,
+                    "Metanorma::Document::Components::Blocks::NoteBlock",
+                    collection: true
+          attribute :quote,
+                    "Metanorma::Document::Components::MultiParagraph::QuoteBlock",
+                    collection: true
+          attribute :table,
+                    "Metanorma::Document::Components::Tables::TableBlock",
+                    collection: true
+          attribute :fmt_name, "Metanorma::Document::Components::Inline::FmtNameElement"
+          attribute :checkedcheckbox, :string
+          attribute :uncheckedcheckbox, :string
+          attribute :label, :string
+          attribute :json_text, :string
+
+          xml do
+            element "li"
+            mixed_content
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "original-id", to: :original_id
+            map_attribute "checkedcheckbox", to: :checkedcheckbox
+            map_attribute "uncheckedcheckbox", to: :uncheckedcheckbox
+            map_attribute "label", to: :label
+            map_content to: :content_text
+            map_element "text", to: :text
+            map_element "p", to: :paragraphs
+            map_element "formula", to: :formula
+            map_element "figure", to: :figure
+            map_element "sourcecode", to: :sourcecode
+            map_element "dl", to: :dl
+            map_element "example", to: :example
+            map_element "note", to: :note
+            map_element "quote", to: :quote
+            map_element "table", to: :table
+            map_element "ul", to: :unordered_lists
+            map_element "ol", to: :ordered_lists
+            map_element "fmt-name", to: :fmt_name
+          end
+
+          json do
+            map "text", to: :json_text
+          end
+
+          def json_text
+            if paragraphs && !paragraphs.empty?
+              return paragraphs.map { |p| p.text || "" }.join(" ").strip
+            end
+
+            ct = content_text
+            if ct.is_a?(Array) && !ct.empty?
+              return ct.compact.join.strip
+            end
+
+            text&.filter_map do |t|
+              t.respond_to?(:text) ? t.text : t.to_s
+            end&.join
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # Ordered list, with numbering applied to the list items.
+        class OrderedList < UnorderedList
+          attribute :type, :string
+          attribute :start, :string
+          attribute :semx_id, :string
+          attribute :displayorder, :integer
+          attribute :display, :string
+          attribute :display_directives, :string
+          attribute :class_attr, :string
+
+          def json_type
+            "ol"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "listitem", to: :listitem
+          end
+
+          xml do
+            element "ol"
+            map_attribute "id", to: :id
+            map_attribute "type", to: :type
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "displayorder", to: :displayorder
+            map_attribute "display", to: :display
+            map_attribute "display-directives", to: :display_directives
+            map_attribute "class", to: :class_attr, render_empty: true
+            map_attribute "start", to: :start
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # Type of numbering applied to the list items in an ordered list.
+        class OrderedListType < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "ordered-list-type"
+            map_content to: :value
+
+            def self.values
+              %w[roman alphabet arabic romanUpper alphabetUpper]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        # Unordered list block.
+        class UnorderedList < List
+          attribute :id, :string
+          attribute :semx_id, :string
+          attribute :original_id, :string
+          attribute :json_type, :string
+
+          def json_type
+            "ul"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "listitem", to: :listitem
+          end
+
+          xml do
+            element "ul"
+            map_attribute "id", to: :id
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "original-id", to: :original_id
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Lists
+        autoload :DdElement, "#{__dir__}/lists/dd_element"
+        autoload :Definition, "#{__dir__}/lists/definition"
+        autoload :DefinitionList, "#{__dir__}/lists/definition_list"
+        autoload :DtElement, "#{__dir__}/lists/dt_element"
+        autoload :List, "#{__dir__}/lists/list"
+        autoload :ListItem, "#{__dir__}/lists/list_item"
+        autoload :OrderedList, "#{__dir__}/lists/ordered_list"
+        autoload :OrderedListType, "#{__dir__}/lists/ordered_list_type"
+        autoload :UnorderedList, "#{__dir__}/lists/unordered_list"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        # A sidebar block outside of the main flow of text,
+        # conveying particular warnings or supplementary text to the reader.
+        class AdmonitionBlock < ParagraphsBlock
+          # 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
+
+          # Caption of admonition.
+          attribute :name, Metanorma::Document::Components::TextElements::TextElement,
+                    collection: true
+
+          # Subclass of admonition allowing different runs of admonitions to be labelled
+          # and auto-numbered differently, even if they are of the same type.
+          # Typically is a subclass of an admonition type.
+          attribute :block_class, :string
+
+          # Location where the content of the admonition is accessible as an external document.
+          attribute :uri, :string
+
+          # Paragraphs within the admonition.
+          attribute :paragraphs,
+                    Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          # Presentation-specific elements
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+
+          attribute :json_type, :string
+
+          def json_type
+            "admonition"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "name", to: :name
+            map "admonition_type", to: :type
+          end
+
+          xml do
+            element "admonition"
+            map_attribute "id", to: :id
+            map_attribute "type", to: :type
+            map_element "name", to: :name
+            map_attribute "class", to: :block_class
+            map_element "uri", to: :uri
+            map_element "p", to: :paragraphs
+            map_element "fmt-name", to: :fmt_name
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        # Subclass of admonition determining how it is to be rendered.
+        class AdmonitionType < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "admonition-type"
+            map_content to: :value
+
+            def self.values
+              %w[warning note tip important caution statement]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        # Block composed of multiple paragraphs.
+        class ParagraphsBlock < Metanorma::Document::Components::Paragraphs::ParagraphWithFootnote
+          # The paragraphs constituting the ParagraphsBlock.
+          attribute :contents, Metanorma::Document::Components::Paragraphs::ParagraphWithFootnote,
+                    collection: true
+
+          xml do
+            element "paragraphs-block"
+            map_element "contents", to: :contents
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+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
+            "quote"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "source", to: :source
+            map "author", to: :author
+          end
+
+          xml do
+            element "quote"
+            map_attribute "id", to: :id
+            map_element "source", to: :source
+            map_element "author", to: :author
+            map_element "p", to: :paragraphs
+            map_element "ul", to: :ul
+            map_element "ol", to: :ol
+            map_element "attribution", to: :attribution
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        # Block intended to capture reviewer comments about some text in the document.
+        class ReviewBlock < ParagraphsBlock
+          # The party who has offered the comment.
+          attribute :reviewer, :string
+
+          # The date when the comment was made.
+          attribute :date, :string
+
+          # Identifier for the start of the text or point in the text to which the comment applies.
+          # If not provided, the comment applies in the vicinity of the place it has been inserted into the
+          # text.
+          attribute :applies_from, :string
+
+          # Identifier for the end of the text to which the comment applies.
+          attribute :applies_to, :string
+
+          xml do
+            element "review"
+            map_attribute "reviewer", to: :reviewer
+            map_attribute "date", to: :date
+            map_attribute "from", to: :applies_from
+            map_attribute "to", to: :applies_to
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module MultiParagraph
+        autoload :AdmonitionBlock, "#{__dir__}/multi_paragraph/admonition_block"
+        autoload :AdmonitionType, "#{__dir__}/multi_paragraph/admonition_type"
+        autoload :ParagraphsBlock, "#{__dir__}/multi_paragraph/paragraphs_block"
+        autoload :QuoteBlock, "#{__dir__}/multi_paragraph/quote_block"
+        autoload :ReviewBlock, "#{__dir__}/multi_paragraph/review_block"
+      end
+    end
+  end
+end