Module: Metanorma::Document

Defined in:
lib/metanorma/document.rb,
lib/metanorma/document/root.rb,
lib/metanorma/document/relaton.rb,
lib/metanorma/document/version.rb,
lib/metanorma/document/components.rb,
lib/metanorma/document/data_types.rb,
lib/metanorma/document/relaton/phone.rb,
lib/metanorma/document/relaton/person.rb,
lib/metanorma/document/relaton/address.rb,
lib/metanorma/document/relaton/edition.rb,
lib/metanorma/document/components/lists.rb,
lib/metanorma/document/components/blocks.rb,
lib/metanorma/document/components/change.rb,
lib/metanorma/document/components/inline.rb,
lib/metanorma/document/components/tables.rb,
lib/metanorma/document/relaton/date_time.rb,
lib/metanorma/document/relaton/full_name.rb,
lib/metanorma/document/relaton/typed_uri.rb,
lib/metanorma/document/relaton/place_type.rb,
lib/metanorma/document/relaton/price_type.rb,
lib/metanorma/document/relaton/title_type.rb,
lib/metanorma/document/relaton/typed_note.rb,
lib/metanorma/document/components/bib_data.rb,
lib/metanorma/document/components/sections.rb,
lib/metanorma/document/relaton/affiliation.rb,
lib/metanorma/document/relaton/contributor.rb,
lib/metanorma/document/relaton/medium_type.rb,
lib/metanorma/document/relaton/region_type.rb,
lib/metanorma/document/relaton/series_type.rb,
lib/metanorma/document/relaton/iso4217_code.rb,
lib/metanorma/document/relaton/iso8601_date.rb,
lib/metanorma/document/relaton/keyword_type.rb,
lib/metanorma/document/relaton/organization.rb,
lib/metanorma/document/relaton/version_info.rb,
lib/metanorma/document/components/data_types.rb,
lib/metanorma/document/components/lists/list.rb,
lib/metanorma/document/components/paragraphs.rb,
lib/metanorma/document/relaton/bib_item_size.rb,
lib/metanorma/document/relaton/bib_item_type.rb,
lib/metanorma/document/relaton/validity_type.rb,
lib/metanorma/document/relaton/vocab_id_type.rb,
lib/metanorma/document/components/id_elements.rb,
lib/metanorma/document/relaton/contact_method.rb,
lib/metanorma/document/relaton/locality_stack.rb,
lib/metanorma/document/relaton/localized_name.rb,
lib/metanorma/document/relaton/org_identifier.rb,
lib/metanorma/document/relaton/document_status.rb,
lib/metanorma/document/relaton/org_subdivision.rb,
lib/metanorma/document/components/change/change.rb,
lib/metanorma/document/components/text_elements.rb,
lib/metanorma/document/relaton/contributor_role.rb,
lib/metanorma/document/relaton/series_type_type.rb,
lib/metanorma/document/relaton/variant_org_name.rb,
lib/metanorma/document/components/data_types/uri.rb,
lib/metanorma/document/components/empty_elements.rb,
lib/metanorma/document/relaton/bib_item_locality.rb,
lib/metanorma/document/relaton/contribution_info.rb,
lib/metanorma/document/relaton/document_relation.rb,
lib/metanorma/document/relaton/person_identifier.rb,
lib/metanorma/document/relaton/variant_full_name.rb,
lib/metanorma/document/components/lists/list_item.rb,
lib/metanorma/document/components/multi_paragraph.rb,
lib/metanorma/document/relaton/bib_item_size_type.rb,
lib/metanorma/document/relaton/bibliographic_date.rb,
lib/metanorma/document/relaton/relaton_collection.rb,
lib/metanorma/document/relaton/typed_title_string.rb,
lib/metanorma/document/components/ancillary_blocks.rb,
lib/metanorma/document/components/change/node_move.rb,
lib/metanorma/document/components/contrib_metadata.rb,
lib/metanorma/document/components/lists/dd_element.rb,
lib/metanorma/document/components/lists/definition.rb,
lib/metanorma/document/components/lists/dt_element.rb,
lib/metanorma/document/relaton/document_identifier.rb,
lib/metanorma/document/components/bib_data/bib_data.rb,
lib/metanorma/document/components/blocks/note_block.rb,
lib/metanorma/document/components/change/change_set.rb,
lib/metanorma/document/components/id_elements/audio.rb,
lib/metanorma/document/components/id_elements/image.rb,
lib/metanorma/document/components/id_elements/media.rb,
lib/metanorma/document/components/id_elements/video.rb,
lib/metanorma/document/components/inline/br_element.rb,
lib/metanorma/document/components/inline/fn_element.rb,
lib/metanorma/document/components/inline/tt_element.rb,
lib/metanorma/document/components/tables/table_cell.rb,
lib/metanorma/document/components/blocks/basic_block.rb,
lib/metanorma/document/components/change/node_change.rb,
lib/metanorma/document/components/change/node_delete.rb,
lib/metanorma/document/components/change/node_insert.rb,
lib/metanorma/document/components/inline/sub_element.rb,
lib/metanorma/document/components/inline/sup_element.rb,
lib/metanorma/document/components/inline/tab_element.rb,
lib/metanorma/document/components/lists/ordered_list.rb,
lib/metanorma/document/components/reference_elements.rb,
lib/metanorma/document/components/tables/table_block.rb,
lib/metanorma/document/relaton/copyright_association.rb,
lib/metanorma/document/components/inline/eref_element.rb,
lib/metanorma/document/components/inline/link_element.rb,
lib/metanorma/document/components/inline/math_element.rb,
lib/metanorma/document/components/inline/semx_element.rb,
lib/metanorma/document/components/inline/span_element.rb,
lib/metanorma/document/components/inline/xref_element.rb,
lib/metanorma/document/components/text_elements/latex.rb,
lib/metanorma/document/relaton/document_relation_type.rb,
lib/metanorma/document/relaton/specific_locality_type.rb,
lib/metanorma/document/components/id_elements/bookmark.rb,
lib/metanorma/document/components/inline/bcp14_element.rb,
lib/metanorma/document/components/inline/comma_element.rb,
lib/metanorma/document/components/lists/unordered_list.rb,
lib/metanorma/document/components/tables/table_section.rb,
lib/metanorma/document/relaton/bibliographic_date_type.rb,
lib/metanorma/document/components/change/content_action.rb,
lib/metanorma/document/components/change/content_change.rb,
lib/metanorma/document/components/change/content_modify.rb,
lib/metanorma/document/components/contrib_metadata/hash.rb,
lib/metanorma/document/components/inline/em_raw_element.rb,
lib/metanorma/document/components/lists/definition_list.rb,
lib/metanorma/document/components/tables/text_alignment.rb,
lib/metanorma/document/components/tables/text_table_row.rb,
lib/metanorma/document/components/text_elements/asciiml.rb,
lib/metanorma/document/relaton/personal_identifier_type.rb,
lib/metanorma/document/components/bib_data/document_type.rb,
lib/metanorma/document/components/data_types/iso639_code.rb,
lib/metanorma/document/components/id_elements/alt_source.rb,
lib/metanorma/document/components/id_elements/id_element.rb,
lib/metanorma/document/components/id_elements/media_type.rb,
lib/metanorma/document/components/inline/concept_element.rb,
lib/metanorma/document/components/sections/basic_section.rb,
lib/metanorma/document/components/tables/text_table_cell.rb,
lib/metanorma/document/components/change/attribute_modify.rb,
lib/metanorma/document/components/data_types/iso3166_code.rb,
lib/metanorma/document/components/inline/fmt_name_element.rb,
lib/metanorma/document/components/inline/fmt_stem_element.rb,
lib/metanorma/document/components/inline/fmt_xref_element.rb,
lib/metanorma/document/components/lists/ordered_list_type.rb,
lib/metanorma/document/components/text_elements/stem_type.rb,
lib/metanorma/document/relaton/org_subdivision_identifier.rb,
lib/metanorma/document/components/change/unique_identifier.rb,
lib/metanorma/document/components/data_types/iso15924_code.rb,
lib/metanorma/document/components/data_types/string_format.rb,
lib/metanorma/document/components/inline/asciimath_element.rb,
lib/metanorma/document/components/inline/fmt_title_element.rb,
lib/metanorma/document/components/inline/small_cap_element.rb,
lib/metanorma/document/components/sections/content_section.rb,
lib/metanorma/document/components/tables/header_table_cell.rb,
lib/metanorma/document/components/text_elements/stem_value.rb,
lib/metanorma/document/components/inline/biblio_tag_element.rb,
lib/metanorma/document/components/inline/enum_comma_element.rb,
lib/metanorma/document/components/inline/semx_child_element.rb,
lib/metanorma/document/components/inline/strong_raw_element.rb,
lib/metanorma/document/components/paragraphs/text_alignment.rb,
lib/metanorma/document/components/tables/vertical_alignment.rb,
lib/metanorma/document/components/ancillary_blocks/subfigure.rb,
lib/metanorma/document/components/contrib_metadata/signature.rb,
lib/metanorma/document/components/inline/attribution_element.rb,
lib/metanorma/document/components/inline/fmt_concept_element.rb,
lib/metanorma/document/components/inline/fmt_fn_body_element.rb,
lib/metanorma/document/components/inline/stem_inline_element.rb,
lib/metanorma/document/components/paragraphs/paragraph_block.rb,
lib/metanorma/document/components/reference_elements/callout.rb,
lib/metanorma/document/components/text_elements/ruby_element.rb,
lib/metanorma/document/components/text_elements/stem_element.rb,
lib/metanorma/document/components/text_elements/text_element.rb,
lib/metanorma/document/components/bib_data/bibliographic_item.rb,
lib/metanorma/document/components/blocks/basic_block_no_notes.rb,
lib/metanorma/document/components/data_types/formatted_string.rb,
lib/metanorma/document/components/data_types/localized_string.rb,
lib/metanorma/document/components/inline/display_text_element.rb,
lib/metanorma/document/components/inline/fmt_admitted_element.rb,
lib/metanorma/document/components/inline/fmt_fn_label_element.rb,
lib/metanorma/document/components/inline/name_with_id_element.rb,
lib/metanorma/document/components/multi_paragraph/quote_block.rb,
lib/metanorma/document/components/reference_elements/citation.rb,
lib/metanorma/document/components/reference_elements/footnote.rb,
lib/metanorma/document/components/sections/references_section.rb,
lib/metanorma/document/components/tables/paragraph_table_cell.rb,
lib/metanorma/document/components/ancillary_blocks/key_element.rb,
lib/metanorma/document/components/change/content_change_action.rb,
lib/metanorma/document/components/data_types/iso8601_date_time.rb,
lib/metanorma/document/components/empty_elements/basic_element.rb,
lib/metanorma/document/components/empty_elements/index_element.rb,
lib/metanorma/document/components/inline/fmt_preferred_element.rb,
lib/metanorma/document/components/inline/variant_title_element.rb,
lib/metanorma/document/components/multi_paragraph/review_block.rb,
lib/metanorma/document/components/text_elements/strike_element.rb,
lib/metanorma/document/components/text_elements/strong_element.rb,
lib/metanorma/document/components/ancillary_blocks/figure_block.rb,
lib/metanorma/document/components/contrib_metadata/iso10118_oid.rb,
lib/metanorma/document/components/contrib_metadata/iso14888_oid.rb,
lib/metanorma/document/components/inline/fmt_definition_element.rb,
lib/metanorma/document/components/inline/fmt_identifier_element.rb,
lib/metanorma/document/components/inline/fmt_sourcecode_element.rb,
lib/metanorma/document/components/inline/fmt_termsource_element.rb,
lib/metanorma/document/components/inline/fmt_xref_label_element.rb,
lib/metanorma/document/components/sections/hierarchical_section.rb,
lib/metanorma/document/components/text_elements/keyword_element.rb,
lib/metanorma/document/components/ancillary_blocks/example_block.rb,
lib/metanorma/document/components/ancillary_blocks/formula_block.rb,
lib/metanorma/document/components/ancillary_blocks/literal_block.rb,
lib/metanorma/document/components/change/attribute_change_action.rb,
lib/metanorma/document/components/text_elements/emphasis_element.rb,
lib/metanorma/document/components/inline/localized_string_element.rb,
lib/metanorma/document/components/multi_paragraph/admonition_type.rb,
lib/metanorma/document/components/text_elements/latexmath_element.rb,
lib/metanorma/document/components/text_elements/monospace_element.rb,
lib/metanorma/document/components/text_elements/subscript_element.rb,
lib/metanorma/document/components/text_elements/text_element_type.rb,
lib/metanorma/document/components/text_elements/underline_element.rb,
lib/metanorma/document/components/bib_data/bib_data_extension_type.rb,
lib/metanorma/document/components/contrib_metadata/integrity_value.rb,
lib/metanorma/document/components/inline/localized_strings_element.rb,
lib/metanorma/document/components/multi_paragraph/admonition_block.rb,
lib/metanorma/document/components/multi_paragraph/paragraphs_block.rb,
lib/metanorma/document/components/text_elements/small_caps_element.rb,
lib/metanorma/document/components/ancillary_blocks/sourcecode_block.rb,
lib/metanorma/document/components/empty_elements/line_break_element.rb,
lib/metanorma/document/components/empty_elements/page_break_element.rb,
lib/metanorma/document/components/inline/fmt_annotation_end_element.rb,
lib/metanorma/document/components/text_elements/superscript_element.rb,
lib/metanorma/document/components/inline/fmt_annotation_body_element.rb,
lib/metanorma/document/components/paragraphs/paragraph_with_footnote.rb,
lib/metanorma/document/components/inline/fmt_annotation_start_element.rb,
lib/metanorma/document/components/reference_elements/reference_format.rb,
lib/metanorma/document/components/inline/title_with_annotation_element.rb,
lib/metanorma/document/components/reference_elements/reference_element.rb,
lib/metanorma/document/components/inline/fmt_footnote_container_element.rb,
lib/metanorma/document/components/reference_elements/index_xref_element.rb,
lib/metanorma/document/components/empty_elements/horizontal_rule_element.rb,
lib/metanorma/document/components/reference_elements/reference_to_id_element.rb,
lib/metanorma/document/components/reference_elements/reference_to_link_element.rb,
lib/metanorma/document/components/contrib_metadata/contribution_element_metadata.rb,
lib/metanorma/document/components/reference_elements/reference_to_citation_element.rb,
lib/metanorma/document/components/reference_elements/reference_to_id_with_paragraph_element.rb

Overview

Metanorma::Document is a class-based document model for Metanorma. It deals with creating a class-based document to be used for handling and converting Metanorma XML documents.

It uses Lutaml::Model::Serializable as the base for all document elements, providing XML serialization/deserialization via a declarative DSL.

It is intended to replace the current (previous?) system of Metanorma programs communicating with one another with XML files, but also allow for a seamless migration from/to those.

Defined Under Namespace

Modules: Components, Relaton Classes: Root

Constant Summary collapse

VERSION = 
"0.2.0"
Version = 
VERSION
DataTypes =
Deprecated.

Use Components::DataTypes instead

Metanorma::Document::Components::DataTypes

Class Method Summary collapse

Class Method Details

.from_file(file) ⇒ Object

Raises:

  • (NotImplementedError) 


26
27
28
29
30
31
32
33
34
35
 
# File 'lib/metanorma/document.rb', line 26

def from_file(file)
  # For now, we cannot parse arbitrary XML into Lutaml models without knowing
  # the target class. This will be addressed in a future refactoring.
  # BasicDocument does not have XML root mapping and cannot be used to parse
  # documents directly. Use StandardDocument or IsoDocument for specific flavors.
  raise NotImplementedError,
        "BasicDocument cannot parse XML directly. " \
        "Use StandardDocument or IsoDocument for specific document flavors, " \
        "or implement a custom parser that determines the appropriate document class."
end