-
Notifications
You must be signed in to change notification settings - Fork 19
Home
Welcome to the DCHM-template wiki!
This is a template that was specifically designed to help students of the Digitising Cultural Heritage Materials (DCHM) course at the University of Borås publish their digitisation projects online with GitHub Pages. But it can be used by anyone who wants to try GitHub Pages to publishing a simple HTML-based website.
The instructions on how to use this template can be found on our Tasks page.
The instructions are designed to have a low threshold, but they do presuppose some familiarity with basic git and GitHub commands.
If concepts like fork, commit, push, and pull request are unfamiliar to you, do check out my pizzaParty repository.
That repository includes links to an introductory video lecture and a set of exercises that were designed to teach the DCHM students (or anyone who is interested to learn) the basics of git and GitHub, which they would need to get started with this repository.
So if you are in the same boat, they might be useful to you too.
Another video lecture to accompany this repository and its instructions is currently in development.
For more advanced users, the template also includes some XSL Transformation Scenarios that automatically transform TEI-XML transcriptions like this example into a set of HTML pages like the ones in this directory. This wiki also includes a set of instructions on how to configure oXygen to make these transformations, in case you want to change the TEI-XML file, or the transformation scenarios to fit your own use case.
As you might have noticed by comparing commits 14 through 18 in this repository, I was struggling with the question whether or not to add community standard files to the repository, like adding a code of conduct, instructions on how to contribute, or issue templates. After some consideration and testing, I decided against adding these to the repository, because I believe they clutter the template. If I added them, it would have meant that when people fork the template, they also copy these files. But while these files apply to my template, they might not apply to their implementation of the template. Someone who is unfamiliar with code of conduct files, for example, might just keep my version, not knowing what it is for, and leave it unchanged. This is problematic, because the code of conduct would have mentioned me as a point of contact, and might not reflect the way in which the forker would like to respond to specific behaviours. Above all else, documents such as codes of conduct require careful consideration, and become meaningless if the responsible party is not prepared to put them into action.
My initial solution to this problem was to keep any community standard files that are not purely functional (such as the repository's LICENSE) out of the repository itself, and move them to the wiki instead. Here, you can read our code of conduct and learn more about how you could contribute to the repository.
Since then, however, I have learned how to I can use GitHub Actions to automatically remove certain files (and modify others) from the user's repository as soon as they use my template to create their own repository.
This solution has been implemented on March 10, 2024..
Doing so fixed Issue 3, which acknowledged that the initial solution was not ideal, because some files (like the LICENSE) can't just be moved to the wiki.
Similarly, this solution also allowed us to reintroduce the .zenodo.json metadata, which substantially improves the Zenodo archiving functionality.
More information on the effects of this solution on the overall usability of the template can be found in the README file.
This repository was originally developed by Wout Dillen as a teaching tool in the Digitising Cultural Heritage Materials course at the University of Borås, where he currently works as a Senior Lecturer in Library and Information Science. He is also the Secretary of the European Society of Textual Scholarship (ESTS), and part of the Executive Board of the DH Benelux community. He is also the General editor of the ESTS's journal Variants, and one of the editors of the DH Benelux Journal – both Open Access publications.