https://github.com/silencesys/dh--tiny-tei-template
Have you ever run a workshop on TEI and then struggled with where or how to publish the students' work? This template was created for that very reason.
https://github.com/silencesys/dh--tiny-tei-template
tei-xml website xml
Last synced: about 1 month ago
JSON representation
Have you ever run a workshop on TEI and then struggled with where or how to publish the students' work? This template was created for that very reason.
- Host: GitHub
- URL: https://github.com/silencesys/dh--tiny-tei-template
- Owner: silencesys
- License: mit
- Created: 2024-01-28T15:24:14.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-12-28T17:33:05.000Z (4 months ago)
- Last Synced: 2025-01-29T20:27:41.168Z (3 months ago)
- Topics: tei-xml, website, xml
- Language: CSS
- Homepage: https://silencesys.github.io/dh--tiny-tei-template/
- Size: 25.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Tiny template for TEI editions
Have you ever run a workshop on TEI and then struggled with where or how to publish the students' work? This template was created for that very reason. It has been designed to be as simple as possible, while still allowing students to make at least some adjustments so that they feel a sense of ownership over their work.
## Limitations
- It does not work with images
- It does not work with multiple files
- It does not work very well with different readings
However in future versions I hope to address these issues and extend the functionality of the template. If you have any suggestions, please let me know.
## How to use this template
1. You can either fork this repository or download it as a zip file in the release section.
2. Copy your XML edition to the `xml` folder.
3. Edit the `index.html` file to include the correct path to your XML file. Look for following line
```html
var CETEIcean = new CETEI()
CETEIcean.getHTML5("xml/[name_of_your_file].xml", function(data) {
document.getElementById("TEI").appendChild(data)
})
```
4. You can tweak colour, text-size etc. in the `config.css` file at the root of the repository.
5. Publish it on GitHub pages or any other web-server.
## Publishing on GitHub pages
1. Create a new repository on GitHub.
2. Upload the files from the template to the repository.
3. Go to the settings of the repository and scroll down to the GitHub pages section.
4. Select the `master` branch as the source and click save.
5. Wait a few minutes and then click on the link provided in the GitHub pages section.
## Copyright and licence
This template is released under the [MIT licence](LICENSE.md) and is free to use, modify and redistribute. The example XML file should be considered as a demonstration of the template and is not covered by the licence.
This template uses the [CETEIcean](https://github.com/TEIC/CETEIcean) library, which is released under the [BSD 2-Clause "Simplified" License](https://github.com/TEIC/CETEIcean/blob/master/LICENSE.md).