search

OpenEnergyPlatform / ontology

Repository for the Open Energy Ontology (OEO)
Creative Commons Zero v1.0 Universal
105 stars 19 forks source link

Add german labels to four terms #1471 #1854

Closed vismayajochem closed 1 month ago

vismayajochem commented 1 month ago

Summary of the discussion

As discussed on the OEO developer meeting I am working on the german labels. This is test PR. I implemented four new labels please check if everything is correct.

PR-Assignee

Reviewer

christian-rli commented 1 month ago

Thank you for checking the PR @l-emele . @vismayajochem and I created the commit together, so I tried to reproduce the problem on my system. It seems that when only adding an annotation and hitting file save in protégé (v5.6.1) the changes are not actually saved. I tried this twice by adding the German label Abkürzung to abbreviation and saving. The file is updated with a new timestamp, but unchanged - git doesn't show a changed file.

In the commit referenced here, the fresh install of protégé just seems to have added these mostly empty lines, which is why we thought our changes were saved.

As a workaround i tried to save the oeo to a new file. I saved the file in the preselected Manchester OWL syntax, which caused the following warning: "The Manchester OWL Syntax can lose information such as GCI's and annotations of undeclared entities. Continue?" (highlighting by me) and sure enough - the new file too, does not show the change. Then I saved the changes to a new file in RDF/XML syntax and the changes were stored.

I admit to be a bit confused. Am I missing something fundamental in the workflow? Did we miss a crucial setup step in protégé? Thanks for a response.

stap-m commented 1 month ago

Protege is moody sometimes. It should be restarted once a new branch is used. Did you try that?

christian-rli commented 1 month ago

Ah. I consulted the mighty wiki to find this manual: https://github.com/OpenEnergyPlatform/ontology/wiki/How-to-use-prot%C3%A9g%C3%A9-to-change-the-ontology

Selecting the correct module did allow saving to the correct file. I assumed saving to the right module would be done automatically. We will adapt our workflow and try again.

stap-m commented 1 month ago

Please use alternative label istead. label must stay unique for each entity.

christian-rli commented 1 month ago

Please use alternative label istead. label must stay unique for each entity.

Thank you for this note. I did wonder about the search now showing the German label only. I reverted the changes, so we can start from scratch.

christian-rli commented 1 month ago

OK. I think we figured out the workflow and will continue to work on this next week. The issue comprises over 1000 labels, so it will have to be done step by step. What is the suggested workflow? We can create many smaller PRs or work on one large one, regularly merging the dev branch back into this one. Thanks again for the helpful quick responses.

vismayajochem commented 1 month ago

In the google docs sheet (https://docs.google.com/spreadsheets/d/1snsx6zF8dqXGM9WCX0EckrdGnorrB9lMnvdvP2fx9ZQ/edit#gid=687082420) in row 79 the english label 'bid' has two german labels. The second one has a questionmark behind it ('Angebot?'). How should I proceed there @l-emele ?

christian-rli commented 1 month ago

There is only a change in oeo.omn (which should not be there) but no changes in other files. Maybe you did not commit the changes in all files?

This has been addressed. We have added some new German alternative labels and are ready to merge this PR, if accepted. As discussed in the last developer meeting, we will work on issue #1471 in several smaller PRs so that this PR won't stay open for too long. The changelog will list all PRs in which German labels were added.

stap-m commented 1 month ago

I'd like to recommend that you mark in the spread sheet which entities have been implemented so far.

l-emele commented 1 month ago

four minor remarks. I think we should unify camel cases. The rest looks fine.

As we follow English language rules for English labels, we should follow German language rules for German labels which means starting with lower case for verbs and and adjectives and upper case for substantive and proper names.

This has nothing to do with Camel Case. In my understanding, ThisIsCamelCase, i.e. concatenating by deleting blanks and starting every word with a capital letter.

l-emele commented 1 month ago

In the google docs sheet (https://docs.google.com/spreadsheets/d/1snsx6zF8dqXGM9WCX0EckrdGnorrB9lMnvdvP2fx9ZQ/edit#gid=687082420) in row 79 the english label 'bid' has two german labels. The second one has a questionmark behind it ('Angebot?'). How should I proceed there @l-emele ?

Angebotis also highlighted yellow. If I recall correctly, we were not sure about Angebot. So I suggest to implement only Gebot.

stap-m commented 1 month ago

four minor remarks. I think we should unify camel cases. The rest looks fine.

As we follow English language rules for English labels, we should follow German language rules for German labels which means starting with lower case for verbs and and adjectives and upper case for substantive and proper names.

Ok. I was irritated by the fact that some labels start with lowercase and other with uppercase, but I get the logic...

christian-rli commented 1 month ago

Thank you @l-emele and @stap-m. I accepted the suggestion in line 1778. Now shouldn't I change back the four labels with adjectives to start in lower case for consistency before merging? I can do that, just need a confirmation.

l-emele commented 1 month ago

The four changes from @stap-m are resolved instead of commited which means they were not included in this branch. So no need to revert.