metanorma-document 0.2.0

data/lib/metanorma/standard_document/elements/orientation_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Orientation of pages in a section of text in paged media.
+      class OrientationType < Lutaml::Model::Serializable
+        attribute :value, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "orientation-type"
+          map_content to: :value
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+
+        def self.values
+          %w[portrait landscape]
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/select.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Input allowing the selection of a value from a list of values. The value attribute is used instead
+      # of a selected
+      # attribute on a component option
+      class Select < Metanorma::StandardDocument::Elements::FormInput
+        attribute :disabled, :boolean
+        attribute :multiple, :boolean
+        attribute :size, :integer
+        attribute :option, Metanorma::StandardDocument::Elements::Option,
+                  collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "select"
+          map_attribute "disabled", to: :disabled
+          map_attribute "multiple", to: :multiple
+          map_attribute "size", to: :size
+          map_element "option", to: :option
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/standard_page_break_element.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      class StandardPageBreakElement < Metanorma::Document::Components::EmptyElements::PageBreakElement
+        attribute :orientation, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "standard-page-break-element"
+          map_attribute "orientation", to: :orientation
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements/textarea.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      # Input involving extended text. The value attribute is used instead of text area content
+      class Textarea < Metanorma::StandardDocument::Elements::FormInput
+        attribute :rows, :integer
+        attribute :cols, :integer
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "textarea"
+          map_attribute "rows", to: :rows
+          map_attribute "cols", to: :cols
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/elements.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Elements
+      autoload :Add, "#{__dir__}/elements/add"
+      autoload :Del, "#{__dir__}/elements/del"
+      autoload :FormInput, "#{__dir__}/elements/form_input"
+      autoload :Input, "#{__dir__}/elements/input"
+      autoload :InputType, "#{__dir__}/elements/input_type"
+      autoload :Label, "#{__dir__}/elements/label"
+      autoload :Option, "#{__dir__}/elements/option"
+      autoload :OrientationType, "#{__dir__}/elements/orientation_type"
+      autoload :Select, "#{__dir__}/elements/select"
+      autoload :StandardPageBreakElement,
+               "#{__dir__}/elements/standard_page_break_element"
+      autoload :Textarea, "#{__dir__}/elements/textarea"
+    end
+  end
+end

data/lib/metanorma/standard_document/lists/standard_definition.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      class StandardDefinition < Metanorma::Document::Components::Lists::Definition
+        attribute :item,
+                  Metanorma::StandardDocument::Lists::StandardDefinitionTerm, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-definition"
+          map_element "item", to: :item
+          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/lists/standard_definition_list.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      class StandardDefinitionList < Metanorma::Document::Components::Lists::DefinitionList
+        attribute :keep_lines_together, :boolean
+        attribute :keep_with_next, :boolean
+        attribute :key, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-definition-list"
+          map_attribute "keep-lines-together", to: :keep_lines_together
+          map_attribute "keep-with-next", to: :keep_with_next
+          map_attribute "key", to: :key
+
+          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/lists/standard_definition_term.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      class StandardDefinitionTerm < Lutaml::Model::Serializable
+        attribute :id, :string
+        attribute :content,
+                  Metanorma::Document::Components::TextElements::TextElement, collection: true
+
+        # Presentation-specific attributes
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-definition-term"
+          map_attribute "id", to: :id
+          map_element "content", to: :content
+          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/lists/standard_unordered_list.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      # Ordered list for standards documents.
+      class StandardUnorderedList < Metanorma::Document::Components::Lists::UnorderedList
+        attribute :display, :string
+        attribute :display_directives, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :autonum, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "standard-unordered-list"
+          map_attribute "display", to: :display
+          map_attribute "display-directives", to: :display_directives
+          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/lists/unordered_checkable_list_item.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      # List item for unordered lists for standards documents.
+      class UnorderedCheckableListItem < Lutaml::Model::Serializable
+        attribute :checkbox, :boolean
+        attribute :checkedcheckbox, :boolean
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+        attribute :displayorder, :integer
+
+        xml do
+          element "unordered-checkable-list-item"
+          map_attribute "checkbox", to: :checkbox
+          map_attribute "checkedcheckbox", to: :checkedcheckbox
+          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/lists.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Lists
+      autoload :StandardDefinition, "#{__dir__}/lists/standard_definition"
+      autoload :StandardDefinitionList,
+               "#{__dir__}/lists/standard_definition_list"
+      autoload :StandardDefinitionTerm,
+               "#{__dir__}/lists/standard_definition_term"
+      autoload :StandardUnorderedList,
+               "#{__dir__}/lists/standard_unordered_list"
+      autoload :UnorderedCheckableListItem,
+               "#{__dir__}/lists/unordered_checkable_list_item"
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/editorial_group_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # A group associated with the production of the standards document, typically within
+      # a standards definition organization.
+      class EditorialGroupType < Lutaml::Model::Serializable
+        attribute :technicalcommittee,
+                  Metanorma::StandardDocument::Metadata::TechnicalCommitteeType, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "editorialgroup"
+          map_element "technical-committee", to: :technicalcommittee
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/ics_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # Classification taken from the International Classification of Standards.
+      # ICS is defined by ISO here -- https://www.iso.org/publication/PUB100033.html
+      class IcsType < Lutaml::Model::Serializable
+        attribute :code, :string
+        attribute :text, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "ics"
+          map_attribute "code", to: :code
+          map_attribute "text", to: :text
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/standard_bib_data.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # The bibliographic description of a _StandardDocument_.
+      class StandardBibData < Metanorma::Document::Components::BibData::BibData
+        attribute :type, :string
+        attribute :ext, Metanorma::StandardDocument::Metadata::StandardBibDataExtensionType
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "bibdata"
+          map_attribute "type", to: :type
+          map_element "ext", to: :ext
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/standard_bib_data_extension_type.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # The extension point of the bibliographic description of a _StandardDocument_.
+      class StandardBibDataExtensionType < Metanorma::Document::Components::BibData::BibDataExtensionType
+        attribute :doctype, :string
+        attribute :doctype_abbreviation, :string
+        attribute :subdoctype, :string
+        attribute :editorial_group, Metanorma::StandardDocument::Metadata::EditorialGroupType
+        attribute :ics, Metanorma::StandardDocument::Metadata::IcsType,
+                  collection: true
+        attribute :structuredidentifier, Metanorma::StandardDocument::Metadata::StructuredIdentifierType,
+                  collection: true
+
+        # Presentation-specific attributes
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "ext"
+          map_attribute "doctype", to: :doctype
+          map_attribute "doctype-abbreviation", to: :doctype_abbreviation
+          map_element "subdoctype", to: :subdoctype
+          map_element "editorial-group", to: :editorial_group
+          map_element "ics", to: :ics
+          map_element "structuredidentifier", to: :structuredidentifier
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/structured_identifier_type.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # Representation of the identifier for a _StandardDocument_, giving its individual semantic
+      # components.
+      class StructuredIdentifierType < Lutaml::Model::Serializable
+        attribute :type, :string
+        attribute :agency, :string, collection: true
+        attribute :class, :string
+        attribute :docnumber, :string
+        attribute :partnumber, :string
+        attribute :edition, :string
+        attribute :version, :string
+        attribute :supplementtype, :string
+        attribute :supplementnumber, :string
+        attribute :year, :string
+        attribute :language, :string
+        attribute :part, :string
+        attribute :appendix, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "structuredidentifier"
+          map_attribute "type", to: :type
+          map_element "agency", to: :agency
+          map_attribute "class", to: :class
+          map_attribute "docnumber", to: :docnumber
+          map_attribute "partnumber", to: :partnumber
+          map_attribute "edition", to: :edition
+          map_attribute "version", to: :version
+          map_attribute "supplementtype", to: :supplementtype
+          map_attribute "supplementnumber", to: :supplementnumber
+          map_element "year", to: :year
+          map_attribute "language", to: :language
+          map_element "part", to: :part
+          map_element "appendix", to: :appendix
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata/technical_committee_type.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      # Technical committee associated with the production of a standards document.
+      class TechnicalCommitteeType < Lutaml::Model::Serializable
+        attribute :number, :integer
+        attribute :type, :string
+        attribute :text, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "technical-committee"
+          map_attribute "number", to: :number
+          map_attribute "type", to: :type
+          map_attribute "text", to: :text
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/metadata.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Metadata
+      autoload :EditorialGroupType, "#{__dir__}/metadata/editorial_group_type"
+      autoload :IcsType, "#{__dir__}/metadata/ics_type"
+      autoload :StandardBibData, "#{__dir__}/metadata/standard_bib_data"
+      autoload :StandardBibDataExtensionType,
+               "#{__dir__}/metadata/standard_bib_data_extension_type"
+      autoload :StructuredIdentifierType,
+               "#{__dir__}/metadata/structured_identifier_type"
+      autoload :TechnicalCommitteeType,
+               "#{__dir__}/metadata/technical_committee_type"
+    end
+  end
+end

data/lib/metanorma/standard_document/namespace.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    class Namespace < Lutaml::Xml::Namespace
+      uri "https://www.metanorma.org/ns/standoc"
+      prefix_default "standoc"
+      element_form_default :qualified
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/reference_to_term.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Cross-reference to a term.
+      class ReferenceToTerm < Metanorma::Document::Components::ReferenceElements::ReferenceElement
+        attribute :source, BasicObject
+        attribute :term, :string, collection: true
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "reference-to-term"
+          map_element "source", to: :source
+          map_element "term", to: :term
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/reference_to_termbase.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Cross-reference to a term defined within a termbase.
+      class ReferenceToTermbase < Lutaml::Model::Serializable
+        attribute :base, :string
+        attribute :target, :string
+        attribute :text, Metanorma::Document::Components::TextElements::TextElement
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "reference-to-termbase"
+          map_attribute "base", to: :base
+          map_attribute "target", to: :target
+          map_element "text", to: :text
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/standoc_locality_stack.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Description of location in a reference, which can be combined with other locations in a single
+      # citation.
+      class StandocLocalityStack < Metanorma::Document::Relaton::LocalityStack
+        attribute :connective, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "standoc-locality-stack"
+          map_attribute "connective", to: :connective
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/standoc_reference_to_citation_element.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Cross-reference to an bibliographic reference within a _StandardDocument_.
+      class StandocReferenceToCitationElement < Metanorma::Document::Components::ReferenceElements::ReferenceToCitationElement
+        attribute :case, :string
+        attribute :droploc, :boolean
+        attribute :style, :string
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "standoc-reference-to-citation-element"
+          map_attribute "case", to: :case
+          map_attribute "droploc", to: :droploc
+          map_attribute "style", to: :style
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end

data/lib/metanorma/standard_document/refs/standoc_reference_to_id_element.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module StandardDocument
+    module Refs
+      # Cross-reference to an identified element within a _StandardDocument_.
+      class StandocReferenceToIdElement < Metanorma::Document::Components::ReferenceElements::ReferenceToIdElement
+        attribute :case, :string
+        attribute :droploc, :boolean
+        attribute :style, :string
+        attribute :label, :string
+        attribute :to, Metanorma::Document::Components::IdElements::IdElement
+        attribute :xref_target, Metanorma::StandardDocument::Refs::XrefTargetType,
+                  collection: true
+        attribute :display_text, Metanorma::Document::Components::Inline::DisplayTextElement
+
+        attribute :semx_id, :string
+        attribute :original_id, :string
+
+        xml do
+          element "standoc-reference-to-id-element"
+          map_attribute "case", to: :case
+          map_attribute "droploc", to: :droploc
+          map_attribute "style", to: :style
+          map_attribute "label", to: :label
+          map_element "to", to: :to
+          map_element "xref-target", to: :xref_target
+          map_element "display-text", to: :display_text
+
+          map_attribute "semx-id", to: :semx_id
+          map_attribute "original-id", to: :original_id
+        end
+      end
+    end
+  end
+end