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

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Abstract of the document.
-      class Abstract < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :original_id, :string
-        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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Acknowledgements for the document.
-      class Acknowledgements < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :original_id, :string
-        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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # An annex section in the document.
-      # Corresponds to isodoc.rnc `Annex-Section-Body`:
-      #   Annex-Section-Attributes, title?,
-      #   ( BasicBlock*,
-      #     (annex-subsection | terms | definitions | references | floating-title)* )
-      #
-      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
-      class AnnexSection < Lutaml::Model::Serializable
-        include Metanorma::StandardDocument::BlockAttributes
-        include Metanorma::StandardDocument::PresentationAttributes
-        include Metanorma::StandardDocument::OrderedContent
-
-        # Section identity and classification
-        attribute :id, :string
-        attribute :number, :string
-        attribute :obligation, :string
-        attribute :unnumbered, :boolean
-        attribute :toc, :string
-        attribute :inline_header, :boolean
-        attribute :title,
-                  Metanorma::Document::Components::Inline::TitleWithAnnotationElement
-
-        # Language/script (unique to annex)
-        attribute :language, :string
-        attribute :script, :string
-
-        # Sub-clauses within annex (recursive)
-        attribute :clause, AnnexSection, collection: true
-
-        # Appendix (sub-sections unique to annex)
-        attribute :appendix, ClauseSection, collection: true
-
-        # Terms, definitions, references within annex
-        attribute :terms,
-                  Metanorma::StandardDocument::Sections::TermsSection,
-                  collection: true
-        attribute :definitions,
-                  Metanorma::StandardDocument::Sections::DefinitionSection,
-                  collection: true
-        attribute :references,
-                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
-                  collection: true
-
-        # Floating titles
-        attribute :floating_title,
-                  Metanorma::StandardDocument::Sections::FloatingTitle,
-                  collection: true
-
-        # Page breaks
-        attribute :pagebreak,
-                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
-                  collection: true
-
-        xml do
-          element "annex"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_annex_elements(self)
-        end
-      end
-    end
-  end
-end

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

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

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

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

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # A numbered clause in the document body.
-      # Corresponds to isodoc.rnc `Clause-Section`:
-      #   Section-Attributes, type?, title?,
-      #   ( (BasicBlock+ | amend) |
-      #     (clause-subsection | terms | definitions | floating-title)+ )
-      #
-      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
-      class ClauseSection < Lutaml::Model::Serializable
-        include Metanorma::StandardDocument::BlockAttributes
-        include Metanorma::StandardDocument::PresentationAttributes
-        include Metanorma::StandardDocument::OrderedContent
-
-        # Section identity and classification
-        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
-
-        # Sub-clauses (recursive)
-        attribute :clause, ClauseSection, collection: true
-
-        # Amend blocks (for amendment documents)
-        attribute :amend,
-                  Metanorma::StandardDocument::Blocks::AmendBlock
-
-        # Terms sections nested inside clauses
-        attribute :terms,
-                  Metanorma::StandardDocument::Sections::TermsSection,
-                  collection: true
-
-        # Definitions sections nested inside clauses
-        attribute :definitions,
-                  Metanorma::StandardDocument::Sections::DefinitionSection,
-                  collection: true
-
-        # References sections nested inside clauses
-        attribute :references,
-                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
-                  collection: true
-
-        # Floating titles
-        attribute :floating_title,
-                  Metanorma::StandardDocument::Sections::FloatingTitle,
-                  collection: true
-
-        # Forms
-        attribute :form,
-                  Metanorma::StandardDocument::Blocks::Form,
-                  collection: true
-
-        # Requirements / recommendations / permissions
-        attribute :requirement,
-                  Metanorma::StandardDocument::Blocks::RequirementModel,
-                  collection: true
-        attribute :recommendation,
-                  Metanorma::StandardDocument::Blocks::RecommendationModel,
-                  collection: true
-        attribute :permission,
-                  Metanorma::StandardDocument::Blocks::PermissionModel,
-                  collection: true
-
-        # Page breaks and bookmarks
-        attribute :pagebreak,
-                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
-                  collection: true
-        attribute :bookmark,
-                  Metanorma::Document::Components::IdElements::Bookmark,
-                  collection: true
-
-        xml do
-          element "clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_clause_elements(self)
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      class Colophon < Lutaml::Model::Serializable
-        attribute :clause, ClauseSection, collection: true
-
-        xml do
-          element "colophon"
-          map_element "clause", to: :clause
-        end
-      end
-    end
-  end
-end

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

@@ -1,72 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Definition sections consist of one or more definition lists,
-      # used to define symbols and abbreviations used in the remainder of
-      # the document.
-      #
-      # Corresponds to isodoc.rnc:
-      #   definitions = element definitions {
-      #     Section-Attributes,
-      #     ( (BasicBlock+) | (dl+) )?,
-      #     definitions*
-      #   }
-      class DefinitionSection < 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
-
-        # Block content
-        attribute :paragraphs,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-        attribute :unordered_lists,
-                  Metanorma::Document::Components::Lists::UnorderedList,
-                  collection: true
-        attribute :tables,
-                  Metanorma::Document::Components::Tables::TableBlock,
-                  collection: true
-        attribute :definition_lists,
-                  Metanorma::Document::Components::Lists::DefinitionList,
-                  collection: true
-        attribute :examples,
-                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
-                  collection: true
-
-        # Recursive definitions
-        attribute :definitions, DefinitionSection, collection: true
-
-        xml do
-          element "definitions"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-
-          map_element "title",          to: :title
-          map_element "variant-title",  to: :variant_title
-          map_element "p",              to: :paragraphs
-          map_element "ul",             to: :unordered_lists
-          map_element "table",          to: :tables
-          map_element "dl",             to: :definition_lists
-          map_element "example",        to: :examples
-          map_element "definitions",    to: :definitions
-          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/floating_section_title.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # A floating section title used in BSI and JIS documents.
-      # Differs from FloatingTitle: uses element name "section-title",
-      # has id (not derived from StandardBlockNoNotes), and contains TextElement.
-      class FloatingSectionTitle < Lutaml::Model::Serializable
-        attribute :id, :string
-        attribute :depth, :integer
-        attribute :text, :string, collection: true
-
-        xml do
-          element "section-title"
-          map_attribute "id", to: :id
-          map_attribute "depth", to: :depth
-          map_content to: :text
-        end
-      end
-    end
-  end
-end

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

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

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Foreword of document.
-      class Foreword < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :original_id, :string
-        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

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Introduction of document.
-      class Introduction < Metanorma::StandardDocument::Sections::ContentSection
-        attribute :original_id, :string
-        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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Extension point for extraneous elements that need to be added to
-      # standards documents from other schemas.
-      #
-      # Observed payload: legacy-serialization <presentation-metadata>
-      # name/value pairs (e.g. metanorma/demo-ab import_from_metanorma).
-      class MiscContainer < Lutaml::Model::Serializable
-        attribute :presentation_metadata,
-                  Metanorma::StandardDocument::Metadata::PresentationMetadata,
-                  collection: true
-
-        attribute :semx_id, :string
-        attribute :original_id, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "misc-container"
-          map_element "presentation-metadata", to: :presentation_metadata
-
-          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

@@ -1,29 +0,0 @@
-# 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/preface.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Container for preface sections.
-      # Corresponds to isodoc.rnc:
-      #   preface = element preface {
-      #     ( content | abstract | foreword | introduction |
-      #       acknowledgements | executivesummary )+
-      #   }
-      class Preface < Lutaml::Model::Serializable
-        attribute :abstract, ContentSection
-        attribute :foreword, ContentSection
-        attribute :introduction, ContentSection
-        attribute :acknowledgements, ContentSection
-        attribute :executivesummary, ContentSection
-        attribute :content, ContentSection, collection: true
-
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
-        xml do
-          element "preface"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_elements(self)
-          map_element "clause", to: :content
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_preface_attributes(self)
-        end
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # Container for the main body sections of a document.
-      # Corresponds to isodoc.rnc:
-      #   sections = element sections {
-      #     ( clause | terms | term-clause | definitions | floating-title )+
-      #   }
-      class Sections < Lutaml::Model::Serializable
-        attribute :clause, ClauseSection, collection: true
-        attribute :terms,
-                  Metanorma::StandardDocument::Sections::TermsSection,
-                  collection: true
-        attribute :definitions,
-                  Metanorma::StandardDocument::Sections::DefinitionSection,
-                  collection: true
-        attribute :floating_title,
-                  Metanorma::StandardDocument::Sections::FloatingTitle,
-                  collection: true
-        attribute :references,
-                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
-                  collection: true
-
-        # Presentation-specific attributes
-        attribute :semx_id, :string
-        attribute :displayorder, :integer
-
-        # Loose paragraphs directly under <sections> (e.g. the ITU
-        # zzSTDTitle1 title paragraph at the start of sections).
-        attribute :p,
-                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
-                  collection: true
-
-        xml do
-          element "sections"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_elements(self)
-          map_element "p", to: :p
-          Metanorma::StandardDocument::SectionXmlMapping.apply_sections_attributes(self)
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module Metanorma
-  module StandardDocument
-    module Sections
-      # A content section used for preface elements (abstract, foreword,
-      # introduction, acknowledgements, executivesummary) and generic clauses
-      # within preface.
-      # Corresponds to isodoc.rnc `Content-Section`:
-      #   Section-Attributes, type?, title?,
-      #   ( BasicBlock*, content-subsection* )
-      class ContentSection < Lutaml::Model::Serializable
-        include Metanorma::StandardDocument::BlockAttributes
-        include Metanorma::StandardDocument::PresentationAttributes
-
-        # Section identity
-        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
-
-        # Nested content subsections (recursive)
-        attribute :subsection, ContentSection, collection: true
-
-        xml do
-          element "clause"
-          ordered
-
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_attributes(self)
-          Metanorma::StandardDocument::SectionXmlMapping.apply_content_section_elements(self)
-        end
-      end
-    end
-  end
-end