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

Suggestion: edit the format of the config.properties file to better allocate multiple values #603

Open
Zack-83 opened this issue Jul 25, 2023 · 3 comments
Assignees
Labels
new feature request for supporting a new feature

Comments

@Zack-83
Copy link
Contributor

Zack-83 commented Jul 25, 2023

Is your feature request related to a problem? Please describe.
Ontology metadata are mainly stored in a config.properties file. If a field contains multiple values, they are separated via a semicolon with no empty space. Several multiple-valued fields in 1:1 correspondence (contributors, contributorsURI, contributorsInstitution etc.) are listed separately. This makes it difficult to keep an overview and is prone to mistakes.

image

Describe the solution you'd like
Solution 1: Allow a table-similar syntax (e.g. allowing nonsignificant leading/trailing spaces, which are trimmed during parsing)

contributors		   = Contributor1             ; Contributor2             ; ...
contributorsURI		   = https://orcid.org/ORCID1 ; https://orcid.org/ORCID2 ; ...
contributorsInstitution	   = Affiliation1 (Acronym1)  ; Affiliation2 (Acronym2)  ; ...
contributorsInstitutionURI = https://ror.org/ROR1     ; https://ror.org/ROR2     ; ...

Solution 2: Group corresponding items (contributor 1 together with URI 1 and affiliation 1), maybe in a JSON-similar syntax

contributorsBlock1 = {
    contributors		= Contributor1
    contributorsURI		= https://orcid.org/ORCID1
    contributorsInstitution	= Affiliation1 (Acronym1)  
    contributorsInstitutionURI	= https://ror.org/ROR1    
}
contributorsBlock2 = {
    contributors		= Contributor2
    contributorsURI		= https://orcid.org/ORCID2
    contributorsInstitution	= Affiliation2 (Acronym2)  
    contributorsInstitutionURI	= https://ror.org/ROR2    
}

Describe alternatives you've considered
The .properties format allows breaking lines with a backslash. Therefore a syntax like

contributorsInstitutionURI = https://ror.org/ROR1;\
    https://ror.org/ROR2;\
    https://ror.org/ROR3

might be used to increase legibility, but would not be tremendously helpful if the number of authors is large.

@dgarijo
Copy link
Owner

dgarijo commented Jul 25, 2023

Another option is keeping the info in RDF in the ontology itself, which works quite well and it's easier for maintenance.
Probably a JSON-like properties file would be better to avoid complicating things

@dgarijo dgarijo self-assigned this Aug 10, 2023
@dgarijo dgarijo added the new feature request for supporting a new feature label Aug 10, 2023
@Zack-83
Copy link
Contributor Author

Zack-83 commented Aug 11, 2023

Probably a JSON-like properties file would be better to avoid complicating things

Could we for instance exploit the "Citation file format"?
https://github.com/citation-file-format/citation-file-format

@dgarijo
Copy link
Owner

dgarijo commented Aug 11, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature request for supporting a new feature
Projects
None yet
Development

No branches or pull requests

2 participants