Various fixes (#2)

- Updated the build-deploy job operating system from `ubuntu-latest` to `macos-latest`. - Updated a hyperlink in the website configuration. - Changed the license to "Attribution-ShareAlike 4.0 International" and updated license terms. - Renamed a custom reference document and added a custom CSS style sheet for printing. - Refined the project description and modified scripts to exclude specific files from Prettier processing. - Introduced a guide on creating discrimination-free metadata in `CITATION.cff`. - Adjusted `.gitignore` and `manuscript/.gitignore` exclusions.
maehr · Jun 2, 2024 · 2204a3d · 2204a3d
1 parent f1253df
commit 2204a3d
Show file tree

Hide file tree

Showing 12 changed files with 606 additions and 1,288 deletions.
diff --git a/.github/_quarto.yml b/.github/_quarto.yml
@@ -41,7 +41,7 @@ website:
           - text: Contributing
             href: CONTRIBUTING.md
           - text: License (Data)
-            href: LICENSE-CCBY.md
+            href: LICENSE-CCBYSA.md
           - text: License (Code)
             href: LICENSE-AGPL.md
           - text: Security

diff --git a/.github/workflows/quarto-publish.yml b/.github/workflows/quarto-publish.yml
@@ -12,9 +12,14 @@ permissions:
 
 jobs:
   build-deploy:
-    runs-on: ubuntu-latest
+    runs-on: macos-latest
 
     steps:
+      - name: Set Timezone
+        uses: szenius/[email protected]
+        with:
+          timezoneMacos: 'Europe/Zurich'
+
       - name: Check out repository
         uses: actions/checkout@v4
 
@@ -36,6 +41,10 @@ jobs:
           path: manuscript
           to: all
 
+      - name: Install Chromium
+        run: |
+          brew install --cask chromium
+
       - name: Convert html to pdf with Chromium
         run: |
           chromium --headless --disable-gpu --print-to-pdf=manuscript/_manuscript/handbuch-diskriminierungsfreie-metadaten.pdf  --scale=1.0 --no-pdf-header-footer --print-background --virtual-time-budget=10000 file:///$(pwd)/manuscript/_manuscript/index.html

diff --git a/.gitignore b/.gitignore
@@ -1,7 +1,3 @@
-# Quarto
-manuscript/.quarto/
-manuscript/_manuscript/
-
 # Exclude example.env
 !example.env
 

diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,34 @@
+cff-version: 1.2.0
+title: >-
+  Handbuch zur Erstellung diskriminierungsfreier Metadaten
+  für historische Quellen und Forschungsdaten
+message: 'If you use this guide, please cite it as below.'
+type: software
+authors:
+  - family-names: Mähr
+    given-names: Moritz
+    affiliation: University of Basel
+    orcid: 'https://orcid.org/0000-0002-1367-1618'
+  - family-names: Schnegg
+    given-names: Noëlle
+    affiliation: University of Basel
+    orcid: 'https://orcid.org/0009-0008-5207-6652'
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.11124720
+repository-code: 'https://github.com/maehr/diskriminierungsfreie-metadaten'
+url: 'https://maehr.github.io/diskriminierungsfreie-metadaten/'
+abstract: >-
+  Dieses Handbuch ist ein Leitfaden zur Erstellung von diskriminierungsfreien Metadaten für historische Quellen und Forschungsdaten, der im Rahmen des Forschungsprojekts Stadt.Geschichte.Basel entwickelt wurde. Es richtet sich an professionelle Historiker\*innen, Archivar\*innen, Bibliothekar\*innen und alle, die sich mit Open Research Data in den Geschichtswissenschaften beschäftigen. Die Autor\*innen Moritz Mähr und Noëlle Schnegg führen durch die praktischen Aspekte der Erstellung von Metadaten, basierend auf den FAIR-Prinzipien, um Forschungsdaten auffindbar, zugänglich, interoperabel und nachnutzbar zu machen. Durch praktische Anleitungen und illustrierte Fallbeispiele zeigt das Handbuch, wie maschinenlesbare Metadaten Forschung und Lehre bereichern und die Interpretation historischer Quellen beeinflussen können. Als öffentlich zugängliches "Living Document" ist es auf eine kontinuierliche Weiterentwicklung durch die Community ausgelegt und verpflichtet sich zu einer inklusiven und diskriminierungsfreien Darstellung historischer Inhalte. Das Handbuch ist eine grundlegende Ressource für alle, die sich mit moderner digitaler Geschichtswissenschaft und Open Research Data beschäftigen wollen.
+keywords:
+  - Diskriminierungsfreie Metadaten
+  - Historische Quellen und Forschungsdaten
+  - FAIR-Prinzipien
+  - Stadt.Geschichte.Basel
+  - Open Research Data
+  - Code of Conduct
+  - Dublin Core
+  - Schlagwortindex GenderOpen
+license: CC-BY-SA-4.0
+version: '1.0'
+date-released: '2024-06-03'
diff --git a/LICENSE-CCBY.md → LICENSE-CCBYSA.md b/LICENSE-CCBY.md → LICENSE-CCBYSA.md
@@ -1,4 +1,4 @@
-Attribution 4.0 International
+Attribution-ShareAlike 4.0 International
 
 =======================================================================
 
@@ -33,7 +33,7 @@ exhaustive, and do not form part of our licenses.
      material not subject to the license. This includes other CC-
      licensed material, or material used under an exception or
      limitation to copyright. More considerations for licensors:
-	wiki.creativecommons.org/Considerations_for_licensors
+    wiki.creativecommons.org/Considerations_for_licensors
 
      Considerations for the public: By using one of our public
      licenses, a licensor grants the public permission to use the
@@ -48,22 +48,24 @@ exhaustive, and do not form part of our licenses.
      rights in the material. A licensor may make special requests,
      such as asking that all changes be marked or described.
      Although not required by our licenses, you are encouraged to
-     respect those requests where reasonable. More_considerations
+     respect those requests where reasonable. More considerations
      for the public:
-	wiki.creativecommons.org/Considerations_for_licensees
+    wiki.creativecommons.org/Considerations_for_licensees
 
 =======================================================================
 
-Creative Commons Attribution 4.0 International Public License
+Creative Commons Attribution-ShareAlike 4.0 International Public
+License
 
 By exercising the Licensed Rights (defined below), You accept and agree
 to be bound by the terms and conditions of this Creative Commons
-Attribution 4.0 International Public License ("Public License"). To the
-extent this Public License may be interpreted as a contract, You are
-granted the Licensed Rights in consideration of Your acceptance of
-these terms and conditions, and the Licensor grants You such rights in
-consideration of benefits the Licensor receives from making the
-Licensed Material available under these terms and conditions.
+Attribution-ShareAlike 4.0 International Public License ("Public
+License"). To the extent this Public License may be interpreted as a
+contract, You are granted the Licensed Rights in consideration of Your
+acceptance of these terms and conditions, and the Licensor grants You
+such rights in consideration of benefits the Licensor receives from
+making the Licensed Material available under these terms and
+conditions.
 
 
 Section 1 -- Definitions.
@@ -82,51 +84,59 @@ Section 1 -- Definitions.
      and Similar Rights in Your contributions to Adapted Material in
      accordance with the terms and conditions of this Public License.
 
-  c. Copyright and Similar Rights means copyright and/or similar rights
+  c. BY-SA Compatible License means a license listed at
+     creativecommons.org/compatiblelicenses, approved by Creative
+     Commons as essentially the equivalent of this Public License.
+
+  d. Copyright and Similar Rights means copyright and/or similar rights
      closely related to copyright including, without limitation,
      performance, broadcast, sound recording, and Sui Generis Database
      Rights, without regard to how the rights are labeled or
      categorized. For purposes of this Public License, the rights
      specified in Section 2(b)(1)-(2) are not Copyright and Similar
      Rights.
 
-  d. Effective Technological Measures means those measures that, in the
+  e. Effective Technological Measures means those measures that, in the
      absence of proper authority, may not be circumvented under laws
      fulfilling obligations under Article 11 of the WIPO Copyright
      Treaty adopted on December 20, 1996, and/or similar international
      agreements.
 
-  e. Exceptions and Limitations means fair use, fair dealing, and/or
+  f. Exceptions and Limitations means fair use, fair dealing, and/or
      any other exception or limitation to Copyright and Similar Rights
      that applies to Your use of the Licensed Material.
 
-  f. Licensed Material means the artistic or literary work, database,
+  g. License Elements means the license attributes listed in the name
+     of a Creative Commons Public License. The License Elements of this
+     Public License are Attribution and ShareAlike.
+
+  h. Licensed Material means the artistic or literary work, database,
      or other material to which the Licensor applied this Public
      License.
 
-  g. Licensed Rights means the rights granted to You subject to the
+  i. Licensed Rights means the rights granted to You subject to the
      terms and conditions of this Public License, which are limited to
      all Copyright and Similar Rights that apply to Your use of the
      Licensed Material and that the Licensor has authority to license.
 
-  h. Licensor means the individual(s) or entity(ies) granting rights
+  j. Licensor means the individual(s) or entity(ies) granting rights
      under this Public License.
 
-  i. Share means to provide material to the public by any means or
+  k. Share means to provide material to the public by any means or
      process that requires permission under the Licensed Rights, such
      as reproduction, public display, public performance, distribution,
      dissemination, communication, or importation, and to make material
      available to the public including in ways that members of the
      public may access the material from a place and at a time
      individually chosen by them.
 
-  j. Sui Generis Database Rights means rights other than copyright
+  l. Sui Generis Database Rights means rights other than copyright
      resulting from Directive 96/9/EC of the European Parliament and of
      the Council of 11 March 1996 on the legal protection of databases,
      as amended and/or succeeded, as well as other essentially
      equivalent rights anywhere in the world.
 
-  k. You means the individual or entity exercising the Licensed Rights
+  m. You means the individual or entity exercising the Licensed Rights
      under this Public License. Your has a corresponding meaning.
 
 
@@ -172,7 +182,13 @@ Section 2 -- Scope.
                Licensed Rights under the terms and conditions of this
                Public License.
 
-            b. No downstream restrictions. You may not offer or impose
+            b. Additional offer from the Licensor -- Adapted Material.
+               Every recipient of Adapted Material from You
+               automatically receives an offer from the Licensor to
+               exercise the Licensed Rights in the Adapted Material
+               under the conditions of the Adapter's License You apply.
+
+            c. No downstream restrictions. You may not offer or impose
                any additional or different terms or conditions on, or
                apply any Effective Technological Measures to, the
                Licensed Material if doing so restricts exercise of the
@@ -254,9 +270,24 @@ following conditions.
           information required by Section 3(a)(1)(A) to the extent
           reasonably practicable.
 
-       4. If You Share Adapted Material You produce, the Adapter's
-          License You apply must not prevent recipients of the Adapted
-          Material from complying with this Public License.
+  b. ShareAlike.
+
+     In addition to the conditions in Section 3(a), if You Share
+     Adapted Material You produce, the following conditions also apply.
+
+       1. The Adapter's License You apply must be a Creative Commons
+          license with the same License Elements, this version or
+          later, or a BY-SA Compatible License.
+
+       2. You must include the text of, or the URI or hyperlink to, the
+          Adapter's License You apply. You may satisfy this condition
+          in any reasonable manner based on the medium, means, and
+          context in which You Share Adapted Material.
+
+       3. You may not offer or impose any additional or different terms
+          or conditions on, or apply any Effective Technological
+          Measures to, Adapted Material that restrict exercise of the
+          rights granted under the Adapter's License You apply.
 
 
 Section 4 -- Sui Generis Database Rights.
@@ -271,7 +302,8 @@ apply to Your use of the Licensed Material:
   b. if You include all or a substantial portion of the database
      contents in a database in which You have Sui Generis Database
      Rights, then the database in which You have Sui Generis Database
-     Rights (but not its individual contents) is Adapted Material; and
+     Rights (but not its individual contents) is Adapted Material,
+     including for purposes of Section 3(b); and
 
   c. You must comply with the conditions in Section 3(a) if You Share
      all or a substantial portion of the contents of the database.
@@ -392,4 +424,4 @@ understandings, or agreements concerning use of licensed material. For
 the avoidance of doubt, this paragraph does not form part of the
 public licenses.
 
-Creative Commons may be contacted at creativecommons.org.
+Creative Commons may be contacted at creativecommons.org.
diff --git a/README.md b/README.md
@@ -6,12 +6,12 @@ This repository contains the source of [Handbuch zur Erstellung diskriminierungs
 [![GitHub forks](https://img.shields.io/github/forks/maehr/diskriminierungsfreie-metadaten.svg)](https://github.com/maehr/diskriminierungsfreie-metadaten/network)
 [![GitHub stars](https://img.shields.io/github/stars/maehr/diskriminierungsfreie-metadaten.svg)](https://github.com/maehr/diskriminierungsfreie-metadaten/stargazers)
 [![Code license](https://img.shields.io/github/license/maehr/diskriminierungsfreie-metadaten.svg)](https://github.com/maehr/diskriminierungsfreie-metadaten/blob/main/LICENSE-AGPL.md)
-[![Data license](https://img.shields.io/github/license/maehr/diskriminierungsfreie-metadaten.svg)](https://github.com/maehr/diskriminierungsfreie-metadaten/blob/main/LICENSE-CCBY.md)
+[![Data license](https://img.shields.io/github/license/maehr/diskriminierungsfreie-metadaten.svg)](https://github.com/maehr/diskriminierungsfreie-metadaten/blob/main/LICENSE-CCBYSA.md)
 [![DOI](https://zenodo.org/badge/11124720.svg)](https://zenodo.org/badge/latestdoi/11124720)
 
 ## What is the publication about?
 
-This handbook is a guide to the creation of non-discriminatory metadata for historical sources and research data, which was developed as part of the Stadt.Geschichte.Basel research project. It is aimed at professional historians, archivists, librarians and anyone working with open research data in the historical sciences. The authors Moritz Mähr and Noëlle Schnegg guide you through the practical aspects of creating metadata based on the FAIR principles to make research data findable, accessible, interoperable and reusable. Through practical guidance and illustrated case studies, the handbook shows 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 history and open research data. It is available in German.
+This manual is a guide to creating non-discriminatory metadata for historical sources and research data, developed as part of the Stadt.Geschichte.Basel research project. It is aimed at professional historians, archivists, librarians and anyone involved in open research data in the field of history. The authors Moritz Mähr and Noëlle Schnegg guide readers through the practical aspects of creating metadata based on the FAIR principles to make research data discoverable, accessible, interoperable and reusable. Through practical instructions and illustrated case studies, the manual shows 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 history and open research data. It is available in German.
 
 Furthermore this repository contains a mapping of the [Schlagwortindex GenderOpen](https://opengenderplatform.de/schlagwortindex) to the [Gemeinsame Normdatei (GND)](https://gnd.network/). The mapping was created as part of the Stadt.Geschichte.Basel research project according to the [Rules for GND cross concordances (mapping methodology)](https://wiki.dnb.de/pages/viewpage.action?pageId=263851113).
 
@@ -24,10 +24,12 @@ See the [CITATION.cff](CITATION.cff) file for citation information.
 This repository is organized as follows:
 
 - `manuscript/`: the manuscript of the publication
-- `manuscript/data/`: data files used in the manuscript
+- `manuscript/data/genderopen_gnd_mapping.csv`: the mapping of the Schlagwortindex GenderOpen to the GND
 - `manuscript/media/`: images, logos, etc. used in the manuscript
-- `manuscript/index.qmd`: the main document, in markdown format
-- `manuscript/custom-reference-doc.docx`: a custom reference document for the manuscript
+- `manuscript/_quarto.yml`: the configuration file for the manuscript
+- `manuscript/handbuch-diskriminierungsfreie-metadaten.qmd`: the main document, in markdown format
+- `manuscript/custom-reference.docx`: a custom reference document for the manuscript
+- `manuscript/custom.css`: a custom css style sheet for printing
 - `manuscript/references.bib`: the bibliography file for the manuscript
 
 ## Getting Started
@@ -51,7 +53,7 @@ This project is maintained by [@maehr](https://github.com/maehr). Please underst
 
 ## Roadmap
 
-This handbook is a living document and will be updated regularly. We plan on releasing a citable version of the handbook later this year.
+This handbook is a living document and will be updated regularly. The discussion of the handbook is open to everyone and we welcome feedback and suggestions for improvement on [GitHub Discussions](https://github.com/maehr/diskriminierungsfreie-metadaten/discussions).
 
 ## Contributing
 
@@ -70,6 +72,6 @@ See also the list of [contributors](https://github.com/maehr/diskriminierungsfre
 
 ## License
 
-The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBY](LICENSE-CCBY.md) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.
+The data in this repository is released under the Creative Commons Attribution 4.0 International (CC BY 4.0) License - see the [LICENSE-CCBYSA](LICENSE-CCBYSA.md) file for details. By using this data, you agree to give appropriate credit to the original author(s) and to indicate if any modifications have been made.
 
 The code in this repository is released under the GNU Affero General Public License v3.0 - see the [LICENSE-AGPL](LICENSE-AGPL.md) file for details. By using this code, you agree to make any modifications available under the same license.
diff --git a/manuscript/.gitignore b/manuscript/.gitignore
@@ -1 +1,3 @@
+# Quarto
+/_manuscript/
 /.quarto/
diff --git a/manuscript/_quarto.yml b/manuscript/_quarto.yml
@@ -6,8 +6,10 @@ manuscript:
   resources:
     - data/genderopen_gnd_mapping.csv
   code-links:
-    - text: GitHub Repo
-      href: https://github.com/maehr/handbuch-diskriminierungsfreie-metadaten
+    - text: Diskussion Living Document
+      href: https://github.com/maehr/diskriminierungsfreie-metadaten/discussions
+    - text: Quellcode
+      href: https://github.com/maehr/diskriminierungsfreie-metadaten
   manuscript-url: https://maehr.github.io/diskriminierungsfreie-metadaten/
 
 format:
@@ -18,7 +20,7 @@ format:
     link-external-newwindow: true
     comments:
       giscus:
-        repo: maehr/handbuch-diskriminierungsfreie-metadaten
+        repo: maehr/diskriminierungsfreie-metadaten
     css:
       - custom.css
   docx:
@@ -31,3 +33,4 @@ format:
     toc-title: Inhaltsverzeichnis
   pdf:
     pdf-engine: xelatex
+    keep-tex: false
diff --git a/manuscript/custom-reference.docx b/manuscript/custom-reference.docx