Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multi-lingual labels and descriptions for concepts #89

Open
coolharsh55 opened this issue Apr 13, 2023 · 6 comments
Open

Multi-lingual labels and descriptions for concepts #89

coolharsh55 opened this issue Apr 13, 2023 · 6 comments
Labels
documentation Improvements or additions to documentation help-wanted Assistance in performing tasks for this issue todo chores, tasks, things to do
Milestone

Comments

@coolharsh55
Copy link
Collaborator

This issue is a placeholder for discussions regarding multi-lingual translations for labels and descriptions associated with DPV concepts. This includes the concept label, description or definition, and any comments. Note the IRIs will not be translated as they are the identifier of the concept.

@coolharsh55 coolharsh55 added documentation Improvements or additions to documentation todo chores, tasks, things to do help-wanted Assistance in performing tasks for this issue labels Apr 13, 2023
@coolharsh55
Copy link
Collaborator Author

Discussed in Meeting 2023-06-22 where the next step is to work with the language speakers to create a glossary of terms to ensure the machine translations are correct(ed) and to assess the outcome of this process.

@bact
Copy link
Collaborator

bact commented Nov 23, 2023

Discussed in Meeting 2023-11-22 about:

  1. How to present multiple languages in the HTML documents?
  • How the user is going to select a language?
  • Displaying a language together with English at the start for the term labels and descriptions on that page in case the translation is incorrect
  1. Translation frequency? e.g. once a year.

  2. How to do generate these systematically?

@bact
Copy link
Collaborator

bact commented Nov 23, 2023

Resources:

@pmcb55
Copy link

pmcb55 commented Nov 24, 2023

Sorry to just 'jump in' here, but in relation to "How to present multiple languages in the HTML documents?", what are you currently using to generate those HTML documents? (If Widoco, then the answer is that Widoco handles this for you (i.e., it provides a language drop-down in the top-right-hand corner of the HTML page), so I presume you're not using Widoco.

But if not Widoco, then can I ask why not? i.e., what specific feature(s) do you think are currently missing, as I believe Daniel (the creator and maintainer of Widoco) is very open to adding missing features, especially if funding might be available(!)...?

@bact
Copy link
Collaborator

bact commented Nov 24, 2023

They are generated from data in spreadsheets by https://github.com/w3c/dpv/tree/master/documentation-generator.

@coolharsh55
Copy link
Collaborator Author

Hi Pat. tldr; the script grew from simple HTML to a complex set of documents which I do not know how to manage using Widoco. I'm open to someone else figuring out how to use Widoco for DPV.

what are you currently using to generate those HTML documents? (If Widoco, then the answer is that Widoco handles this for you (i.e., it provides a language drop-down in the top-right-hand corner of the HTML page), so I presume you're not using Widoco.

Yes, we are not using Widoco. We have a bunch of python scripts hacked together to produce the RDF and the HTML.

But if not Widoco, then can I ask why not? i.e., what specific feature(s) do you think are currently missing, as I believe Daniel (the creator and maintainer of Widoco) is very open to adding missing features, especially if funding might be available(!)...?

The main reason is flexibility to dictate what the HTML content for each term looks like.

  1. DPV has somewhere near ~1000 concepts in the main vocabulary, spread across several 'modules'. Widoco puts them all within the same big list of concepts and AFAIK doesn't allow separating concepts by modules or sections - this has to be done manually. This means all purposes, technical measures, etc. get put into a single list and then we have to manually generate the HTML for set of concepts e.g. some script to list purposes, another one to list technical measure, and so on. I opened an issue to discuss this - see Take modular ontologies as input and generate modular sections in HTML dgarijo/Widoco#558 (sadly no responses)
  2. In order to modify Widoco outputs, we need XSLT templating knowledge - which I personally do not have. I did look into it, but found a steep learning curve. I know python & jinja2 - so I have used that and set up the code in a way that you can swap out the RDF generation and HTML generation parts with someone else in the future - see New style according to respec dgarijo/Widoco#175 where XSLT templating is mentioned
  3. We use ReSpec as this work is a W3C CG output. Widoco AFAIK does not have ReSpec as an output - see New style according to respec dgarijo/Widoco#175 for mention of ReSpec
  4. We have multiple 'serialisations' and Widoco only supports OWL (sort of). So where we are using a SKOS+RDFS based taxonomy - which is quite uncommon - Widoco won't produce the output we want. E.g. Purpose taxonomy has dpv:Purpose as a class and all purposes are instances of this class with skos:broader/narrower relations between them. In the OWL variant, they use rdfs:subClassOf instead.
  5. also see Switch DPV namespace IRI from the current hash to use slash instead #53 (comment) where we discussed in passing the implications of tooling on ability to produce specific kinds of documentation

@coolharsh55 coolharsh55 added this to the dpv v2.1 milestone Apr 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation help-wanted Assistance in performing tasks for this issue todo chores, tasks, things to do
Projects
None yet
Development

No branches or pull requests

3 participants