ドキュメントの変更・追加 (#340)

ドキュメント作成のイメージを共有するため、若干の作業を行いました。

- rules.jsonの簡易な使い方を追記
- マッピングルールの雛形を追加
  - `docs/all_in_one.md`は`docs/manual/mapping_rules/geoPackage.md`として格納

.github/workflows/test_libs.yml

@@ -12,6 +12,7 @@ on:
       - "nusamai-*/**"
       - ".github/**"
       - "demo/**"
+      - "docs/**"
       - "*"
 
 env: 

docs/docfx.json

@@ -12,7 +12,7 @@
 			},
 			{
 				"src": "manual",
-				"files": ["toc.yml", "*.md"],
+				"files": ["toc.yml", "**/*.md"],
 				"dest": "manual"
 			}
 		],

docs/manual/importPostGis.md

@@ -1,6 +1,6 @@
 # PostGISにインポートする
 
-*todo: 未整備です。
+*todo: ドキュメント未整備です。
 
 ## GeoPackageに変換する
 

docs/manual/mapping_rules/cesiumTiles.md

@@ -0,0 +1,3 @@
+# Cesium 3D Tiles マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/mapping_rules/czml.md

@@ -0,0 +1,3 @@
+# CZML マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/mapping_rules/geoJson.md

@@ -0,0 +1,3 @@
+# GeoJSON マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/mapping_rules/index.md

@@ -0,0 +1,11 @@
+# 属性マッピングルールとは
+
+*todo: ドキュメント整備中です。
+
+- [3D Tiles](./cesiumTiles.md)
+- [Mapbox Vector Tiles](./mapboxVectorTiles.md)
+- [GeoPackage](./geoPackage.md)
+- [GeoJSON](./geoJson.md)
+- [Shapefile](./shapefile.md)
+- [KML](./kml.md)
+- [CZML](./czml.md)

docs/manual/mapping_rules/kml.md

@@ -0,0 +1,3 @@
+# KML マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/mapping_rules/mapboxVectorTiles.md

@@ -0,0 +1,3 @@
+# Mapbox Vector Tiles マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/mapping_rules/shapefile.md

@@ -0,0 +1,3 @@
+# Shapefile マッピングルール
+
+*todo: ドキュメント整備中です。

docs/manual/toc.yml

@@ -12,3 +12,22 @@
     href: useCommandLine.md
   - name: PostGISへのインポートする
     href: importPostGis.md
+  - name: 属性マッピングルール
+    items:
+    - name: 属性マッピングルールとは
+      href: ./mapping_rules/index.md
+    - name: 3D Tiles
+      href: ./mapping_rules/cesiumTiles.md
+    - name: Mapbox Vector Tiles
+      href: ./mapping_rules/mapboxVectorTiles.md
+    - name: GeoPackage
+      href: ./mapping_rules/geoPackage.md
+    - name: GeoJSON
+      href: ./mapping_rules/geoJson.md
+    - name: Shapefile
+      href: ./mapping_rules/shapefile.md
+    - name: KML
+      href: ./mapping_rules/kml.md
+    - name: CZML
+      href: ./mapping_rules/czml.md
+

docs/manual/useGui.md

@@ -28,11 +28,8 @@ Windowsで利用する場合も、同様のUI・手順で利用することが
 
 ![alt text](../resources/useGui_image-2.png)
 
-- 座標参照系を変換したい座標系に変える
-
-※todo: 機能開発中です
-
-- 属性マッピング用の`mapping.json`を選択します。
+- 座標参照系を変換したい座標系に変えます。
+  - 座標参照系は、GeoPackageおよびShapefile選択時にのみ変更することができます。
 
 ※todo: 機能開発中です
 
@@ -205,3 +202,35 @@ Serving HTTP on :: port 8000 (http://[::]:8000/) ...
 - `localhost:8000`にアクセスすると、以下のように3DTilesが表示されます。
 
 ![alt text](../resources/useGui_image-16.png)
+
+### 属性名を変換する
+
+- 属性名などに日本語名などを利用したい場合は、`rules.json`を利用して属性名を変換することができます。
+- 以下のような、属性名変換用の`rules.json`を作成します。
+  - `rename`に変換前の属性名と変換後の属性名を記述します。
+  - 例えば、`buildingIDAttribute`を`建物ID`に変換したい場合は、以下のように記述します。
+
+```json
+{
+    "rename": {
+        "buildingIDAttribute": "建物ID",
+        "address": "住所",
+        "buildingDataQualityAttribute": "データ品質",
+        "buildingDetailAttribute": "建物詳細",
+        "genericAttribute": "ジェネリック",
+        "measuredHeight": "高さ",
+        "buildingDisasterRiskAttribute": "災害リスク",
+        "name": "名前"
+    }
+}
+```
+
+- `設定`の`属性マッピングルール`に`rules.json`を指定します。
+
+![alt text](../resources/useGui_image-17.png)
+
+- `変換`ボタンをクリックし、データを変換すると、属性名が変換されたGeoPackageが出力されます。
+
+![alt text](../resources/useGui_image-18.png)
+
+- 設定を行わない場合のデフォルトの属性名は「[属性マッピングルール](./mapping_rules/index.md)」に記載されています。