alpheios-project / alpheios-core

Alpheios Core Javascript Packages and Libraries
15 stars 2 forks source link

Add a new glossary for Latin short definitions (paideia) #647

Closed irina060981 closed 3 years ago

irina060981 commented 3 years ago

1A Glossary.txt

from @balmas I wrote up the instructions for adding a new short definitions file to Alpheios at https://github.com/alpheios-project/documentation/blob/master/development/adding-short-definitions.md

The minimum additional step that is needed for Paidea here is to add a parameter to the embedded library that allows you to override which short definitions file to use as the default for the page. The way I had done this originally was to use the site-options.json config file (https://github.com/alpheios-project/alpheios-core/blob/master/packages/components/src/settings/site-options.json) to provide site-specific options. So that might be an alternative too but I honestly don't know if that works anymore or not. You'd have to look through the code to see.

In an ideal world, we would eliminate the need to rebuild the alpheios-core libraries for new settings and make it so that the defaults for the dictionary settings (and others) come from the config api too, so that no rebuild of Alpheios is required to add new short definitions in the future. But I'm not sure we want to undertake that right now.

I'd recommend getting it working with the alpheios-core code as it stands (following the linked instructions and then either adding the dictionary setting to site-options.json if it works, or to the language-optios-defaults.json if it doesn't and using an override from the embedded library to set the default) and then taking stock of where we are before going further.

irina060981 commented 3 years ago

done