The first few days of training will be largely self-directed and spent reading introductory articles and completing tutotials about the Text Encoding Initiative (TEI) standard. Afterwards, we will hold a follow-up session and use the specific encoding guidelines developed for the project to which you have been assigned.
Readings
- Reference the readings list predefined in your internship wiki page.
Tutorials
- Intensive Introduction to TEI by Women Writers Project, Brown University
- Review session 1-3
Sample Exercises
Conduct these sample exercises while undergoing the tutorial or afterwards
- Brief Genre Samples: Prose, Verse, Drama and Letters
- Example Encoding of Genres (all sample genres in one XML file)
Getting Started with the Sample Exercises
- Launch Oxygen editor (see Oxygen User Manual or the DLP's Tips to Using Oxygen for help with the editor)
- Select "File" from the menu bar
- Select "New" for new file
- When the dialog box appears, select "from templates"
- Scroll down and select TEI P5 All
- Now you have a basic TEI template to work with using the P5 All schema
- Encode each sample genre in a separate XML file (repeat steps 1-5 for the next sample)
- Copy and paste text from PDF document (easier than transcribing!)
Validate
This project uses a schema, which makes sure the XML document is well-structured. Your Oxygen editor automatically knows this information. The Oxygen editor will show you a green box towards the top-right of the editor if the file is valid or a red box if the file is invalid. As you are encoding, validate often to catch errors before they escalate
To validate and XML/TEI file already open in the Oxygen editor:
- Select the "validate document" icon (red checkmark)
- Or in the menus, select "Document" => "Validate" => "Validate Document"
If the file is valid, you will see:
- Green box towards the top-right of the editor
- Green box on the bottom of the editor that reads: "Document is valid"
If the file is invalid, you will see:
- Red box towards the top-right of the editor
- Red box on the bottom of the editor that reads: "Validation-failed. Errors: #"
- Error messages in a bottom pane
- Click on each error message to position the cursor near the error (often the error is somewhere before the cursor, often a line or more of code above)
- If the error message is cut off, right-click on the error message and select "Show message"
Once you fix the errors, re-validate the document.
Wrapping up with the Sample Exercises
...
Caveat
The tutorial focuses on the newest version of the TEI, P5. You may be working with a previous version, P4 (i.e., IMH, Newton project), but the differences between the two versions are usually inconsequential in terms of learning the basics.
Readings
More or less in order
- An Introduction to TEI and the TEI Consortium
- Electronic Texts: Audiences & Purposes by Perry Willett in A Companion to Digital Humanities
- Text Encoding by Allen H. Renear Willett in A Companion to Digital Humanities
- Other chapters may be of interest to you: http://www.digitalhumanities.org/companion/
- XML in Ten Points
- Gentle Introduction to XML
- Default Text Structure (from the TEI Guidelines, P5)
- Default Text Structure, P4 (only for the IMH project)
- TEI Header (from the TEI Guidelines, P5)
- TEI Header, P4 (only for the IMH project)
- "Challenges of Serials Text Encoding in the Spirit of Scholarly Communication" by Michelle Dalmau & Melanie Schlosser, Library Hi Tech (2010) – (only for the IMH)
- "The Text Encoding Initiative and the Study of Literature" by James Cummings in A Companion to Digital Literary Studies
Tutorials & Sample Exercises
- A brief introduction to Markup, Part 1 by John Walsh (about 15 minutes).
- A brief introduction to Markup, Part 2 by John Walsh (about 14 minutes).
- The exercises referenced in the video are available at: http://dcl.ils.indiana.edu/intromarkup/.
- Catapult TEI Workshops: Part 1 and Part 2
- Review all slides for Part 1: http://dcl.slis.indiana.edu/teiworkshop/teiworkshop_i.pdf
- Sample Exercises: Brief Genre Samples – Prose, Verse, Drama and Letters (instructions and access to PDF Samples)
- Example Encoding of Genres (all sample genres encoded in one XML file)
- Consult if you get stuck, but resist the temptation of looking before you give it a try ...
- Example Encoding of Genres (all sample genres encoded in one XML file)
- Sample Exercises: Brief Genre Samples – Prose, Verse, Drama and Letters (instructions and access to PDF Samples)
- Review all slides for Part 2: http://dcl.slis.indiana.edu/teiworkshop/teiworkshop_ii/
- Sample Exercise: Manuscript Encoding
- Review all slides for Part 1: http://dcl.slis.indiana.edu/teiworkshop/teiworkshop_i.pdf
- TEI by Example
- Tutorials 0-3, 6
General Guidelines and TEI Element References
- TEI Guidelines, P5 (Official guidelines from the TEI; newest version)
- TEI Guidelines, P4 (Official guidelines from the TEI)
- TEI P4 Element Reference (List of elements in TEI P4)
- Best Practices for Text Encoding in Libraries (Includes description of encoding 'levels' and project planning information)