metanorma-document 0.2.0

data/lib/metanorma/document/components/ancillary_blocks/formula_block.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Block containing a mathematical expression or other formulas.
+        class FormulaBlock < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
+          # The content of the formula, as a mathematical expression.
+          attribute :stem, Metanorma::Document::Components::TextElements::StemElement
+
+          # The block should be excluded from any automatic numbering of blocks of this class in the document.
+          attribute :unnumbered, :boolean
+
+          # Define a subsequence for numbering of this block; e.g. if this block would be numbered
+          # as 7, but it has a subsequence value of XYZ, this block, and all consecutive blocks
+          # of the same class and with the same subsequence value, will be numbered consecutively
+          # with the same number and in a subsequence: 7a, 7b, 7c etc.
+          attribute :subsequence, :string
+
+          # Indication that the formula is to be labelled as an Inequality, if inequalities are differentiated
+          # from equations.
+          attribute :inequality, :boolean
+
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :autonum, :string
+          attribute :displayorder, :integer
+
+          # A definitions list defining any symbols used in the formula.
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+
+          # The caption of the block.
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+
+          # Key definitions for formula variables
+          attribute :key, KeyElement
+
+          # Presentation-specific elements
+          attribute :fmt_stem, Metanorma::Document::Components::Inline::FmtStemElement
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+          attribute :fmt_footnote_container, Metanorma::Document::Components::Inline::FmtFootnoteContainerElement,
+                    collection: true
+
+          attribute :json_type, :string
+
+          def json_type
+            "formula"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "stem", to: :stem
+          end
+
+          xml do
+            element "formula"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum
+            map_attribute "displayorder", to: :displayorder
+            map_element "stem", to: :stem
+            map_attribute "unnumbered", to: :unnumbered
+            map_attribute "subsequence", to: :subsequence
+            map_attribute "inequality", to: :inequality
+            map_element "dl", to: :dl
+            map_element "name", to: :name
+            map_element "key", to: :key
+            map_element "fmt-stem", to: :fmt_stem
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+            map_element "p", to: :p
+            map_element "fmt-footnote-container", to: :fmt_footnote_container
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks/key_element.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Key definitions for formula or figure variables.
+        class KeyElement < Lutaml::Model::Serializable
+          attribute :class_attr, :string
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "key"
+            map_attribute "class", to: :class_attr
+            map_element "name", to: :name
+            map_element "dl", to: :dl
+            map_element "p", to: :p
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks/literal_block.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Pre-formatted blocks are wrappers for text to be rendered with fixed-width typeface, and preserving
+        # spaces including line breaks. They are intended for a restricted number of functions, most typically
+        # ASCII Art (which is still in prominent use in some standards documents), and computer output. In
+        # most cases, Sourcecode blocks are more appropriate in markup, as it is more clearly motivated
+        # semantically.
+        class LiteralBlock < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :alt, :string
+          attribute :align, :string
+          attribute :name, Metanorma::Document::Components::TextElements::TextElement,
+                    collection: true
+          attribute :content, :string
+
+          xml do
+            element "pre"
+            map_attribute "id", to: :id
+            map_attribute "alt", to: :alt
+            map_attribute "align", to: :align
+            map_element "name", to: :name
+            map_content to: :content
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks/sourcecode_block.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # Body of sourcecode block, containing code text with embedded callout elements.
+        # Uses map_all_content to preserve mixed content.
+        class SourcecodeBody < Lutaml::Model::Serializable
+          attribute :content, :string
+
+          xml do
+            element "body"
+            map_all_content to: :content
+          end
+        end
+
+        # Callout annotation in sourcecode, containing id, anchor, and paragraphs.
+        class CalloutAnnotation < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :original_id, :string
+          attribute :p, Metanorma::Document::Components::Paragraphs::ParagraphBlock,
+                    collection: true
+
+          xml do
+            element "callout-annotation"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "original-id", to: :original_id
+            map_element "p", to: :p
+          end
+        end
+
+        # Block containing computer code or comparable text.
+        class SourcecodeBlock < Metanorma::Document::Components::Blocks::BasicBlockNoNotes
+          # The caption of the block.
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+
+          # The block should be excluded from any automatic numbering of blocks of this class in the document.
+          attribute :unnumbered, :boolean
+
+          # Anchor attribute for cross-references
+          attribute :anchor, :string
+
+          # Define a subsequence for numbering of this block; e.g. if this block would be numbered
+          # as 7, but it has a subsequence value of XYZ, this block, and all consecutive blocks
+          # of the same class and with the same subsequence value, will be numbered consecutively
+          # with the same number and in a subsequence: 7a, 7b, 7c etc.
+          attribute :subsequence, :string
+
+          # A file name associated with the source code (and which could be used to extract the source code
+          # fragment to from the document, or to populate the source code fragment with from the external file,
+          # in automated processing of the document).
+          attribute :filename, :string
+
+          # The computer language or other notational convention that the source code is expressed in.
+          attribute :lang, :string
+
+          # Whether callout markers are displayed
+          attribute :markers, :string
+
+          # The computer code or other such text presented in the block, as a single unformatted string. (The
+          # string should be treated as pre-formatted text, with whitespace treated as significant.)
+          attribute :content, :string
+
+          # The source code body, containing code text with embedded callout references.
+          attribute :body, SourcecodeBody
+
+          # Zero or more cross-references; these are intended to be embedded within the `content` string, and
+          # link to annotations.
+          attribute :callouts,
+                    Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement, collection: true
+
+          # Annotations to the source code; each annotation consists of zero or more paragraphs, and is intended
+          # to be referenced by a callout within the source code.
+          attribute :callout_annotations,
+                    CalloutAnnotation, collection: true
+
+          # Presentation-specific elements
+          attribute :fmt_sourcecode, Metanorma::Document::Components::Inline::FmtSourcecodeElement
+
+          # Presentation-specific: semx-id for round-trip fidelity
+          attribute :semx_id, :string
+
+          attribute :json_type, :string
+
+          def json_type
+            "sourcecode"
+          end
+
+          json do
+            map "type", to: :json_type
+            map "id", to: :id
+            map "content", to: :content
+            map "filename", to: :filename
+            map "lang", to: :lang
+          end
+
+          xml do
+            element "sourcecode"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_element "name", to: :name
+            map_attribute "unnumbered", to: :unnumbered
+            map_attribute "subsequence", to: :subsequence
+            map_attribute "filename", to: :filename
+            map_attribute "lang", to: :lang
+            map_attribute "markers", to: :markers
+            map_content to: :content
+            map_element "body", to: :body
+            map_element "callout", to: :callouts
+            map_element "callout-annotation", to: :callout_annotations
+            map_attribute "semx-id", to: :semx_id
+            map_element "fmt-sourcecode", to: :fmt_sourcecode
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks/subfigure.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        # A figure embedded within another figure.
+        # Subfigures only occur within figures.
+        class Subfigure < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :anchor, :string
+          attribute :name, Metanorma::Document::Components::Inline::NameWithIdElement
+          attribute :image, Metanorma::Document::Components::IdElements::Image
+          attribute :figure, Subfigure, collection: true
+          attribute :key, :string
+          attribute :dl, Metanorma::Document::Components::Lists::DefinitionList
+          attribute :semx_id, :string
+          attribute :autonum, :string
+          attribute :fmt_name, Metanorma::Document::Components::Inline::FmtNameElement
+          attribute :fmt_xref_label,
+                    Metanorma::Document::Components::Inline::FmtXrefLabelElement, collection: true
+
+          xml do
+            element "figure"
+            map_attribute "id", to: :id
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "autonum", to: :autonum
+            map_element "name", to: :name
+            map_element "image", to: :image
+            map_element "figure", to: :figure
+            map_element "key", to: :key
+            map_element "dl", to: :dl
+            map_element "fmt-name", to: :fmt_name
+            map_element "fmt-xref-label", to: :fmt_xref_label
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/ancillary_blocks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module AncillaryBlocks
+        autoload :ExampleBlock, "#{__dir__}/ancillary_blocks/example_block"
+        autoload :FigureBlock, "#{__dir__}/ancillary_blocks/figure_block"
+        autoload :FormulaBlock, "#{__dir__}/ancillary_blocks/formula_block"
+        autoload :KeyElement, "#{__dir__}/ancillary_blocks/key_element"
+        autoload :LiteralBlock, "#{__dir__}/ancillary_blocks/literal_block"
+        autoload :SourcecodeBlock,
+                 "#{__dir__}/ancillary_blocks/sourcecode_block"
+        autoload :Subfigure, "#{__dir__}/ancillary_blocks/subfigure"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/bib_data/bib_data.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module BibData
+        # The bibliographic description of a BasicDocument.
+        # BibData differs from BibliographicItem by making `title` and `copyright` mandatory.
+        class BibData < Lutaml::Model::Serializable
+          attribute :ext, Metanorma::Document::Components::BibData::BibDataExtensionType
+          attribute :title, Metanorma::Document::Relaton::TypedTitleString,
+                    collection: true
+          attribute :link, Metanorma::Document::Relaton::TypedUri,
+                    collection: true
+          attribute :docidentifier, Metanorma::Document::Relaton::DocumentIdentifier,
+                    collection: true
+          attribute :docnumber, :string
+          attribute :date, Metanorma::Document::Relaton::BibliographicDate,
+                    collection: true
+          attribute :contributor, Metanorma::Document::Relaton::ContributionInfo,
+                    collection: true
+          attribute :edition, Metanorma::Document::Relaton::Edition
+          attribute :version, Metanorma::Document::Relaton::VersionInfo
+          attribute :language, Metanorma::Document::Components::DataTypes::Iso639Code,
+                    collection: true
+          attribute :script, Metanorma::Document::Components::DataTypes::Iso15924Code,
+                    collection: true
+          attribute :abstract, Metanorma::Document::Components::DataTypes::FormattedString,
+                    collection: true
+          attribute :status, Metanorma::Document::Relaton::DocumentStatus
+          attribute :copyright, Metanorma::Document::Relaton::CopyrightAssociation,
+                    collection: true
+          attribute :relation, Metanorma::Document::Relaton::DocumentRelation,
+                    collection: true
+          attribute :series, Metanorma::Document::Relaton::SeriesType,
+                    collection: true
+          attribute :keyword, Metanorma::Document::Relaton::KeywordType,
+                    collection: true
+          attribute :classification, Metanorma::Document::Relaton::DocumentIdentifier,
+                    collection: true
+
+          xml do
+            element "bibdata"
+            map_element "ext", to: :ext
+            map_element "title", to: :title
+            map_element "uri", to: :link
+            map_element "docidentifier", to: :docidentifier
+            map_element "docnumber", to: :docnumber
+            map_element "date", to: :date
+            map_element "contributor", to: :contributor
+            map_element "edition", to: :edition
+            map_element "version", to: :version
+            map_element "language", to: :language
+            map_element "script", to: :script
+            map_element "abstract", to: :abstract
+            map_element "status", to: :status
+            map_element "copyright", to: :copyright
+            map_element "relation", to: :relation
+            map_element "series", to: :series
+            map_element "keyword", to: :keyword
+            map_element "classification", to: :classification
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/bib_data/bib_data_extension_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module BibData
+        # The extension point of the bibliographic description of a BasicDocument.
+        class BibDataExtensionType < Lutaml::Model::Serializable
+          attribute :doctype, Metanorma::Document::Components::BibData::DocumentType
+
+          xml do
+            element "ext"
+            map_element "doctype", to: :doctype
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/bib_data/bibliographic_item.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module BibData
+        # Description of a bibliographic resource.
+        class BibliographicItem < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :type, Metanorma::Document::Relaton::BibItemType
+          attribute :fetched, Metanorma::Document::Relaton::DateTime
+          attribute :title, Metanorma::Document::Relaton::TypedTitleString,
+                    collection: true
+          attribute :formatted_ref, Metanorma::Document::Components::DataTypes::FormattedString
+          attribute :link, Metanorma::Document::Relaton::TypedUri,
+                    collection: true
+          attribute :docidentifier, Metanorma::Document::Relaton::DocumentIdentifier,
+                    collection: true
+          attribute :docnumber, :string
+          attribute :date, Metanorma::Document::Relaton::BibliographicDate,
+                    collection: true
+          attribute :contributor, Metanorma::Document::Relaton::ContributionInfo,
+                    collection: true
+          attribute :edition, Metanorma::Document::Relaton::Edition
+          attribute :version, Metanorma::Document::Relaton::VersionInfo
+          attribute :note, Metanorma::Document::Relaton::TypedNote,
+                    collection: true
+          attribute :language, Metanorma::Document::Components::DataTypes::Iso639Code,
+                    collection: true
+          attribute :script, Metanorma::Document::Components::DataTypes::Iso15924Code,
+                    collection: true
+          attribute :abstract, Metanorma::Document::Components::DataTypes::FormattedString,
+                    collection: true
+          attribute :status, Metanorma::Document::Relaton::DocumentStatus
+          attribute :copyright, Metanorma::Document::Relaton::CopyrightAssociation,
+                    collection: true
+          attribute :relation, Metanorma::Document::Relaton::DocumentRelation,
+                    collection: true
+          attribute :series, Metanorma::Document::Relaton::SeriesType,
+                    collection: true
+          attribute :medium, Metanorma::Document::Relaton::MediumType
+          attribute :place, Metanorma::Document::Relaton::PlaceType,
+                    collection: true
+          attribute :price, Metanorma::Document::Relaton::PriceType,
+                    collection: true
+          attribute :extent, Metanorma::Document::Relaton::LocalityStack,
+                    collection: true
+          attribute :size, Metanorma::Document::Relaton::BibItemSize,
+                    collection: true
+          attribute :access_location, :string, collection: true
+          attribute :license, :string, collection: true
+          attribute :classification, Metanorma::Document::Relaton::DocumentIdentifier,
+                    collection: true
+          attribute :keyword, Metanorma::Document::Relaton::KeywordType,
+                    collection: true
+          attribute :validity, Metanorma::Document::Relaton::ValidityType
+
+          # Presentation-specific
+          attribute :anchor, :string
+          attribute :semx_id, :string
+          attribute :schema_version, :string
+          attribute :biblio_tag, Metanorma::Document::Components::Inline::BiblioTagElement
+          attribute :type_attr, :string
+
+          xml do
+            element "bibitem"
+            map_attribute "id", to: :id
+            map_attribute "type", to: :type_attr
+            map_attribute "anchor", to: :anchor
+            map_attribute "semx-id", to: :semx_id
+            map_attribute "schema-version", to: :schema_version
+            map_element "biblio-tag", to: :biblio_tag
+            map_element "type", to: :type
+            map_element "fetched", to: :fetched
+            map_element "title", to: :title
+            map_element "formattedref", to: :formatted_ref
+            map_element "uri", to: :link
+            map_element "docidentifier", to: :docidentifier
+            map_element "docnumber", to: :docnumber
+            map_element "date", to: :date
+            map_element "contributor", to: :contributor
+            map_element "edition", to: :edition
+            map_element "version", to: :version
+            map_element "note", to: :note
+            map_element "language", to: :language
+            map_element "script", to: :script
+            map_element "abstract", to: :abstract
+            map_element "status", to: :status
+            map_element "copyright", to: :copyright
+            map_element "relation", to: :relation
+            map_element "series", to: :series
+            map_element "medium", to: :medium
+            map_element "place", to: :place
+            map_element "price", to: :price
+            map_element "extent", to: :extent
+            map_element "size", to: :size
+            map_element "accessLocation", to: :access_location
+            map_element "license", to: :license
+            map_element "classification", to: :classification
+            map_element "keyword", to: :keyword
+            map_element "validity", to: :validity
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/bib_data/document_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module BibData
+        # Classifications of BasicDocuments.
+        class DocumentType < Lutaml::Model::Serializable
+          attribute :value, :string
+
+          xml do
+            element "document-type"
+            map_content to: :value
+
+            def self.values
+              %w[document]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/bib_data.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module BibData
+        autoload :BibData, "#{__dir__}/bib_data/bib_data"
+        autoload :BibDataExtensionType,
+                 "#{__dir__}/bib_data/bib_data_extension_type"
+        autoload :BibliographicItem, "#{__dir__}/bib_data/bibliographic_item"
+        autoload :DocumentType, "#{__dir__}/bib_data/document_type"
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/blocks/basic_block.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        # Block of textual content in BasicDocument.
+        class BasicBlock < Lutaml::Model::Serializable
+          attribute :notes, NoteBlock, collection: true
+
+          xml do
+            element "basic-block"
+            map_element "notes", to: :notes
+          end
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/document/components/blocks/basic_block_no_notes.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Document
+    module Components
+      module Blocks
+        # Base class of blocks for a BasicDocument, omitting notes.
+        class BasicBlockNoNotes < Lutaml::Model::Serializable
+          attribute :id, :string
+          attribute :contrib_metadata, Metanorma::Document::Components::ContribMetadata::ContributionElementMetadata,
+                    collection: true
+
+          xml do
+            element "basic-block-no-notes"
+            map_attribute "id", to: :id
+            map_element "contrib-metadata", to: :contrib_metadata
+          end
+        end
+      end
+    end
+  end
+end