metanorma-document 0.2.0

data/lib/metanorma/document/components/paragraphs/paragraph_block.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Paragraphs
+        # Default block of textual content.
+        class ParagraphBlock < Metanorma::Document::Components::Blocks::BasicBlock
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :alignment, :string
+          attribute :semx_id, :string
+          attribute :original_id, :string
+          attribute :keep_with_next, :string
+          attribute :class_attr, :string
+          attribute :type_attr, :string
+          attribute :displayorder, :integer
+          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 :smallcap, Metanorma::Document::Components::Inline::SmallCapElement,
+                    collection: true
+          attribute :sub, Metanorma::Document::Components::Inline::SubElement,
+                    collection: true
+          attribute :sup, Metanorma::Document::Components::Inline::SupElement,
+                    collection: true
+          attribute :tt, Metanorma::Document::Components::Inline::TtElement,
+                    collection: true
+          attribute :underline, Metanorma::Document::Components::TextElements::UnderlineElement,
+                    collection: true
+          attribute :strike, Metanorma::Document::Components::TextElements::StrikeElement,
+                    collection: true
+          attribute :keyword, :string, collection: true
+          attribute :fmt_annotation_end,
+                    Metanorma::Document::Components::Inline::FmtAnnotationEndElement, collection: true
+          attribute :fmt_annotation_start,
+                    Metanorma::Document::Components::Inline::FmtAnnotationStartElement, 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 :span, Metanorma::Document::Components::Inline::SpanElement,
+                    collection: true
+          attribute :stem, Metanorma::Document::Components::Inline::StemInlineElement,
+                    collection: true
+          attribute :concept, Metanorma::Document::Components::Inline::ConceptElement,
+                    collection: true
+          attribute :fn, Metanorma::Document::Components::Inline::FnElement,
+                    collection: true
+          attribute :note, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+          attribute :semx, Metanorma::Document::Components::Inline::SemxElement,
+                    collection: true
+          attribute :tab, Metanorma::Document::Components::Inline::TabElement,
+                    collection: true
+          attribute :fmt_stem, Metanorma::Document::Components::Inline::FmtStemElement,
+                    collection: true
+          attribute :fmt_fn_label,
+                    Metanorma::Document::Components::Inline::FmtFnLabelElement, collection: true
+          attribute :fmt_concept,
+                    Metanorma::Document::Components::Inline::FmtConceptElement, collection: true
+          attribute :bookmark, Metanorma::Document::Components::IdElements::Bookmark,
+                    collection: true
+          attribute :bcp14, Metanorma::Document::Components::Inline::Bcp14Element,
+                    collection: true
+          attribute :index, Metanorma::Document::Components::EmptyElements::IndexElement,
+                    collection: true
+          attribute :image, Metanorma::Document::Components::IdElements::Image,
+                    collection: true
+          attribute :add, "Metanorma::StandardDocument::Elements::Add",
+                    collection: true
+          attribute :del, "Metanorma::StandardDocument::Elements::Del",
+                    collection: true
+
+          # JSON serialization attributes
+          attribute :json_type, :string
+          attribute :json_content, :string
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "content", to: :json_content
+          end
+
+          xml do
+            element "p"
+            mixed_content
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "align", to: :alignment
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "original-id", to: :original_id
+            map_attribute "keep-with-next", to: :keep_with_next
+            map_attribute "class", to: :class_attr
+            map_attribute "type", to: :type_attr
+            map_attribute "displayorder", to: :displayorder
+            map_content to: :text
+            map_element "em", to: :em
+            map_element "strong", to: :strong
+            map_element "smallcap", to: :smallcap
+            map_element "sub", to: :sub
+            map_element "sup", to: :sup
+            map_element "tt", to: :tt
+            map_element "underline", to: :underline
+            map_element "strike", to: :strike
+            map_element "keyword", to: :keyword
+            map_element "br", to: :br
+            map_element "xref", to: :xref
+            map_element "eref", to: :eref
+            map_element "link", to: :link
+            map_element "span", to: :span
+            map_element "stem", to: :stem
+            map_element "concept", to: :concept
+            map_element "fn", to: :fn
+            map_element "note", to: :note
+            map_element "fmt-annotation-end", to: :fmt_annotation_end
+            map_element "fmt-annotation-start", to: :fmt_annotation_start
+            map_element "semx", to: :semx
+            map_element "tab", to: :tab
+            map_element "fmt-stem", to: :fmt_stem
+            map_element "fmt-fn-label", to: :fmt_fn_label
+            map_element "fmt-concept", to: :fmt_concept
+            map_element "bookmark", to: :bookmark
+            map_element "bcp14", to: :bcp14
+            map_element "index", to: :index
+            map_element "image", to: :image
+            map_element "add", to: :add
+            map_element "del", to: :del
+          end
+
+          def json_content
+            t = text
+            if t
+              joined = t.is_a?(Array) ? t.join : t
+              return joined unless joined.strip.empty?
+            end
+            ""
+          end
+
+          def json_type
+            "paragraph"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/paragraphs/paragraph_with_footnote.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Paragraphs
+        # A paragraph which may also contain footnotes.
+        # While most paragraphs in a document can contain footnotes, the distinction is necessary, as
+        # footnotes are not appropriate for all instances of paragraph content in a document (e.g. sourcecode
+        # annotations).
+        class ParagraphWithFootnote < Metanorma::Document::Components::Paragraphs::ParagraphBlock
+          # Footnotes contained in the paragraph.
+          attribute :footnotes,
+                    Metanorma::Document::Components::ReferenceElements::Footnote, collection: true
+
+          xml do
+            element "paragraph-with-footnote"
+            map_element "footnotes", to: :footnotes
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Paragraphs
+        # The alignment of the paragraph against the margins of the document.
+        class TextAlignment < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "text-alignment"
+            map_content to: :value
+
+            def self.values
+              %w[left center right justified]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Paragraphs
+        autoload :ParagraphBlock, "#{__dir__}/paragraphs/paragraph_block"
+        autoload :ParagraphWithFootnote,
+                 "#{__dir__}/paragraphs/paragraph_with_footnote"
+        autoload :TextAlignment, "#{__dir__}/paragraphs/text_alignment"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # Inline reference to a paragraph or paragraphs, appearing as annotation of source code.
+        # The target of the callout is understood to be the location of the callout within the source code;
+        # the extent of the target is not expressed overtly.
+        class Callout < ReferenceToIdElement
+          attribute :target_attr, :string
+          attribute :type, :string
+          attribute :text, Metanorma::Document::Components::TextElements::TextElement
+
+          xml do
+            element "callout"
+            map_attribute "target", to: :target_attr
+            map_element "type", to: :type
+            map_element "text", to: :text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # Representation of a citation of a bibliographic item, typically within a document.
+        class Citation < Lutaml::Model::Serializable
+          attribute :bibitemid, :string
+          attribute :date, :string
+          attribute :type, :string
+          attribute :citeas, :string
+          attribute :bib_locality, Metanorma::Document::Relaton::BibItemLocality,
+                    collection: true
+          attribute :bib_locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+          attribute :bib_item, Metanorma::Document::Components::BibData::BibliographicItem
+          attribute :display_text, "Metanorma::Document::Components::Inline::DisplayTextElement"
+
+          xml do
+            element "citation"
+            map_attribute "bibitemid", to: :bibitemid
+            map_attribute "date", to: :date
+            map_attribute "type", to: :type
+            map_attribute "citeas", to: :citeas
+            map_element "bib-locality", to: :bib_locality
+            map_element "bib-locality-stack", to: :bib_locality_stack
+            map_element "localityStack", to: :locality_stack
+            map_element "bib-item", to: :bib_item
+            map_element "display-text", to: :display_text
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # Inline reference to a paragraph or paragraphs, appearing as a footnote.
+        class Footnote < ReferenceToIdWithParagraphElement
+          attribute :type, :string
+
+          xml do
+            element "footnote"
+            map_element "type", to: :type
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # A reference to an index term, cross-referenced within an index as an
+        # alternative index entry, either as a "see" or a "see also" cross-reference.
+        # The text in the inline element is the primary index term to be be cross-referenced.
+        class IndexXrefElement < ReferenceElement
+          attribute :secondary, :string
+          attribute :tertiary, :string
+          attribute :target, :string
+          attribute :also, :boolean
+
+          xml do
+            element "index-xref-element"
+            map_attribute "secondary", to: :secondary
+            map_attribute "tertiary", to: :tertiary
+            map_attribute "target", to: :target
+            map_attribute "also", to: :also
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # Inline element, which references an identifier of a document, a block in a document, or an element
+        # in a document.
+        class ReferenceElement < Metanorma::Document::Components::EmptyElements::BasicElement
+          attribute :type, :string
+          attribute :text, Metanorma::Document::Components::EmptyElements::BasicElement
+          attribute :alt, :string
+
+          xml do
+            element "reference-element"
+            map_attribute "type", to: :type
+            map_element "text", to: :text
+            map_attribute "alt", to: :alt
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # The type of Reference Element, prescribing how it is to be rendered.
+        class ReferenceFormat < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "reference-format"
+            map_content to: :value
+
+            def self.values
+              %w[external inline footnote callout]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # An external reference to a bibliographic entity.
+        class ReferenceToCitationElement < Metanorma::Document::Components::ReferenceElements::ReferenceElement
+          attribute :id, :string
+          attribute :normative, :boolean
+          attribute :cite_as, Metanorma::Document::Components::TextElements::TextElement,
+                    collection: true
+          attribute :bibitemid, :string
+          attribute :citeas, :string
+          attribute :uri, :string
+          attribute :locality_stack, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+
+          xml do
+            element "reference-to-citation-element"
+            map_attribute "id", to: :id
+            map_attribute "normative", to: :normative
+            map_element "cite-as", to: :cite_as
+            map_attribute "bibitemid", to: :bibitemid
+            map_attribute "citeas", to: :citeas
+            map_attribute "uri", to: :uri
+            map_element "localityStack", to: :locality_stack
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # An internal reference to an element of the current document.
+        class ReferenceToIdElement < ReferenceElement
+          attribute :target, Metanorma::Document::Components::IdElements::IdElement
+
+          xml do
+            element "reference-to-id-element"
+            map_element "target", to: :target
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # Inline reference to a paragraph or paragraphs: element combining the reference and the referenced
+        # content in the one element.
+        class ReferenceToIdWithParagraphElement < ReferenceToIdElement
+          attribute :content, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "reference-to-id-with-paragraph-element"
+            map_element "content", to: :content
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        # A reference to an external document or resource.
+        class ReferenceToLinkElement < ReferenceElement
+          attribute :target, :string
+
+          xml do
+            element "reference-to-link-element"
+            map_attribute "target", to: :target
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module ReferenceElements
+        autoload :Callout, "#{__dir__}/reference_elements/callout"
+        autoload :Citation, "#{__dir__}/reference_elements/citation"
+        autoload :Footnote, "#{__dir__}/reference_elements/footnote"
+        autoload :IndexXrefElement,
+                 "#{__dir__}/reference_elements/index_xref_element"
+        autoload :ReferenceElement,
+                 "#{__dir__}/reference_elements/reference_element"
+        autoload :ReferenceFormat,
+                 "#{__dir__}/reference_elements/reference_format"
+        autoload :ReferenceToCitationElement,
+                 "#{__dir__}/reference_elements/reference_to_citation_element"
+        autoload :ReferenceToIdElement,
+                 "#{__dir__}/reference_elements/reference_to_id_element"
+        autoload :ReferenceToIdWithParagraphElement,
+                 "#{__dir__}/reference_elements/reference_to_id_with_paragraph_element"
+        autoload :ReferenceToLinkElement,
+                 "#{__dir__}/reference_elements/reference_to_link_element"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/sections/basic_section.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Sections
+        # Group of blocks within text, which is a leaf node in the hierarchical organisation of text (does not
+        # contain any sections of its own).
+        class BasicSection < Lutaml::Model::Serializable
+          attribute :title, Metanorma::Document::Components::TextElements::TextElement,
+                    collection: true
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :language, Metanorma::Document::Components::DataTypes::Iso639Code,
+                    collection: true
+          attribute :script, Metanorma::Document::Components::DataTypes::Iso15924Code,
+                    collection: true
+          attribute :blocks, Metanorma::Document::Components::Blocks::BasicBlock,
+                    collection: true
+          attribute :notes, Metanorma::Document::Components::Blocks::NoteBlock,
+                    collection: true
+
+          xml do
+            element "basic-section"
+            map_element "title", to: :title
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_element "language", to: :language
+            map_element "script", to: :script
+            map_element "blocks", to: :blocks
+            map_element "notes", to: :notes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/sections/content_section.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      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 < HierarchicalSection
+          xml do
+            element "content-section"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/sections/hierarchical_section.rb

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

data/lib/metanorma/document/components/sections/references_section.rb

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

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

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

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

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

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

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