SEMICeu / style-guide

SEMIC style guide to create reusable vocabularies and application profiles
https://semiceu.github.io/style-guide/
Creative Commons Attribution 4.0 International
9 stars 2 forks source link

IRIs (Chapter 7.3, Element names and URIs) #74

Closed RiittaA closed 1 year ago

RiittaA commented 1 year ago
csnyulas commented 1 year ago

This is related to the similar issue #21, where we explained why we decided to stick with URIs instead of IRIs. In the context of that issue, we have also added specific explanations regarding this to the Style Guide (see CMC-R3, CMC-R4, GC-R4].

I would point out a particular paragraph in the CMC-R3 recommendation: "Internationalisation, if required, should be provided through the use of the UML Element Tags to specify labels that will be used for generation of specification documents in languages other than English. Country specific data specifications, which are meant to be used primarily at a national level, might decide to relax on this convention and permit the use of Unicode characters in the Element names, which will result in the generations of IRIs, instead of URIs [iri]. However, this is unnecessary, and strongly discouraged, in the SEMIC context."

As you mentioned @RiittaA, there are ways to convert IRIs to valid URIs e.g. by percent-encoding Unicode glyphs. So, even in the context of a national-level vocabularies/APs one could adhere to this recommendation, if they want to, by adjusting the tooling, and still keeping the more meaningful names in their conceptual model.