Skip to content

Commit

Permalink
Merge branch 'rdmorganiser:master-rdmo2.x' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
laura-tte authored May 15, 2024
2 parents ac8b9f6 + e0e04a5 commit aa1e948
Show file tree
Hide file tree
Showing 29 changed files with 21,885 additions and 13,992 deletions.
58 changes: 53 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,61 @@

![Tests](https://github.com/rdmorganiser/rdmo-catalog/actions/workflows/tests.yaml/badge.svg)

The repository holds XML files that can be imported into RDMO. They contain different kinds of information like for example the domain model, question catalogs or optionsets.
This repository contains all content objects (catalogs, attributes, options, conditions, views, tasks) to be used with the DMP software [RDMO](https://github.com/rdmorganiser/rdmo).

The files that are officially provided by the RDMO project are in the `rdmorganiser` folder. We recommend to import these files to be able to make use of the official domain model, options, tasks and conditions. *Note that parts of these data are required to import user content because RDMO user's question catalogs may refer to parts of the official data*.
The main branch [master-rdmo2.x](https://github.com/rdmorganiser/rdmo-catalog/tree/master-rdmo2.x) contains material structured according to the recommended data model 2.0.0+. It is at the latest state and will be updated over time.

Content shared by RDMO Users can be found under `shared`. There may be multiple files in a folder like for example conditions, options and questions. Files in the same folder belong together. All of them should be imported. Please pay attention to the order in which you import files. Question catalogs referring to other content should be imported at last.
The legacy branch [master-rdmo1.x](https://github.com/rdmorganiser/rdmo-catalog/tree/master-rdmo1.x) contains material structured according to the previous data model 1.6.0+. It is frozen at the state of April 2024 und will be not updated any more.

Different scripts are located in `tools`. These are interesting for people maintaining this repo.
The content officially curated by the [RDMO Consortium](https://rdmorganiser.github.io/Community/) is in the [`rdmorganiser`](./rdmorganiser) folder. We recommend to import these files to be able to make use of the official domain model, options, tasks and conditions. *Note that parts of these data are required to import user content because RDMO user's question catalogs may refer to parts of the official data*.

Content shared by RDMO Users can be found under [`shared`](./shared). There may be multiple files in a folder like for example conditions, options and questions. Files in the same folder belong together: all of them should be imported.

Please pay attention to the order in which you import files. Question catalogs referring to other content should be imported at last. See the following section for details.

Different scripts are located in [`tools`](./tools). These are interesting for people maintaining this repo.

# How to install content

The RDMO content objects (catalogs, attributes, options, conditions, views, tasks) depend on each other, as shown in the [documentation](https://rdmo.readthedocs.io/en/latest/management/data-model.html).

In particular, the installation of question catalogues requires the newest version of attributes, optionsets and conditions.

Therefore we suggest this sequence to install content in a RDMO instance:

## Via the RDMO web interface

Management --> Attributes --> Import <chosen_domain_file>.xml
Management --> Conditions --> Import <chosen_conditions_file>.xml
Management --> Option sets --> Import <chosen_options_file>.xml
Management --> Conditions --> Import <chosen_conditions_file>.xml # yes, again
Management --> Questions --> Import <chosen_catalog_file>.xml
Management --> Tasks --> Import <chosen_task_file>.xml
Management --> Views --> Import <chosen_view_file>.xml

REMARK: If the chosen catalog is available as a **full XML**, it already includes the necessary attributes, conditions and options.

## Via a Python script

```python
./manage.py import /path/to/domain/<chosen_domain_file>.xml
./manage.py import /path/to/conditions/<chosen_conditions_file>.xml
./manage.py import /path/to/options/<chosen_options_file>.xml
./manage.py import /path/to/conditions/<chosen_conditions_file>.xml # yes, again
./manage.py import /path/to/questions/<chosen_catalog_file>.xml
./manage.py import /path/to/tasks>/<chosen_task_file>.xml
./manage.py import /path/to/views>/<chosen_view_file>.xml
```

Use the same order when importing over the RDMO web interface.

Please note that the master branch will only work with the latest version of RDMO. If you need the xml files for an older version, please browse the releases or contact us.

To indent the XML files use:

```bash
for f in *.xml; do xmllint --format $f > /tmp/$f; mv /tmp/$f $f; done
```

## Issues

Expand Down Expand Up @@ -63,7 +111,7 @@ For problems or bugs with the RDMO Software, please use the issues in the [rdmo]
|Horizon 2020 |[catalog](shared/ub_fau_erlangen_nuernberg/h2020-ehum/ehum_h2020_fragebogen.xml)|[view](shared/ub_fau_erlangen_nuernberg/h2020-ehum/views_h2020.xml)|2020-09|FDM Bayern eHumanities|
|Mathematics |[catalog](shared/MATH+/mathplus_questions.xml) ||2022-11|DFG Excellence Cluster MATH+|
|Mechanical Engineering |[catalog](shared/nfdi4ing/rdmo_mechanical_engineering/catalog_mb_20190124.xml)||2023-06|NFDI4Ing|
|Research data policy generator|[catalog](shared/FDNext/) ||2023-11|FDNext|
|Research data policy generator|[catalog](shared/FDNext/) ||2024-03|FDNext|
|VW Foundation - Science Europe|[catalog](shared/ub_fau_erlangen_nuernberg/ScienceEurope_VW_Stiftung/catalog_VW_SE.xml)||2021-04|FDM Bayern eHumanities|

Total: 34 catalogs, 15 views
29 changes: 0 additions & 29 deletions rdmorganiser/README.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,17 +1,44 @@
<?xml version="1.0" encoding="UTF-8"?>
<rdmo xmlns:dc="http://purl.org/dc/elements/1.1/">
<rdmo xmlns:dc="http://purl.org/dc/elements/1.1/" created="2024-03-11T10:51:39.946148+01:00" version="2.0.0">
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/additional_rdm_policy">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>additional_rdm_policy</key>
<uri_path>additional_rdm_policy</uri_path>
<dc:comment>There are additional data management requirements.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/additional_rdm_policy/yesno"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/other_requirements_options/146"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-1">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<uri_path>application-class-1</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/1"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-2">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<uri_path>application-class-2</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/2"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-3">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<uri_path>application-class-3</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/3"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/costs_relevant">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>costs_relevant</key>
<uri_path>costs_relevant</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/costs"/>
<relation>eq</relation>
Expand All @@ -20,7 +47,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/data_published">
<uri_prefix>https://rdmorganiser.github.io/terms/</uri_prefix>
<key>data_published</key>
<uri_path>data_published</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/data_publication_date"/>
<relation>eq</relation>
Expand All @@ -29,7 +56,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/data_sharing">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>data_sharing</key>
<uri_path>data_sharing</uri_path>
<dc:comment>The data will be shared.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/sharing/yesno"/>
<relation>eq</relation>
Expand All @@ -38,7 +65,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/embargo">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>embargo</key>
<uri_path>embargo</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/preservation/embargo_period"/>
<relation>gt</relation>
Expand All @@ -47,7 +74,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/infrastructure_resources">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>infrastructure_resources</key>
<uri_path>infrastructure_resources</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/usage_infrastructure"/>
<relation>eq</relation>
Expand All @@ -56,7 +83,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/intellectual_property_rights">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>intellectual_property_rights</key>
<uri_path>intellectual_property_rights</uri_path>
<dc:comment>The project uses data or software that is protected by intellectual property rights.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/legal_aspects/ipr/yesno"/>
<relation>eq</relation>
Expand All @@ -65,7 +92,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/international">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>international</key>
<uri_path>international</uri_path>
<dc:comment>The legal situation of different countries has to be considered.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/legal_aspects/international_yesno"/>
<relation>eq</relation>
Expand All @@ -74,7 +101,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/law_international">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>law_international</key>
<uri_path>law_international</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/legal_aspects/international_yesno"/>
<relation>eq</relation>
Expand All @@ -83,7 +110,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/long_term_preservation">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>long_term_preservation</key>
<uri_path>long_term_preservation</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/preservation"/>
<relation>eq</relation>
Expand All @@ -92,7 +119,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/other_sensitive_data">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>other_sensitive_data</key>
<uri_path>other_sensitive_data</uri_path>
<dc:comment>Other sensitive data being used in the project.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/sensitive_data/other/yesno"/>
<relation>eq</relation>
Expand All @@ -101,7 +128,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/personal_data">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>personal_data</key>
<uri_path>personal_data</uri_path>
<dc:comment>Personal data is used in the project.</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/sensitive_data/personal_data_yesno/yesno"/>
<relation>eq</relation>
Expand All @@ -110,16 +137,25 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/personal_inf_bdsg_3_9">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>personal_inf_bdsg_3_9</key>
<uri_path>personal_inf_bdsg_3_9</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/sensitive_data/personal_data/bdsg_3_9"/>
<relation>eq</relation>
<target_text>1</target_text>
<target_option/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/publish-software">
<uri_prefix>https://rdmorganiser.github.io/terms/</uri_prefix>
<uri_path>publish-software</uri_path>
<dc:comment>introduced by the Max Planck Digital Library to implement the Software Management Plan</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/software-sharing"/>
<relation>neq</relation>
<target_text>0</target_text>
<target_option/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/repository_extern">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>repository_extern</key>
<uri_path>repository_extern</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/preservation/repository"/>
<relation>neq</relation>
Expand All @@ -128,7 +164,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/reuse_scenario">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>reuse_scenario</key>
<uri_path>reuse_scenario</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/reuse_scenario"/>
<relation>neq</relation>
Expand All @@ -137,7 +173,7 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/rights_owner_clear">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>rights_owner_clear</key>
<uri_path>rights_owner_clear</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/ipr/owner/name"/>
<relation>eq</relation>
Expand All @@ -146,25 +182,16 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/rights_owner_unclear">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>rights_owner_unclear</key>
<uri_path>rights_owner_unclear</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/ipr/owner/name"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/yes_with_text_no/no"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/publish-software">
<uri_prefix>https://rdmorganiser.github.io/terms/</uri_prefix>
<key>publish-software</key>
<dc:comment>introduced by the Max Planck Digital Library to implement the Software Management Plan</dc:comment>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/software-sharing"/>
<relation>neq</relation>
<target_text>0</target_text>
<target_option/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/usage_support">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>usage_support</key>
<uri_path>usage_support</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/usage_support"/>
<relation>eq</relation>
Expand All @@ -173,38 +200,11 @@
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/versioning_tool_undecided">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>versioning_tool_undecided</key>
<uri_path>versioning_tool_undecided</uri_path>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/project/dataset/versioning_tool"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/software_versioning_technology_options/164"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-1">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>application-class-1</key>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/1"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-2">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>application-class-2</key>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/2"/>
</condition>
<condition dc:uri="https://rdmorganiser.github.io/terms/conditions/application-class-3">
<uri_prefix>https://rdmorganiser.github.io/terms</uri_prefix>
<key>application-class-3</key>
<dc:comment/>
<source dc:uri="https://rdmorganiser.github.io/terms/domain/smp/application-class"/>
<relation>eq</relation>
<target_text/>
<target_option dc:uri="https://rdmorganiser.github.io/terms/options/application-class/3"/>
</condition>
</rdmo>
Loading

0 comments on commit aa1e948

Please sign in to comment.