diff --git a/README.md b/README.md index 606ad22d8a184a0afd8f0f880f67fc5074104ed5..6e0e01189809d94f80f98bf2d65b17ccdb9ae04d 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,17 @@ # SFB 1280 MetaDataApp ## Introduction and wiki -One of the most important steps in managing research data is the creation of metadata. Metadata represents characteristics of the raw data collected, such as the creator, date, subjects. License, publisher, etc. are also metadata. However, selecting the appropriate metadata fields is a difficult task. The easiest way is to have a template that contains a [mapping to bibliometric metadata standards](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/MetaDataApp-Wiki/Mapping-to-DublinCore-and-DataCite) such as DublinCore and DataCite: The [SFB 1280 metadata schema](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/MetaDataApp-Wiki/SFB-1280-metadata-fields) is such a template with 16 fields developed by SFB representatives. In accordance with the [SFB's research data management policy](https://sfb1280.ruhr-uni-bochum.de/wp-content/uploads/2022/10/SFB1280_ResearchDataManagementPolicy_ADOPTED_20220928.pdf), storage of this metadata is mandatory for all SFB 1280 groups. +One of the most important steps in managing research data is the creation of metadata. Metadata represents characteristics of the raw data collected, such as the creator, date, subjects. License, publisher, etc. are also metadata. However, selecting the appropriate metadata fields is a difficult task. The easiest way is to have a template that contains a [mapping to bibliometric metadata standards](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/MetaDataApp-Wiki/Mapping-to-DublinCore-and-DataCite) such as DublinCore and DataCite: The [SFB 1280 metadata schema](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/MetaDataApp-Wiki/SFB-1280-metadata-fields) is such a template with 16 fields developed by SFB representatives. In accordance with the [SFB's research data management policy](https://doi.org/10.5281/zenodo.8004432), storage of this metadata is mandatory for all SFB 1280 groups. Please refer to this project's [wiki page for information about the SFB 1280 metadata schema](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/wikis/home). ## About this project -To save researchers noticeable routine work in creating metadata in the medium term, the SFB 1280 INF project developed the SFB 1280 MetadataApp. The MetaDataApp is a Java application with a graphical user interface that allows researchers to easily enter metadata, as well as store metadata in local json files along with research data using an inheritance strategy. It allows the input of SFB 1280 metadata, as well as additional DublinCore and DataCite metadata that have no mapping to SFB 1280 metadata but are important for publishing the data according to the FAIR principles later. +To save researchers noticeable routine work in creating metadata in the medium term, the SFB 1280 INF project developed the SFB 1280 MetadataApp. The MetaDataApp is a Java application with a graphical user interface that allows researchers to easily enter metadata, as well as store metadata in local json files along with research data using an inheritance strategy. It allows the input of SFB 1280 metadata, as well as additional DublinCore and DataCite metadata that have no mapping to SFB 1280 metadata but are important for publishing the data according to the FAIR principles later. You can download an already exported version of the program [here](https://gitlab.ruhr-uni-bochum.de/sfb1280/metaapp_2/-/blob/main/exported_example/MetaDataApp.jar) as a .jar file to get a first overview of the program.  -The MetaDataApp will store the entries in a json file format that allows further use in a database (see related project: [SFB 1280 DatabaseApp](https://gitlab.ruhr-uni-bochum.de/sfb1280/databaseapp)) and other repositories. Json is a well-established data-interchange format that can be transformed easily in any pipeline regardless of programming language use. The [SFB 1280 DatabaseApp](https://gitlab.ruhr-uni-bochum.de/sfb1280/databaseapp) is an additional developed Java application that makes the thus created metadata searchable and search results easily retrievable. +The MetaDataApp will store the entries in a json file format that allows further use in a database (see related project: [SFB 1280 DatabaseApp](https://gitlab.ruhr-uni-bochum.de/sfb1280/databaseapp_2.0)) and other repositories. Json is a well-established data-interchange format that can be transformed easily in any pipeline regardless of programming language use. The [SFB 1280 DatabaseApp](https://gitlab.ruhr-uni-bochum.de/sfb1280/databaseapp_2.0) is an additional developed Java application that makes the thus created metadata searchable and search results easily retrievable. ## Structure of the project @@ -25,7 +25,7 @@ The MetaDataApp will store the entries in a json file format that allows further - jgoodies-forms-1.8.0-source.jar - json-simple-1.1.jar - miglayout15-swing.jar -- **.classpath**: Might be importatant to setup the libs, but this can be done manual aswell. +- **.classpath**: Might be important to setup the libs, but this can be done manual as well. ## Structure of the code @@ -39,8 +39,8 @@ External Libaries: Both for JSON handling #### Line 92 to 266 -Functions for inputfield formatting. -Those functions get a input component as a parameter and add certain listener to it. For example: This could be a listener, which colors the field red, whenever the input format is not correct. +Functions for input field formatting. +Those functions get a input component as a parameter and add certain listener to it. For example: This could be a listener, which colours the field red, whenever the input format is not correct. #### Line 271 to 357 Utilily functions @@ -58,7 +58,7 @@ If there is already a meta.JSON file, then this code area will read the data out UI of the application #### Line 1641 to 1808 -Adding special features to the UI. Such as adding enforced formats to inputfields. +Adding special features to the UI. Such as adding enforced formats to input fields. #### Line 1809 to 1948 Save the content to a new meta.JSON file. @@ -70,11 +70,11 @@ UI (Panels) ## License and Citation This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License: https://creativecommons.org/licenses/by-sa/4.0/ -Please cite as:Zomorodpoosh, Setareh; Diers, Erik; Linn, Sandra; Merz, Christian J.; Windeck, Jürgen; Pacharra, Marlene; Otto, Tobias (2023). MetaDataApp. +Please cite as: Zomorodpoosh, Setareh, Diers, Erik, Linn, Sandra, Merz, Christian J., Pacharra, Marlene, & Otto, Tobias. (2023). MetaDataApp v2.0. Zenodo. https://doi.org/10.5281/zenodo.8040229 ## Contact If you have any questions about the MetaDataApp, or if you have feature requests or found bugs, please contact the SFB's INF project via email: sfb1280data@rub.de ## Funding -The development of the SFB 1280 subject code generator was carried out as part of the SFB 1280 INF project, supported by the Deutsche Forschungsgemeinschaft DFG (German Research Foundation, project number 31680338). +The development of the SFB 1280 subject code generator was carried out as part of the SFB 1280 INF project, supported by the Deutsche Forschungsgemeinschaft DFG (German Research Foundation, project number 316803389). CJM received support by the SFB 1280 A09 project. diff --git a/exported_example/.gitkeep b/exported_example/.gitkeep new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/exported_example/MetaDataApp.jar b/exported_example/MetaDataApp.jar new file mode 100644 index 0000000000000000000000000000000000000000..74cf70698547e2af4012066aca5a0f005179ea9b Binary files /dev/null and b/exported_example/MetaDataApp.jar differ