metanorma-document 0.2.0

data/lib/metanorma/standard_document/refs/xref_case_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Casing of the autogenerated label of a cross-reference.
+      class XrefCaseType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[capital lowercase]
+        end
+
+        xml do
+          element "xref-case-type"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/xref_connective_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Connective linking the current cross-reference target to its predecessor.
+      class XrefConnectiveType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[and or from to]
+        end
+
+        xml do
+          element "xref-connective-type"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/xref_target_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Listing of multiple cross-reference targets to be combined under the one element
+      class XrefTargetType < Lutaml::Model::Serializable
+        attribute :target, Metanorma::Document::Components::IdElements::IdElement
+        attribute :connective, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "xref-target-type"
+          map_element "target", to: :target
+          map_attribute "connective", to: :connective
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      autoload :ReferenceToTerm, "#{__dir__}/refs/reference_to_term"
+      autoload :ReferenceToTermbase, "#{__dir__}/refs/reference_to_termbase"
+      autoload :StandocLocalityStack, "#{__dir__}/refs/standoc_locality_stack"
+      autoload :StandocReferenceToCitationElement,
+               "#{__dir__}/refs/standoc_reference_to_citation_element"
+      autoload :StandocReferenceToIdElement,
+               "#{__dir__}/refs/standoc_reference_to_id_element"
+      autoload :XrefCaseType, "#{__dir__}/refs/xref_case_type"
+      autoload :XrefConnectiveType, "#{__dir__}/refs/xref_connective_type"
+      autoload :XrefTargetType, "#{__dir__}/refs/xref_target_type"
+    end
+  end
+end

data/lib/metanorma/standard_document/root.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    class Root < Metanorma::Document::Root
+      attribute :autonum, :string
+      attribute :fmt_xref_label, :string
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/abstract.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Abstract of the document.
+      class Abstract < Metanorma::StandardDocument::Sections::StandardContentSection
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+        xml do
+          element "abstract"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/acknowledgements.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Acknowledgements for the document.
+      class Acknowledgements < Metanorma::StandardDocument::Sections::StandardContentSection
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+        xml do
+          element "acknowledgements"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/annex_section.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Section of document constituting an annex or appendix.
+      class AnnexSection < Metanorma::StandardDocument::Sections::StandardSection
+        attribute :subsections,
+                  Metanorma::StandardDocument::Sections::ClauseSection, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :inline_header, :string
+        attribute :type, :string
+
+        xml do
+          element "annex-section"
+          map_element "subsections", to: :subsections
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "inline-header", to: :inline_header
+          map_attribute "type", to: :type
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/bibliography_section.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Wrapper for the <bibliography> element that contains
+      # one or more <references> sections (normative and/or informative).
+      class BibliographySection < Lutaml::Model::Serializable
+        attribute :references, StandardReferencesSection, collection: true
+        attribute :clause, Metanorma::IsoDocument::Sections::IsoClauseSection,
+                  collection: true
+
+        xml do
+          element "bibliography"
+          map_element "references", to: :references
+          map_element "clause", to: :clause
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/boilerplate_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Content addressing legal and licensing concerns around the document,
+      # outside of the main flow of document content.
+      class BoilerplateType < Lutaml::Model::Serializable
+        attribute :copyright, Metanorma::Document::Components::Sections::HierarchicalSection
+        attribute :license, Metanorma::Document::Components::Sections::HierarchicalSection
+        attribute :legal, Metanorma::Document::Components::Sections::HierarchicalSection
+        attribute :feedback, Metanorma::Document::Components::Sections::HierarchicalSection
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "boilerplate"
+          map_element "copyright", to: :copyright
+          map_element "license", to: :license
+          map_element "legal", to: :legal
+          map_element "feedback", to: :feedback
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/clause_hierarchical_section.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Clauses in which all textual content belongs in a strict clause hierarchy. such that no blocks of
+      # text
+      # are siblings to subclauses.
+      class ClauseHierarchicalSection < Metanorma::StandardDocument::Sections::ClauseSection
+        attribute :subsections,
+                  Metanorma::StandardDocument::Sections::ClauseHierarchicalSection, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :inline_header, :string
+
+        xml do
+          element "clause-hierarchical-section"
+          map_element "subsections", to: :subsections
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "inline-header", to: :inline_header
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/clause_section.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # A numbered clause constituting part of the main body of a _StandardDocument_.
+      class ClauseSection < Metanorma::StandardDocument::Sections::StandardSection
+        attribute :type, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :inline_header, :string
+
+        xml do
+          element "clause"
+          map_attribute "type", to: :type
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "inline-header", to: :inline_header
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/definition_section.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Definition sections consist of one or more definition lists (`DefinitionCollection`),
+      # are used to define symbols and
+      # abbreviations used in the remainder of the document.
+      #
+      # They can also be used as glossaries, with simple definitions,
+      # in contrast to the more elaborate definitions given in
+      # terms sections.
+      #
+      # In addition to allowing prefatory text per section, each definition list
+      # within each definition section can also be preceded by prefatory text.
+      class DefinitionSection < Metanorma::StandardDocument::Sections::ClauseSection
+        attribute :definitions, DefinitionSection, collection: true
+        attribute :type, :string
+        attribute :obligation, :string
+
+        # Block content
+        attribute :id, :string
+        attribute :anchor, :string
+        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :definition_lists,
+                  Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+        attribute :unordered_lists,
+                  Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :example,
+                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                  collection: true
+        attribute :table,
+                  Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        # Presentation-specific
+        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label, Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                  collection: true
+
+        xml do
+          element "definitions"
+          ordered
+          map_attribute "id", to: :id
+          map_attribute "anchor", to: :anchor
+          map_attribute "type", to: :type
+          map_attribute "obligation", to: :obligation
+          map_element "title", to: :title
+          map_element "p", to: :paragraphs
+          map_element "dl", to: :definition_lists
+          map_element "ul", to: :unordered_lists
+          map_element "example", to: :example
+          map_element "table", to: :table
+          map_element "definitions", to: :definitions
+          map_element "fmt-title", to: :fmt_title
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/floating_title.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # A floating title, outside of the clause hierarchy
+      class FloatingTitle < Metanorma::StandardDocument::Blocks::StandardBlockNoNotes
+        attribute :depth, :integer
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "floating-title"
+          map_attribute "depth", to: :depth
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/foreword.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Foreword of document.
+      class Foreword < Metanorma::StandardDocument::Sections::StandardContentSection
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+        xml do
+          element "foreword"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/introduction.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Introduction of document.
+      class Introduction < Metanorma::StandardDocument::Sections::StandardContentSection
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        xml do
+          element "introduction"
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/misc_container.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Extension point for extraneous elements that need to be added to standards document
+      # from other schemas, e.g. UnitsML.
+      class MiscContainer < Lutaml::Model::Serializable
+        attribute :element, Object, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "misc-container"
+          map_element "element", to: :element
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/normative_type.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # The force of a clause of text in a _StandardDocument_.
+      class NormativeType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        def self.values
+          %w[normative informative]
+        end
+
+        xml do
+          element "normative-type"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/standard_content_section.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # An unnumbered clause, outside the main body of text of a _StandardDocument_.
+      class StandardContentSection < Metanorma::StandardDocument::Sections::StandardHierarchicalSection
+        attribute :type, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-content-section"
+          map_attribute "type", to: :type
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/standard_hierarchical_section.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # A hierarchical section containing other sections, within a _StandardDocument_.
+      class StandardHierarchicalSection < Metanorma::StandardDocument::Sections::StandardSection
+        attribute :subsections,
+                  Metanorma::StandardDocument::Sections::StandardSection, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :inline_header, :string
+
+        xml do
+          element "standard-hierarchical-section"
+          map_element "subsections", to: :subsections
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "inline-header", to: :inline_header
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/sections/standard_references_section.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # The `StandardReferencesSection` class within _StandardDocument_
+      # is used to represent a bibliography section.
+      # It is used to collate references within the document, where
+      # there could be one or more of such sections within a document.
+      #
+      # For example, some standardization documents differentiate
+      # normative or informative references, some split references into
+      # sections organized by concept relevance.
+      #
+      # Similar to the `ReferencesSection` of the _BasicDocument_ model,
+      # they are leaf nodes which contain zero or more
+      # bibliographical references (as modelled in Relaton), along with
+      # any prefatory text.
+      class StandardReferencesSection < Metanorma::StandardDocument::Sections::StandardSection
+        attribute :normative, :string
+        attribute :obligation, :string
+        attribute :hidden, :string
+        attribute :references, Metanorma::Document::Components::BibData::BibliographicItem,
+                  collection: true
+        attribute :passthrough, Metanorma::StandardDocument::Blocks::Passthrough,
+                  collection: true
+        attribute :note,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
+        attribute :p,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
+        attribute :table,
+                  Metanorma::Document::Components::Tables::TableBlock, collection: true
+
+        # Presentation-specific attributes
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement, 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
+          element "references"
+          map_attribute "normative", to: :normative
+          map_attribute "obligation", to: :obligation
+          map_attribute "hidden", to: :hidden
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_element "title", to: :title
+          map_element "p", to: :p
+          map_element "note", to: :note
+          map_element "bibitem", to: :references
+          map_element "passthrough", to: :passthrough
+          map_element "table", to: :table
+          map_element "fmt-title", to: :fmt_title
+          map_element "fmt-xref-label", to: :fmt_xref_label
+          map_element "fmt-annotation-start", to: :fmt_annotation_start
+          map_element "fmt-annotation-end", to: :fmt_annotation_end
+        end
+      end
+    end
+  end
+end