metanorma-document 0.5.1 → 0.5.2.pre.alpha.1

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

@@ -1,30 +0,0 @@
-# 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, :boolean
-
-        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

@@ -1,74 +0,0 @@
-# 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, :boolean
-        attribute :obligation, :string
-        attribute :hidden, :boolean
-        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

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

@@ -1,39 +0,0 @@
-# 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, :boolean
-        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

@@ -1,61 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Term sections give elaborated definitions of terms used in a
-      # standardization document.
-      #
-      # Corresponds to isodoc.rnc:
-      #   terms = element terms {
-      #     Section-Attributes, title?,
-      #     ( paragraph | ul )*,
-      #     term+
-      #   }
-      class TermsSection < Lutaml::Model::Serializable
-        include Metanorma::StandardDocument::PresentationAttributes
-
-        attribute :id, :string
-        attribute :type, :string
-        attribute :number, :string
-        attribute :obligation, :string
-        attribute :inline_header, :boolean
-        attribute :unnumbered, :boolean
-        attribute :toc, :string
-        attribute :class_attr, :string
-        attribute :title,
-                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
-
-        # Prefatory paragraphs before term entries
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :unordered_lists,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-
-        # Term entries
-        attribute :terms,
-                  Metanorma::StandardDocument::Terms::Term,
-                  collection: true
-
-        xml do
-          element "terms"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-
-          map_element "title",            to: :title
-          map_element "variant-title",    to: :variant_title
-          map_element "fmt-title",        to: :fmt_title
-          map_element "fmt-xref-label",   to: :fmt_xref_label
-          map_element "p",                to: :paragraphs
-          map_element "ul",               to: :unordered_lists
-          map_element "term",             to: :terms
-          map_element "fmt-annotation-start", to: :fmt_annotation_start
-          map_element "fmt-annotation-end",   to: :fmt_annotation_end
-        end
-      end
-    end
-  end
-end

data/lib/metanorma/standard_document/sections.rb

@@ -1,34 +0,0 @@
-# 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 :Colophon, "#{__dir__}/sections/colophon"
-      autoload :BoilerplateType, "#{__dir__}/sections/boilerplate_type"
-      autoload :ClauseHierarchicalSection,
-               "#{__dir__}/sections/clause_hierarchical_section"
-      autoload :ClauseSection, "#{__dir__}/sections/clause_section"
-      autoload :ContentSection, "#{__dir__}/sections/standard_content_section"
-      autoload :DefinitionSection, "#{__dir__}/sections/definition_section"
-      autoload :FloatingSectionTitle,
-               "#{__dir__}/sections/floating_section_title"
-      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 :Preface, "#{__dir__}/sections/preface"
-      autoload :Sections, "#{__dir__}/sections/sections"
-      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

@@ -1,15 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,42 +0,0 @@
-# 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

@@ -1,24 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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::StandardDocument::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

@@ -1,38 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,33 +0,0 @@
-# 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

@@ -1,31 +0,0 @@
-# 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

@@ -1,28 +0,0 @@
-# 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