metanorma-document 0.2.0

data/lib/metanorma/basic_document/ancillary_blocks/formula_block.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module AncillaryBlocks
+      # Block containing a mathematical expression or other formulas.
+      class FormulaBlock < Metanorma::BasicDocument::Blocks::BasicBlockNoNotes
+        # The content of the formula, as a mathematical expression.
+        attribute :stem, Metanorma::BasicDocument::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
+
+        # A definitions list defining any symbols used in the formula.
+        attribute :definitions, Metanorma::BasicDocument::Lists::DefinitionList
+
+        xml do
+          element "formula"
+          map_element "stem", to: :stem
+          map_attribute "unnumbered", to: :unnumbered
+          map_attribute "subsequence", to: :subsequence
+          map_attribute "inequality", to: :inequality
+          map_element "definitions", to: :definitions
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/ancillary_blocks/literal_block.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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 :alt, :string
+        attribute :name, Metanorma::BasicDocument::TextElements::TextElement,
+                  collection: true
+        attribute :content, :string
+
+        xml do
+          element "pre"
+          map_attribute "alt", to: :alt
+          map_element "name", to: :name
+          map_content to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/ancillary_blocks/sourcecode_block.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module AncillaryBlocks
+      # Block containing computer code or comparable text.
+      class SourcecodeBlock < Metanorma::BasicDocument::Blocks::BasicBlockNoNotes
+        # The caption of the block.
+        attribute :name, Metanorma::BasicDocument::TextElements::TextElement,
+                  collection: true
+
+        # 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
+
+        # 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
+
+        # 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
+
+        # Zero or more cross-references; these are intended to be embedded within the `content` string, and
+        # link to annotations.
+        attribute :callouts,
+                  Metanorma::BasicDocument::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,
+                  Metanorma::BasicDocument::Paragraphs::ParagraphBlock, collection: true
+
+        xml do
+          element "sourcecode"
+          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_content to: :content
+          map_element "callouts", to: :callouts
+          map_element "callout-annotations", to: :callout_annotations
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/ancillary_blocks/subfigure.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module AncillaryBlocks
+      # A figure embedded within another figure.
+      # Subfigures only occur within figures.
+      class Subfigure < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "subfigure"
+          map_content to: :value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/ancillary_blocks.rb

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

data/lib/metanorma/basic_document/bib_data/bib_data.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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::BasicDocument::BibData::BibDataExtensionType
+
+        xml do
+          element "ext"
+          map_element "ext", to: :ext
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/bib_data/bib_data_extension_type.rb

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

data/lib/metanorma/basic_document/bib_data/bibliographic_item.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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
+
+        xml do
+          element "bibitem"
+          map_attribute "id", to: :id
+          map_element "type", to: :type
+          map_element "fetched", to: :fetched
+          map_element "title", to: :title
+          map_element "formattedRef", to: :formatted_ref
+          map_element "link", 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

data/lib/metanorma/basic_document/bib_data/document_type.rb

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

data/lib/metanorma/basic_document/bib_data.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    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

data/lib/metanorma/basic_document/blocks/basic_block.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Blocks
+      class BasicBlock < Lutaml::Model::Serializable
+        xml do
+          element "basic-block"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/blocks/basic_block_no_notes.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Blocks
+      # Base class of blocks for a BasicDocument, omitting notes.
+      class BasicBlockNoNotes < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :contrib_metadata,
+                  Metanorma::BasicDocument::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

data/lib/metanorma/basic_document/blocks/note_block.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Blocks
+      class NoteBlock < Metanorma::BasicDocument::Blocks::BasicBlockNoNotes
+        xml do
+          element "note"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/blocks.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "blocks/basic_block_no_notes"
+require_relative "blocks/basic_block"
+require_relative "blocks/note_block"
+
+module Metanorma
+  module BasicDocument
+    module Blocks
+    end
+  end
+end
+
+Metanorma::BasicDocument::Blocks::BasicBlock.class_eval do
+  attribute :notes, Metanorma::BasicDocument::Blocks::NoteBlock,
+            collection: true
+
+  xml do
+    map_element "notes", to: :notes
+  end
+end
+
+require_relative "paragraphs"
+
+Metanorma::BasicDocument::Blocks::NoteBlock.class_eval do
+  attribute :content,
+            Metanorma::BasicDocument::Paragraphs::ParagraphBlock, collection: true
+
+  xml do
+    map_element "content", to: :content
+  end
+end

data/lib/metanorma/basic_document/change/attribute_change_action.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Possible actions
+      # that involve modification of an attribute within a BasicDocument
+      # data element.
+      class AttributeChangeAction < Metanorma::BasicDocument::Change::ContentChangeAction
+        attribute :attribute_id, :string
+
+        xml do
+          element "attribute-change-action"
+          map_attribute "attribute-id", to: :attribute_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/attribute_modify.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # A container for a multiple _AttributeChangeAction_ data.
+      # Add attribute; Remove attribute; Modify attribute.
+      class AttributeModify < Metanorma::BasicDocument::Change::ContentModify
+        attribute :actions,
+                  Metanorma::BasicDocument::Change::AttributeChangeAction, collection: true
+
+        xml do
+          element "attribute-modify"
+          map_element "actions", to: :actions
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/change.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Specification of an update action to be performed incrementally on an element within a
+      # BasicDocument.
+      class Change < Lutaml::Model::Serializable
+        attribute :target, Metanorma::BasicDocument::ReferenceElements::ReferenceToIdElement
+        attribute :identifier, Metanorma::BasicDocument::Change::UniqueIdentifier
+        attribute :parent_identifier, Metanorma::BasicDocument::Change::UniqueIdentifier
+        attribute :contrib_metadata, Metanorma::BasicDocument::ContribMetadata::ContributionElementMetadata,
+                  collection: true
+
+        xml do
+          element "change"
+          map_element "target", to: :target
+          map_element "identifier", to: :identifier
+          map_element "parent-identifier", to: :parent_identifier
+          map_element "contrib-metadata", to: :contrib_metadata
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/change_set.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # A collection of _Change_ data, specifying the document they should be applied to.
+      class ChangeSet < Lutaml::Model::Serializable
+        attribute :changes, Metanorma::BasicDocument::Change::Change,
+                  collection: true
+        attribute :document_identifier, Metanorma::BasicDocument::Change::UniqueIdentifier
+
+        xml do
+          element "change-set"
+          map_element "changes", to: :changes
+          map_element "document-identifier", to: :document_identifier
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/content_action.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Specifies the kind of textual change to be undertaken.
+      class ContentAction < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        xml do
+          element "content-action"
+          map_content to: :value
+        end
+
+        def self.values
+          %w[insert delete]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/content_change.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Possible actions
+      # that involve modification of content within a BasicDocument
+      # data element.
+      # Add text; Delete text; Modify text.
+      class ContentChange < Metanorma::BasicDocument::Change::Change
+        xml do
+          element "content-change"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/content_change_action.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # The actual content
+      # changes that applies to the specified portion of textual content.
+      # This is used both by the _ContentModify_ and _AttributeModify_ models
+      # as their content are treated as pure text.
+      class ContentChangeAction < Lutaml::Model::Serializable
+        attribute :action, :string
+        attribute :from, :integer
+        attribute :to, :integer
+        attribute :text, :string
+        attribute :length, :integer
+
+        xml do
+          element "content-change-action"
+          map_attribute "action", to: :action
+          map_attribute "from", to: :from
+          map_attribute "to", to: :to
+          map_attribute "text", to: :text
+          map_attribute "length", to: :length
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/content_modify.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Container for a multiple _ContentChangeAction_ data
+      class ContentModify < Metanorma::BasicDocument::Change::ContentChange
+        attribute :actions,
+                  Metanorma::BasicDocument::Change::ContentChangeAction, collection: true
+
+        xml do
+          element "content-modify"
+          map_element "actions", to: :actions
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/node_change.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Possible actions that involve
+      # modification of data elements at the node level within a
+      # BasicDocument. Add/remove node; Move node.
+      class NodeChange < Metanorma::BasicDocument::Change::Change
+        xml do
+          element "node-change"
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/node_delete.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Specification of the deletion of a data node in a BasicDocument.
+      class NodeDelete < Metanorma::BasicDocument::Change::NodeChange
+        attribute :hash_value, :string
+
+        xml do
+          element "node-delete"
+          map_attribute "hash-value", to: :hash_value
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/node_insert.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Specification of the insertion
+      # of a data node in a BasicDocument.
+      class NodeInsert < Metanorma::BasicDocument::Change::NodeChange
+        attribute :content, Metanorma::BasicDocument::EmptyElements::BasicElement
+
+        xml do
+          element "node-insert"
+          map_element "content", to: :content
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/basic_document/change/node_move.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module BasicDocument
+    module Change
+      # Specification of moving a particular node in a BasicDocument
+      # to another location within the same BasicDocument.
+      class NodeMove < Metanorma::BasicDocument::Change::NodeChange
+        attribute :position_old, Metanorma::BasicDocument::ReferenceElements::ReferenceToIdElement
+        attribute :position_new, Metanorma::BasicDocument::ReferenceElements::ReferenceToIdElement
+
+        xml do
+          element "node-move"
+          map_element "position-old", to: :position_old
+          map_element "position-new", to: :position_new
+        end
+      end
+    end
+  end
+end