Skip to content

Data and metadata for an edition created with EditionCrafter

License

Notifications You must be signed in to change notification settings

cu-mkp/editioncrafter-data

Repository files navigation

DOI

editioncrafter-data

Data and metadata for an edition created with EditionCrafter, a publication tool for digital critical editions under development by the Making and Knowing Project (M&K), Performant Software Solutions, and a number of case-study collaborators. EditionCrafter, under development (2022-2024), is designed to be an open-source, customizable publishing tool that will allow users to deploy their own texts, data, and commentary as low-maintenance digital critical editions. It will enable the creation of static sites that rely on basic well-established technologies and workflows to address issues of longevity, maintenance, sustainability, and cost. For more about this work, see the NSF award announcement: Crafting an Open Source Digital Publication Tool for the History of Science.

This project builds upon the publication of Secrets of Craft and Nature. A Digital Critical Edition of BnF Ms. Fr. 640 by the Making and Knowing Project. The underlying software developed for Secrets of Craft and Nature will serve as the starting point for EditionCrafter.

editioncrafter-data repository

This repository is a template repository for users who plan to use EditionCrafter to create their editions. It contains the basic structure and organization of the files needed as input for the creation of the "folios view" element: the side-by-side viewing panes of the text, where users can choose between versions of the text including facsimile images, transcribed text, and translated text. All associated metadata is also to be housed in this repository.

how-to-use-dualpane

Example of the "folios view," with side-by-side viewing panes of fol. 4r of BnF Ms. Fr. 640 in Secrets of Craft and Nature.

How-tos

Because this repository may be used by beginners, a number of helpful how-tos have been included:

Repository Structure

This repository has two main areas:

  1. texts/ directory - all files associated with an edition's source material (i.e., transcriptions and translations)
  2. metadata/ directory - all metadata (data about data) associated with an edition

This is based upon the model used for the creation of Secrets of Craft and Nature. M&K's repository for BnF Ms. Fr. 640’s data is cu-mkp/m-k-manuscript-data and the “read me” file (scroll down below the file and directory listings on the repo's homepage) describes the repo's structure and how M&K has already worked with Github for Secrets of Craft and Nature.