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.
- You can either fork this repository or download it as a zip file in the release section.
- Copy your XML edition to the
xml
folder. - Edit the
index.html
file to include the correct path to your XML file. Look for following line
<script>
var CETEIcean = new CETEI()
CETEIcean.getHTML5("xml/[name_of_your_file].xml", function(data) {
document.getElementById("TEI").appendChild(data)
})
</script>
- You can tweak colour, text-size etc. in the
config.css
file at the root of the repository. - Publish it on GitHub pages or any other web-server.
- Create a new repository on GitHub.
- Upload the files from the template to the repository.
- Go to the settings of the repository and scroll down to the GitHub pages section.
- Select the
master
branch as the source and click save. - Wait a few minutes and then click on the link provided in the GitHub pages section.
This template is released under the MIT licence 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 library, which is released under the BSD 2-Clause "Simplified" License.