metanorma-document 0.2.0

data/lib/metanorma/iso_document/metadata.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Metadata
+      autoload :AbstractTitle, "#{__dir__}/metadata/abstract_title"
+      autoload :DocIdentifier, "#{__dir__}/metadata/doc_identifier"
+      autoload :IecDocumentCategory, "#{__dir__}/metadata/iec_document_category"
+      autoload :IsoBibDataExtensionType,
+               "#{__dir__}/metadata/iso_bib_data_extension_type"
+      autoload :IsoBibliographicItem,
+               "#{__dir__}/metadata/iso_bibliographic_item"
+      autoload :IsoDocumentId, "#{__dir__}/metadata/iso_document_id"
+      autoload :IsoDocumentStageCodes,
+               "#{__dir__}/metadata/iso_document_stage_codes"
+      autoload :IsoDocumentStatus, "#{__dir__}/metadata/iso_document_status"
+      autoload :IsoDocumentSubstageCodes,
+               "#{__dir__}/metadata/iso_document_substage_codes"
+      autoload :IsoDocumentType, "#{__dir__}/metadata/iso_document_type"
+      autoload :IsoLocalizedTitle, "#{__dir__}/metadata/iso_localized_title"
+      autoload :TitleCollection, "#{__dir__}/metadata/title_collection"
+      autoload :IsoProjectGroup, "#{__dir__}/metadata/iso_project_group"
+      autoload :IsoSubGroup, "#{__dir__}/metadata/iso_sub_group"
+      autoload :TitleFull, "#{__dir__}/metadata/title_full"
+      autoload :TitleIntro, "#{__dir__}/metadata/title_intro"
+      autoload :TitleMain, "#{__dir__}/metadata/title_main"
+      autoload :TitlePart, "#{__dir__}/metadata/title_part"
+      autoload :TitlePartPrefix, "#{__dir__}/metadata/title_part_prefix"
+      autoload :TitleAmd, "#{__dir__}/metadata/title_amd"
+      autoload :TitleAmendmentPrefix,
+               "#{__dir__}/metadata/title_amendment_prefix"
+      autoload :Ics, "#{__dir__}/metadata/ics"
+      autoload :StructuredIdentifier,
+               "#{__dir__}/metadata/structured_identifier"
+      autoload :ProjectNumber, "#{__dir__}/metadata/structured_identifier"
+      autoload :MetanormaExtension, "#{__dir__}/metadata/metanorma_extension"
+    end
+  end
+end

data/lib/metanorma/iso_document/raw_paragraph.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    # Paragraph with mixed inline content preserved as raw XML.
+    # Used for contexts where <p> contains inline elements like
+    # <concept>, <xref>, <em>, <strong>, <stem>, <fn>, <link>.
+    class RawParagraph < Lutaml::Model::Serializable
+      attribute :id, :string
+      attribute :semx_id, :string
+      attribute :original_id, :string
+      attribute :content, :string
+
+      xml do
+        element "p"
+        map_attribute "id", to: :id
+        map_attribute "semx-id", to: :semx_id
+        map_attribute "original-id", to: :original_id
+        map_all_content to: :content
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/root.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    class Root < Metanorma::StandardDocument::Root
+      # Version number of the schema used for this standards document.
+      attribute :version, :string
+
+      # Type of the document (semantic, presentation).
+      attribute :type, :string
+
+      # Schema version.
+      attribute :schema_version, :string
+
+      # Document flavor (iso, standoc, etc).
+      attribute :flavor, :string
+
+      # Bibliographic description of the document itself, expressed in the Relaton
+      # model.
+      attribute :bibdata, Metanorma::IsoDocument::Metadata::IsoBibliographicItem
+
+      # Citations for sources of term definitions.
+      attribute :term_sources,
+                Metanorma::Document::Components::ReferenceElements::Citation,
+                collection: true
+
+      # Zero or more optional _preface_ sections.
+      attribute :preface, Metanorma::IsoDocument::Sections::IsoPreface
+
+      # One or more _sections_.
+      attribute :sections, Metanorma::IsoDocument::Sections::IsoSections
+
+      # Zero or more _annexes_.
+      attribute :annex, Metanorma::IsoDocument::Sections::IsoAnnexSection,
+                collection: true
+
+      # Zero to two _bibliographies_.
+      attribute :bibliography,
+                Metanorma::StandardDocument::Sections::BibliographySection
+
+      # Boilerplate section (copyright statements, license text).
+      attribute :boilerplate, Boilerplate
+
+      # Metanorma-specific extensions (semantic-metadata, presentation-metadata, UnitsML).
+      attribute :metanorma_extension, Metadata::MetanormaExtension
+
+      # Container for review annotations.
+      attribute :annotation_container, AnnotationContainer
+
+      # Index of a standards document.
+      attribute :indexsect,
+                Metanorma::Document::Components::Sections::BasicSection
+
+      # Presentation-specific attributes
+      attribute :autonum, :string
+      attribute :fmt_xref_label, :string
+
+      # Localized strings container (presentation XML)
+      attribute :localized_strings, Metanorma::Document::Components::Inline::LocalizedStringsElement
+
+      # Formatted footnote container (presentation XML)
+      attribute :fmt_footnote_container, Metanorma::Document::Components::Inline::FmtFootnoteContainerElement
+
+      # Colophon section (presentation XML)
+      attribute :colophon, Sections::Colophon
+
+      xml do
+        element "metanorma"
+        namespace Metanorma::StandardDocument::Namespace
+        map_attribute "type", to: :type
+        map_attribute "version", to: :version
+        map_attribute "schema-version", to: :schema_version
+        map_attribute "flavor", to: :flavor
+        map_element "bibdata", to: :bibdata
+        map_element "termdocsource", to: :term_sources
+        map_element "metanorma-extension", to: :metanorma_extension
+        map_element "boilerplate", to: :boilerplate
+        map_element "preface", to: :preface
+        map_element "sections", to: :sections
+        map_element "annex", to: :annex
+        map_element "bibliography", to: :bibliography
+        map_element "annotation-container", to: :annotation_container
+        map_element "indexsect", to: :indexsect
+        map_element "localized-strings", to: :localized_strings
+        map_element "fmt-footnote-container", to: :fmt_footnote_container
+        map_element "colophon", to: :colophon
+        map_attribute "autonum", to: :autonum
+        map_attribute "fmt-xref-label", to: :fmt_xref_label
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Sections
+      # Colophon section in presentation XML.
+      # Contains document control information.
+      class Colophon < Lutaml::Model::Serializable
+        attribute :clause, IsoClauseSection, collection: true
+
+        xml do
+          element "colophon"
+          map_element "clause", to: :clause
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/sections/iso_abstract_section.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Sections
+      # Abstract section in the preface. Same structure as a clause but maps
+      # to the "abstract" element.
+      class IsoAbstractSection < IsoClauseSection
+        xml do
+          element "abstract"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/sections/iso_amendment_clause.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Sections
+      # Clause appearing in an ISO/IEC Amendment or Technical Corrigendum document.
+      class IsoAmendmentClause < Lutaml::Model::Serializable
+        # Block expressing a machine-readable change in a document.
+        attribute :amend, Metanorma::StandardDocument::Blocks::AmendBlock
+        attribute :semx_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "clause"
+          map_element "amend", to: :amend
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/sections/iso_annex_section.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Sections
+      # Annex appearing in ISO/IEC document.
+      class IsoAnnexSection < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :number, :string
+        attribute :obligation, :string
+        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+
+        # Sub-clauses within annex.
+        attribute :clause, IsoClauseSection,
+                  collection: true
+
+        # Appendixes to annex.
+        attribute :appendix, IsoClauseSection,
+                  collection: true
+
+        # Block collections
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :unordered_lists,
+                  Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :ordered_lists,
+                  Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :tables,
+                  Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+        attribute :figures,
+                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                  collection: true
+        attribute :formulas,
+                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                  collection: true
+        attribute :examples,
+                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                  collection: true
+        attribute :notes,
+                  Metanorma::Document::Components::Blocks::NoteBlock,
+                  collection: true
+        attribute :admonitions,
+                  Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
+                  collection: true
+        attribute :sourcecode_blocks,
+                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                  collection: true
+        attribute :quote_blocks,
+                  Metanorma::Document::Components::MultiParagraph::QuoteBlock,
+                  collection: true
+        attribute :definition_lists,
+                  Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+
+        # Terms sections within annex
+        attribute :terms,
+                  IsoTermsSection, collection: true
+
+        # Definitions sections within annex
+        attribute :definitions,
+                  Metanorma::StandardDocument::Sections::DefinitionSection,
+                  collection: true
+
+        # References sections within annex
+        attribute :references,
+                  Metanorma::StandardDocument::Sections::StandardReferencesSection,
+                  collection: true
+
+        # Page breaks
+        attribute :pagebreak,
+                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
+                  collection: true
+
+        # Presentation-specific attributes
+        attribute :semx_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :inline_header, :string
+        attribute :anchor, :string
+        attribute :language, :string
+        attribute :script, :string
+        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label,
+                  Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+        attribute :variant_title,
+                  Metanorma::Document::Components::Inline::VariantTitleElement, 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 "annex"
+          ordered
+          map_attribute "id", to: :id
+          map_attribute "number", to: :number
+          map_attribute "obligation", to: :obligation, render_empty: true
+          map_attribute "anchor", to: :anchor
+          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 "clause", to: :clause
+          map_element "appendix", to: :appendix
+          map_element "p", to: :paragraphs
+          map_element "ul", to: :unordered_lists
+          map_element "ol", to: :ordered_lists
+          map_element "table", to: :tables
+          map_element "figure", to: :figures
+          map_element "formula", to: :formulas
+          map_element "example", to: :examples
+          map_element "note", to: :notes
+          map_element "admonition", to: :admonitions
+          map_element "sourcecode", to: :sourcecode_blocks
+          map_element "quote", to: :quote_blocks
+          map_element "dl", to: :definition_lists
+          map_element "terms", to: :terms
+          map_element "definitions", to: :definitions
+          map_element "references", to: :references
+          map_element "pagebreak", to: :pagebreak
+          map_element "fmt-annotation-start", to: :fmt_annotation_start
+          map_element "fmt-annotation-end", to: :fmt_annotation_end
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+          map_attribute "inline-header", to: :inline_header
+          map_attribute "language", to: :language, render_empty: true
+          map_attribute "script", to: :script, render_empty: true
+        end
+
+        # Blocks in document order
+        def blocks
+          @blocks ||=
+            begin
+              result = []
+              each_mixed_content do |node|
+                result << node unless node.is_a?(String)
+              end
+              result
+            end
+        end
+
+        json do
+          map "id", to: :id
+          map "number", to: :number
+          map "obligation", to: :obligation
+          map "title", to: :title
+          map "clause", to: :clause
+          map "appendix", to: :appendix
+          map "paragraphs", to: :paragraphs
+          map "unordered_lists", to: :unordered_lists
+          map "ordered_lists", to: :ordered_lists
+          map "tables", to: :tables
+          map "figures", to: :figures
+          map "formulas", to: :formulas
+          map "examples", to: :examples
+          map "notes", to: :notes
+          map "admonitions", to: :admonitions
+          map "sourcecode_blocks", to: :sourcecode_blocks
+          map "quote_blocks", to: :quote_blocks
+          map "definition_lists", to: :definition_lists
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/iso_document/sections/iso_clause_section.rb

@@ -0,0 +1,206 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module IsoDocument
+    module Sections
+      # A numbered clause in an ISO/IEC document body.
+      # Supports recursive nesting via `clause` collection.
+      # Uses `ordered` to enable `each_mixed_content` for document-order iteration.
+      class IsoClauseSection < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :type, :string
+        attribute :number, :string
+        attribute :obligation, :string
+        attribute :inline_header, :string
+        attribute :unnumbered, :string
+        attribute :toc, :string
+        attribute :class_attr, :string
+        attribute :title, Metanorma::Document::Components::Inline::TitleWithAnnotationElement
+
+        # Sub-clauses (recursive)
+        attribute :clause, IsoClauseSection, collection: true
+
+        # Block collections
+        attribute :paragraphs,
+                  Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                  collection: true
+        attribute :unordered_lists,
+                  Metanorma::Document::Components::Lists::UnorderedList,
+                  collection: true
+        attribute :ordered_lists,
+                  Metanorma::Document::Components::Lists::OrderedList,
+                  collection: true
+        attribute :tables,
+                  Metanorma::Document::Components::Tables::TableBlock,
+                  collection: true
+        attribute :figures,
+                  Metanorma::Document::Components::AncillaryBlocks::FigureBlock,
+                  collection: true
+        attribute :formulas,
+                  Metanorma::Document::Components::AncillaryBlocks::FormulaBlock,
+                  collection: true
+        attribute :examples,
+                  Metanorma::Document::Components::AncillaryBlocks::ExampleBlock,
+                  collection: true
+        attribute :notes,
+                  Metanorma::Document::Components::Blocks::NoteBlock,
+                  collection: true
+        attribute :admonitions,
+                  Metanorma::Document::Components::MultiParagraph::AdmonitionBlock,
+                  collection: true
+        attribute :sourcecode_blocks,
+                  Metanorma::Document::Components::AncillaryBlocks::SourcecodeBlock,
+                  collection: true
+        attribute :quote_blocks,
+                  Metanorma::Document::Components::MultiParagraph::QuoteBlock,
+                  collection: true
+        attribute :definition_lists,
+                  Metanorma::Document::Components::Lists::DefinitionList,
+                  collection: true
+
+        # Amend blocks (for amendment documents)
+        attribute :amend,
+                  Metanorma::StandardDocument::Blocks::AmendBlock
+
+        # Terms sections nested inside clauses
+        attribute :terms,
+                  IsoTermsSection, 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
+
+        # Forms (HTML input forms with tables)
+        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
+        attribute :pagebreak,
+                  Metanorma::Document::Components::EmptyElements::PageBreakElement,
+                  collection: true
+
+        # Bookmarks (inline anchors)
+        attribute :bookmark,
+                  Metanorma::Document::Components::IdElements::Bookmark,
+                  collection: true
+
+        # Presentation annotation markers
+        attribute :fmt_annotation_start,
+                  Metanorma::Document::Components::Inline::FmtAnnotationStartElement,
+                  collection: true
+        attribute :fmt_annotation_end,
+                  Metanorma::Document::Components::Inline::FmtAnnotationEndElement,
+                  collection: true
+
+        # Presentation-specific attributes
+        attribute :anchor, :string
+        attribute :semx_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+        attribute :fmt_title, Metanorma::Document::Components::Inline::FmtTitleElement
+        attribute :fmt_xref_label, Metanorma::Document::Components::Inline::FmtXrefLabelElement,
+                  collection: true
+        attribute :variant_title,
+                  Metanorma::Document::Components::Inline::VariantTitleElement, collection: true
+
+        xml do
+          element "clause"
+          ordered
+          map_attribute "id", to: :id
+          map_attribute "anchor", to: :anchor
+          map_attribute "type", to: :type
+          map_attribute "number", to: :number
+          map_attribute "obligation", to: :obligation
+          map_attribute "inline-header", to: :inline_header
+          map_attribute "unnumbered", to: :unnumbered
+          map_attribute "toc", to: :toc
+          map_attribute "class", to: :class_attr
+          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 "clause", to: :clause
+          map_element "p", to: :paragraphs
+          map_element "ul", to: :unordered_lists
+          map_element "ol", to: :ordered_lists
+          map_element "table", to: :tables
+          map_element "figure", to: :figures
+          map_element "formula", to: :formulas
+          map_element "example", to: :examples
+          map_element "note", to: :notes
+          map_element "admonition", to: :admonitions
+          map_element "sourcecode", to: :sourcecode_blocks
+          map_element "quote", to: :quote_blocks
+          map_element "dl", to: :definition_lists
+          map_element "amend", to: :amend
+          map_element "terms", to: :terms
+          map_element "definitions", to: :definitions
+          map_element "references", to: :references
+          map_element "form", to: :form
+          map_element "requirement", to: :requirement
+          map_element "recommendation", to: :recommendation
+          map_element "permission", to: :permission
+          map_element "pagebreak", to: :pagebreak
+          map_element "bookmark", to: :bookmark
+          map_element "fmt-annotation-start", to: :fmt_annotation_start
+          map_element "fmt-annotation-end", to: :fmt_annotation_end
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "autonum", to: :autonum
+          map_attribute "displayorder", to: :displayorder
+        end
+
+        # Blocks in document order, used by JSON serialization
+        def blocks
+          @blocks ||=
+            begin
+              result = []
+              each_mixed_content do |node|
+                result << node unless node.is_a?(String)
+              end
+              result
+            end
+        end
+
+        json do
+          map "id", to: :id
+          map "type", to: :type
+          map "number", to: :number
+          map "title", to: :title
+          map "inline_header", to: :inline_header
+          map "obligation", to: :obligation
+          map "paragraphs", to: :paragraphs
+          map "unordered_lists", to: :unordered_lists
+          map "ordered_lists", to: :ordered_lists
+          map "tables", to: :tables
+          map "figures", to: :figures
+          map "formulas", to: :formulas
+          map "examples", to: :examples
+          map "notes", to: :notes
+          map "admonitions", to: :admonitions
+          map "sourcecode_blocks", to: :sourcecode_blocks
+          map "quote_blocks", to: :quote_blocks
+          map "definition_lists", to: :definition_lists
+          map "clause", to: :clause
+        end
+      end
+    end
+  end
+end