Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file not shown.
70 changes: 70 additions & 0 deletions content/projects/metadata-handbook/index.qmd
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
Comment on lines +4 to +11
Copy link
Contributor

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 format
The 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.

-  affiliation: University of Bern
+  affiliation:
+    - University of Bern
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
author:
- name: Levyn Bürki
orcid: 0009-0009-7602-0714
email: [email protected]
affiliation: University of Bern
roles:
- writing
corresponding: true
author:
- name: Levyn Bürki
orcid: 0009-0009-7602-0714
email: [email protected]
affiliation:
- University of Bern
roles:
- writing
corresponding: true
🤖 Prompt for AI Agents
In content/projects/metadata-handbook/index.qmd around lines 4 to 11, the author
metadata uses a scalar value for the affiliation of the first author, while
others use lists. To fix this, change the affiliation field for all authors to
be lists, even if there is only one affiliation. Additionally, verify that each
ORCID follows the standard 0000-0000-0000-0000 format and correct any
deviations.

- 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue

Fix truncated sentence in Version 2 callout
The sentence currently ends with “with the goal of fostering” and is incomplete. Please finish the thought to maintain clarity and coherence.

🤖 Prompt for AI Agents
In content/projects/metadata-handbook/index.qmd around lines 63 to 69, the
callout note about Version 2 ends with an incomplete sentence "with the goal of
fostering." Complete this sentence by adding the intended conclusion to clearly
express the goal, ensuring the thought is fully conveyed and the text reads
smoothly.