generated from maehr/open-research-data-template
-
Notifications
You must be signed in to change notification settings - Fork 4
Metadata Handbook #12
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
Open
maehr
wants to merge
3
commits into
DHBern:main
Choose a base branch
from
maehr:metadata-handbook
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Binary file added
BIN
+14.3 MB
content/projects/metadata-handbook/handbuch-diskriminierungsfreie-metadaten.pdf
Binary file not shown.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
--- | ||
title: Metadata Handbook | ||
subtitle: Handbook for creating non-discriminatory metadata for historical sources and research data | ||
author: | ||
- name: Levyn Bürki | ||
orcid: 0009-0009-7602-0714 | ||
email: [email protected] | ||
affiliation: University of Bern | ||
roles: | ||
- writing | ||
corresponding: true | ||
- name: Moritz Mähr | ||
orcid: 0000-0002-1367-1618 | ||
email: [email protected] | ||
affiliation: | ||
- University of Basel | ||
- University of Bern | ||
roles: | ||
- writing | ||
- project management | ||
- research data management | ||
corresponding: true | ||
- name: Noëlle Schnegg | ||
orcid: 0009-0008-5207-6652 | ||
email: [email protected] | ||
affiliation: University of Basel | ||
roles: | ||
- writing | ||
- data curation | ||
corresponding: true | ||
categories: | ||
- Metadata Handbook | ||
status: active | ||
other-links: | ||
- text: Handbook (HTML) | ||
icon: filetype-html | ||
href: 'https://maehr.github.io/diskriminierungsfreie-metadaten/' | ||
- text: Handbook (PDF) | ||
icon: filetype-pdf | ||
href: 'https://maehr.github.io/diskriminierungsfreie-metadaten/handbuch-diskriminierungsfreie-metadaten.pdf' | ||
- text: Handbook (Word) | ||
icon: filetype-docx | ||
href: 'https://maehr.github.io/diskriminierungsfreie-metadaten/handbuch-diskriminierungsfreie-metadaten.docx' | ||
- text: Discussion Forum | ||
icon: github | ||
href: https://github.com/maehr/diskriminierungsfreie-metadaten/discussions | ||
code-links: | ||
- text: GitHub Code Repository | ||
icon: github | ||
href: https://github.com/maehr/diskriminierungsfreie-metadaten | ||
--- | ||
|
||
This handbook is a guide to creating non-discriminatory metadata for historical sources and research data, developed as part of the research project Stadt.Geschichte.Basel. It is aimed at professional historians, archivists, librarians, and anyone involved with Open Research Data in the historical sciences. Authors Moritz Mähr and Noëlle Schnegg lead through the practical aspects of creating metadata based on the FAIR principles, to make research data findable, accessible, interoperable, and reusable. Through practical instructions and illustrated case studies, the handbook demonstrates how machine-readable metadata can enrich research and teaching and influence the interpretation of historical sources. As a publicly accessible "Living Document," it is designed for continuous development by the community and is committed to an inclusive and non-discriminatory representation of historical content. The handbook is a fundamental resource for anyone interested in modern digital historical science and Open Research Data. | ||
|
||
::: {.callout-tip title="View Handbook" icon="false" collapse="true"} | ||
<iframe src="./handbuch-diskriminierungsfreie-metadaten.pdf" width="100%" height="600px" loading="lazy" allowfullscreen title="Metadata Handbook"> | ||
|
||
This browser does not support PDFs. Please download the PDF <a href="./handbuch-diskriminierungsfreie-metadaten.pdf">here</a> to view it. | ||
|
||
</iframe> | ||
::: | ||
|
||
::: {.callout-note title="Work on Version 2 Underway"} | ||
Since its first publication in June 2024, this handbook has been used and discussed by a growing community of researchers, archivists, and data professionals. Based on the extensive feedback received, a second, significantly expanded and reorganized version is currently in development. | ||
|
||
Levyn Bürki has joined the author team to support this next phase. Their contributions focus on improving inclusive metadata practices, refining data standards, and updating the handbook’s structure to better support practical use in historical research and cultural heritage institutions. | ||
|
||
Version 2 will continue the handbook’s role as an open, living document—publicly available and collaboratively maintained on [GitHub](https://github.com/maehr/diskriminierungsfreie-metadaten)—with the goal of fostering | ||
::: | ||
Comment on lines
+63
to
+69
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Fix truncated sentence in Version 2 callout 🤖 Prompt for AI Agents
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🛠️ Refactor suggestion
Standardize
affiliation
entries and verify ORCID formatThe first author uses a scalar
affiliation
while the others use lists. For consistency—and to avoid YAML parsing issues—represent all affiliations as lists. Also confirm each ORCID follows the 0000-0000-0000-0000 pattern.📝 Committable suggestion
🤖 Prompt for AI Agents