Child pages
  • TEI Tutorial
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 7 Next »

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.


The tutorial focuses on the newest version of the TEI, P5.  You may be working with a previous version, P4 (i.e., Newton project), but the differences between the two versions are usually inconsequential in terms of learning the basics.  


  • Reference the readings list predefined in your internship wiki page.


Sample Exercises

Conduct these sample exercises while undergoing the tutorial or afterwards

Getting Started with the Sample Exercises

  1. Launch Oxygen editor (see Oxygen User Manual or the DLP's Tips to Using Oxygen for help with the editor)
  2. Select "File" from the menu bar
  3. Select "New" for new file
  4. When the dialog box appears, select "from templates"
  5. Scroll down and select TEI P5 All
  6. Now you have a basic TEI template to work with using the P5 All schema
  7. Encode each sample genre in a separate XML file (repeat steps 1-5 for the next sample)
    1. Copy and paste text from PDF document (easier than transcribing!)

      Note:  Skip encoding the TEI Header as part of this exercise


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

  • As you complete a sample genre, feel free to email Michelle the XML file as an attachment so I can provide feedback. Or stop by and see me for in-person help!
  • No labels