diff --git a/Makefile b/Makefile index 8b1557b..4ea2906 100644 --- a/Makefile +++ b/Makefile @@ -1,14 +1,26 @@ -all: +all: edmg_help.html + +pdf: sed '/^## \[A\./,/^## \[C. Examples/d' BestPracticeGuide.md | \ sed 's/^# DataCite Best Practice Guide//' | \ sed 's/^#//' | \ pandoc \ -f markdown_github+pandoc_title_block \ -V geometry:a4paper \ -V colorlinks \ --toc \ --metadata link-citations \ - -s \ - -o bestpractice.pdf + -s -o bestpractice.pdf + +edmg_help.html: + sed '/^## \[A\./,/^## \[C. Examples/d' BestPracticeGuide.md | \ + sed 's/^# DataCite Best Practice Guide//' | \ + sed 's/^#//' | \ + pandoc \ + -f markdown_github+pandoc_title_block \ + --toc \ + --metadata link-citations \ + -s -o edmg_help.html + clean: - @$(RM) *.bcf *.run.xml *.out *.aux *.bbl *.blg *.dvi *.log *.pdfsync *.synctex.gz *.toc *~ + @$(RM) *.bcf *.run.xml *.out *.aux *.bbl *.blg *.dvi *.log *.pdfsync *.synctex.gz *.toc *~ edmg_help.html diff --git a/edmg_help.html b/edmg_help.html new file mode 100644 index 0000000..3048419 --- /dev/null +++ b/edmg_help.html @@ -0,0 +1,956 @@ + + +
+ + + + + + + + + + + + + +Version 1.0 (15.11.2019)
+This document is a guideline to use the DataCite Metadata Schema [external link], version 4.3.
+It is meant for researchers, IT and library support staff in the context of the following institutions:
+If you wish to publish your research data in one of these institutions, this guide helps to make your submission compliant to best practices in the context of research data management.
+This guide is also designed to be reused by other institutions as well.
+To create the DataCite-XML file for the project you want to describe, we recommend to you to use our DataCite-Generator [external link]. This tool is kept in sync with this guideline, safe for transmission times inbetween versions. If you want to create metadata for research data on a scale that is too large for manual procedures, please contact one of the institutions named above.
+The first part, General Best Practice, is a selection of recommendations and obligations when using DataCite in general. It has been written in an FAQ-style (Frequently Asked Questions).
+The second part, Best Practice for specific fields, gives more details for each of the 19 metadata fields of the DataCite metadata standard. Note that the following fields are optional/recommended in the DataCite standard, but mandatory according to this guide: Subject, Description, and Rights.
+The third part consists of four complete examples.
+Unless otherwise specified all information in the metadata concerns the research data (also denoted as "resource"), neither the project in whose context the data have been created or collected nor the metadata themselves.
+<title xml:lang="de">
+
+ Bayerisches Musiker-Lexikon Online (BMLO)"</title>
+<title xml:lang="en" titleType="TranslatedTitle">
+
+ Digital Encyclopedia of Bavarian Musicians"</title>
<publisher xml:lang="en">Leibniz Supercomputing Centre</publisher>
<affiliation xml:lang="de">
+
+ Institut für Romanische Philologie, Ludwig-Maximilians-Universität München</affiliation>
<fundingReference>
+ <funderName>Deutsche Forschungsgemeinschaft (DFG)</funderName>
+ <funderIdentifier
+ funderIdentifierType="ROR">
+
+ https://ror.org/018mejw64</funderIdentifier>
+
+ ...</fundingReference>
<creatorName nameType="Personal">Krefeld, Thomas</creatorName>
<givenName>Thomas</givenName>
+ <familyName>Krefeld</familyName>
<nameIdentifier
+ schemeURI="http://d-nb.info/gnd/"
+ nameIdentifierScheme="GND">
+
+ 123778689</nameIdentifier>
+ <nameIdentifier
+ schemeURI="http://orcid.org/"
+ nameIdentifierScheme="ORCID">
+
+ 0000-0001-9657-6052</nameIdentifier>
Metadata can be updated without releasing a new version of the research data, but not vice versa; if the research data change, you need to update the metadata to reflect these changes.
+If you want to publish several versions of the research data, but also want to have a point of reference for all of these publications together, we recommend to use a form of DOI-versioning [external link]:
+Example
+<identifier identifierType="DOI">10.5282/ubm/data.158</identifier>
Example
+<titles>
+<title
+ xml:lang="de">
+
+ Bayerisches Musiker-Lexikon Online (BMLO)</title>
+ <title
+ xml:lang="en"
+ titleType="TranslatedTitle">
+
+ Digital Encyclopedia of Bavarian Musicians</title>
+ </titles>
Example
+<creators>
+<creator>
+ <creatorName nameType="Personal">Krefeld, Thomas</creatorName>
+ <givenName>Thomas</givenName>
+ <familyName>Krefeld</familyName>
+ <nameIdentifier
+ schemeURI="http://d-nb.info/gnd/"
+ nameIdentifierScheme="GND">
+
+ 123778689</nameIdentifier>
+ <nameIdentifier
+ schemeURI="http://orcid.org/"
+ nameIdentifierScheme="ORCID">
+
+ 0000-0001-9657-6052</nameIdentifier>
+ <affiliation
+ xml:lang="de">
+
+ Institut für Romanische Philologie, Ludwig-Maximilians-Universität München</affiliation>
+ </creator>
+ </creators>
Example
+<publisher
+ xml:lang="de">
+
+ Universitätsbibliothek der Ludwig-Maximilians-Universität München</publisher>
Example
+<publicationYear>2019</publicationYear>
Example
+<resourceType resourceTypeGeneral="Dataset">
+
+ Regional Climate Simulation</resourceType>
Type of Subject | +Standard | +Type of standard | +Usage hint | +
---|---|---|---|
Discipline | +DDC | +Classification | +Add 3 digits DDC as specific as possible followed by the English term for the discipline (Canonical Source [external link]) | +
Keywords | +Wikidata Q-ID and GND | +Keyword | +Wikidata and GND terms are both mandatory, including redundancy (if an appropriate entry does not exist contact the ITG). Use Wikidata-Search [external link] and GND-Search [external link] to find the appropriate identifiers. | +
There should be no overlap between the discipline specifier(s) and the keywords.
+Specifying the location via subject is mandatory, if applicable to the resource:
+Example
+<subjects>
+<subject xml:lang="en" schemeURI="http://dewey.info/" subjectScheme="dewey">
+
+ 410 Linguistics</subject>
+ <subject xml:lang="en" schemeURI="http://dewey.info/" subjectScheme="dewey">
+
+ 004 Data processing computer science</subject>
+ <subject
+ xml:lang="de"
+ schemeURI="http://d-nb.info/gnd/"
+ subjectScheme="GND"
+ valueURI="http://d-nb.info/gnd/4740815-7">
+
+ Chalet (Definition: Urspr. die franz. Bezeichnung für Alphütte)</subject>
+ <subject
+ xml:lang="de"
+ schemeURI="https://www.wikidata.org/wiki/"
+ subjectScheme="wikidata"
+ valueURI="https://www.wikidata.org/wiki/Q136689">
+
+ Sennhütte (Gebäude, einfach, auf der Alm zur Verarbeitung von Milch)</subject>
+ <subject
+ xml:lang="en"
+ schemeURI="https://glottolog.org/resource/languoid/id/"
+ subjectScheme="Glottocode"
+ valueURI="https://glottolog.org/resource/languoid/id/high1286">
+
+ High German</subject>
+ <subject
+ xml:lang="de"
+ schemeURI="http://www.geonames.org/"
+ subjectScheme="geonames"
+ valueURI="http://www.geonames.org/2764958">
+
+ Hall in Tirol</subject>
+ </subjects>
Option | +Description from DataCite standard (italics) and usage hints | +
---|---|
ContactPerson | +Person with knowledge of how to access, troubleshoot, or otherwise field issues related to the resource. | +
DataCollector | +Person/institution responsible for finding, gathering/collecting data under the guidelines of the author(s) or Principal Investigator (PI). | +
DataCurator | +Person tasked with reviewing, enhancing, cleaning, or standardizing metadata and the associated data submitted for storage, use, and maintenance within a data centre or repository. | +
HostingInstitution | +Typically, the organisation allowing the resource to be available on the internet through the provision of its hardware/software/operating support. | +
ProjectLeader | +Person officially designated as head of project team or sub-project team instrumental in the work necessary to development of the resource. | +
ProjectManager | +Person officially designated as manager of a project. Project may consist of one or many project teams and sub-teams. | +
ProjectMember | +Person on the membership list of a designated project/project team. All persons with a contract in the context of the project which produced the resource. | +
Researcher | +A person involved in analyzing data or the results of an experiment or formal study. May indicate an intern or assistant to one of the authors who helped with research but who was not so “key” as to be listed as an author. | +
RightsHolder | +Person or institution owning or managing property rights, including intellectual property rights over the resource. Mandatory for non-free licenses; person or institution that owns the rights listed in field Rights. | +
WorkPackageLeader | +The Work Package Leader is responsible for ensuring the comprehensive contents, versioning, and availability of the Work Package during the development of the resource. | +
Example
+<contributors>
+<contributor contributorType="ProjectLeader">
+ <contributorName>Ludwig, Ralf</contributorName>
+ <givenName>Ralf</givenName>
+ <familyName>Ludwig</familyName>
+ <nameIdentifier
+ nameIdentifierScheme="ORCID"
+ schemeURI="http://orcid.org/">
+
+ 0000-0002-4225-4098</nameIdentifier>
+ <affiliation xml:lang="de">
+
+ Department für Geographie, Ludwig-Maximilians-Universität München</affiliation>
+ </contributor>
+ <contributor contributorType="RightsHolder">
+ <contributorName>Štědronská, Markéta</contributorName>
+ <givenName>Markéta</givenName>
+ <familyName>Štědronská</familyName>
+ <nameIdentifier
+ nameIdentifierScheme="GND"
+ schemeURI="http://d-nb.info/gnd/">
+
+ 141321350</nameIdentifier>
+ <affiliation xml:lang="de">
+
+ Institut für Musikwissenschaft, Universität Wien</affiliation>
+ </contributor>
+ </contributors>
Example
+<dates>
+<date dateType="Created">2016</date>
+ <date
+ dateType="Other"
+ dateInformation="coverage">
+
+ 2050-09-01T00:00:00/2050-09-30T23:59:59</date>
+ </dates>
relationType | +Definition (Derived from DataCite Metadata Schema v4.3) | +Example | +Usage | +
---|---|---|---|
Describes | +indicates A describes B | +a README "describes" a dataset | ++ |
IsDescribedBy | +indicates A is described by B | +a dataset "IsDescribedBy" a README | ++ |
HasPart | +indicates A is a portion of B; may be used for elements of a series | +a container "HasPart" a dataset | +use to create hierarchical structures | +
IsPartOf | +indicates A includes the part B | +a dataset "IsPartOf" a container | +use to create hierarchical structures | +
HasMetadata | +indicates resource A has additional metadata B | +a dataset "HasMetadata" | +use to add additional metadata to a dataset e.g. domain-specific metadata | +
IsMetadataFor | +indicates additional metadata A for a resource B | +a metadata file "IsMetadataFor" a dataset | +use to add additional metadata to a dataset e.g. domain-specific metadata | +
HasVersion | +indicates A has a version B | +a dataset "HasVersion" | +use for relating a non-versioned or abstract resource to a versioned resource e.g. a snapshot; alternative usage: Use if exact order of the versions is not known | +
IsVersionOf | +indicates B is a version of A | +a dataset "IsVersionOf" of a dataset | +use for relating a versioned resource (e.g. a snapshot) to a non-versioned or abstract resource; alternative Usage: Use if exact order of the versions is not known | +
IsNewVersionOf | +indicates A is a new edition of B, where the new edition has been modified or updated | +a dataset "IsNewVersionOf" a dataset | +use to order versions | +
IsPreviousVersionOf | +indicates B is a previous edition of A | +a dataset "IsPreviousVersionOf" a dataset | +use to order versions | +
IsSourceOf | +indicates A is a source upon which B is based | +a dataset A "IsSourceOf" a dataset B | +use to express that A has been refined or modified by B | +
IsDerivedFrom | +indicates B is a source upon which A is based | +a dataset B "IsDerivedFrom" a dataset A | +use to express that B is the result of refining or modifying the content of A | +
References | +indicates B is used as a source of information for A | +an article "References" a dataset | ++ |
IsReferencedBy | +indicates A is used as a source of information by B | +a dataset "IsReferencedBy" an article | ++ |
IsVariantFormOf | +indicates A is a variant or different form of B | +a dataset (xml-file) "IsVariantFormOf" a dataset (csv-file) with the same content | ++ |
IsIdenticalTo | +indicates that A is identical to B, for use when there is a need to register two separate instances of the same resource | +a dataset in location A "IsIdenticalTo" a dataset in location B | +use for a resource that is the same as the registered resource but is saved in another location, maybe another institution | +
IsSupplementTo | +indicates that A is a supplement to B | +a dataset "IsSupplementTo" an article | ++ |
IsSupplementedBy | +indicates that B is a supplement to A | +an article "IsSupplementedBy" a dataset | ++ |
Documents | +indicates A is documentation about B; e.g. points to software documentation | +a data management plan (DMP) "Documents" a dataset | ++ |
IsDocumentedBy | +indicates B is documentation about/explaining A; e.g. points to software documentation | +a dataset "IsDocumentedBy" a data management plan (DMP) | ++ |
Example
+
+<relatedIdentifiers>
+<relatedIdentifier relatedIdentifierType="DOI" relationType="IsDescribedBy">
+
+ 10.1175/JAMC-D-18-0021.1</relatedIdentifier>
+ <relatedIdentifier
+ relatedIdentifierType="DOI"
+ relationType="HasMetadata"
+ relatedMetadataSchema="DDI-L"
+ schemeURI="http://www.ddialliance.org/[...]/3.1/XMLSchema/instance.xsd">
+
+ 10.1234/567890</relatedIdentifier>
+ </relatedIdentifiers>
Example
+<descriptions>
+<description xml:lang="en" descriptionType="Abstract">
+
+ The “Kritische Ausgabe der Werke von Richard Strauss”, a long-term editorial
+ project, has been under way at the Institut für Musikwissenschaft of the
+ Ludwig-Maximilians-Universität Munich since 2011; it is directed by ...</description>
+ <description xml:lang="de" descriptionType="Abstract">
+
+ Das Langzeit-Editionsprojekt „Kritische Ausgabe der Werke von Richard Strauss“
+ wird seit Februar 2011 unter der Leitung von Prof. Dr. Hartmut Schick am
+ Institut für Musikwissenschaft der Ludwig-Maximilians-Universität München ...</description>
+ <description xml:lang="en" descriptionType="Methods">
+
+ digital editing, software/application development</description>
+ </descriptions>
Examples
+<geoLocations>
+<geoLocation>
+ <geoLocationPlace>Höslwang</geoLocationPlace>
+ <geoLocationPolygon>
+ <polygonPoint>
+ <pointLatitude>47.9231796264648</pointLatitude>
+ <pointLongitude>12.2860469818115</pointLongitude>
+ </polygonPoint>
+ <polygonPoint>
+ <pointLatitude>47.9231796264648</pointLatitude>
+ <pointLongitude>12.3512439727784</pointLongitude>
+ </polygonPoint>
+ <polygonPoint>
+ <pointLatitude>47.9707412719727</pointLatitude>
+ <pointLongitude>12.3512439727784</pointLongitude>
+ </polygonPoint>
+ <polygonPoint>
+ <pointLatitude>47.9707412719727</pointLatitude>
+ <pointLongitude>12.2860469818115</pointLongitude>
+ </polygonPoint>
+ <polygonPoint>
+ <pointLatitude>47.9231796264648</pointLatitude>
+ <pointLongitude>12.2860469818115</pointLongitude>
+ </polygonPoint>
+ </geoLocationPolygon>
+ </geoLocation>
+ </geoLocations>
<geoLocations>
+<geoLocation>
+ <geoLocationPlace>Hall in Tirol</geoLocationPlace>
+ <geoLocationPoint>
+ <pointLongitude>11.51667</pointLongitude>
+ <pointLatitude>47.28333</pointLatitude>
+ </geoLocationPoint>
+ <geoLocationBox>
+ <westBoundLongitude>11.5272636413574</westBoundLongitude>
+ <eastBoundLongitude>11.4707803726196</eastBoundLongitude>
+ <southBoundLatitude>47.2697830200196</southBoundLatitude>
+ <northBoundLatitude>47.2893867492676</northBoundLatitude>
+ </geoLocationBox>
+ </geoLocation>
+ </geoLocations>
Example
+<language>en</language>
Example
+<alternateIdentifiers>
+<alternateIdentifier alternateIdentifierType="project-specific identifier">
+
+ S15645_v4_182</alternateIdentifier>
+ </alternateIdentifiers>
Example
+<sizes>
+<size>6197732B</size>
+ </sizes>
Example
+<formats>
+<format>application/tar+gzip</format>
+ <format>application/netcdf</format>
+ <format>text/plain</format>
+ <format>text/csv</format>
+ </formats>
Example
+<version>4.2.1</version>
Guidance for using a license:
+Example
+<rightsList>
+<rights
+ xml:lang="en-US"
+ schemeURI="https://spdx.org/licenses/"
+ rightsIdentifierScheme="SPDX"
+ rightsIdentifier="CC0-1.0"
+ rightsURI="http://creativecommons.org/publicdomain/zero/1.0/"
+/>
+ </rightsList>
Example
+<fundingReferences>
+<fundingReference>
+ <funderName>Deutsche Forschungsgemeinschaft (DFG)</funderName>
+ <funderIdentifier funderIdentifierType="ROR">
+
+ https://ror.org/018mejw64</funderIdentifier>
+ <awardNumber>253900505</awardNumber>
+ <awardURI>http://gepris.dfg.de/gepris/projekt/253900505</awardURI>
+ <awardTitle xml:lang="de">
+
+ VERBA ALPINA. Der alpine Kulturraum im Spiegel seiner Mehrsprachigkeit</awardTitle>
+ </fundingReference>
+ </fundingReferences>
The Digital Encyclopedia of Bavarian Musicians (Bayerisches Musiker-Lexikon Online, short BMLO) refers as a musicological model project. The BMLO offers a digital biographical dictionary focussing on music science, furthermore it enriches the presented personalities of Bavarian history of music by implementing further information, gathered from biographical literature, archives, libraries and digital collections. In this way, the BMLO constitutes the core of an interconnected, virtual cluster for history of music. Currently, 24621 out of a total of 27818 records is presented on the web. As parts of this semantic network should also be mentioned the Munich Dictionary of Musik (Münchner Musiklexikon, short MUK), which serves since 2010 as a encyclopedia for music corporations with a linkage to Munich, as well as LOCI, a geographic database for music, culture and history, founded in 2012.
+ +The project VerbaAlpina seeks to investigate the Alpine region in its cultural and historical linguistic unity from a transnational perspective through selective analyses. For this purpose, a comprehensive, multilingual research environment will be set up using up-to-date media technology (database, georeferenced cartography, internet, data collection with social software). The guiding intention is to analyze already existing data from linguistic atlases and dictionaries (partly difficult of access) which is first structured and linguistically annotated according to certain principles to fit the database of VerbaAlpina.
+Verba Alpina metadata example 1 Verba Alpina metadata example 2
+The ClimEx project investigates the effects of climate change on meteorological and hydrological extreme events and implications for water management in Bavaria and Québec. It especially consists of two new aspects:
+An ensemble of 50 transient runs of the canadian general circulation model CanESM2 (~200km resolution) from 1950 to 2100, resulting in 7500 years of modelled climate. As each of these runs is initialized with only slightly altered starting conditions, this ensemble can be interpreted as (modelled) natural variability. The CanESM2 then drives the regional climate model CRCM5 (~11km resolution) for a domain that covers most of central Europe. Both models are internationally established and widely used in the climate science community.
A physically based hydrological model (WaSiM) is driven by this climate input for the entire hydrological Bavaria at very high temporal and spatial resolution of 3 hours and 500m to investigate both climate change impacts and natural variability of extreme events, especially floods.
ClimEx further strengthens the international collaboration between Bavaria and Québec as research facilities, universities and public water agencies intensify their former cooperation approaches.
+ + +