metanorma-plugin-lutaml 0.4.8 → 0.4.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 202335c2a56ade17a5bdfedd489b6c39363b256ebbaa2e2cbfe812a6bb6995e5
-  data.tar.gz: 9637bc5a68bbbe8cda105e74a537ae7e41d5676f584e64e907ad26ba6cf50082
+  metadata.gz: 7be44107e7c1d3c9a4471ead7d39630d49cdced1e3996b6bea8b3c64be4fd03f
+  data.tar.gz: b99ff8fa3069c0fb0f983de14a984c06db12ecc595e0b876ed83e83926c6eeba
 SHA512:
-  metadata.gz: 7e183219067f431d7b839d59ab3e5c8a8b3f54b335cb1e232297f1fa997e7f7abafa4a0858d5398a034c2a025d46feef240f3e71b14db7730fb1789b2dd11afb
-  data.tar.gz: 400132cae1b7b1b3f03414f4c4ab8b16edde68ab285cd192bd0894d913bee26985182aaf880c2a4ddac1935541bac62913679424e433d88bacc8242c7fcabede
+  metadata.gz: 2e6d79ef550cecde85e2e0d49717259f6e9016ef7e3935fdb938d13173361daf404e586a1d1319b05a1ab4a393213086625399d5d3e1090a4afd902c0bfc3f82
+  data.tar.gz: 454fe356b82f983a2a4ed9b2a1fa81de19ea8dcb6ac0c10243f1afc8db8e2eed8b8600658c7f0e37040224401dae077a0f93e433227b31c9dd63c7119c59db5f

data/README.adoc

@@ -377,11 +377,15 @@ For instance, the script will take package diagrams supplied in the XMI file and
 
 * `[.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 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:
+In addition to the macros listed above that can be used only inside `lutaml_uml_datamodel_description` macro there is another macroses called `lutaml_figure` and `lutaml_table`. `lutaml_figure` is used to lookup and reference xmi package diagrams. `lutaml_table` is used to lookup rendered xmi entries. The syntax is as follows:
 
 [source,adoc]
 -----
 This is lutaml_figure::[package="Wrapper root package", name="Fig B1 Full model"] figure
+This is lutaml_table::[package="Wrapper root package"] package
+This is lutaml_table::[package="Wrapper root package", class="my name"] class
+This is lutaml_table::[package="Wrapper root package", enum="my name"] enum
+This is lutaml_table::[package="Wrapper root package", data_type="my name"] data_type
 -----
 
 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.
@@ -418,9 +422,9 @@ Content for CityGML package
 
 ==== Defining tables
 
-.<<tab-P-another-C-{XMI_ID}>> -- Elements of &#8220;Another::AbstractAtomicTimeseries&#8221; (class)
+.<<section-EAPK_9C96A88B_E98B_490b_8A9C_24AEDAC64293>> -- Elements of &#8220;Another::AbstractAtomicTimeseries&#8221; (class)
 
-[[tab-P-another-C-{XMI_ID}]]
+[[section-EAPK_9C96A88B_E98B_490b_8A9C_24AEDAC64293]]
 .Elements of &#8220;Another::AbstractAtomicTimeseries&#8221; (class)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===

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

@@ -10,11 +10,8 @@
 {% elsif is_package_spare == 'Spare' %}{% continue %}
 {% endif %}
 
-{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}
-
-[[lutaml-section-{{ package_name }}]]
-{{equalsigns}} {{ package.name }} package
-
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }} package
+[[section-{{ package.xmi_id }}]]
 {{equalsigns}}= {{ package.name }} overview
 
 {% assign before_package_key = 'before;' | append: package.name %}
@@ -54,8 +51,7 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign klass_xid = klass.xmi_id %}
-.<<tab-P-{{ package_name }}-C-{{ klass_xid }}>> -- Elements of "{{ package.name }}::{{ klass.name }}"
+.<<section-{{ klass.xmi_id }}>> -- &#8220;Elements of {{ package.name }}::{{ klass.name }}&#8221; (class)
 
 {% endfor %}
 {% for enum in package.enums %}
@@ -64,8 +60,7 @@
 {% elsif is_enum_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign enum_name = enum.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign enum_xid = enum.xmi_id %}
-.<<tab-P-{{ package_name }}-E-{{ enum_xid }}>> -- Elements of "{{ package.name }}::{{ enum.name }}"
+.<<section-{{ enum.xmi_id }}>> -- &#8220;Elements of {{ package.name }}::{{ enum.name }}&#8221; (enum)
 
 {% endfor %}
 {% for data_type in package.data_types %}
@@ -74,8 +69,7 @@
 {% elsif is_data_type_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign data_type_name = data_type.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign data_type_xid = data_type.xmi_id %}
-.<<tab-P-{{ package_name }}-DT-{{ data_type_xid }}>> -- Elements of "{{ package.name }}::{{ data_type.name }}"
+.<<section-{{ data_type.xmi_id }}>> -- &#8220;Elements of {{ package.name }}::{{ data_type.name }}&#8221; (data_type)
 
 {% endfor %}
 

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

@@ -3,9 +3,8 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign klass_xid = klass.xmi_id %}
-[[tab-P-{{ package_name }}-C-{{ klass_xid }}]]
-.Elements of "{{ package.name }}::{{ klass.name }}" (class)
+[[section-{{ klass.xmi_id }}]]
+.Elements of “{{ package.name }}::{{ klass.name }}” (class)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 

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

@@ -6,7 +6,6 @@
 {% endfor %}
 {% endif %}
 {% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
-{{equalsigns}}= {{ package.name }}
 
 {% assign before_package_key = 'before;' | append: package.name %}
 {% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
@@ -24,41 +23,58 @@ h|Stereotype:     | «{{ package.stereotype }}»
 
 |===
 
-{% assign feature_types = package.classes | where: "stereotype", "FeatureType" %}
-{% assign object_types = package.classes | where: "stereotype", "ObjectType" %}
 {% assign basic_types = package.classes | where: "stereotype", "BasicType" %}
-{% assign unions = package.classes | where: "stereotype", "Union" %}
+{% assign unions = package.data_types | where: "stereotype", "Union" %}
 {% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
-{% if feature_types.size > 0 or object_types.size > 0 %}
+{% assign not_classes_length = basic_types.size | plus: code_lists.size %}
+{% assign not_classes_stereoptypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
 {{equalsigns}}= Classes
 
-{% include "packages_data_dictionary_classes", classes: feature_types %}
-{% include "packages_data_dictionary_classes", classes: object_types %}
-{% endif %}
+{% unless not_classes_length == package.classes.size %}
+
+{% for klass in package.classes %}
+{% unless not_classes_stereoptypes contains klass.stereotype  %}
+{% include "packages_data_dictionary_class" %}
+{% endunless %}
+{% endfor %}
+{% else %}
+None
+{% endunless %}
 
-{% if basic_types.size > 0 %}
 {{equalsigns}}= Basic types
 
+{% if basic_types.size > 0 %}
+
 {% include "packages_data_dictionary_classes", classes: basic_types %}
+{% else %}
+None
 {% endif %}
 
-{% if unions.size > 0 %}
 {{equalsigns}}= Unions
 
+{% if unions.size > 0 %}
+
 {% include "packages_data_dictionary_classes", classes: unions %}
+{% else %}
+None
 {% endif %}
 
-{% if code_lists.size > 0 %}
 {{equalsigns}}= Code lists
 
+{% if code_lists.size > 0 %}
+
 {% include "packages_data_dictionary_classes", classes: code_lists %}
+{% else %}
+None
 {% endif %}
 
-{% if package.data_types.size > 0 %}
 {{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 %}
+{% assign non_unions = package.data_types | where: "stereotype", "DataType"  %}
+{% if non_unions.size > 0 %}
+
+{% for data_type in non_unions %}
+{% capture generalizations %}{% assign inheritance = data_type.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
 [[{{ data_type.name }}-section]]
 [cols="1a"]
 |===
@@ -66,8 +82,8 @@ h|Stereotype:     | «{{ package.stereotype }}»
 |[cols="1,4"]
 !===
 !Definition:  ! {{ data_type.definition }}
-!Subclass of: ! {{ generalizations }}
-!Stereotype:  !  «DataType»
+!Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
+!Stereotype:  !  «{{ data_type.stereotype }}»
 !===
 {% if data_type.associations.size > 0 %}
 {% capture rendered_associations %}
@@ -78,7 +94,7 @@ h|Stereotype:     | «{{ package.stereotype }}»
 {% endif %}
 {% endfor %}
 {% endcapture %}
-{% if rendered_associations.size > 0 %}
+{% if rendered_associations.size > 100 %}
 |
 [cols="15,20,60",options="header"]
 !===
@@ -94,7 +110,7 @@ h|Stereotype:     | «{{ package.stereotype }}»
 ! 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 %}
-! {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.name }}>>  {{ cardinality }} !{{ attr.definition }}
+! {{ attr.name }}  !<<{{ attr.type }}-section,{{ attr.type }}>>  {{ cardinality }} !{{ attr.definition }}
 {% endfor %}
 !===
 | NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
@@ -102,13 +118,15 @@ h|Stereotype:     | «{{ package.stereotype }}»
 |===
 
 {% endfor %}
+{% else %}
+None
 {% endif %}
 
-{% if package.enums.size > 0 %}
 {{equalsigns}}= Enumerations
 
+{% if package.enums.size > 0 %}
+
 {% for enum in package.enums %}
-{% capture generalizations %}{% for assoc in enum.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
 [[{{ enum.name }}-section]]
 [cols="1a"]
 |===
@@ -133,6 +151,8 @@ h|Stereotype:     | «{{ package.stereotype }}»
 |===
 
 {% endfor %}
+{% else %}
+None
 {% endif %}
 
 {% if additional_context.include_block and additional_context.include_block.size > 0 %}

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

@@ -0,0 +1,67 @@
+{% capture generalizations %}{% assign inheritance = klass.associations | where: "member_end_type", "inheritance" %}{% for assoc in inheritance %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
+[[{{ klass.name }}-section]]
+[cols="1a"]
+|===
+|*{{ klass.name }}*
+|
+[cols="1,4"]
+!===
+! Definition:  ! {{ klass.definition }}
+! Subclass of: ! {% if generalizations.size > 4 %}{{ generalizations }}{% else %}None{% endif %}
+! Stereotype:  ! «{{ klass.stereotype }}»
+{% if klass.constraints.size > 0 %}
+{% for constraint in klass.constraints %}
+! Constraint:  ! {{ constraint.body }}: {{ constraint.definition | replace: '|', '\|' }}
+{% endfor %}
+{% endif %}
+!===
+
+{% 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 %}
+
+! {{ assoc.member_end_attribute_name }}
+! <<{{assoc.member_end}}-section,{{assoc.member_end}}>> {{ cardinality }}
+! {{ assoc.definition }}
+
+{% endif %}
+{% endfor %}
+{% endcapture %}
+
+{% if rendered_associations.size > 100 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! *Role name*
+! *Target class and multiplicity*
+! *Definition*
+{{ rendered_associations }}
+!===
+{% endif %}
+
+{% endif %}
+{% if klass.attributes.size > 0 %}
+|
+[cols="15,20,60",options="header"]
+!===
+! *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 %}
+
+! {{ attr.name }}
+!<<{{ attr.type }}-section,{{ attr.type }}>> {{ cardinality }}
+!{{ attr.definition }}
+
+{% endfor %}
+!===
+
+| NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
+{% endif %}
+|===

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

@@ -1,65 +1,3 @@
 {% for klass in classes %}
-{% capture generalizations %}{% for assoc in klass.associations | where: "member_end_type", "generalization" %}{{ assoc.member_end }} {% endfor %}{% endcapture %}
-[[{{ klass.name }}-section]]
-[cols="1a"]
-|===
-|*{{ klass.name }}*
-|
-[cols="1,4"]
-!===
-! 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 %}
-
-! {{ 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",options="header"]
-!===
-! *Role name*
-! *Target class and multiplicity*
-! *Definition*
-{{ rendered_associations }}
-!===
-{% endif %}
-
-{% endif %}
-{% if klass.attributes.size > 0 %}
-|
-[cols="15,20,60",options="header"]
-!===
-! *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 %}
-
-! {{ attr.name }}
-!<<{{ attr.type }}-section,{{ attr.name }}>> {{ cardinality }}
-!{{ attr.definition }}
-
-{% endfor %}
-!===
-
-| NOTE: Unless otherwise specified, all attributes and role names have the stereotype «Property».
-{% endif %}
-|===
-
+{% include "packages_data_dictionary_class" %}
 {% endfor %}

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

@@ -3,9 +3,8 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign klass_xid = klass.xmi_id %}
-[[tab-P-{{ package_name }}-DT-{{ klass_xid }}]]
-.Elements of "{{ package.name }}::{{ klass.name }}" (data type)
+[[section-{{ klass.xmi_id }}]]
+.Elements of {{ package.name }}::{{ klass.name }}” (data_type)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 

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

@@ -5,66 +5,89 @@
 {{ before.text }}
 {% endfor %}
 {% endif %}
-{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
-
+{% if depth %}
 [[rc_{{ package_name }}-model_section]]
-{{equalsigns}}= {{ package.name }}
-
-{% assign before_package_key = 'before;' | append: package.name %}
-{% if additional_context[before_package_key] and additional_context[before_package_key].size > 0 %}
-{% for before in additional_context[before_package_key] %}
-{{ before.text }}
-{% endfor %}
-{% endif %}
-{% if additional_context.diagram_include_block %}
-{% for diagram_include_block in additional_context.diagram_include_block %}
-{% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
-{% endfor %}
+{% capture equalsigns %}{% for count in (1..depth) %}={% endfor %}{% endcapture %}{{equalsigns}} {{ package.name }}
 {% endif %}
 
-{% if additional_context.include_block and additional_context.include_block.size > 0 %}
-{% for block in additional_context.include_block %}
+{% if additional_context.all_macroses.size > 0 %}
+{% assign sorted_all_macroses = additional_context.all_macroses | where: "position", "before" | sort: 'index' %}
+{% for block in sorted_all_macroses %}
+{% case block.type %}
+{% when 'include_block' %}
+{% unless block.package and block.package != package.name %}
 {% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
 {% capture block_content %}{% include block_filename %}{% endcapture %}
 {% unless block_content contains "Liquid error" %}
 {% if block.text %}
+
 {{ block.text }}
 {% endif %}
+
 {{ block_content }}
 {% endunless %}
-{% endfor %}
-{% endif %}
+{% endunless %}
+{% when 'package_text' %}
+{% unless block.package and block.package != package.name %}
 
-{% assign include_block_package_key = 'include_block;' | append: package.name %}
-{% if additional_context[include_block_package_key] and additional_context[include_block_package_key].size > 0 %}
-{% for block in additional_context[include_block_package_key] %}
-{% capture block_filename %}{{ block.base_path }}{{ package_name }}{% endcapture %}
-{% capture block_content %}{% include block_filename %}{% endcapture %}
-{% unless block_content contains "Liquid error" %}
-{% if block.text %}
 {{ block.text }}
-{% endif %}
-{{ block_content }}
 {% endunless %}
+{% else %}
+{% endcase %}
+{% endfor %}
+{% endif %}
+
+// TODO: move to all_macroses block
+{% if additional_context.diagram_include_block %}
+{% for diagram_include_block in additional_context.diagram_include_block %}
+{% include "diagrams_block", package_name: package_name, image_base_path: diagram_include_block.base_path, text: diagram_include_block.text %}
 {% endfor %}
 {% endif %}
 
-{{equalsigns}}= Class definitions
 {% if package.classes.size > 0 %}
+{{equalsigns}}= Class definitions
+
+{% comment %} {% assign data_types = package.classes | where: "stereotype", "DataType" %} {% endcomment %}
+{% assign basic_types = package.classes | where: "stereotype", "BasicType" %}
+{% comment %} {% assign enumerations = package.classes | where: "stereotype", "Enumeration" %} {% endcomment %}
+{% assign code_lists = package.classes | where: "stereotype", "CodeList" %}
+
+{% assign not_classes_length = plus: basic_types.size | plus: code_lists.size %}
+{% assign not_classes_stereoptypes = 'DataType,BasicType,Enumeration,CodeList' | split: ','%}
+{% unless not_classes_length == package.classes.size %}
 .Classes used in {{ package.name }}
 [cols="2a,6a",options="header"]
 |===
-|Class |Description
-
+|Name |Description
 {% for klass in package.classes %}
+{% unless not_classes_stereoptypes contains klass.stereotype  %}
 |<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype }}»
 |{{ klass.definition }}
 
+{% endunless %}
 {% endfor %}
 |===
-{% endif %}
+{% endunless %}
 
 {% if package.data_types.size > 0 %}
+{% include "packages_entity_list_classes", classes: package.data_types, type: "Data Types" %}
+{% endif %}
+
+{% if basic_types.size > 0 %}
+{% include "packages_entity_list_classes", classes: basic_types, type: "Primitive Data Types" %}
+{% endif %}
+
+{% if package.enums.size > 0 %}
+{% include "packages_entity_list_classes", classes: package.enums, type: "Enumerated Classes" %}
+{% endif %}
+
+{% if code_lists.size > 0 %}
+{% include "packages_entity_list_classes", classes: code_lists, type: "CodeList Classes" %}
+{% endif %}
+
+{% endif %}
+
+{% comment %} {% if package.data_types.size > 0 %}
 .Data types used in {{ package.name }}
 [cols="2,6",options="header"]
 |===
@@ -92,7 +115,7 @@
 {% endfor %}
 
 |===
-{% endif %}
+{% endif %} {% endcomment %}
 
 {% assign after_package_key = 'after;' | append: package.name %}
 {% if additional_context[after_package_key] %}

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

@@ -0,0 +1,11 @@
+.{{ type }} used in {{ package.name }}
+[cols="2a,6a",options="header"]
+|===
+|Name |Description
+
+{% for klass in classes %}
+|<<{{ klass.name }}-section,{{ klass.name }}>> «{{ klass.stereotype | default: "Enumeration" }}»
+|{{ klass.definition }}
+
+{% endfor %}
+|===

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

@@ -3,9 +3,9 @@
 {% elsif is_klass_spare == 'Spare' %}{% continue %}
 {% endif %}
 {% assign klass_name = klass.name | downcase | replace: ':', '' | replace: ' ', '_' %}
-{% assign klass_xid = klass.xmi_id %}
-[[tab-P-{{ package_name }}-E-{{ klass_xid }}]]
-.Elements of "{{ package.name }}::{{ klass.name }}" (enumeration)
+
+[[section-{{ klass.xmi_id }}]]
+.Elements of {{ package.name }}::{{ klass.name }}” (enum)
 [width="100%",cols="a,a,a,a,a,a,a,a"]
 |===
 

data/lib/metanorma/plugin/lutaml/liquid_templates/test.rb

@@ -0,0 +1 @@
+k = {"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_0BD8DEDF_F024_453d_AA7D_6EBC873FDBB6", "member_end"=>"AbstractFeatureWithLifespan", "member_end_type"=>"inheritance", "member_end_cardinality"=>{"min"=>nil, "max"=>""},"}, "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_1C91D9CF_14CB_400c_A818_7C74428AE5B7", "member_end"=>"AbstractAppearance", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"appearance", "owner_end"=>"AbstractCityObject", "definition"=>"Relates appearances to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_BDD0FCAB_72F7_499b_AC4D_2391D4DE7CAC", "member_end"=>"AbstractGenericAttribute", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"genericAttribute", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generic attributes to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C22B8769_C2E7_4e9b_9C0D_138631E90002", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"generalizesTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generalized representations of the same real-world object in different Levels of Detail to the city object. The direction of this relation is from the city object to the corresponding generalized city objects."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_CF0045E1_6BF1_40a7_B08D_9B7B30ECA025", "member_end"=>"ExternalReference", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"externalReference", "owner_end"=>"AbstractCityObject", "definition"=>"References external objects in other information systems that have a relation to the city object."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_D45045CA_AAD6_418a_AF10_F4BC95DE923A", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"relatedTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates other city objects to the city object. It also describes how the city objects are related to each other."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_E3BB8700_143D_4dbd_A7EC_49D33C66D430", "member_end"=>"AbstractDynamizer", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"dynamizer", "owner_end"=>"AbstractCityObject", "definition"=>"Relates Dynamizer objects to the city object. These allow timeseries data to override static attribute values of the city object."}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_BE026036_E811_494c_9776_D1A309393D6D", "member_end"=>"AbstractSpace", "member_end_type"=>"generalization", "member_end_cardinality"=>nil, "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C2189DFF_0F24_475b_AB55_070CD09A3186", "member_end"=>"AbstractSpaceBoundary", "member_end_type"=>"generalization", "member_end_cardinality"=>{"min"=>nil, "max"=>" "member_end_attribute_name"=>nil, "owner_end"=>"AbstractCityObject", "definition"=>""}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_C22B8769_C2E7_4e9b_9C0D_138631E90002", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>""},"}, "member_end_attribute_name"=>"generalizesTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates generalized representations of the same real-world object in different Levels of Detail to the city object. The direction of this relation is from the city object to the corresponding generalized city objects."}{"visibility"=>"public", "name"=>nil, "xmi_id"=>"EAID_D45045CA_AAD6_418a_AF10_F4BC95DE923A", "member_end"=>"AbstractCityObject", "member_end_type"=>"aggregation", "member_end_cardinality"=>{"min"=>"M", "max"=>" "member_end_attribute_name"=>"relatedTo", "owner_end"=>"AbstractCityObject", "definition"=>"Relates other city objects to the city object. It also describes how the city objects are related to each other."}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}{"visibility"=>"public", "name"=>nil, "owner_end"=>"AbstractCityObject"}

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Metanorma
+  module Plugin
+    module Lutaml
+      class LutamlTableInlineMacro < Asciidoctor::Extensions::InlineMacroProcessor
+        include LutamlDiagramBase
+        SUPPORTED_OPTIONS = %w[class enum data_type]
+
+        use_dsl
+        named :lutaml_table_class
+
+        def process(parent, _target, attrs)
+          keyword = SUPPORTED_OPTIONS.find { |n| attrs[n] }
+          entity_key = [keyword, attrs["package"], attrs[keyword]].compact.join(":")
+          return if parent.document.attributes['lutaml_entity_id'].nil?
+          xmi_id = parent.document.attributes['lutaml_entity_id'][entity_key]
+          return unless xmi_id
+
+          %Q(<xref target="section-#{xmi_id}"></xref>)
+        end
+      end
+    end
+  end
+end

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

@@ -26,8 +26,9 @@ module Metanorma
           'entity_list' => 'packages_entity_list',
           'data_dictionary' => 'packages_data_dictionary'
         }.freeze
+        RENDER_STYLE_ATTRIBUTE = 'render_style'.freeze
         SUPPORTED_NESTED_MACRO = %w[
-          before diagram_include_block after include_block].freeze
+          before diagram_include_block after include_block package_text].freeze
         # search document for block `lutaml_uml_datamodel_description`
         #  read include derectives that goes after that in block and transform
         #  into yaml2text blocks
@@ -74,6 +75,35 @@ module Metanorma
             parse_yaml_config_file(document, block_match[2]))
         end
 
+        def fill_in_entities_refs_attributes(document, lutaml_document_wrapper, options)
+          lutaml_document = lutaml_document_wrapper.original_document
+          render_style = options.fetch(RENDER_STYLE_ATTRIBUTE, 'default')
+          all_children_packages = lutaml_document.packages.map(&:children_packages).flatten
+          package_flat_packages = lambda do |pks|
+            pks.each_with_object({}) do |package, res|
+              res[package.name] = package.xmi_id
+            end
+          end
+          children_pks = package_flat_packages.call(all_children_packages)
+          ref_dictionary = package_flat_packages.call(lutaml_document.packages)
+                            .merge(children_pks)
+          %w[class enum data_type].each do |type|
+            package_flat = lambda do |pks|
+              pks.each_with_object({}) do |package, res|
+                plural = type == "class" ? "classes" : "#{type}s"
+                package.send(plural).map do |entity|
+                  res["#{type}:#{package.name}:#{entity.name}"] = entity.xmi_id
+                end
+              end
+            end
+            children_pks_daigs = package_flat.call(all_children_packages)
+              ref_dictionary = ref_dictionary
+                                .merge(package_flat.call(lutaml_document.packages)
+                                        .merge(children_pks_daigs))
+          end
+          document.attributes['lutaml_entity_id'] = ref_dictionary
+        end
+
         def fill_in_diagrams_attributes(document, lutaml_document_wrapper)
           lutaml_document = lutaml_document_wrapper.original_document
           package_flat_diagrams = lambda do |pks|
@@ -88,6 +118,7 @@ module Metanorma
 
         def collect_additional_context(input_lines, end_mark)
           additional_context = Hash.new { |hash, key| hash[key] = [] }
+          additional_context['all_macroses'] = []
           block_lines = []
           while (block_line = input_lines.next) != end_mark
             block_lines.push(block_line)
@@ -100,8 +131,9 @@ module Metanorma
             name = attrs.delete('role')
             package = attrs.delete('package')
             macro_keyword = [name, package].compact.join(";")
-            block_text = block.lines.length > 0 ? block.lines[1..-2].join("\n") : ''
+            block_text = block.lines.length > 0 ? block.lines.join("\n") : ''
             additional_context[macro_keyword].push({ 'text' => block_text }.merge(attrs))
+            additional_context['all_macroses'].push({ 'text' => block_text, 'type' => name, 'package' => package }.merge(attrs))
           end
           additional_context
         end
@@ -118,14 +150,18 @@ module Metanorma
             return {
               'render_nested_packages' => true,
               "packages" => root_package['packages'],
-              "additional_context" => additional_context
+              "root_packages" => [root_package],
+              "additional_context" => additional_context,
+              "name" => root_package['name']
             }
           end
 
           all_packages = [root_package, *root_package['children_packages']]
           {
             "packages" => sort_and_filter_out_packages(all_packages, options),
-            "additional_context" => additional_context
+            "additional_context" => additional_context,
+            "root_packages" => [root_package],
+            "name" => root_package['name']
           }
         end
 
@@ -163,8 +199,9 @@ module Metanorma
         end
 
         def model_representation(lutaml_document, document, additional_context, options)
+          fill_in_entities_refs_attributes(document, lutaml_document, options)
           render_result, errors = Utils.render_liquid_string(
-            template_string: table_template(options['section_depth'] || 2, options['render_style']),
+            template_string: table_template(options['section_depth'] || 2, options['render_style'], options['include_root']),
             context_items: create_context_object(lutaml_document,
                               additional_context,
                               options),
@@ -176,9 +213,15 @@ module Metanorma
           render_result.split("\n")
         end
 
-        def table_template(section_depth, render_style)
+        def table_template(section_depth, render_style, include_root)
           include_name = RENDER_STYLES_INCLUDES.fetch(render_style, DEFAULT_RENDER_INCLUDE)
-          <<~LIQUID
+          result = ""
+          if include_root
+            result += <<~LIQUID
+              {% include "#{include_name}", context: context.root_packages, additional_context: context.additional_context, render_nested_packages: false %}
+            LIQUID
+          end
+          result += <<~LIQUID
             {% include "#{include_name}", depth: #{section_depth}, context: context, additional_context: context.additional_context, render_nested_packages: context.render_nested_packages %}
           LIQUID
         end

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

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

data/lib/metanorma-plugin-lutaml.rb

@@ -5,6 +5,7 @@ require "metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor"
 require "metanorma/plugin/lutaml/lutaml_diagram_block"
 require "metanorma/plugin/lutaml/lutaml_diagram_block_macro"
 require "metanorma/plugin/lutaml/lutaml_figure_inline_macro"
+require "metanorma/plugin/lutaml/lutaml_table_inline_macro"
 
 module Metanorma
   module Plugin

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metanorma-plugin-lutaml
 version: !ruby/object:Gem::Version
-  version: 0.4.8
+  version: 0.4.9
 platform: ruby
 authors:
 - Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-24 00:00:00.000000000 Z
+date: 2021-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: liquid
@@ -262,15 +262,19 @@ files:
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_class.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary_class.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_dictionary_classes.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_data_type.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/_packages_entity_list_classes.liquid
 - lib/metanorma/plugin/lutaml/liquid_templates/_packages_enum.liquid
+- lib/metanorma/plugin/lutaml/liquid_templates/test.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_base.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block.rb
 - lib/metanorma/plugin/lutaml/lutaml_diagram_block_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_figure_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_preprocessor.rb
+- lib/metanorma/plugin/lutaml/lutaml_table_inline_macro.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_attributes_table_preprocessor.rb
 - lib/metanorma/plugin/lutaml/lutaml_uml_datamodel_description_preprocessor.rb
 - lib/metanorma/plugin/lutaml/utils.rb
@@ -296,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key:
 specification_version: 4
 summary: Metanorma plugin for LutaML