search

carpentries / glosario

A multilingual glossary for computing and data science terms.
https://glosario.carpentries.org
Other
105 stars 227 forks source link

2021-02-08: Would glosario take over reference.md ? #280

Open masamiy opened 3 years ago

masamiy commented 3 years ago

There may be other lessons doing the same, but Programming with Python lessons (e.g., https://swcarpentry.github.io/python-novice-inflammation/02-numpy/index.html) has a link to reference.md explaining terminology, such as 'library' and 'import'. Is there a plan for glosario taking over this link in the future?

zkamvar commented 3 years ago

I believe so! The reference guide is one of the older features of the lesson template, and they've been manually curated in the past, which leads to overlap in the definitions (e.g. Programming for Python and Programming for R both have the same definitions for loops), but also leads to divergence in definitions.

One of the features I want to incorporate into the new template is to automatically create links to glosario (and/or compiling a local glossary reference).

zkamvar commented 3 years ago

Until the new template gains this feature, the current way to link to glosario would be to use: [term](https://glosario.carpentries.org/lang/#term), so "libraries" in Spanish would be [biblioteca](https://glosario.carpentries.org/es/#library): biblioteca. If a definition does not exist in a given language, then the link will bring the user to the top of the page (which I realize now is not the best outcome since it's not clear that the definition does not exist).

masamiy commented 3 years ago

Thanks @zkamvar! At this stage, I have no idea when our translated lesson is ready for publish, so, it is okay not to look good. However, I like the idea to insert a glosario link instead of reference.md. So, I will do that and go back to glosario to translate terms.

zkamvar commented 3 years ago

Another approach used by the folks over at the Jekyll lesson in the incubator is to just populate the glossary with the links to glosario: https://carpentries-incubator.github.io/jekyll-pages-novice/reference.html#glossary (instead of replacing all of the inline links).

ezherman commented 2 years ago

Hi @zkamvar, I was wondering whether there have been any developments in this space. Is there a preferred way of integrating glosario definitions into Carpentries Incubator lessons?

I would be happy to make the glossaries manually, just thought I'd check whether automated compilation has been implemented (as is the case for the "Key Points" section of the reference page.

zkamvar commented 2 years ago

Hi @zkamvar, I was wondering whether there have been any developments in this space. Is there a preferred way of integrating glosario definitions into Carpentries Incubator lessons?

I would be happy to make the glossaries manually, just thought I'd check whether automated compilation has been implemented (as is the case for the "Key Points" section of the reference page.

Hi Ezra! At the moment, there is no automatic way to integrate glosario into the lessons. This will be a project for after the beta phase of The Carpentries Workbench, so the perferred method is to directly link to the glosario definitions.

ezherman commented 2 years ago

Sounds good @zkamvar, thank you!