hxltmcli (#22): documented ontologia:normam.HXLTM general notes

EticaAI · Oct 20, 2021 · f4fe986 · f4fe986
1 parent 64f8f2c
commit f4fe986
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 5 deletions.
diff --git a/ontologia/cor.hxltm.yml b/ontologia/cor.hxltm.yml
@@ -333,12 +333,39 @@ normam:
       descriptionem: |
         _[eng-Latn]
         `ontologia:normam.HXLTM` is an abstraction to several data containers
-        of HXLTM implementation.
+        of HXLTM implementation able to store multilingual data without loss.
+
+        Some general notes:
+
+          - The most feature-complete are the HXLTM implementation using
+            tabular storage (plain HXLTM in CSV, or Google Sheets, or Excel,
+            or HXL-proxy, or...), which is able to preserve valid HXL HXLated
+            columns, but unknown to documented HXLTM implementation.
+          - The `ontologia:normam.XML`, while not tabular implementation,
+            contains information that allow data be exportable with
+            `hxltmcli --objectivum-XML` and importable with
+            `hxltmdexml` with more features than would be possible with other
+            data standards that could be close to what HXLTM is, TBX, TMX and
+            the tabular UTX.
+            - Valid HXLated HXL columns (but unknown HXLTM), even if the
+              templating engine know the undocumented HXL tags, are not
+              intended to be exported. The idea is the generic XML format still
+              designed to only export what could be imported back using the
+              same ontologia.
+            - If you plan to do VERY long-term data storage consider save
+              together with the data the ontologia that generated it.
+              - A cor.hxltm.yml with 3000 lines exported to PDF (which could be
+                printed if you data already is printed) takes around 48 pages
+                (A4 format).
+              - Is it possible to also change the tags from latin to your natural
+                language. While still have better ways to save more compact
+                export, if you plan to save a backup on some library on a
+                physical book, then at least customize it.
         [eng-Latn]_
       normam:
         - <https://github.com/HXL-CPLP/forum/issues/58>
       nomen:
-        eng-Latn: 'HXL Trānslātiōnem Memoriam'
+        eng-Latn: 'HXLTM: Terminologium Multilinguam (Datum ideam)'
       situs_interretialis:
         referens_officinale:
           - <https://hdp.etica.ai/hxltm>

diff --git a/ontologia/json/cor.hxltm.json b/ontologia/json/cor.hxltm.json
@@ -185,12 +185,12 @@
             ".hxltm.xml"
           ]
         },
-        "descriptionem": "_[eng-Latn]\n`ontologia:normam.HXLTM` is an abstraction to several data containers\nof HXLTM implementation.\n[eng-Latn]_\n",
+        "descriptionem": "_[eng-Latn]\n`ontologia:normam.HXLTM` is an abstraction to several data containers\nof HXLTM implementation able to store multilingual data without loss.\n\nSome general notes:\n\n  - The most feature-complete are the HXLTM implementation using\n    tabular storage (plain HXLTM in CSV, or Google Sheets, or Excel,\n    or HXL-proxy, or...), which is able to preserve valid HXL HXLated\n    columns, but unknown to documented HXLTM implementation.\n  - The `ontologia:normam.XML`, while not tabular implementation,\n    contains information that allow data be exportable with\n    `hxltmcli --objectivum-XML` and importable with\n    `hxltmdexml` with more features than would be possible with other\n    data standards that could be close to what HXLTM is, TBX, TMX and\n    the tabular UTX.\n    - Valid HXLated HXL columns (but unknown HXLTM), even if the\n      templating engine know the undocumented HXL tags, are not\n      intended to be exported. The idea is the generic XML format still\n      designed to only export what could be imported back using the\n      same ontologia.\n    - If you plan to do VERY long-term data storage consider save\n      together with the data the ontologia that generated it.\n      - A cor.hxltm.yml with 3000 lines exported to PDF (which could be\n        printed if you data already is printed) takes around 48 pages\n        (A4 format).\n      - Is it possible to also change the tags from latin to your natural\n        language. While still have better ways to save more compact\n        export, if you plan to save a backup on some library on a\n        physical book, then at least customize it.\n[eng-Latn]_\n",
         "normam": [
           "<https://github.com/HXL-CPLP/forum/issues/58>"
         ],
         "nomen": {
-          "eng-Latn": "HXL Trānslātiōnem Memoriam"
+          "eng-Latn": "HXLTM: Terminologium Multilinguam (Datum ideam)"
         },
         "situs_interretialis": {
           "referens_officinale": [

diff --git a/ontologia/json/cor.hxltm.json.sum b/ontologia/json/cor.hxltm.json.sum
@@ -1 +1 @@
-SHA384 (cor.hxltm.json) = ee49c33b09b95cac39fcce38b245b0ef8e6232af213e9c8ffdf9ccf421f1ffba113f667ecdb3b7c5d348391cc88dc290
+SHA384 (cor.hxltm.json) = c53524488956ba91889ee5a1c0cfdfdcf24e409d486548b59afd5d50e1c2169dbd0790036f8fc8567085be76fe27774b