cu-mkp / m-k-manuscript-data

Text of BnF Ms Fr 640 in multiple formats, metadata about the manuscript, and derived data
13 stars 5 forks source link
digital-editions manuscript-transcription metadata xml

The Making and Knowing Project: Manuscript Data Repository

DOI: 10.5281/zenodo.4724101

run-ci

Working files and data for the XML transcription and translation of Making and Knowing Project's Digital Critical Edition (DCE) of BnF Ms Fr 640. The repository contains the text of the manuscript in multiple formats, metadata about the manuscript, and derived data.

As the the main working repository for cu-mkp, this repository also functions as a larger, more general M&K project management tool.

https://www.makingandknowing.org/

Secrets of Craft and Nature in Renaissance France. A Digital Critical Edition and English Translation of BnF Ms. Fr. 640 https://edition640.makingandknowing.org/

Throughout: tc = transcription; tcn = normalized transcription tl = translation

The backbone data of this repository is in ms-xml/

Directories

Use in DCE

The following files and directories are watched for updates by the MK asset_server:

Modification of these files on the master branch results in changes on the staging/development server.

Derivative Files

A number of files are generated from ms-xml/ by manuscript-object.

These include:

NOTE for TXT versions:

Making changes to derivative files in m-k-manuscript-data:

  1. cd to m-k-manuscript-data directory
  2. git fetch
  3. git pull to make sure you are up to date
  4. Checkout a branch: git checkout -b [name of branch] -- though you will be running code in the manuscript-object directory, its output will be written to the m-k-manuscript-data directory (i.e., the changes will be made in that directory)
  5. Navigate to your local manuscript-object directory: cd to manuscript-object directory
  6. Make sure you're on the correct (usually master) branch by typing git status. If you're not in the correct branch, type git checkout -b [BRANCH_NAME].
  7. git fetch
  8. git pull
  9. Run update.py: python3 update.py (might need to use python3.8, e.g., if you have more than one version installed) -- more technical details are provided in this step in the README of manuscript-object
  10. cd back to m-k-manuscript-data directory
  11. git add .
  12. git commit -m '#[issue##]: [commit message]'
  13. git push -u origin [name of branch]