metanorma-plugin-lutaml 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6975d55ed93f086ff54367a880fe6cd997da1040dd5266d3c5c2f5c984370801
-  data.tar.gz: fa336cbe86550862521a4fe051a69dfdd8e809cc3ba652c07482ab6f9d5bb7ac
+  metadata.gz: 202335c2a56ade17a5bdfedd489b6c39363b256ebbaa2e2cbfe812a6bb6995e5
+  data.tar.gz: 9637bc5a68bbbe8cda105e74a537ae7e41d5676f584e64e907ad26ba6cf50082
 SHA512:
-  metadata.gz: bf4817cf9ec3c41195ae30425bf4462f58dffce5773f4f07e146915a13fc7c1f9e46be8285c5f4814a673a7558aacb937b7e0dfb3939c644ad9b8cb438c1a580
-  data.tar.gz: e987082dd620fcf4b455204e86607df45632c5ce9bdca7dfd30815c1c720a6facab339a436d90cc8b78809c608c2271a8f7cb3e32dbad66205a25e3f11c525a7
+  metadata.gz: 7e183219067f431d7b839d59ab3e5c8a8b3f54b335cb1e232297f1fa997e7f7abafa4a0858d5398a034c2a025d46feef240f3e71b14db7730fb1789b2dd11afb
+  data.tar.gz: 400132cae1b7b1b3f03414f4c4ab8b16edde68ab285cd192bd0894d913bee26985182aaf880c2a4ddac1935541bac62913679424e433d88bacc8242c7fcabede

data/README.adoc

@@ -1,21 +1,36 @@
-= metanorma-plugin-lutaml
+= Metanorma LutaML plugin (metanorma-plugin-lutaml)
 
 image:https://github.com/metanorma/metanorma-plugin-lutaml/workflows/rake/badge.svg["Build Status", link="https://github.com/metanorma/metanorma-plugin-lutaml/actions?workflow=rake"]
 
-== Functionality
+== Purpose
 
-Metanorma plugin that allows you to access lutaml objects from a Metanorma document
+LutaML is a data model accessor that supports various data model formats,
+including:
 
-=== Installation
+* EXPRESS (`*.exp` files)
+* OMG UML in XMI format (`*.xmi` files)
+
+This plugin allows you to access LutaML models from within a Metanorma document.
+
+== Installation
 
 [source,console]
 ----
 $ gem install metanorma-plugin-lutaml
 ----
 
-=== Usage, `lutaml` macro
 
-Given `example.exp` file with the content:
+== Usage with EXPRESS
+
+=== General
+
+LutaML supports accessing EXPRESS models via the
+https://github.com/lutaml/expressir[Expressir] parser.
+
+
+=== Usage of the `lutaml_express` EXPRESS macro
+
+Given an `example.exp` EXPRESS file with the content:
 
 [source,exp]
 ----
@@ -42,11 +57,11 @@ SCHEMA test_schema 'test';
 END_SCHEMA;
 ----
 
-And the `lutaml` macro block:
+And the `lutaml_express` macro block:
 
 [source,adoc]
 -----
-[lutaml,example.exp,my_context]
+[lutaml_express,example.exp,my_context]
 ----
 
 {% for schema in my_context.schemas %}
@@ -67,13 +82,15 @@ Where:
 * `{example.exp}` is the location of the EXPRESS schema file (`*.exp`) that
 contains data to be loaded. Location of the file is computed relative to the
 source directory that `[lutaml]` is used (e.g., if
-`[lutaml,example.exp,my_context]` is invoked in an `.adoc` file located at
+`[lutaml_express,example.exp,my_context]` is invoked in an `.adoc` file located at
 `/foo/bar/doc.adoc`, the data file is expected to be found at
 `/foo/bar/example.exp`);
 
-* `{my_context}` is the name where the EXPRESS Repository read from the .exp
-file can be accessed with. Context object is a serialized
-`Expressir::Model::Repository` object with all variable names available. See
+* `{my_context}` is the name where the EXPRESS Repository read from the `.exp`
+file can be accessed with.
+
+** The `context` object is a serialized `Expressir::Model::Repository` object
+with all variable names available. See
 https://github.com/lutaml/expressir[Expressir] docs for reference.
 `{my_context}` has `schemas` method to access Expressir
 https://github.com/lutaml/expressir/blob/master/lib/expressir/model/schema.rb[schemas]
@@ -121,7 +138,7 @@ Example of usage:
 = Document title
 Author
 :lutaml-express-index: my_custom_name; /path/to/express_files; cache=/path/to/cache_file.yaml
-[lutaml,my_custom_name,my_context]
+[lutaml_express,my_custom_name,my_context]
 ----
 {% for schema in my_context.schemas %}
 == {{schema.id}}
@@ -142,7 +159,7 @@ diagram MyView {
   enum AddressClassProfile {
     imlicistAttributeProfile: CharacterString [0..1] {
       definition
-        this is multiline with `ascidoc`
+        this is multiline with `asciidoc`
       end definition
     }
   }
@@ -193,7 +210,7 @@ diagram MyView {
 ----
 
 
-=== Usage, `lutaml_uml_attributes_table` macro
+=== Usage of `lutaml_uml_attributes_table` macro
 
 This macro allows to quickly render data model attributes/values tables.
 
@@ -246,7 +263,7 @@ Will produce this output:
 |===
 -----
 
-In case of "enumeration"(AddressClassProfile) entity:
+In case of "enumeration" (AddressClassProfile) entity:
 
 [source,adoc]
 -----
@@ -264,12 +281,12 @@ Will produce this output:
 |===
 |Name |Definition
 
-|imlicistAttributeProfile |this is multiline with `ascidoc`
+|imlicistAttributeProfile |this is multiline with `asciidoc`
 
 |===
 -----
 
-=== Usage, `lutaml_uml_datamodel_description` macro
+=== Usage of `lutaml_uml_datamodel_description` macro
 
 This macro allows to quickly render data model packages and its dependent
 objects for supplied XMI file.
@@ -338,7 +355,7 @@ Where:
 
 * `[.after, package="Another"]` - macro with text to be inserted before(after in case of `.before` name) the package
 
-* `[.diagram_include_block]` - macro to automatically include diagram images. Attribute `base_path` is a required attribute to supply path prefix where to look for a digram image. `format` is an optional attribute that tells what file extention to use when including diagram file. The logic is as follows:
+* `[.diagram_include_block]` - macro to automatically include diagram images. Attribute `base_path` is a required attribute to supply path prefix where to look for a diagram image. `format` is an optional attribute that tells what file extension to use when including diagram file. The logic is as follows:
 [source,adoc]
 -----
 {% for diagram in package.diagrams %}
@@ -351,22 +368,23 @@ image::{{ image_base_path }}/{{ diagram.xmi_id }}.{{ format | default: 'png' }}[
 {% endif %}
 {% endfor %}
 -----
-Eg: script will take package diagrams supplied in xmi file and will try to include `image` with the name equal to diagram' xmi_id attribute plus `.png`. Also one can add any text to the macro text, it will be added as paragraph before each image include.
+
+For instance, the script will take package diagrams supplied in the XMI file and will try to include `image` with the name equal to diagram' xmi_id attribute plus `.png`. Also one can add any text to the macro text, it will be added as paragraph before each image include.
 
 * `[.diagram_include_block, package="Another"]` - same as above, but diagram will be included only for supplied package name
 
-* `[.include_block, base_path="spec/fixtures"]` - macro to inlude files(adoc/liquid) for each package name. Attribute `base_path` is a required attribute to supply path prefix where to look for file to include. Macro will look for a file called `base_path` + `/` `_package_name`(downcase, replace : -> '', ' ' -> '_') + `.adoc`[`.liquid`], eg for package 'My Package name' and `base_path` eq to `my/path`, macro will look for the following file path: `my/path/_my_package_name.adoc`.
+* `[.include_block, base_path="spec/fixtures"]` - macro to include files (`*.adoc` or `*.liquid`) for each package name. Attribute `base_path` is a required attribute to supply path prefix where to look for file to include. Macro will look for a file called `base_path` + `/` `_package_name`(downcase, replace : -> '', ' ' -> '_') + `.adoc`[`.liquid`], eg for package 'My Package name' and `base_path` eq to `my/path`, macro will look for the following file path: `my/path/_my_package_name.adoc`.
 
 * `[.include_block, package="Another", base_path="spec/fixtures"]` - same as above, but include block will be included only for supplied package name
 
-In addition to macroses listed above that can be used only inside `lutaml_uml_datamodel_description` macro there is another macro called `lutaml_figure`. `lutaml_figure` is used to lookup and reference xmi package diagrams. The syntax is as follows:
+In addition to the macros listed above that can be used only inside `lutaml_uml_datamodel_description` macro there is another macro called `lutaml_figure`. `lutaml_figure` is used to lookup and reference xmi package diagrams. The syntax is as follows:
 
 [source,adoc]
 -----
 This is lutaml_figure::[package="Wrapper root package", name="Fig B1 Full model"] figure
 -----
 
-This code will be transformed into `<<figure-{diagram.xmi_id}>>` and will point to diagram figure. One can only use this macro when document rendered `lutaml_uml_datamodel_description` macro as it needs diagram lookup table in order to refernce package diagram.
+This code will be transformed into `<<figure-{diagram.xmi_id}>>` and will point to diagram figure. One can only use this macro when document rendered `lutaml_uml_datamodel_description` macro as it needs diagram lookup table in order to reference package diagram.
 
 Will produce this output:
 
@@ -380,18 +398,17 @@ Diagram text
 
 [[figure-EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29]]
 .CityGML Package Diagram
-image::requirements//EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29.png[]
+image::requirements/EAID_ACBB5EE3_3428_40f5_9C7C_E41923419F29.png[]
 
 BuildingFurnitureFunctionValue is a code list that enumerates the different purposes of a BuildingFurniture.
 
 [[figure-EAID_938AE961_1C57_4052_B964_997D1894A58D]]
 .Use of ISO and OASIS standards in CityGML
-image::requirements//EAID_938AE961_1C57_4052_B964_997D1894A58D.png[]
+image::requirements/EAID_938AE961_1C57_4052_B964_997D1894A58D.png[]
 
 The CityGML package is organized into
 2 packages with 1 modules:
 
-[arabic]
 . Another package
 . CityTML package
 
@@ -401,18 +418,17 @@ Content for CityGML package
 
 ==== Defining tables
 
-[arabic]
-.<<tab-P-another-C-abstractatomictimeseries>> -- Elements of Another::AbstractAtomicTimeseries
+.<<tab-P-another-C-{XMI_ID}>> -- Elements of &#8220;Another::AbstractAtomicTimeseries&#8221; (class)
 
-[[tab-P-another-C-abstractatomictimeseries]]
-.Elements of Another::AbstractAtomicTimeseries
+[[tab-P-another-C-{XMI_ID}]]
+.Elements of &#8220;Another::AbstractAtomicTimeseries&#8221; (class)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 h|Name: 7+| AbstractAtomicTimeseries
 h|Definition: 7+|
 h|Stereotype: 7+| interface
 h|Abstract: 7+|
-.1+h|Associations: 7+| (none)
+h|Associations: 7+| (none)
 .4+h|Public attributes:
 | _Name_
 2+| _Definition_
@@ -446,7 +462,7 @@ h|Constraints: 7+| (none)
 text after CityGML package
 -----
 
-In addition to just supplying XMI file, this macro also supports YAML
+In addition to just supplying an XMI file, this macro also supports a YAML
 configuration file.
 
 The format for using YAML is this:
@@ -480,10 +496,14 @@ NOTE: In this example, it is equal to the following regular expression: `/^Packa
 Usage with macro:
 
 [source,adoc]
------
+--
 [lutaml_uml_datamodel_description, path/to/example.xmi, path/to/config.yml]
-....
------
+----
+[.diagram_include_block, base_path="models/Images", format="png"]
+...
+...
+----
+--
 
 The macro processor will read supplied YAML file and arrange packages according
 to the order supplied in the config file, also all packages supplied as `skip`

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages.liquid

@@ -10,7 +10,11 @@
 {% elsif is_package_spare == 'Spare' %}{% continue %}
 {% endif %}
 
-{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
+
+[[lutaml-section-{{ package_name }}]]
+{{equalsigns}} {{ package.name }} package
+
 {{equalsigns}}= {{ package.name }} overview
 
 {% assign before_package_key = 'before;' | append: package.name %}
@@ -28,7 +32,7 @@
 {% if package.packages.size > 0 %}The {{ package.name }} package is organized into
 {{ package.packages.size }} packages{% assign modules_nested_size = 0 %}{% for module in package.packages %}{% assign modules_nested_size = modules_nested_size | plus: module.packages.size %}{% endfor %}{% if modules_nested_size > 0 %} with {{modules_nested_size}} modules{% endif %}:
 {% endif %}
-[arabic]
+
 {% for module in package.packages %}
 {% if module.packages.length > 0 %}
 . {{ module.name }} package comprises:
@@ -44,14 +48,14 @@
 
 {{equalsigns}}= Defining tables
 
-[arabic]
 {% for klass in package.classes %}
 {% assign is_klass_spare = klass.name | slice: 0,5 %}
 {% if is_klass_spare == 'old: ' %}{% continue %}
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-.<<tab-P-{{ package_name }}-C-{{ klass_name }}>> -- Elements of {{ package.name }}::{{ klass.name }}
+{% assign klass_xid = klass.xmi_id %}
+.<<tab-P-{{ package_name }}-C-{{ klass_xid }}>> -- Elements of "{{ package.name }}::{{ klass.name }}"
 
 {% endfor %}
 {% for enum in package.enums %}
@@ -60,7 +64,8 @@
 {% elsif is_enum_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign enum_name = enum.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-.<<tab-P-{{ package_name }}-E-{{ enum_name }}>> -- Elements of {{ package.name }}::{{ enum.name }}
+{% assign enum_xid = enum.xmi_id %}
+.<<tab-P-{{ package_name }}-E-{{ enum_xid }}>> -- Elements of "{{ package.name }}::{{ enum.name }}"
 
 {% endfor %}
 {% for data_type in package.data_types %}
@@ -69,7 +74,8 @@
 {% elsif is_data_type_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign data_type_name = data_type.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-.<<tab-P-{{ package_name }}-DT-{{ data_type_name }}>> -- Elements of {{ package.name }}::{{ data_type.name }}
+{% assign data_type_xid = data_type.xmi_id %}
+.<<tab-P-{{ package_name }}-DT-{{ data_type_xid }}>> -- Elements of "{{ package.name }}::{{ data_type.name }}"
 
 {% endfor %}
 
@@ -116,7 +122,7 @@
 
 {% assign after_package_key = 'after;' | append: package.name %}
 {% if additional_context[after_package_key] %}
-{{equalsigns}}= Additional Information
+{{equalsigns}}= Additional information
 {% for after in additional_context[after_package_key] %}
 {{ after.text }}
 {% endfor %}

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid

@@ -3,8 +3,9 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-C-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+{% assign klass_xid = klass.xmi_id %}
+[[tab-P-{{ package_name }}-C-{{ klass_xid }}]]
+.Elements of "{{ package.name }}::{{ klass.name }}" (class)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -24,14 +25,14 @@ h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
 h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
 {% endif %}
 
-h|Abstract: 7+| {{ klass.is_abstract }}
+h|Abstract: 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
 {% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
 {% if aggregations.size > 0 %}
 .{{aggregations.size | plus: 1}}+h|Associations:
-4+|_Association with:_
-|_Obligation_
+4+| _Association with_
+| _Obligation_
 | _Maximum occurrence_
-|_Provides:_
+| _Provides_
 
 {% for assoc in aggregations %}
 4+| {{assoc.member_end}}
@@ -41,9 +42,9 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-
-.1+h|Associations: 7+| (none)
+h| Associations: 7+| (none)
 {% endif %}
+
 {% if klass.attributes.size > 0 %}
 .{{klass.attributes.size | plus: 1}}+h|Public attributes:
 | _Name_
@@ -63,12 +64,12 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Public attributes:
+h| Public attributes:
 7+| (none)
 {% endif %}
 
 {% if klass.constraints.size > 0 %}
-.{{ klass.constraints.size }}+|*Constraints:*
+.{{ klass.constraints.size }}+h| Constraints:
 {% for constr in klass.constraints %}
 7+| `{{ constr.body }}`
 

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary.liquid

@@ -19,7 +19,7 @@
 |===
 
 h|Description:    | {{ package.definition }}
-h|Parent Package: | {{ context.name }}
+h|Parent package: | {{ context.name }}
 h|Stereotype:     | «{{ package.stereotype }}»
 
 |===
@@ -37,7 +37,7 @@ h|Stereotype:     | «{{ package.stereotype }}»
 {% endif %}
 
 {% if basic_types.size > 0 %}
-{{equalsigns}}= Basic Types
+{{equalsigns}}= Basic types
 
 {% include "packages_data_dictionary_classes", classes: basic_types %}
 {% endif %}
@@ -49,13 +49,13 @@ h|Stereotype:     | «{{ package.stereotype }}»
 {% endif %}
 
 {% if code_lists.size > 0 %}
-{{equalsigns}}= Code Lists
+{{equalsigns}}= Code lists
 
 {% include "packages_data_dictionary_classes", classes: code_lists %}
 {% endif %}
 
 {% if package.data_types.size > 0 %}
-{{equalsigns}}= Data Types
+{{equalsigns}}= Data types
 
 {% for data_type in package.data_types %}
 {% capture generalizations %}{% for assoc in data_type.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
@@ -63,39 +63,41 @@ h|Stereotype:     | «{{ package.stereotype }}»
 [cols="1a"]
 |===
 |*{{ data_type.name }}*
-|[cols="1,4",frame=none,grid=none]
+|[cols="1,4"]
 !===
-!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ data_type.definition }}
-!{nbsp}{nbsp}{nbsp}{nbsp}Subclass of: ! {{ generalizations }}
-!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: !  «DataType»
+!Definition:  ! {{ data_type.definition }}
+!Subclass of: ! {{ generalizations }}
+!Stereotype:  !  «DataType»
 !===
 {% if data_type.associations.size > 0 %}
 {% capture rendered_associations %}
 {% for assoc in data_type.associations %}
 {% if assoc.member_end_attribute_name.size > 0 %}
 {% capture cardinality %}{% if assoc.member_end_cardinality.min == 'C' %}[0..{{ assoc.member_end_cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ assoc.member_end_cardinality.max }}]{% endif %}{% endcapture %}
-!{set:cellbgcolor:#FFFFFF} {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
+! {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
 {% endif %}
 {% endfor %}
 {% endcapture %}
 {% if rendered_associations.size > 0 %}
-|[cols="15,20,60",frame=none,grid=none,options="header"]
+|
+[cols="15,20,60",options="header"]
 !===
-!{set:cellbgcolor:#DDDDDD} *Role name* !*Target class and multiplicity*  !*Definition*
+! Role name !Target class and multiplicity !Definition
 {{ rendered_associations }}
 !===
 {% endif %}
 {% endif %}
 {% if data_type.attributes.size > 0 %}
-|[cols="15,20,60",frame=none,grid=none,options="header"]
+|
+[cols="15,20,60",options="header"]
 !===
-!{set:cellbgcolor:#DDDDDD} *Attribute* !*Value type and multiplicity* !*Definition*
+! Attribute ! Value type and multiplicity ! Definition
 {% for attr in data_type.attributes %}
 {% capture cardinality %}{% if attr.cardinality.min == 'C' %}[0..{{ attr.cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ attr.cardinality.max }}]{% endif %}{% endcapture %}
-!{set:cellbgcolor:#FFFFFF} {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
+! {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
 {% endfor %}
 !===
-|{set:cellbgcolor:#FFFFFF} Note: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+| NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
 {% endif %}
 |===
 
@@ -111,18 +113,20 @@ h|Stereotype:     | «{{ package.stereotype }}»
 [cols="1a"]
 |===
 |*{{ enum.name }}*
-|[cols="1,4",frame=none,grid=none]
+|
+[cols="1,4"]
 !===
-!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ enum.definition }}
-!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: ! «Enumeration»
+!Definition: ! {{ enum.definition }}
+!Stereotype: ! «Enumeration»
 !===
 {% if enum.values.size > 0 %}
-|[cols="1,4",frame=none,grid=none,options="header"]
+|
+[cols="1,4",options="header"]
 !===
-^!{set:cellbgcolor:#DDDDDD} *Literal value* !*Definition*
+! Literal value !Definition
 
 {% for val in enum.values %}
-^!{set:cellbgcolor:#FFFFFF} {{ val.name }}  !{{ val.definition }}
+! {{ val.name }}  !{{ val.definition }}
 {% endfor %}
 !===
 {% endif %}
@@ -160,7 +164,7 @@ h|Stereotype:     | «{{ package.stereotype }}»
 
 {% assign after_package_key = 'after;' | append: package.name %}
 {% if additional_context[after_package_key] %}
-{{equalsigns}}= Additional Information
+{{equalsigns}}= Additional information
 {% for after in additional_context[after_package_key] %}
 {{ after.text }}
 {% endfor %}

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary_classes.liquid

@@ -4,39 +4,61 @@
 [cols="1a"]
 |===
 |*{{ klass.name }}*
-|[cols="1,4",frame=none,grid=none]
+|
+[cols="1,4"]
 !===
-!{nbsp}{nbsp}{nbsp}{nbsp}Definition: ! {{ klass.definition }}
-!{nbsp}{nbsp}{nbsp}{nbsp}Subclass of: ! {{ generalizations }}
-!{nbsp}{nbsp}{nbsp}{nbsp}Stereotype: !  «{{ klass.stereotype }}»
+! Definition:  ! {{ klass.definition }}
+! Subclass of: ! {{ generalizations }}
+! Stereotype:  ! «{{ klass.stereotype }}»
 !===
+
 {% if klass.associations.size > 0 %}
 {% capture rendered_associations %}
 {% for assoc in klass.associations %}
+
 {% if assoc.member_end_attribute_name.size > 0 %}
+
 {% capture cardinality %}{% if assoc.member_end_cardinality.min == 'C' %}[0..{{ assoc.member_end_cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ assoc.member_end_cardinality.max }}]{% endif %}{% endcapture %}
-!{set:cellbgcolor:#FFFFFF} {{ assoc.member_end_attribute_name }}  !<<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }} ! {{ assoc.definition }}
+
+! {{ assoc.member_end_attribute_name }}
+! <<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }}
+! {{ assoc.definition }}
+
 {% endif %}
 {% endfor %}
 {% endcapture %}
+
 {% if rendered_associations.size > 0 %}
-|[cols="15,20,60",frame=none,grid=none,options="header"]
+|
+[cols="15,20,60",options="header"]
 !===
-!{set:cellbgcolor:#DDDDDD} *Role name* !*Target class and multiplicity*  !*Definition*
+! *Role name*
+! *Target class and multiplicity*
+! *Definition*
 {{ rendered_associations }}
 !===
 {% endif %}
+
 {% endif %}
 {% if klass.attributes.size > 0 %}
-|[cols="15,20,60",frame=none,grid=none,options="header"]
+|
+[cols="15,20,60",options="header"]
 !===
-!{set:cellbgcolor:#DDDDDD} *Attribute* !*Value type and multiplicity* !*Definition*
+! *Attribute*
+! *Value type and multiplicity*
+! *Definition*
 {% for attr in klass.attributes %}
+
 {% capture cardinality %}{% if attr.cardinality.min == 'C' %}[0..{{ attr.cardinality.max }}]{% elsif assoc.member_end_cardinality.min == 'M' and assoc.member_end_cardinality.max == '1' %}[1..1]{% else %}[{{ attr.cardinality.max }}]{% endif %}{% endcapture %}
-!{set:cellbgcolor:#FFFFFF} {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
+
+! {{ attr.name }}
+!<<{{ attr.type }}-section,{{ attr.name }}>> {{ cardinality }}
+!{{ attr.definition }}
+
 {% endfor %}
 !===
-|{set:cellbgcolor:#FFFFFF} Note: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+
+| NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
 {% endif %}
 |===
 

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_type.liquid

@@ -3,8 +3,9 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-DT-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+{% assign klass_xid = klass.xmi_id %}
+[[tab-P-{{ package_name }}-DT-{{ klass_xid }}]]
+.Elements of "{{ package.name }}::{{ klass.name }}" (data type)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -24,14 +25,14 @@ h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
 h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
 {% endif %}
 
-h|Abstract: 7+| {{ klass.is_abstract }}
+h|Abstract: 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
 {% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
 {% if aggregations.size > 0 %}
 .{{aggregations.size | plus: 1}}+h|Associations:
-4+|_Association with:_
-|_Obligation_
+4+| _Association with_
+| _Obligation_
 | _Maximum occurrence_
-|_Provides:_
+| _Provides_
 
 {% for assoc in aggregations %}
 4+| {{assoc.member_end}}
@@ -41,12 +42,11 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-
-.1+h|Associations: 7+| (none)
+h| Associations: 7+| (none)
 {% endif %}
 
 {% if klass.attributes.size > 0 %}
-.{{klass.attributes.size | plus: 1}}+h|Values:
+.{{klass.attributes.size | plus: 1}}+h| Values:
 | _Name_
 6+| _Definition_
 
@@ -56,7 +56,7 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Values:
+h| Values:
 7+| (none)
 {% endif %}
 

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list.liquid

@@ -6,6 +6,7 @@
 {% endfor %}
 {% endif %}
 {% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
+
 [[rc_{{ package_name }}-model_section]]
 {{equalsigns}}= {{ package.name }}
 
@@ -48,7 +49,7 @@
 {% endfor %}
 {% endif %}
 
-{{equalsigns}}= Class Definitions
+{{equalsigns}}= Class definitions
 {% if package.classes.size > 0 %}
 .Classes used in {{ package.name }}
 [cols="2a,6a",options="header"]
@@ -56,8 +57,7 @@
 |Class |Description
 
 {% for klass in package.classes %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
-«{{ klass.stereotype }}»
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
 |{{ klass.definition }}
 
 {% endfor %}
@@ -65,13 +65,13 @@
 {% endif %}
 
 {% if package.data_types.size > 0 %}
-.Data Types used in {{ package.name }}
+.Data types used in {{ package.name }}
 [cols="2,6",options="header"]
 |===
 |Name |Description
 
 {% for klass in package.data_types %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
 |{{ klass.definition }}
 
 {% endfor %}
@@ -86,7 +86,7 @@
 |Name |Description
 
 {% for klass in package.enums %}
-|<<{{ klass.name }}-section,{{ klass.name }}>>
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
 |{{ klass.definition }}
 
 {% endfor %}
@@ -96,7 +96,7 @@
 
 {% assign after_package_key = 'after;' | append: package.name %}
 {% if additional_context[after_package_key] %}
-{{equalsigns}}= Additional Information
+{{equalsigns}}= Additional information
 {% for after in additional_context[after_package_key] %}
 {{ after.text }}
 {% endfor %}

data/lib/metanorma/plugin/lutaml/liquid_templates/_packages_enum.liquid

@@ -3,8 +3,9 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-[[tab-P-{{ package_name }}-E-{{ klass_name }}]]
-.Elements of {{ package.name }}::{{ klass.name }}
+{% assign klass_xid = klass.xmi_id %}
+[[tab-P-{{ package_name }}-E-{{ klass_xid }}]]
+.Elements of "{{ package.name }}::{{ klass.name }}" (enumeration)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 
@@ -24,14 +25,14 @@ h|Inheritance from: 7+| {{ inherited | map: 'member_end' | join: ", " }}
 h|Generalization of: 7+| {{ generalizations | map: 'member_end' | join: ", " }}
 {% endif %}
 
-h|Abstract: 7+| {{ klass.is_abstract }}
+h|Abstract: 7+| {% if klass.is_abstract %}True{% else %}False{% endif %}
 {% assign aggregations = klass.associations | where: "member_end_type", "aggregation" %}
 {% if aggregations.size > 0 %}
 .{{aggregations.size | plus: 1}}+h|Associations:
-4+|_Association with:_
-|_Obligation_
+4+| _Association with_
+| _Obligation_
 | _Maximum occurrence_
-|_Provides:_
+| _Provides_
 
 {% for assoc in aggregations %}
 4+| {{assoc.member_end}}
@@ -41,11 +42,11 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-
-.1+h|Associations: 7+| (none)
+h| Associations: 7+| (none)
 {% endif %}
+
 {% if klass.values.size > 0 %}
-.{{klass.values.size | plus: 1}}+h|Values:
+.{{klass.values.size | plus: 1}}+h| Values:
 | _Name_
 6+| _Definition_
 
@@ -55,7 +56,7 @@ h|Abstract: 7+| {{ klass.is_abstract }}
 
 {% endfor %}
 {% else %}
-.1+h|Values:
+h| Values:
 7+| (none)
 {% endif %}
 

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

@@ -52,7 +52,7 @@ module Metanorma
 
         def process_text_blocks(document, input_lines, express_indexes)
           line = input_lines.next
-          block_match = line.match(/^\[lutaml,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
+          block_match = line.match(/^\[lutaml_express,([^,]+)?,?([^,]+)?,?([^,]+)?\]/)
           return [line] if block_match.nil?
 
           end_mark = input_lines.next

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.7
+  version: 0.4.8
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-20 00:00:00.000000000 Z
+date: 2021-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -296,7 +296,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML