DSE-Static-Cookiecutter

Cookiecutter template for a Static site generator powered by TEI/XML files

What is this for

The current repo should ease the process of publishing TEI/XML encoded files as a Static-Site Application using mainly XSLT to generate static HTML files.

Important

DSE-Static-Cookiecutter is developed for digital editions projects run at the ACDH. Therefore some parts of the code (especially the usage imprint service {{cookiecutter.directory_name}}/shellscripts/dl_imprint.sh) won't work properly outside of our institutional context.

Quickstart

Important

DSE-Static-Cookiecutter is tested to work on Linux/Mac. To make it work on Windows you'll need to change some parts of the initial setup.

• Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 2.1.0 or higher) by running pip install -U cookiecutter
• To generate a new dse-static-site project run cookiecutter gh:acdh-oeaw/dse-static-cookiecutter and answer the appearing questions
• Change into the created directory, have a look at the README.md in this directory and start developing/customizing your great digital editions project.

Features

• Generate HTML files from your TEI/XML documents using XSLT
• GitHub Actions workflows are configured to
  • build your application and serve them via GitHub Pages
  • bake your application into a Dockerfile publish it via GitHub's container registry.
• XSLTs provided by DSE-Static-Cookiecutter are designed in a modular fashion, trying to avoid code duplications
• Recent version of Bootstrap implemented
• Opinionated way to organize data/code; but everything can be changed/overwritten/customized
• Handling of indices for persons, places, organizations, or works is included
• Search and filterable overview pages of your editions (table of contents) and indices
• Example code on how to implement a faceted full-text search powered by Typesense
• Geovisualization of places via leaflet.js powered maps; contributed by @cfhaak and @kisram
• Ships with an Oxygen XML Editor project .xpr including some transformation scenarios for local development/testing of TEI to HTML transformations.

Full Text Search

As mentioned above, DSE-Static-Cookiecutter implements a faceted full text search with Typesense. This breaks of course the static site paradigme but as ACDH we are confident to keep our own typesense instance up and running for a long time. If you don't have your own typesense instance you could have a look at https://cloud.typesense.org/.

Alternatively you could rewrite the XSLT's to produce valid XHTML files and implement a powerful full text search using the awesome staticSearch.

Previouse versions of DSE-Static-Cookiecutter shipped with an option to implement staticSearch but this had to be dropped due to limited maintainance resources.

Plug-ins/Customization

• Try out Digital Edition Micro-Editor for customization of interactive features

Projects using DSE-Static-Cookiecutter (by start date)

2021

• https://schnitzler-tagebuch.acdh.oeaw.ac.at (ongoing)
• https://schnitzler-lektueren.acdh.oeaw.ac.at

2022

• https://rita.acdh.oeaw.ac.at
• https://thun-korrespondenz.acdh.oeaw.ac.at
• https://amp.acdh.oeaw.ac.at (finished 2024)
• https://schnitzler-briefe.acdh.oeaw.ac.at (ongoing)
• https://schnitzler-bahr.acdh.oeaw.ac.at (ongoing)

2023

• https://b-vg.acdh.oeaw.ac.at (ongoing)
• https://hanslick.acdh.oeaw.ac.at (ongoing)
• https://kaiserin-eleonora.oeaw.ac.at (ongoing)
• https://ofm-graz.acdh.oeaw.ac.at

2024

• https://akademieprotokolle.acdh.oeaw.ac.at (ongoing)
• https://grazer-nuntiatur.acdh.oeaw.ac.at
• https://gtrans.acdh.oeaw.ac.at
• https://maechtekongresse.acdh.oeaw.ac.at
• https://sappho-digital.com
• https://staribacher.acdh.oeaw.ac.at
• https://tillich-briefe.acdh.oeaw.ac.at (ongoing)
• https://tillich-lectures.acdh-dev.oeaw.ac.at (ongoing)
• https://wmp1.acdh.oeaw.ac.at

2025

• https://daacda.acdh.oeaw.ac.at
• https://nuntiatur-pius-xi.acdh.oeaw.ac.at
• https://schnitzler-interviews.acdh.oeaw.ac.at
• https://wienerschnitzler.org
• https://www.kraus.wienbibliothek.at/
• https://schnitzler-kultur.acdh.oeaw.ac.at/
• https://auden.acdh.oeaw.ac.at/ (ongoing)
• https://kraus1933.acdh.oeaw.ac.at/ (ongoing)

LICENSE

dse-static-cookiecutter is licensed under the MIT License. See the LICENSE file for details. Be aware that this does not apply to third party libraries included in this project as Saxon or CSS/JS libraries included in vendor.