Update templates for guidance

.github/workflows/docker.yml

@@ -37,10 +37,43 @@ jobs:
           use-bundler: true
 
       - name: Print Metanorma version
-        run: metanorma --version   
+        run: metanorma --version
 
       - name: Metanorma generate site
         uses: actions-mn/build-and-publish@v2
         with:
           agree-to-terms: true
           destination: artifact
+
+  build-collection:
+    runs-on: ubuntu-latest
+    container:
+      image: metanorma/metanorma:latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      - name: Setup Flavor
+        uses: actions-mn/setup-flavors@v1
+        with:
+          extra-flavors: plateau
+          github-pakages-token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}
+          use-bundler: true
+
+      - name: Print Metanorma version
+        run: metanorma --version
+
+      - name: Generate Metanorma collection
+        run: metanorma collection collection.yml --agree-to-terms
+
+      - name: Upload collection artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: collection
+          path: |
+            index.html
+            *_index.html
+            document*.html
+            collection.presentation.xml

.gitignore

@@ -7,4 +7,5 @@ Gemfile.lock
 /.vscode
 /_backups
 .DS_Store
-.ruby-version
+.ruby-version
+_tmp_images*

sources/001-mds/lutaml_data_dictionary.yml

@@ -26,3 +26,4 @@ render_nested_packages: true
 # ea_extension:
 #   - "ISO19103MDG v1.0.0-beta.xml"
 template_path: "../../sources/liquid_templates"
+guidance: "../../sources/guidance/guidance.yaml"

sources/001-v4/sections/section-04/section-02.adoc

@@ -1882,7 +1882,7 @@ image::images/040.svg[]
 
 ====== bldg:Building
 
-lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="Building",template="../../sources/liquid_templates/_klass_table.liquid"]
+lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="Building",template="../../sources/liquid_templates/_klass_table.liquid",guidance="../../sources/guidance/guidance.yaml"]
 
 [cols="1a,1a,2a"]
 |===

sources/001-v4/sections/section-04/section-08.adoc

@@ -106,7 +106,7 @@ image::images/198.svg[]
 
 ====== luse:LandUse
 
-lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="LandUse",template="../../sources/liquid_templates/_klass_table.liquid"]
+lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="LandUse",template="../../sources/liquid_templates/_klass_table.liquid",guidance="../../sources/guidance/guidance.yaml"]
 
 [cols="1a,1a,2a"]
 |===
@@ -162,7 +162,7 @@ h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
 
 ====== uro:LandUseDetailAttribute
 
-lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="LandUseDetailAttribute",template="../../sources/liquid_templates/_klass_table.liquid"]
+lutaml_klass_table::../../sources/xmi/plateau_all_packages_export.xmi[name="LandUseDetailAttribute",template="../../sources/liquid_templates/_klass_table.liquid",guidance="../../sources/guidance/guidance.yaml"]
 
 [cols="1a,1a,2a"]
 |===

sources/guidance/guidance.yaml

@@ -0,0 +1,86 @@
+---
+classes:
+  - name: Building
+    attributes:
+      - name: gml:boundedBy
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: core:relativeToTerrain
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: core:relativeToWater
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: bldg:function
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: bldg:storeyHeightsAboveGround
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: bldg:storeyHeightsBelowGround
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: bldg:lod2MultiSurface
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: bldg:lod3MultiSurface
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+  - name: LandUse
+    attributes:
+      - name: gml:boundedBy
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: core:relativeToTerrain
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: core:relativeToWater
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: luse:function
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: luse:usage
+        used: false
+        guidance: |
+          この属性は使用されていません。
+      - name: gen:stringAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:intAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:doubleAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:dateAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:uriAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:measureAttribute
+        used: false
+        guidance: |
+          この関連役割は使用されていません。
+      - name: gen:genericAttributeSet
+        used: false
+        guidance: |
+          この関連役割は使用されていません。

sources/liquid_templates/_klass_table.liquid

@@ -11,75 +11,105 @@
   {%- assign stereotype = " " -%}
 {%- endif -%}
 
-[cols="1a,1a,2a"]
+[cols="1a,1a,2a,1a"]
 |===
-| AGT 型の定義
-2+| {{ root.definition }}
-
-h| 上位の型 2+| {{ upper_klass_name }}
-h| ステレオタイプ 2+| {{ stereotype }}
+| AGT 型の定義 3+| {{ root.definition }}
+h| 上位の型 3+| {{ upper_klass_name }}
+h| ステレオタイプ 3+| {{ stereotype }}
 
 {% if root.inherited_props.size > 0 %}
-3+h| 継承する属性
-h| 属性名 h| 属性の型及び多重度 h| 定義
+4+h| 継承する属性
+h| 属性名 h| 属性の型及び多重度 h| 定義 h| 補導
 {% endif %}
 {% for attr in root.inherited_props %}
   {%- if attr.has_association? == false -%}
-    {%- capture name_col -%}
-      {{ attr.name_ns }}:{{ attr.name }}
-      ({{ attr.gen_name }})
-    {%- endcapture -%}
+    {%- if attr.used? == false -%}
+      {%- capture name_col -%}
+        ({{ attr.name_ns }}:{{ attr.name }})
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- else -%}
+      {%- capture name_col -%}
+        {{ attr.name_ns }}:{{ attr.name }}
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- endif -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
+    | {{ attr.guidance }}
   {%- endif -%}
 {% endfor %}
 
 {% if root.owned_props.size > 0 %}
-3+h| 自身に定義された属性
-h| 属性名 h| 属性の型及び多重度 h| 定義
+4+h| 自身に定義された属性
+h| 属性名 h| 属性の型及び多重度 h| 定義 h| 補導
 {% endif %}
 {% for attr in root.owned_props %}
   {%- if attr.has_association? == false -%}
-    {%- capture name_col -%}
-      {{ attr.name_ns }}:{{ attr.name }}
-      ({{ attr.gen_name }})
-    {%- endcapture -%}
+    {%- if attr.used? == false -%}
+      {%- capture name_col -%}
+        ({{ attr.name_ns }}:{{ attr.name }})
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- else -%}
+      {%- capture name_col -%}
+        {{ attr.name_ns }}:{{ attr.name }}
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- endif -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
+    | {{ attr.guidance }}
   {%- endif -%}
 {% endfor %}
 
 {% if root.inherited_assoc_props.size > 0 %}
-3+h| 継承する関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+4+h| 継承する関連役割
+h| 関連役割名 h| 関連役割の型及び多重度 h| 定義 h| 補導
 {% endif %}
 {% for attr in root.inherited_assoc_props %}
   {%- if attr.has_association? == true -%}
-    {%- capture name_col -%}
-      {{ attr.name_ns }}:{{ attr.name }}
-      ({{ attr.gen_name }})
-    {%- endcapture -%}
+    {%- if attr.used? == false -%}
+      {%- capture name_col -%}
+        ({{ attr.name_ns }}:{{ attr.name }})
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- else -%}
+      {%- capture name_col -%}
+        {{ attr.name_ns }}:{{ attr.name }}
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- endif -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
+    | {{ attr.guidance }}
   {%- endif -%}
 {% endfor %}
 
 {% if root.assoc_props.size > 0 %}
-3+h| 自身に定義された関連役割
-h| 関連役割名 h| 関連役割の型及び多重度 h| 定義
+4+h| 自身に定義された関連役割
+h| 関連役割名 h| 関連役割の型及び多重度 h| 定義 h| 補導
 {% endif %}
 {% for attr in root.assoc_props %}
   {%- if attr.has_association? == true -%}
-    {%- capture name_col -%}
-      {{ attr.name_ns }}:{{ attr.name }}
-      ({{ attr.gen_name }})
-    {%- endcapture -%}
+    {%- if attr.used? == false -%}
+      {%- capture name_col -%}
+        ({{ attr.name_ns }}:{{ attr.name }})
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- else -%}
+      {%- capture name_col -%}
+        {{ attr.name_ns }}:{{ attr.name }}
+        <{{ attr.gen_name }}>
+      {%- endcapture -%}
+    {%- endif -%}
     | {{ name_col | newline_to_br }}
-    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}] 
+    | {{ attr.type_ns }}:{{ attr.type }} [{{ attr.cardinality.min }}..{{ attr.cardinality.max }}]
     | {{ attr.definition }}
+    | {{ attr.guidance }}
   {%- endif -%}
 {% endfor %}
 |===