aad-data

Repository for editorial data and data-creation workflows in the Auden in Austria Digital project.

• aad-data Directory Structure
• aad-data Workflows
  • check-n-transform Workflow
  • write-xmls Workflow

1 aad-data Directory Structure

The metadata/csv directory contains the input_img_id.csv input CSV file for basic (image-ID-centered) metadata creation as well as the automatically transformed (document-ID-centered) output_doc_id.csv. The md directory holds the metadata-analysis.md Markdown file, which reports key aspects of the metadata in summative fashion.

The .github/workflows directory holds the check-n-transform GitHub Action, which (on: push) runs three scripts (in the scripts directory, hereby licensed GNU General Public License v3.0) to validate and transform the input CSV, and write the Markdown report.

The write-xmls GitHub-Actions workflow (on: workflow_dispatch) lets another script read the output_doc_id.csv output CSV file and write template TEI/XML files (aad-transcript__????_tmp.xml) into the data/xml/tmp directory. From here, TEI/XML files are renamed (aad-transcript__????.xml) and moved to data/xml/editions for editing.

Important

Run the write-xmls workflow from the dev branch to avoid merge conflicts.

Warning

The write-xmls workflow will overwrite unrenamed template TEI/XML files in the data/xml/tmp directory.

2 aad-data Workflows

2.1 check-n-transform Workflow

flowchart TD;
    input_img_id.csv---|on:push| check-n-transform;
    check-n-transform-->A{validate-scv.py};
    A-->|#9989;| img2doc-csv.py;
    A-->|#9989;| metadata-analysis.py;
    img2doc-csv.py-->output_doc_id.csv;
    A-. #10060; .->input_img_id.csv;
    metadata-analysis.py-->metadata-analysis.md;

Loading

2.2 write-xmls Workflow

flowchart TD;
    output_doc_id.csv---|on:workflow_dispatch| write-xmls;
    write-xmls-->csv2xml.py;
    csv2xml.py-.->aad-transcript__????.xml;

Loading