TEI P5: Guidelines for Electronic Text Encoding and Interchange

Releases of the TEI Guidelines
Dedication
Preface and Acknowledgments
About These Guidelines
- Structure and Notational Conventions of this Document
  The use of modal verbs
  TEI Naming Conventions
  Element and Attribute Names
  Class, Macro, and Datatype Names
  Design Principles
  Intended Use
  Use in Text Capture and Text Creation
  Use for Interchange
  Use for Local Processing
- Historical Background
- Future Developments and Version Numbers
A Gentle Introduction to XML
- What's Special about XML?
  Descriptive Markup
  Types of Document
  Data Independence
- Textual Structures
- XML Structures
  Elements
  Content Models: an Example
- Validating a Document's Structure
  An Example Schema
  Generic Identifier
  Content Model
  Occurrence Indicators
  Connectors
  Groups
- Complicating the Issue
- Attributes
  Declaring Attributes
  Identifiers and Indicators
- Other Components of an XML Document
  Character References
  Namespaces
  Marked Sections
  Processing Instructions
- Putting It All Together
  Associating Entity Definitions with a Document Instance
  Associating a Document Instance with Its Schema
  Assembling Multiple Resources into a Single Document
  Stylesheet Association and Processing
  Content Validation
Languages and Character Sets
- Language Identification
- Characters and Character Sets
  4.1 Historical Considerations
  4.2 Terminology and Key Concepts
  4.3 Abstract Characters, Glyphs, and Encoding Scheme Design
  4.4. Entry of Characters
  Output of Characters
  4.5 Unicode and XML
  4.6 Special Aspects of Unicode Character Definitions
  4.6.1 Compatibility Characters
  4.6.2 Precomposed and Combining Characters and Normalization
  4.6.3 Character Semantics
  4.8 Issues Arising from the Internal Representations of Unicode
  4.8.1. Encoding Errors Related to UTF-8
The TEI Infrastructure
- TEI Modules
- Defining a TEI Schema
  A Simple Customization
  A Larger Customization
- The TEI Class System
  Attribute Classes
  Global Attributes
  Element Identifiers and Labels
  Language Indicators
  Rendition Indicators
  Sources, certainty, and responsibility
  Evaluation of Links
  XML Whitespace
  Other Globally Available Attributes
  Model Classes
  Informal Element Classifications
- Macros
  Standard Content Models
  Datatype Specifications
- The TEI Infrastructure Module
The TEI Header
- Organization of the TEI Header
  The TEI Header and Its Components
  Types of Content in the TEI Header
  Model Classes in the TEI Header
- The File Description
  The Title Statement
  The Edition Statement
  Type and Extent of File
  Publication, Distribution, Licensing, etc.
  The Series Statement
  The Notes Statement
  The Source Description
  Computer Files Derived from Other Computer Files
- The Encoding Description
  The Project Description
  The Sampling Declaration
  The Editorial Practices Declaration
  The Tagging Declaration
  Rendition
  Tag Usage
  The Default Style Definition Language Declaration
  The Reference System Declaration
  Prose Method
  Search-and-Replace Method
  Milestone Method
  The Classification Declaration
  The Geographic Coordinates Declaration
  The Unit Declaration
  The Schema Specification
  The Application Information Element
  Module-Specific Declarations
- The Profile Description
  Creation
  Language Usage
  The Text Classification
  Abstracts
  Calendar Description
  Correspondence Description
- Non-TEI Metadata
- The Revision Description
- Minimal and Recommended Headers
- Note for Library Cataloguers
- The TEI Header Module
Elements Available in All TEI Documents
- Paragraphs
- Treatment of Punctuation
  Functions of Punctuation
  Hyphenation
- Highlighting and Quotation
  What Is Highlighting?
  Emphasis, Foreign Words, and Unusual Language
  Foreign Words or Expressions
  Emphatic Words and Phrases
  Other Linguistically Distinct Material
  Quotation
- Terms and Glosses, Ruby Annotations, and Equivalents and Descriptions
  Terms and Glosses
  Some Further Examples
  Ruby Annotations
  Equivalents and Descriptions
- Simple Editorial Changes
  Apparent Errors
  Regularization and Normalization
  Additions, Deletions, and Omissions
- Names, Numbers, Dates, Abbreviations, and Addresses
  Referring Strings
  Addresses
  Numbers and Measures
  Dates and Times
  Abbreviations and Their Expansions
- Simple Links and Cross-References
- Lists
- Notes, Annotation, and Indexing
  Notes and Simple Annotation
  Encoding Grouped Notes
  Index Entries
  Pre-existing Indexes
  Auto-generated Indexes
- Graphics and Other Non-textual Components
- Reference Systems
  Using the xml:id and n Attributes
  Creating New Reference Systems
  Referencing system derived from markup
  Referencing systems based on project conventions
  Milestone Elements
  Declaring Reference Systems
- Bibliographic Citations and References
  Methods of Encoding Bibliographic References and Lists of References
  Components of Bibliographic References
  Analytic, Monographic, and Series Levels
  Titles, Authors, and Editors
  Document Identifiers
  Imprint, Size of a Document, and Reprint Information
  Scopes and Ranges in Bibliographic Citations
  Series Information
  Related Items
  Notes and Statement of Language
  Order of Components within References
  Bibliographic Pointers
  Relationship to Other Bibliographic Schemes
- Passages of Verse or Drama
  Core Tags for Verse
  Core Tags for Drama
- Overview of the Core Module
Default Text Structure
- Divisions of the Body
  Un-numbered Divisions
  Numbered Divisions
  Numbered or Un-numbered?
  Partial and Composite Divisions
- Elements Common to All Divisions
  Headings and Trailers
  Openers and Closers
  Arguments, Epigraphs, and Postscripts
  Content of Textual Divisions
- Grouped and Floating Texts
  Grouped Texts
  Floating Texts
- Virtual Divisions
- Front Matter
- Title Pages
- Back Matter
- Module for Default Text Structure
Characters, Glyphs, and Writing Modes
- Is Your Journey Really Necessary?
- Markup Constructs for Representation of Characters and Glyphs
  Character Properties
- Annotating Characters
- Adding New Characters
- How to Use Code Points from the Private Use Area
- Writing Modes
- Examples of Different Writing Modes
  Vertical Writing Modes
  Vertical Text with Embedded Horizontal Text
  Vertical Orientation in Horizontal Scripts
  Bottom-to-top Writing
  Mixed Horizontal Directionality
  Summary
- Text Rotation
- Caveat
- Formal Definition
Verse
- Structural Divisions of Verse Texts
- Components of the Verse Line
- Encoding Textual Structures Across Verses
- Rhyme and Metrical Analysis
  Sample Metrical Analyses
  Segment-Level versus Line-level Tagging
  Metrical Analysis of Stanzaic Verse
- Rhyme
- Metrical Notation Declaration
- Encoding Procedures for Other Verse Features
- Module for Verse
Performance Texts
- Front and Back Matter
  The Set Element
  Prologues and Epilogues
  Records of Performances
  Cast Lists
- The Body of a Performance Text
  Major Structural Divisions
  Speeches and Speakers
  Grouped Speeches
  Stage Directions
  Speech Contents
  Embedded Structures
  Simultaneous Action
- Other Types of Performance Text
  Technical Information
- Module for Performance Texts
Transcriptions of Speech
- General Considerations and Overview
- Documenting the Source of Transcribed Speech
- Elements Unique to Spoken Texts
  Utterances
  Pausing
  Vocal, Kinesic, Incident
  Writing
  Temporal Information
  Shifts
- Elements Defined Elsewhere
  Segmentation
  Synchronization and Overlap
  Regularization of Word Forms
  Prosody
  Speech Management
  Analytic Coding
- Module for Transcribed Speech
Dictionaries
- Dictionary Body and Overall Structure
- The Structure of Dictionary Entries
  Hierarchical Levels
  Groups and Constituents
- Top-level Constituents of Entries
  Information on Written and Spoken Forms
  Grammatical Information
  Sense Information
  Definitions
  Translation Equivalents
  Etymological Information
  Other Information
  Examples
  Usage Information and Other Labels
  Cross-References to Other Entries
  Notes within Entries
  Related Entries
- Headword and Pronunciation References
- Typographic and Lexical Information in Dictionary Data
  Editorial View
  Lexical View
  Retaining Both Views
  Using Attribute Values to Capture Alternate Views
  Recording Original Locations of Transposed Elements
- Unstructured Entries
- The Dictionary Module
Manuscript Description
- Overview
- The Manuscript Description Element
- Phrase-level Elements
  Origination
  Material and Object Type
  Watermarks and Stamps
  Dimensions
  References to Locations within a Manuscript
  Identifying a Location
  Linking a Location to a Transcription or an Image
  Using Multiple Location Schemes
  Names of Persons, Places, and Organizations
  Catchwords, Signatures, Secundo Folio
  Heraldry
- The Manuscript Identifier
- The Manuscript Heading
- Intellectual Content
  The msItem and msItemStruct Elements
  Authors and Titles
  Rubrics, Incipits, Explicits, and Other Quotations from the Text
  Filiation
  Text Classification
  Languages and Writing Systems
- Physical Description
  Object Description
  Support
  Extent
  Collation
  Foliation
  Condition
  Layout Description
  Writing, Decoration, and Other Notations
  Writing
  Decoration
  Musical Notation
  Additions and Marginalia
  Bindings, Seals, and Additional Material
  Binding Descriptions
  Seals
  Accompanying Material
- History
- Additional Information
  Administrative Information
  Record History
  Availability and Custodial History
  Surrogates
- Manuscript Parts
- Manuscript Fragments
- Module for Manuscript Description
Representation of Primary Sources
- Digital Facsimiles
- Combining Transcription with Facsimile
  Parallel Transcription
  Embedded Transcription
  Advanced Uses of surface and zone
- Scope of Transcriptions
  Altered, Corrected, and Erroneous Texts
  Core Elements for Transcriptional Work
  Abbreviation and Expansion
  Correction and Conjecture
  Additions and Deletions
  Substitutions
  Cancellation of Deletions and Other Markings
  Text Omitted from or Supplied in the Transcription
  Hands and Responsibility
  Document Hands
  Hand, Responsibility, and Certainty Attributes
  Damage and Conjecture
  Damage, Illegibility, and Supplied Text
  Use of the gap , del , damage , unclear , and supplied Elements in Combination
  Marking up the Writing Process
  Generic Modification
  Metamarks
  Fixation and Clarification
  Confirmation, Cancellation, and Reinstatement of Modifications
  Transpositions
  Alternative Readings
  Instant Corrections
- Aspects of Layout
  Space
  Lines
- Transcription and Ruby
- Headers, Footers, and Similar Matter
- Identifying Changes and Revisions
- Other Primary Source Features not Covered in these Guidelines
- Module for Transcription of Primary Sources
Critical Apparatus
- The Apparatus Entry, Readings, and Witnesses
  The Apparatus Entry
  Readings
  Indicating Subvariation in Apparatus Entries
  Witness Information
  Witness Detail Information
  Witness Information in the Source
  The Witness List
  Fragmentary Witnesses
- Linking the Apparatus to the Text
  The Location-referenced Method
  The Double End-Point Attachment Method
  The Parallel Segmentation Method
  Other Linking Methods
- Using Apparatus Elements in Transcriptions
- Strategies for Encoding Variation
- Module for Critical Apparatus
Names, Dates, People, and Places
- Attribute Classes Defined by This Module
  Linking Names and Their Referents
  Dating Attributes
- Names
  Personal Names
  Organizational Names
  Place Names
  Geo-political Place Names
  Geographic Names
  Relative Place Names
  Object Names
- Biographical and Prosopographical Data
  Basic Principles
  The Person Element
  Personal Characteristics
  Personal Events
  Personal Relationships
  Organizational Data
  Places
  Varieties of Location
  Multiple Places
  States, Traits, and Events
  Relations Between Places
  Objects
  Names and Nyms
- Dates
  Relative Dates and Times
  Absolute Dates and Times
  More Expressive Normalizations
  Using Non-Gregorian Calendars
- Module for Names and Dates
Tables, Formulæ, Graphics, and Notated Music
- Tables
  TEI Tables
  Other Table Schemas
- Formulæ and Mathematical Expressions
- Notated Music in Written Text
- Specific Elements for Graphic Images
- Overview of Basic Graphics Concepts
- Graphic Image Formats
  Vector Graphic Formats
  Raster Graphic Formats
  Photographic and Motion Video Formats
- Module for Tables, Formulæ, Notated Music, and Graphics
Language Corpora
- Varieties of Composite Text
- Contextual Information
  The Text Description
  The Participant Description
  The Setting Description
- Associating Contextual Information with a Text
  Combining Corpus and Text Headers
  Declarable Elements
  Summary
- Linguistic Annotation of Corpora
  Levels of Analysis
- Recommendations for the Encoding of Large Corpora
- Module for Language Corpora
Linking, Segmentation, and Alignment
- Links
  Pointers and Links
  Using Pointers and Links
  Groups of Links
  Intermediate Pointers
- Pointing Mechanisms
  Pointing Elsewhere
  Pointing Locally
  Using Abbreviated Pointers
  TEI XPointer Schemes
  Introduction to TEI Pointers
  xpath()
  left()
  right()
  string-index()
  range()
  string-range()
  match()
  Canonical References
  Worked Example
  Complete and Partial URI Examples
  Miscellaneous Usages
  Citation Structures
- Blocks, Segments, and Anchors
- Synchronization
  Aligning Synchronous Events
  Placing Synchronous Events in Time
- Correspondence and Alignment
  Correspondence
  Alignment of Parallel Texts
  A Three-way Alignment
- Identical Elements and Virtual Copies
- Aggregation
- Alternation
- Stand-off Markup
  Introduction
  Overview of XInclude
  Stand-off Markup in TEI
  Well-formedness and Validity of Stand-off Markup
  Including Text or XML Fragments
- The standOff Container
- Annotations
- Connecting Analytic and Textual Markup
- Module for Linking, Segmentation, and Alignment
Simple Analytic Mechanisms
- Linguistic Segment Categories
  Words and Above
  Below the Word Level
- Global Attributes for Simple Analyses
- Spans and Interpretations
- Linguistic Annotation
  Linguistic Annotation by Means of Generic TEI Devices
  Lightweight Linguistic Annotation
  Spoken Text
- Module for Analysis and Interpretation
Feature Structures
- Organization of this Chapter
- Elementary Feature Structures and the Binary Feature Value
- Other Atomic Feature Values
- Feature Libraries and Feature-Value Libraries
- Feature Structures as Complex Feature Values
- Re-entrant Feature Structures
- Collections as Complex Feature Values
- Feature Value Expressions
  Alternation
  Negation
  Collection of Values
- Default Values
- Linking Text and Analysis
- Feature System Declaration
  Linking a TEI Text to Feature System Declarations
  The Overall Structure of a Feature System Declaration
  Feature Declarations
  Feature Structure Constraints
  A Complete Example
- Formal Definition and Implementation
Graphs, Networks, and Trees
- Graphs and Digraphs
  Transition Networks
  Family Trees
  Historical Interpretation
- Trees
- Another Tree Notation
- Representing Textual Transmission
- Module for Graphs, Networks, and Trees
Non-hierarchical Structures
- Multiple Encodings of the Same Information
- Boundary Marking with Empty Elements
- Fragmentation and Reconstitution of Virtual Elements
- Stand-off Markup
- Non-XML-based Approaches
Certainty, Precision, and Responsibility
- Levels of Certainty
  Using Notes to Record Uncertainty
  Structured Indications of Uncertainty
  Contingent Conditions
  Pervasive Conditions
  Content Uncertainty
  Target or Match?
- Indications of Precision
- Attribution of Responsibility
- The Certainty Module
Documentation Elements
- Phrase Level Documentary Elements
  Phrase Level Terms
  Element and Attribute Descriptions
- Modules and Schemas
- Specification Elements
- Common Elements
  Description of Components
  Exemplification of Components
  Classification of Components
- Element Specifications
  Defining Content Models
  Defining Content Models: TEI
  Defining Content Models: RELAX NG
  Additional Constraints
  Attribute List Specification
  Datatypes
  Value Specification
  Processing Models
  The TEI processing model
  Output Rendition
  CSS Class
  Model Contexts and Outputs
  Behaviours and their parameters
  Outputs
  Model sequence
  Defining a processing model
  Implementation of Processing Models
- Class Specifications
- Macro Specifications
- Building a TEI Schema
  TEI customizations
  Combining TEI and Non-TEI Modules
  Linking Schemas to XML Documents
- Module for Documentation Elements
Using the TEI
- Serving TEI files with the TEI Media Type
- Obtaining the TEI
- Customization
  Kinds of Modification
  Deletion of Elements
  Modification of Content Models
  Modification of Attribute and Attribute Value Lists
  Class Modification
  Addition of New Elements
  Renaming of Elements
  Modification and Namespaces
  Documenting the Modification
  Examples of Modification
- Conformance
  Well-formedness Criterion
  Validation Constraint
  Conformance to the TEI Abstract Model
  Semantic Constraints
  Mandatory Components of a TEI Document
  Use of the TEI Namespace
  Documentation Constraint
  Varieties of TEI Conformance
- Implementation of an ODD System
  Making a Unified ODD
  Generating Schemas
  Names and Documentation in Generated Schemas
  Making a RELAX NG Schema
  Macros
  Classes
  Elements
  Making a DTD
  Generating Documentation
  Using TEI Parameterized Schema Fragments
  Selection of Modules
  Inclusion and Exclusion of Elements
  Changing the Names of Generic Identifiers
  Embedding Local Modifications (DTD only)
Model Classes
- About the Model Classes Appendix
Attribute Classes
- About the Attribute Classes Appendix
Elements
- About the Elements Appendix
Attributes
- About the Attributes Appendix
Datatypes and Other Macros
- About the Datatypes and Macros Appendix
Bibliography
- Works Cited in Examples in these Guidelines
- Works Cited Elsewhere in the Text of these Guidelines
- Reading List
  Theory of Markup and XML
  TEI
Deprecations
- Items Scheduled to be Removed
Prefatory Notes
- Prefatory Note (March 2002)
- Introductory Note (November 2001)
- Introductory Note (June 2001)
- Introductory Note (May 1999)
  Typographic Corrections Made
  Specific Changes in the DTD
  Outstanding Errors
- Preface (April 1994)
- Acknowledgments
  TEI Working Committees (1990-1993)
  Advisory Board
  Steering Committee Membership
Colophon

Contents