Resources
Reference materials, tools, and models for scholars encoding Arabic-script texts in TEI.
Standards
- The TEI Guidelines ↗ The full P5 Guidelines from the Text Encoding Initiative Consortium.
- TEI Elements Reference ↗ Alphabetical reference for every element in the TEI Guidelines.
Editors and publishing tools
-
TEI framework for Oxygen
Oxygen includes TEI support. To install a separate TEI framework when needed, open Help > Install new add-ons. Paste
https://tei-c.org/release/oxygen/updateSite.oxygeninto "Show add-ons from", choose the compatible TEI P5 entry, and follow the prompts. See the official Oxygen installation instructions. Check the version and project-specific framework settings before changing an existing setup. - Oxygen XML Editor ↗ An XML editor with an Author mode for working with TEI documents.
- TEI Boilerplate for Arabic Editions ↗ A version of TEI Boilerplate adapted for Arabic: RTL support, the Amiri typeface, and browser-side rendering of TEI XML. Check the repository documentation for hosting and browser requirements.
Examples and tutorials
- Till Grallert's Open Arabic Periodical Editions ↗ TEI editions of early Arabic periodicals.
- Arabic TEI Workshop — Examples Repository ↗ Sample encoded files from the 2021 Arabic TEI XML Digital Workshop.
- Introduction to TEI (slides) ↗ Hugh Cayless's introductory slides from the same workshop.
- Arabic TEI Workshop — YouTube channel ↗ Recorded walkthroughs on markup, GitHub, and Oxygen.
Getting started: a short glossary
- Commit
- Registering changes to a document in Git. Commit often — each commit is a timestamped point you can search and restore later.
- Push
- Uploading your commits to GitHub, synchronizing your local work with the shared repository.
- Pull
- Downloading the latest changes from GitHub to your computer. Start collaborative work with a pull.
- Creating an element (Oxygen, Author mode)
- Highlight the text, press Ctrl-E (Windows) or Cmd-E (Mac), then choose the element from the menu or type into the search box and hit Enter.
- Creating an attribute (Oxygen, Author mode)
- Place the cursor inside the element and edit its attributes in the Attributes view. Alternatively, press Alt+Enter to open the in-place editor. Double-clicking a named start tag also works when tags are displayed. See Oxygen's attribute-editing instructions.