Skip to content

Commit

Permalink
hxltmcli (#22): improved documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fititnt committed Oct 19, 2021
1 parent 3b75806 commit 476e4fd
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 14 deletions.
2 changes: 1 addition & 1 deletion bin/hxltmcli
Original file line number Diff line number Diff line change
Expand Up @@ -4523,7 +4523,7 @@ Salvi, {{ i }}! \
# print(globum.keys())

if hasattr(self.hxltm_asa.argumentum, 'tmeta') and \
self.hxltm_asa.argumentum.tmeta:
self.hxltm_asa.argumentum.tmeta:
summam_tmeta['tmeta'] = self.hxltm_asa.argumentum.tmeta

# summam_tmeta = {
Expand Down
2 changes: 1 addition & 1 deletion hxltm/README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= HXLM: Humanitarian Exchange Language Trānslātiōnem Memoriam
= HXLM: Humanitarian Exchange Language Terminologium Multilinguam
:toc: preamble
:icons: font
:source-highlighter: highlight.js
Expand Down
44 changes: 34 additions & 10 deletions hxltm/archivum/README.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
= `+HXLTM+` HXL Trānslātiōnem Memoriam: archīvum fōrmātum normam
= `+HXLTM+` Terminologium Multilinguam: archīvum fōrmātum normam
:toc: preamble
:toclevels: 3
:icons: font
Expand Down Expand Up @@ -121,26 +121,27 @@ include::../../testum/hxltm/disciplinam-manuale-anglicum.sh[tag=CSV-HXL-XLIFF]
----
////

[#HXLTM-ASA]
=== `+HXLTM-ASA+`:
==== HXLTM Abstractum Syntaxim Arborem
[#HXLTM-TMETA]
=== `+HXLTM-TMETA+`:
==== HXLTM Terminologium Multilinguam Meta

[source,yaml]
----
include::../../ontologia/cor.hxltm.yml[tag=normam_HXLTM-ASA]
include::../../ontologia/cor.hxltm.yml[tag=normam_HXLTM-TMETA]
----


////
===== Command line examples
[source,bash]
----
include::../../testum/hxltm/disciplinam-manuale-anglicum.sh[tag=HXLTM-ASA]
----
////

[#HXLTM-TMETA]
=== `+HXLTM-TMETA+`:
==== HXLTM Terminologiam
[#HXLTM-ASA]
=== `+HXLTM-ASA+`:
==== HXLTM Abstractum Syntaxim Arborem

[source,yaml]
----
Expand All @@ -156,7 +157,19 @@ include::../../testum/hxltm/disciplinam-manuale-anglicum.sh[tag=HXLTM-ASA]
----

[#HXLTM-archivum-exportandum]
== HXLTM exported formats
== HXLTM Normam (HXLTM interoperability with conventions/standards)

TIP: The `hxltmcli` and (for importing XML, as long as you map the
tags and attributes, as this page already do for TMX, TBX, XLIFFs, ...)
`+hxltmdexml+` *are designed to work with gigabyte size datasets*.
The ontology file can be customized with `--archivum-configurationem`
which means both edit or create new exporters/importers are possible.

////
TIP: Consider the formats here as example of how to export HXLTM.
`hxltmcli --archivum-configurationem path/to/mycopy.hxltm.yml`.
////


[#CSV-3]
=== `+CSV-3+`:
Expand Down Expand Up @@ -389,6 +402,17 @@ include::../../ontologia/cor.hxltm.yml[tag=normam_XLSX]
include::../../ontologia/cor.hxltm.yml[tag=normam_YAML]
----

[#HXLTM-ad-hoc]
== HXLTM Ad Hoc Fōrmulam (HXLTM templated export)

TIP: *About create new HXLTM Ad Hoc*: different from customizable
link:++#HXLTM-archivum-exportandum++[HXLTM Normam]
(support for gigabyte size data manipulation) the use of this strategy
is more optimized for end user who is unlikely o care about load data
in chunks and try to explain how to import back to HXLTM working file.

NOTE: TODO: this is a draft. Document already implemented functionality

== HXLTM ontologies

[#ontologia]
Expand Down
29 changes: 27 additions & 2 deletions ontologia/cor.hxltm.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ __ontologia_cor_versionem__: v0.8.6+EticaAI+voluntārium-commūne
# - https://hxlstandard.org/
# - "Trānslātiōnem Memoriam"
# - https://www.wikidata.org/wiki/Q333761
# - "HXL Trānslātiōnem Memoriam"
# - "Terminologium Multilinguam"
# - https://github.com/EticaAI/HXL-Data-Science-file-formats#HXLTM
# - "HXL Trānslātiōnem Memoriam" (priore)
# - https://github.com/EticaAI/HXL-Data-Science-file-formats#HXLTM
# - "cor"
# - https://en.wiktionary.org/wiki/cor#Latin
Expand Down Expand Up @@ -241,7 +243,7 @@ normam:
# tag::normam_HXLTM[]
HXLTM:
__meta:
archivum_extensionem: .tm.hxl.csv
archivum_extensionem: .tm.hxl.csv # .tm.hxl.xlsx, xlsx, ...
normam:
- <https://github.com/HXL-CPLP/forum/issues/58>
nomen:
Expand Down Expand Up @@ -293,6 +295,29 @@ normam:

# end::normam_HXLTM-ASA[]

#### HXLTM: Terminologium Multilinguam Meta __________________________________
# tag::normam_HXLTM-TMETA[]
HXLTM-TMETA:
__meta:
archivum_extensionem:
- .tmeta.json
- .tmeta.yml
normam:
- <https://hdp.etica.ai/hxltm/archivum/#HXLTM-TMETA>
descriptionem: |
_[eng-Latn]
To be documented.
[eng-Latn]_
nomen:
eng-Latn: 'HXLTM Terminologium Multilinguam Meta'
situs_interretialis:
referens_officinale:
- <https://hdp.etica.ai/hxltm>
- <https://github.com/EticaAI/HXL-Data-Science-file-formats/labels/HXLTM>
- <https://github.com/EticaAI/HXL-Data-Science-file-formats/issues/24>

# end::normam_HXLTM-TMETA[]

#### JSON-kv: JSON key: val; id/source -> target _____________________________
# tag::normam_JSON-kv[]
JSON-kv:
Expand Down

0 comments on commit 476e4fd

Please sign in to comment.