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

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

Open
masamiy opened this issue Feb 7, 2021 · 7 comments
Open

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

masamiy opened this issue Feb 7, 2021 · 7 comments
Labels
question Further information is requested

Comments

@masamiy
Copy link
Contributor

masamiy commented Feb 7, 2021

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?

@masamiy masamiy added the question Further information is requested label Feb 7, 2021
@zkamvar
Copy link
Contributor

zkamvar commented Feb 8, 2021

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
Copy link
Contributor

zkamvar commented Feb 8, 2021

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
Copy link
Contributor Author

masamiy commented Feb 13, 2021

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
Copy link
Contributor

zkamvar commented Feb 15, 2021

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
Copy link

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
Copy link
Contributor

zkamvar commented Apr 20, 2022

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
Copy link

Sounds good @zkamvar, thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants