metanorma-document 0.2.0

data/lib/metanorma/basic_document/lists/definition.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      # Definition used to constitute a definition list.
+      class Definition < Lutaml::Model::Serializable
+        attribute :item, Metanorma::BasicDocument::TextElements::TextElement,
+                  collection: true
+        attribute :definition,
+                  Metanorma::BasicDocument::Paragraphs::ParagraphWithFootnote, collection: true
+
+        xml do
+          element "dd"
+          map_element "item", to: :item
+          map_element "definition", to: :definition
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists/definition_list.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      # Definition list, composed of definitions rather than list items.
+      class DefinitionList < Metanorma::BasicDocument::Lists::List
+        attribute :listitem, Metanorma::BasicDocument::Lists::Definition,
+                  collection: true
+
+        xml do
+          element "dl"
+          map_element "listitem", to: :listitem
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists/list.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      # List block.
+      class List < Metanorma::BasicDocument::Blocks::BasicBlock
+        attribute :listitem, BasicObject, collection: true
+
+        xml do
+          element "list"
+          map_element "listitem", to: :listitem
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists/ordered_list.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      # Ordered list, with numbering applied to the list items.
+      class OrderedList < Metanorma::BasicDocument::Lists::UnorderedList
+        attribute :type, :string
+        attribute :start, :string
+
+        xml do
+          element "ol"
+          map_attribute "type", to: :type
+          map_element "start", to: :start
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists/ordered_list_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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
+        end
+
+        def self.values
+          %w[roman alphabet arabic romanUpper alphabetUpper]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists/unordered_list.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      # Unordered list block.
+      class UnorderedList < Metanorma::BasicDocument::Lists::List
+        xml do
+          element "ul"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/lists.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Lists
+      autoload :Definition, "#{__dir__}/lists/definition"
+      autoload :DefinitionList, "#{__dir__}/lists/definition_list"
+      autoload :List, "#{__dir__}/lists/list"
+      autoload :OrderedList, "#{__dir__}/lists/ordered_list"
+      autoload :OrderedListType, "#{__dir__}/lists/ordered_list_type"
+      autoload :UnorderedList, "#{__dir__}/lists/unordered_list"
+    end
+  end
+end

data/lib/metanorma/basic_document/multi_paragraph/admonition_block.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module MultiParagraph
+      # A sidebar block outside of the main flow of text,
+      # conveying particular warnings or supplementary text to the reader.
+      class AdmonitionBlock < Metanorma::BasicDocument::MultiParagraph::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::BasicDocument::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 :class, :string
+
+        # Location where the content of the admonition is accessible as an external document.
+        attribute :uri, Metanorma::Document::Components::DataTypes::Uri
+
+        xml do
+          element "admonition"
+          map_attribute "type", to: :type
+          map_element "name", to: :name
+          map_attribute "class", to: :class
+          map_element "uri", to: :uri
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/multi_paragraph/admonition_type.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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
+        end
+
+        def self.values
+          %w[warning note tip important caution statement]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/multi_paragraph/paragraphs_block.rb

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

data/lib/metanorma/basic_document/multi_paragraph/quote_block.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module MultiParagraph
+      # Block quotation, containing extensive textual content originally authored outside of the current
+      # document.
+      class QuoteBlock < Metanorma::BasicDocument::MultiParagraph::ParagraphsBlock
+        # Bibliographic citation for the quotation.
+        attribute :source, Metanorma::BasicDocument::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, Metanorma::Document::Relaton::Contributor
+
+        xml do
+          element "quote"
+          map_element "source", to: :source
+          map_element "author", to: :author
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/multi_paragraph/review_block.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module MultiParagraph
+      # Block intended to capture reviewer comments about some text in the document.
+      class ReviewBlock < Metanorma::BasicDocument::MultiParagraph::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

data/lib/metanorma/basic_document/multi_paragraph.rb

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

data/lib/metanorma/basic_document/paragraphs/paragraph_block.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Paragraphs
+      class ParagraphBlock < Metanorma::BasicDocument::Blocks::BasicBlock
+        # Inline elements constituting the content of the paragraph.
+        attribute :contents,
+                  Metanorma::BasicDocument::EmptyElements::BasicElement, collection: true
+
+        # The alignment of the paragraph against the margins of the document.
+        # Text alignment is the only concession the modelling of paragraphs makes to rendering, and is there
+        # because the application of alignment to paragraphs, while rare, can be unpredictable from paragraph
+        # semantics. Other rendering attributes of paragraphs, such as spacing before and after, are
+        # considered to be semantically predictable and are relegated to document stylesheets.
+        attribute :alignment, Metanorma::BasicDocument::Paragraphs::TextAlignment
+
+        xml do
+          element "p"
+          map_element "contents", to: :contents
+          map_element "alignment", to: :alignment
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/paragraphs/paragraph_with_footnote.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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::BasicDocument::Paragraphs::ParagraphBlock
+        # Footnotes contained in the paragraph.
+        attribute :footnotes, BasicObject, collection: true # But actually: ReferenceToldWithParagraphElement
+
+        xml do
+          element "paragraph-with-footnote"
+          map_element "footnotes", to: :footnotes
+        end
+      end
+    end
+  end
+end

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

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

data/lib/metanorma/basic_document/paragraphs.rb

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

data/lib/metanorma/basic_document/reference_elements/callout.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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 < Metanorma::BasicDocument::ReferenceElements::ReferenceToIdElement
+        attribute :type, BasicObject
+        attribute :text, Metanorma::BasicDocument::TextElements::TextElement
+
+        xml do
+          element "callout"
+          map_element "type", to: :type
+          map_element "text", to: :text
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/reference_elements/citation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ReferenceElements
+      # Representation of a citation of a bibliographic item, typically within a document.
+      class Citation < Lutaml::Model::Serializable
+        attribute :date, :string
+        attribute :bib_locality, Metanorma::Document::Relaton::BibItemLocality,
+                  collection: true
+        attribute :bib_locality_stack,
+                  Metanorma::Document::Relaton::LocalityStack, collection: true
+        attribute :bib_item, Metanorma::BasicDocument::BibData::BibliographicItem
+
+        xml do
+          element "citation"
+          map_attribute "date", to: :date
+          map_element "bib-locality", to: :bib_locality
+          map_element "bib-locality-stack", to: :bib_locality_stack
+          map_element "bib-item", to: :bib_item
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/reference_elements/footnote.rb

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

data/lib/metanorma/basic_document/reference_elements/index_xref_element.rb

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

data/lib/metanorma/basic_document/reference_elements/reference_element.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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::BasicDocument::EmptyElements::BasicElement
+        attribute :type, :string
+        attribute :text, Metanorma::BasicDocument::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

data/lib/metanorma/basic_document/reference_elements/reference_format.rb

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

data/lib/metanorma/basic_document/reference_elements/reference_to_citation_element.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module ReferenceElements
+      # An external reference to a bibliographic entity.
+      class ReferenceToCitationElement < Metanorma::BasicDocument::ReferenceElements::ReferenceElement
+        attribute :normative, :boolean
+        attribute :cite_as,
+                  Metanorma::BasicDocument::TextElements::TextElement, collection: true
+
+        xml do
+          element "reference-to-citation-element"
+          map_attribute "normative", to: :normative
+          map_element "cite-as", to: :cite_as
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/reference_elements/reference_to_id_element.rb

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

data/lib/metanorma/basic_document/reference_elements/reference_to_id_with_paragraph_element.rb

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

data/lib/metanorma/basic_document/reference_elements/reference_to_link_element.rb

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

data/lib/metanorma/basic_document/reference_elements.rb

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

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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::BasicDocument::TextElements::TextElement,
+                  collection: true
+        attribute :id, :string
+        attribute :language,
+                  Metanorma::Document::Components::DataTypes::Iso639Code,
+                  collection: true
+        attribute :script,
+                  Metanorma::Document::Components::DataTypes::Iso15924Code,
+                  collection: true
+        attribute :blocks,
+                  Metanorma::BasicDocument::Blocks::BasicBlock,
+                  collection: true
+        attribute :notes,
+                  Metanorma::BasicDocument::Blocks::NoteBlock,
+                  collection: true
+
+        xml do
+          element "basic-section"
+          map_element "title", to: :title
+          map_attribute "id", to: :id
+          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