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

Check english and german language files #154

Closed
roewenstrunk opened this issue Dec 1, 2021 · 6 comments · Fixed by #454
Closed

Check english and german language files #154

roewenstrunk opened this issue Dec 1, 2021 · 6 comments · Fixed by #454

Comments

@roewenstrunk
Copy link
Member

Check if the english and german language files have equal entries.

@bwbohl bwbohl added this to the refactoring milestone Jun 17, 2022
@bwbohl
Copy link
Member

bwbohl commented Jun 17, 2022

Schematron could be very useful here.

@krHERO krHERO moved this to New in Edirom Development Jul 3, 2024
@krHERO krHERO removed this from the refactoring milestone Jul 4, 2024
@bwbohl bwbohl added this to the 1.0.0 milestone Sep 6, 2024
@peterstadler
Copy link
Member

It'd probably quite easy to add a test to the GitHub actions to check for this issue (be it schematron or what have you).

On the other hand that would not help customizations of the Edirom where users might alter those dictionaries or even provide their own (I assume this is possible)? So maybe we should even run this check at startup and output a warning if some misalignment was found?

@bwbohl
Copy link
Member

bwbohl commented Sep 30, 2024

It is very easy to provide individual dictionaries in your Edition data (should find a way into documentation, e.g. #415 ) that will override the default dictionaries but still use them as a fallback.

@bwbohl bwbohl moved this from New to Backlog in Edirom Development Oct 9, 2024
@peterstadler peterstadler self-assigned this Oct 10, 2024
@peterstadler
Copy link
Member

I'm volunteering to implement such a test but still need some guidance on where and when to run such a test:

  • when installing Edirom Online, i.e. as a post-install-script within eXist?
  • when building Edirom Online, i.e. as part of the (yet to be implemented) test suite? (This would allow to test this locally as well as on any CI/CD system)

@roewenstrunk
Copy link
Member Author

Hi @peterstadler, Ideally, we would have two tests. When the Edirom is built, we can only test the information that is delivered with the Edirom or the information that is built in via a fork. We often also allow project-specific customizations through information in the data packages, but these are not available neither when building nor when installing the Edirom. It might be a good idea to offer tests for data packages here.
I would suggest that we first start with a test when building the Edirom. This can then also be offered stand-alone for data packets. What do you think?

@bwbohl
Copy link
Member

bwbohl commented Oct 11, 2024

We could decide on whether to have the schematron for this in the https://github.com/Edirom/edirom-edition-schema repository then it could be used 'idendependently'.

The fist aim could be to just check the lang files when editing them, e.g. by referencing the schematron from the files. Checking this on build seems like a good idea. Additionally we could add a GitHub Action that performs the check when any of the files gets modified in a PR to assure that all languages cover all terms e.g. in case something get added or removed.

For data packages the tricky part is they don’t have to provide full coverage of all language variables but might just provide those that should be overridden. The Edirom Online uses its default language files as fallback in those cases.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment