metanorma-plugin-lutaml 0.7.14 → 0.7.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd66711f9da2a1623acfdb2b6b24d2cea272b6d318cf17dbbdc0167cf69738c2
-  data.tar.gz: 5bd65ea93f25f27e57902389acc574ceb62105ab68a24ab4a44de22e88a9081d
+  metadata.gz: '084aa029d93896c415377c7d2cf97cbc449c4105e838496cc8d598ecf3aa9a5f'
+  data.tar.gz: 50347ca8bb82cb0cf10a3c07eb2df5386180395948b06dd7a266bcd50565bb93
 SHA512:
-  metadata.gz: bc2223f766f4edf63c2cbf69a487306f2575d5448960a56a92f53a5b4fdf712d4c8246ca7bfc48d26b72bec4d054c3266c6eb504f181261490a3cc67770a9c6a
-  data.tar.gz: 681b2571df350dd559241c0047b0a618a083bfc9d52f9b3dc8adf5dc67925b0ab07b9fdf21aa789ae895325edc14adadae2c83c384ad036f2674864e4315b2aa
+  metadata.gz: 5298953ac429e585eab80983840e541f83be422e7ffec84c8c4dd398aba5a3e0534146e775088e9dcf6659ef3747718953a95d25b37b3b76ae50ad2ea971057f
+  data.tar.gz: 6533e3763431b164961944be151092bec140137d244b8fad2664d59aec2854d8bc955bb733c1a439eddb3450aa239aff9d5bfdfa02814b34f15ce920a304dd35

data/README.adoc

@@ -907,8 +907,36 @@ packages:
 guidance: "path/to/guidance.yaml"
 -----
 
-Please refer to `lutaml_klass_table` section for how to configure the guidance
-yaml file.
+The guidance file should be in the following format:
+
+[source,yaml]
+----
+---
+classes:
+  - name: "NameOfClass"
+    attributes:
+      - name: Name Of Attribute (e.g. gml:boundedBy)
+        used: false
+        guidance: |
+          Drop guidance message here.
+...
+----
+
+If you want to define the guidance, you can define the `name` of the class
+under `classes`.  Then define which `attributes` you want to add guidance by the
+`name`. Set `used` to show the attribute is used or not. Drop the message of
+guidance in `guidance`.
+
+The `name` of class can be defined in the following ways:
+
+* `name: "NameOfClass"` specifies the name of the `class`.
+  (e.g. `name: "Building"`)
+  If there are multiple classes with the same name, it is recommended to
+  specify the class by absolute path.
+
+* `name: "::NameOfPackage::NameOfClass"` specifies the name of the `class` in
+  `absolute` path.
+  (e.g. `name: "::EA_Model::Conceptual Models::CityGML2.0::bldg::Building"`)
 
 == Documentation
 

data/lib/metanorma/plugin/lutaml/version.rb

@@ -1,7 +1,7 @@
 module Metanorma
   module Plugin
     module Lutaml
-      VERSION = "0.7.14".freeze
+      VERSION = "0.7.15".freeze
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.7.14
+  version: 0.7.15
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-11-14 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: asciidoctor