tbx 0.1.0 → 0.1.2

data/lib/tbx/transac_grp.rb

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
 module Tbx
+  # Groups a `<transac>` transaction element with its date and
+  # responsibility information.
+  #
+  # Children: `transac` (required), then date, note, ref, transacNote, xref.
+  #
+  # Schema source: TBXcoreStructV03.rng `<define name="transacGrp">`
   class TransacGrp < Lutaml::Model::Serializable
     attribute :id, :string
     attribute :transac, ::Tbx::Transac
@@ -13,7 +19,7 @@ module Tbx
     xml do
       root "transacGrp"
       mixed_content
-      namespace ::Tbx::Namespaces::TbxNamespace
+      namespace ::Tbx::Namespace
 
       map_attribute "id", to: :id
       map_element "transac", to: :transac

data/lib/tbx/transac_note.rb

@@ -1,18 +1,29 @@
 # frozen_string_literal: true
 
 module Tbx
+  # Transaction note element `<transacNote>`.
+  #
+  # Provides additional information about a transaction, typically identifying
+  # the person or organization responsible.
+  #
+  # Permitted `type` values:
+  #
+  # * Basic module: `responsibility` — person/org responsible for the
+  #   transaction (DC-451)
+  #
+  # Content is plain text only (no inline elements per the core RNG).
+  #
+  # Schema source: TBXcoreStructV03.rng `<define name="transacNote">`;
+  # data category: Basic.tbxmd.
   class TransacNote < Lutaml::Model::Serializable
-    attribute :id, :string
-    attribute :lang, Lutaml::Xml::W3c::XmlLangType
-    attribute :target, :string
-    attribute :datatype, :string
-    attribute :type, :string
-    attribute :content, :string, collection: true
+    include Tbx::DataElement
+
+    TYPES = Modules::Basic::TRANSAC_NOTE_TYPES.freeze
 
     xml do
       root "transacNote"
       mixed_content
-      namespace ::Tbx::Namespaces::TbxNamespace
+      namespace ::Tbx::Namespace
 
       map_attribute "id", to: :id
       w3c_attributes :lang

data/lib/tbx/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tbx
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/tbx/xref.rb

@@ -1,7 +1,23 @@
 # frozen_string_literal: true
 
 module Tbx
+  # External cross-reference element `<xref>`.
+  #
+  # The `target` attribute holds a URI (http/https) pointing to an external
+  # resource. Unlike `Ref`, which uses IDREF for internal references, Xref
+  # uses anyURI for external resources.
+  #
+  # Permitted `type` values:
+  #
+  # * Min module: `externalCrossReference` — reference to an external resource
+  # * Basic module: `externalCrossReference` — external reference (DC-226),
+  #   `xGraphic` — graphic image associated with the concept (DC-2920)
+  #
+  # Schema source: TBXcoreStructV03.rng `<define name="xref">`;
+  # data categories: Basic.tbxmd.
   class Xref < Lutaml::Model::Serializable
+    TYPES = Modules::Min::XREF_TYPES
+      .merge(Modules::Basic::XREF_TYPES).freeze
     attribute :id, :string
     attribute :target, :string
     attribute :type, :string
@@ -10,7 +26,7 @@ module Tbx
     xml do
       root "xref"
       mixed_content
-      namespace ::Tbx::Namespaces::TbxNamespace
+      namespace ::Tbx::Namespace
 
       map_attribute "id", to: :id
       map_attribute "target", to: :target

data/lib/tbx.rb

@@ -4,7 +4,14 @@ require "lutaml/model"
 require_relative "tbx/version"
 
 module Tbx
-  autoload :Namespaces, "#{__dir__}/tbx/namespaces"
+  module Modules
+    autoload :Min, "#{__dir__}/tbx/modules/min"
+    autoload :Basic, "#{__dir__}/tbx/modules/basic"
+    autoload :Linguist, "#{__dir__}/tbx/modules/linguist"
+    autoload :CoreTypes, "#{__dir__}/tbx/modules/core_types"
+  end
+
+  autoload :Namespace, "#{__dir__}/tbx/namespace"
 
   # Inline elements
   autoload :Ec, "#{__dir__}/tbx/ec"
@@ -18,6 +25,9 @@ module Tbx
   autoload :P, "#{__dir__}/tbx/p"
   autoload :Title, "#{__dir__}/tbx/title"
 
+  # Shared concerns
+  autoload :DataElement, "#{__dir__}/tbx/data_element"
+
   # Data elements
   autoload :Admin, "#{__dir__}/tbx/admin"
   autoload :AdminGrp, "#{__dir__}/tbx/admin_grp"
@@ -45,6 +55,9 @@ module Tbx
 
   # Structural elements
   autoload :Term, "#{__dir__}/tbx/term"
+  autoload :TermComp, "#{__dir__}/tbx/term_comp"
+  autoload :TermCompGrp, "#{__dir__}/tbx/term_comp_grp"
+  autoload :TermCompSec, "#{__dir__}/tbx/term_comp_sec"
   autoload :TermSec, "#{__dir__}/tbx/term_sec"
   autoload :LangSec, "#{__dir__}/tbx/lang_sec"
   autoload :ConceptEntry, "#{__dir__}/tbx/concept_entry"

data/reference-docs/README.adoc

@@ -0,0 +1,109 @@
+= Reference Documentation
+
+This directory contains official TBX schema, dialect, and module reference
+files from https://ltac-global.org[LTAC Global] (LTAC-Global on GitHub).
+
+== Source repositories
+
+All files below are sourced from the
+https://github.com/LTAC-Global[LTAC-Global GitHub organization] and are
+used under their respective licenses for reference purposes.
+
+=== Dialects
+
+Dialects define a specific profile of TBX with Schematron constraints,
+RELAX NG schemas, and example files.
+
+|===
+| Directory | Source repository | Description
+
+| `schemas/TBX-Basic_dialect_v1/`
+| https://github.com/LTAC-Global/TBX-Basic_dialect[TBX-Basic_dialect]
+| TBX-Basic dialect (DCA + DCT schemas, example files, bundled modules)
+
+| `schemas/TBX-Min_dialect/`
+| https://github.com/LTAC-Global/TBX-Min_dialect[TBX-Min_dialect]
+| TBX-Min dialect (DCA + DCT Schematron, NVDL)
+
+| `schemas/TBX-Core_dialect/`
+| https://github.com/LTAC-Global/TBX-Core_dialect[TBX-Core_dialect]
+| TBX-Core dialect (integrated RNG, Schematron, example)
+
+| `schemas/TBX-Linguist_dialect/`
+| https://github.com/LTAC-Global/TBX-Linguist_dialect[TBX-Linguist_dialect]
+| TBX-Linguist dialect (DCA + DCT Schematron, integrated RNG, examples)
+|===
+
+=== Modules
+
+Modules define data categories and structural rules for a specific level
+of terminological detail.
+
+|===
+| Directory | Source repository | Key files
+
+| `schemas/TBX-Basic_dialect_v1/Modules/TBX_min_module/`
+| https://github.com/LTAC-Global/TBX_min_module[TBX_min_module]
+| `Min.rng`, `Min.sch`, `Min.tbxmd`
+
+| `schemas/TBX-Basic_dialect_v1/Modules/TBX_basic_module/`
+| https://github.com/LTAC-Global/TBX_basic_module[TBX_basic_module]
+| `Basic.rng`, `Basic.sch`, `Basic.tbxmd`
+
+| `schemas/TBX_linguist_module/`
+| https://github.com/LTAC-Global/TBX_linguist_module[TBX_linguist_module]
+| `Linguist.rng`, `Linguist.sch`, `Linguist.tbxmd`
+
+| `schemas/TBX_termComp_module/`
+| https://github.com/LTAC-Global/TBX_termComp_module[TBX_termComp_module]
+| `TermComp-namespace.rng`
+|===
+
+=== Core schema
+
+|===
+| File | Source repository | Description
+
+| `schemas/TBXcoreStructV03.rng`
+| https://github.com/LTAC-Global/TBX_core_module[TBX_core_module]
+| TBX core structural RELAX NG schema
+
+| `schemas/TBX_core.xsd`
+| https://github.com/LTAC-Global/TBX_core_module[TBX_core_module]
+| TBX core XML Schema (XSD)
+|===
+
+=== Module description format
+
+|===
+| Directory | Source repository | Key files
+
+| `schemas/TBX_module_description_xml/`
+| https://github.com/LTAC-Global/TBX_module_description_xml[TBX_module_description_xml]
+| `tbxmd.rng` -- RELAX NG schema for `.tbxmd` module definition files
+|===
+
+=== Implementation guide
+
+|===
+| Directory | Source repository | Key files
+
+| `schemas/TBX-Basic_ImplementationGuide/`
+| https://github.com/LTAC-Global/TBX-Basic_ImplementationGuide[TBX-Basic_ImplementationGuide]
+| `TBX-Basic_ImplementationGuide.pdf`
+|===
+
+== TBX module hierarchy
+
+The TBX standard (ISO 30042:2019) defines a modular architecture:
+
+....
+TBX-Core          structural foundation (element definitions)
+  +-- TBX-Min     minimal data categories for basic terminology
+  +-- TBX-Basic   standard data categories for general terminology
+  +-- TBX-Linguist  extended data categories for linguistic detail
+  +-- TBX-TermComp  term composition and decomposition
+....
+
+Each dialect (TBX-Min, TBX-Basic, etc.) combines the core structure with
+one or more modules and adds dialect-specific Schematron constraints.