metanorma-document 0.2.0

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      class StandardSection < Metanorma::Document::Components::Sections::BasicSection
+        attribute :variant_title, Metanorma::Document::Relaton::TypedTitleString,
+                  collection: true
+        attribute :status, :string
+        attribute :amend, Metanorma::StandardDocument::Blocks::AmendBlock
+        attribute :number, :string
+        attribute :branch_number, :string
+        attribute :unnumbered, :string
+        attribute :obligation, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-section"
+          map_element "variant-title", to: :variant_title
+          map_attribute "status", to: :status
+          map_element "amend", to: :amend
+          map_attribute "number", to: :number
+          map_attribute "branch-number", to: :branch_number
+          map_attribute "unnumbered", to: :unnumbered
+          map_attribute "obligation", to: :obligation
+
+          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/terms_section.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      # Term sections give elaborated definitions of terms used in a standardization document.
+      # The <terms> element contains <title>, <p>, <ul>, <term> children.
+      class TermsSection < Metanorma::StandardDocument::Sections::ClauseSection
+        attribute :terms, Metanorma::StandardDocument::Terms::Term,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "terms"
+          map_element "term", to: :terms
+
+          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.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Sections
+      autoload :Abstract, "#{__dir__}/sections/abstract"
+      autoload :Acknowledgements, "#{__dir__}/sections/acknowledgements"
+      autoload :AnnexSection, "#{__dir__}/sections/annex_section"
+      autoload :BibliographySection, "#{__dir__}/sections/bibliography_section"
+      autoload :BoilerplateType, "#{__dir__}/sections/boilerplate_type"
+      autoload :ClauseHierarchicalSection,
+               "#{__dir__}/sections/clause_hierarchical_section"
+      autoload :ClauseSection, "#{__dir__}/sections/clause_section"
+      autoload :DefinitionSection, "#{__dir__}/sections/definition_section"
+      autoload :FloatingTitle, "#{__dir__}/sections/floating_title"
+      autoload :Foreword, "#{__dir__}/sections/foreword"
+      autoload :Introduction, "#{__dir__}/sections/introduction"
+      autoload :MiscContainer, "#{__dir__}/sections/misc_container"
+      autoload :NormativeType, "#{__dir__}/sections/normative_type"
+      autoload :StandardContentSection,
+               "#{__dir__}/sections/standard_content_section"
+      autoload :StandardHierarchicalSection,
+               "#{__dir__}/sections/standard_hierarchical_section"
+      autoload :StandardReferencesSection,
+               "#{__dir__}/sections/standard_references_section"
+      autoload :StandardSection, "#{__dir__}/sections/standard_section"
+      autoload :TermsSection, "#{__dir__}/sections/terms_section"
+    end
+  end
+end

data/lib/metanorma/standard_document/standard_document_type.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    # Type of standards document representation.
+    class StandardDocumentType < Lutaml::Model::Serializable
+      attribute :value, :string, values: %w[semantic presentation]
+
+      xml do
+        element "standard-document-type"
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/abbreviation_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Type of abbreviation, according to how it is formed.
+      class AbbreviationType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[truncation acronym initialism]
+        end
+
+        xml do
+          element "abbreviation-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/terms/concept.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Formally defined concept used in a _StandardDocument_, aligned to a definition.
+      # That concept may be defined as a term within the current document, or it may
+      # be defined externally.
+      class Concept < Lutaml::Model::Serializable
+        attribute :ital, :boolean
+        attribute :ref, :boolean
+        attribute :linkmention, :boolean
+        attribute :linkref, :boolean
+        attribute :refterm, :string, collection: true
+        attribute :renderterm, :string
+        attribute :xref, Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+        attribute :eref, Metanorma::Document::Components::ReferenceElements::ReferenceToCitationElement
+        attribute :termref, Metanorma::StandardDocument::Refs::ReferenceToTermbase
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "concept"
+          mixed_content
+          map_attribute "ital", to: :ital
+          map_attribute "ref", to: :ref
+          map_attribute "linkmention", to: :linkmention
+          map_attribute "linkref", to: :linkref
+          map_content to: :refterm
+          map_element "renderterm", to: :renderterm
+          map_element "xref", to: :xref
+          map_element "eref", to: :eref
+          map_element "termref", to: :termref
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/definition_collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Collection of definitions, constituting the core content of a DefinitionSection.
+      class DefinitionCollection < Lutaml::Model::Serializable
+        attribute :definitions,
+                  Metanorma::Document::Components::Lists::Definition, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "definition-collection"
+          map_element "definitions", to: :definitions
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/designation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A name under which a managed term is known.
+      class Designation < Lutaml::Model::Serializable
+        attribute :absent, :boolean
+        attribute :geographic_area,
+                  Metanorma::Document::Components::DataTypes::Iso3166Code, collection: true
+        attribute :sources, Metanorma::StandardDocument::Terms::TermSource,
+                  collection: true
+        attribute :expression, Metanorma::IsoDocument::Terms::TermExpression
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "designation"
+          map_attribute "absent", to: :absent
+          map_element "geographic-area", to: :geographic_area
+          map_element "sources", to: :sources
+          map_element "expression", to: :expression
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/expression_designation.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A designation realised as a linguistic form.
+      class ExpressionDesignation < Lutaml::Model::Serializable
+        attribute :language, :string
+        attribute :script, :string
+        attribute :type, :string
+        attribute :text, :string, collection: true
+        attribute :pronunciation, Metanorma::Document::Components::DataTypes::LocalizedString,
+                  collection: true
+        attribute :is_international, :boolean
+        attribute :abbreviation_type, :string
+        attribute :grammar_info, Metanorma::StandardDocument::Terms::GrammarInfo
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "expression"
+          map_attribute "language", to: :language
+          map_attribute "script", to: :script
+          map_attribute "type", to: :type
+          map_element "text", to: :text
+          map_element "pronunciation", to: :pronunciation
+          map_attribute "is-international", to: :is_international
+          map_attribute "abbreviation-type", to: :abbreviation_type
+          map_element "grammar-info", to: :grammar_info
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/expression_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Type of linguistic form used as designation.
+      class ExpressionType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[prefix suffix abbreviation full]
+        end
+
+        xml do
+          element "expression-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/terms/grammar_gender.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The grammatical gender of the designation.
+      class GrammarGender < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[masculine feminine neuter common]
+        end
+
+        xml do
+          element "grammar-gender"
+          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/terms/grammar_info.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Grammatical information about a designation.
+      class GrammarInfo < Lutaml::Model::Serializable
+        attribute :gender, Metanorma::StandardDocument::Terms::GrammarGender,
+                  collection: true
+        attribute :is_preposition, :boolean
+        attribute :is_participle, :boolean
+        attribute :is_adjective, :boolean
+        attribute :is_verb, :boolean
+        attribute :is_adverb, :boolean
+        attribute :is_noun, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "grammar-info"
+          map_element "gender", to: :gender
+          map_attribute "is-preposition", to: :is_preposition
+          map_attribute "is-participle", to: :is_participle
+          map_attribute "is-adjective", to: :is_adjective
+          map_attribute "is-verb", to: :is_verb
+          map_attribute "is-adverb", to: :is_adverb
+          map_attribute "is-noun", to: :is_noun
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/graphical_symbol_designation.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A designation realised as a graphical symbol
+      class GraphicalSymbolDesignation < Lutaml::Model::Serializable
+        attribute :figure, Metanorma::Document::Components::AncillaryBlocks::FigureBlock
+        attribute :is_international, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "graphical-symbol"
+          map_element "figure", to: :figure
+          map_attribute "isInternational", to: :is_international
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/letter_symbol_designation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A designation realised as a letter or symbol.
+      class LetterSymbolDesignation < Lutaml::Model::Serializable
+        attribute :text, :string, collection: true
+        attribute :stem, Metanorma::Document::Components::TextElements::StemElement
+        attribute :is_international, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "letter-symbol"
+          map_element "text", to: :text
+          map_element "stem", to: :stem
+          map_attribute "isInternational", to: :is_international
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/non_verbal_representation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Non-verbal representation of the term.
+      class NonVerbalRepresentation < Lutaml::Model::Serializable
+        attribute :figure,
+                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock, collection: true
+        attribute :formula,
+                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock, collection: true
+        attribute :table, Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+        attribute :sources, Metanorma::StandardDocument::Terms::TermSource,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "non-verbal-representation"
+          map_element "figure", to: :figure
+          map_element "formula", to: :formula
+          map_element "table", to: :table
+          map_element "sources", to: :sources
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/related_term.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # Term related to the current term.
+      class RelatedTerm < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :preferred, Metanorma::StandardDocument::Terms::Designation
+        attribute :xref, Metanorma::Document::Components::Inline::XrefElement
+        attribute :eref, Metanorma::Document::Components::Inline::ErefElement
+        attribute :termref, Metanorma::StandardDocument::Refs::ReferenceToTermbase
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "related"
+          map_attribute "type", to: :type
+          map_element "preferred", to: :preferred
+          map_element "xref", to: :xref
+          map_element "eref", to: :eref
+          map_element "termref", to: :termref
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/related_term_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The relation of a term to the current term.
+      class RelatedTermType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        def self.values
+          %w[deprecates supersedes narrower broader equivalent compare contrast
+             see]
+        end
+
+        xml do
+          element "related-term-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/terms/term.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A term (`Term`) represents a terminology entry with
+      # its definition.
+      #
+      # NOTE: The `Term` definition fully aligns with the structure
+      # and requirements of terms in ISO/IEC DIR 2, 16.6.
+      class Term < Lutaml::Model::Serializable
+        attribute :language, :string
+        attribute :script, :string
+        attribute :tag, :string
+        attribute :multilingual_rendering, :string
+        attribute :id, :string
+        attribute :preferred, Metanorma::StandardDocument::Terms::Designation,
+                  collection: true
+        attribute :admitted, Metanorma::StandardDocument::Terms::Designation,
+                  collection: true
+        attribute :related, Metanorma::StandardDocument::Terms::RelatedTerm,
+                  collection: true
+        attribute :deprecates, Metanorma::StandardDocument::Terms::Designation,
+                  collection: true
+        attribute :domain, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :subject, Metanorma::Document::Components::DataTypes::LocalizedString
+        attribute :usage_info,
+                  Metanorma::Document::Components::Blocks::BasicBlock, collection: true
+        attribute :definition, Metanorma::StandardDocument::Terms::TermDefinition,
+                  collection: true
+        attribute :note,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
+        attribute :example,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock, collection: true
+        attribute :source, Metanorma::StandardDocument::Terms::TermSource,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "term"
+          map_attribute "language", to: :language
+          map_attribute "script", to: :script
+          map_attribute "tag", to: :tag
+          map_attribute "multilingual-rendering", to: :multilingual_rendering
+          map_attribute "id", to: :id
+          map_element "preferred", to: :preferred
+          map_element "admitted", to: :admitted
+          map_element "related", to: :related
+          map_element "deprecates", to: :deprecates
+          map_element "domain", to: :domain
+          map_element "subject", to: :subject
+          map_element "usage-info", to: :usage_info
+          map_element "definition", to: :definition
+          map_element "termnote", to: :note
+          map_element "termexample", to: :example
+          map_element "source", to: :source
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/term_collection.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # A collection of terms, constituting the main body of a Terms Section.
+      class TermCollection < Lutaml::Model::Serializable
+        attribute :term, Metanorma::StandardDocument::Terms::Term,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "terms"
+          map_element "term", to: :term
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/terms/term_definition.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Terms
+      # The definition of a term applied in the current
+      # document.
+      class TermDefinition < Lutaml::Model::Serializable
+        attribute :verbalexpression, Metanorma::StandardDocument::Terms::VerbalExpression
+        attribute :nonverbalrepresentation, Metanorma::StandardDocument::Terms::NonVerbalRepresentation
+        attribute :source, Metanorma::StandardDocument::Terms::TermSource,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "definition"
+          map_element "verbal-definition", to: :verbalexpression
+          map_element "nonverbalrepresentation", to: :nonverbalrepresentation
+          map_element "source", to: :source
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end