glossarist / glossarist-ruby

Concept modeller in Ruby
BSD 2-Clause "Simplified" License
1 stars 1 forks source link

International symbols #9

Open skalee opened 3 years ago

skalee commented 3 years ago

@ronaldtse, @opoudjis, @strogonoff I have three questions:

  1. Should international symbols be shared by all localizations of given concept?
  2. If so, how to represent them in underlying YAMLs, in order to maintain compatibility with Paneron? Separate array at concept level? Together with other designations, just repeated for every language? Together with designations for default language only (this is what we do now, but it's by accident rather than deliberate)?
  3. Any special requirements regarding Glossarist gem API?
ronaldtse commented 3 years ago
  1. Yes
  2. Ask @strogonoff ?
  3. I expect @opoudjis would be able to tell you when he integrates with Metanorma?
ronaldtse commented 2 years ago

@HassanAkbar is this task addressed?

HassanAkbar commented 2 years ago

@ronaldtse From what I understand currently in glossarist the symbols are in the LocalizedConcept and are not currently being shared by all localization.

In the concept model, the symbols are in concept base so they will be shared by all localizations (this is not implemented yet).

I'm not sure about 2 and 3. Will have to look into it.

ronaldtse commented 2 years ago

I think for symbols there are two types: across languages and per language. There is a special type of symbol that applies internationally, ie. “international symbol” and across localizations. These are the ones like the SI system symbols “m”, “s” etc.

Let’s take this concept and elaborate into 2 and 3.

strogonoff commented 2 years ago

If so, how to represent them in underlying YAMLs, in order to maintain compatibility with Paneron? Separate array at concept level? Together with other designations, just repeated for every language? Together with designations for default language only (this is what we do now, but it's by accident rather than deliberate)?

We have some provisions to do that (let me check), but I don’t think they’re necessarily the most elegant way to handle this.

I think our data structure doesn’t really allow for international concept data, and this is something that should be addressed on a more fundamental level—adding this symbol to localized concept description for a particular language and indicating a symbol as “international” strikes me as a crutch.

ronaldtse commented 2 years ago

Please feel free to update the concept model and resulting structures to accommodate the international symbol in a clean/native way. Thanks!

opoudjis commented 2 years ago

I have no idea what the integration into Metanorma will look like, and if I have my way, I'm not going to be the one to implement it anyway :-P

While you can do what you want in the conceptual modelling of symbols and whatever classes are associated, I'm responsible in Metanorma for a serialisation of the concept model that is parsed grammatically, and I'm responsible for an existing (non-YAML) implementation of markup for concepts. Therefore, I am to be consulted before that changes. Although frankly, I'm not convinced the serialisation, as opposed to the underlying model, needs to change at all.

HassanAkbar commented 1 year ago

@ronaldtse Not sure what’s to be done in this ticket. There is an international flag in the symbols class what should we do if it is true? Should we add it to all the localizations if the flag is true or move it outside the localizations and save it at the concept level?