P5: Guidelines for Electronic Text Encoding and Interchange

Text Body

•  1 The TEI Infrastructure
  •    1.1 TEI Modules
  •    1.2 Defining a TEI Schema
    •   1.2.1 A Simple Customization
    •   1.2.2 A Larger Customization
  •    1.3 The TEI Class System
    •   1.3.1 Attribute Classes
      •   1.3.1.1 Global Attributes
    •   1.3.2 Model Classes
      •   1.3.2.1 Informal element classifications
  •    1.4 Macros
    •   1.4.1 Standard Content Models
    •   1.4.2 Datatype Macros
  •    1.5 The TEI Infrastructure Module
•  2 The TEI Header
  •    2.1 Organization of the TEI Header
    •   2.1.1 The TEI Header and its Components
    •   2.1.2 Types of Content in the TEI Header
    •   2.1.3 Model Classes in the TEI Header
  •    2.2 The File Description
    •   2.2.1 The Title Statement
    •   2.2.2 The Edition Statement
    •   2.2.3 Type and Extent of File
    •   2.2.4 Publication, Distribution, Licensing, etc.
    •   2.2.5 The Series Statement
    •   2.2.6 The Notes Statement
    •   2.2.7 The Source Description
    •   2.2.8 Computer Files Derived from Other Computer Files
  •    2.3 The Encoding Description
    •   2.3.1 The Project Description
    •   2.3.2 The Sampling Declaration
    •   2.3.3 The Editorial Practices Declaration
    •   2.3.4 The Tagging Declaration
      •   2.3.4.1 Rendition
      •   2.3.4.2 Tag usage
    •   2.3.5 The default style definition language declaration
    •   2.3.6 The Reference System Declaration
      •   2.3.6.1 Prose Method
      •   2.3.6.2 Search-and-Replace Method
      •   2.3.6.3 Milestone Method
    •   2.3.7 The Classification Declaration
    •   2.3.8 The Geographic Coordinates Declaration
    •   2.3.9 The Schema Specification
    •   2.3.10 The Application Information Element
    •   2.3.11 Module-Specific Declarations
  •    2.4 The Profile Description
    •   2.4.1 Creation
    •   2.4.2 Language Usage
    •   2.4.3 The Text Classification
    •   2.4.4 Calendar Description
  •    2.5 The Revision Description
  •    2.6 Minimal and Recommended Headers
  •    2.7 Note for Library Cataloguers
  •    2.8 The TEI Header Module
•  3 Elements Available in All TEI Documents
  •    3.1 Paragraphs
  •    3.2 Treatment of Punctuation
    •   3.2.1 Functions of Punctuation
    •   3.2.2 Hyphenation
  •    3.3 Highlighting and Quotation
    •   3.3.1 What Is Highlighting?
    •   3.3.2 Emphasis, Foreign Words, and Unusual Language
      •   3.3.2.1 Foreign Words or Expressions
      •   3.3.2.2 Emphatic Words and Phrases
      •   3.3.2.3 Other Linguistically Distinct Material
    •   3.3.3 Quotation
    •   3.3.4 Terms, Glosses, Equivalents, and Descriptions
    •   3.3.5 Some Further Examples
  •    3.4 Simple Editorial Changes
    •   3.4.1 Apparent Errors
    •   3.4.2 Regularization and Normalization
    •   3.4.3 Additions, Deletions, and Omissions
  •    3.5 Names, Numbers, Dates, Abbreviations, and Addresses
    •   3.5.1 Referring Strings
    •   3.5.2 Addresses
    •   3.5.3 Numbers and Measures
    •   3.5.4 Dates and Times
    •   3.5.5 Abbreviations and Their Expansions
  •    3.6 Simple Links and Cross-References
  •    3.7 Lists
  •    3.8 Notes, Annotation, and Indexing
    •   3.8.1 Notes and Simple Annotation
    •   3.8.2 Index Entries
      •   3.8.2.1 Pre-existing indexes
      •   3.8.2.2 Auto-generated indexes
  •    3.9 Graphics and Other Non-textual Components
  •    3.10 Reference Systems
    •   3.10.1 Using the xml:id and n Attributes
    •   3.10.2 Creating New Reference Systems
    •   3.10.3 Milestone Elements
    •   3.10.4 Declaring Reference Systems
  •    3.11 Bibliographic Citations and References
    •   3.11.1 Methods of Encoding Bibliographic References and Lists of References
    •   3.11.2 Components of Bibliographic References
      •   3.11.2.1 Analytic, Monographic, and Series Levels
      •   3.11.2.2 Titles, Authors, and Editors
      •   3.11.2.3 Document Identifiers
      •   3.11.2.4 Imprint, Size of a Document, and Reprint Information
      •   3.11.2.5 Scopes and Ranges in Bibliographic Citations
      •   3.11.2.6 Series Information
      •   3.11.2.7 Related Items
      •   3.11.2.8 Notes and Statement of Language
      •   3.11.2.9 Order of Components within References
    •   3.11.3 Bibliographic Pointers
    •   3.11.4 Relationship to Other Bibliographic Schemes
  •    3.12 Passages of Verse or Drama
    •   3.12.1 Core Tags for Verse
    •   3.12.2 Core Tags for Drama
  •    3.13 Overview of the Core Module
•  4 Default Text Structure
  •    4.1 Divisions of the Body
    •   4.1.1 Un-numbered Divisions
    •   4.1.2 Numbered Divisions
    •   4.1.3 Numbered or Un-numbered?
    •   4.1.4 Partial and Composite Divisions
  •    4.2 Elements Common to All Divisions
    •   4.2.1 Headings and Trailers
    •   4.2.2 Openers and Closers
    •   4.2.3 Arguments, Epigraphs, and Postscripts
    •   4.2.4 Content of Textual Divisions
  •    4.3 Grouped and Floating Texts
    •   4.3.1 Grouped Texts
    •   4.3.2 Floating Texts
  •    4.4 Virtual Divisions
  •    4.5 Front Matter
  •    4.6 Title Pages
  •    4.7 Back Matter
  •    4.8 Module for Default Text Structure
•  5 Non-standard Characters and Glyphs
  •    5.1 Is Your Journey Really Necessary?
  •    5.2 Markup Constructs for Representation of Characters and Glyphs
    •   5.2.1 Character Properties
  •    5.3 Annotating Characters
  •    5.4 Adding New Characters
  •    5.5 How to Use Code Points from the Private Use Area
  •    5.6 Module Character and Glyph Documentation
•  6 Verse
  •    6.1 Structural Divisions of Verse Texts
  •    6.2 Components of the Verse Line
  •    6.3 Rhyme and Metrical Analysis
    •   6.3.1 Sample Metrical Analyses
    •   6.3.2 Segment-Level versus Line-level Tagging
    •   6.3.3 Metrical Analysis of Stanzaic Verse
  •    6.4 Rhyme
  •    6.5 Metrical Notation Declaration
  •    6.6 Encoding Procedures for Other Verse Features
  •    6.7 Module for Verse
•  7 Performance Texts
  •    7.1 Front and Back Matter
    •   7.1.1 The Set Element
    •   7.1.2 Prologues and Epilogues
    •   7.1.3 Records of Performances
    •   7.1.4 Cast Lists
  •    7.2 The Body of a Performance Text
    •   7.2.1 Major Structural Divisions
    •   7.2.2 Speeches and Speakers
    •   7.2.3 Grouped speeches
    •   7.2.4 Stage Directions
    •   7.2.5 Speech Contents
    •   7.2.6 Embedded Structures
    •   7.2.7 Simultaneous Action
  •    7.3 Other Types of Performance Text
    •   7.3.1 Technical Information
  •    7.4 Module for Performance Texts
•  8 Transcriptions of Speech
  •    8.1 General Considerations and Overview
  •    8.2 Documenting the Source of Transcribed Speech
  •    8.3 Elements Unique to Spoken Texts
    •   8.3.1 Utterances
    •   8.3.2 Pausing
    •   8.3.3 Vocal, Kinesic, Incident
    •   8.3.4 Writing
    •   8.3.5 Temporal Information
    •   8.3.6 Shifts
  •    8.4 Elements Defined Elsewhere
    •   8.4.1 Segmentation
    •   8.4.2 Synchronization and Overlap
    •   8.4.3 Regularization of Word Forms
    •   8.4.4 Prosody
    •   8.4.5 Speech Management
    •   8.4.6 Analytic Coding
  •    8.5 Module for Transcribed Speech
•  9 Dictionaries
  •    9.1 Dictionary Body and Overall Structure
  •    9.2 The Structure of Dictionary Entries
    •   9.2.1 Hierarchical Levels
    •   9.2.2 Groups and Constituents
  •    9.3 Top-level Constituents of Entries
    •   9.3.1 Information on Written and Spoken Forms
    •   9.3.2 Grammatical Information
    •   9.3.3 Sense Information
      •   9.3.3.1 Definitions
      •   9.3.3.2 Translation Equivalents
    •   9.3.4 Etymological Information
    •   9.3.5 Other Information
      •   9.3.5.1 Examples
      •   9.3.5.2 Usage Information and Other Labels
      •   9.3.5.3 Cross-References to Other Entries
      •   9.3.5.4 Notes within Entries
    •   9.3.6 Related Entries
  •    9.4 Headword and Pronunciation References
  •    9.5 Typographic and Lexical Information in Dictionary Data
    •   9.5.1 Editorial View
    •   9.5.2 Lexical View
    •   9.5.3 Retaining Both Views
      •   9.5.3.1 Using Attribute Values to Capture Alternate Views
      •   9.5.3.2 Recording Original Locations of Transposed Elements
  •    9.6 Unstructured Entries
  •    9.7 The Dictionary Module
• 10 Manuscript Description
  •   10.1 Overview
  •   10.2 The Manuscript Description Element
  •   10.3 Phrase-level Elements
    •   10.3.1 Origination
    •   10.3.2 Material and object type
    •   10.3.3 Watermarks and Stamps
    •   10.3.4 Dimensions
    •   10.3.5 References to Locations within a Manuscript
      •   10.3.5.1 Identifying a location
      •   10.3.5.2 Linking a location to a transcription or an image
      •   10.3.5.3 Using multiple location schemes
    •   10.3.6 Names of Persons, Places, and Organizations
    •   10.3.7 Catchwords, Signatures, Secundo Folio
    •   10.3.8 Heraldry
  •   10.4 The Manuscript Identifier
  •   10.5 The Manuscript Heading
  •   10.6 Intellectual Content
    •   10.6.1 The msItem and msItemStruct Elements
    •   10.6.2 Authors and Titles
    •   10.6.3 Rubrics, Incipits, Explicits, and Other Quotations from the Text
    •   10.6.4 Filiation
    •   10.6.5 Text Classification
    •   10.6.6 Languages and Writing Systems
  •   10.7 Physical Description
    •   10.7.1 Object Description
      •   10.7.1.1 Support
      •   10.7.1.2 Extent
      •   10.7.1.3 Collation
      •   10.7.1.4 Foliation
      •   10.7.1.5 Condition
      •   10.7.1.6 Layout Description
    •   10.7.2 Writing, Decoration, and Other Notations
      •   10.7.2.1 Writing
      •   10.7.2.2 Decoration
      •   10.7.2.3 Musical Notation
      •   10.7.2.4 Additions and Marginalia
    •   10.7.3 Bindings, Seals, and Additional Material
      •   10.7.3.1 Binding Descriptions
      •   10.7.3.2 Seals
      •   10.7.3.3 Accompanying Material
  •   10.8 History
  •   10.9 Additional information
    •   10.9.1 Administrative information
      •   10.9.1.1 Record History
      •   10.9.1.2 Availability and Custodial History
    •   10.9.2 Surrogates
  •   10.10 Manuscript Parts
  •   10.11 Module for Manuscription Description
• 11 Representation of Primary Sources
  •   11.1 Digital Facsimiles
  •   11.2 Combining Transcription with Facsimile
    •   11.2.1 Parallel Transcription
    •   11.2.2 Embedded Transcription
  •   11.3 Scope of Transcriptions
    •   11.3.1 Altered, Corrected, and Erroneous Texts
      •   11.3.1.1 Core elements for Transcriptional Work
      •   11.3.1.2 Abbreviation and Expansion
      •   11.3.1.3 Correction and Conjecture
      •   11.3.1.4 Additions and Deletions
      •   11.3.1.5 Substitutions
      •   11.3.1.6 Cancellation of Deletions and Other Markings
      •   11.3.1.7 Text Omitted from or Supplied in the Transcription
    •   11.3.2 Hands and Responsibility
      •   11.3.2.1 Document Hands
      •   11.3.2.2 Hand, Responsibility, and Certainty Attributes
    •   11.3.3 Damage and Conjecture
      •   11.3.3.1 Damage, Illegibility, and Supplied Text
      •   11.3.3.2 Use of the gap, del, damage, unclear, and supplied Elements in Combination
    •   11.3.4 Marking up the Writing Process
      •   11.3.4.1 Generic Modification
      •   11.3.4.2 Metamarks
      •   11.3.4.3 Fixation and Clarification
      •   11.3.4.4 Confirmation, Cancellation, and Reinstatement of Modifications
      •   11.3.4.5 Transpositions
      •   11.3.4.6 Alternative Readings
      •   11.3.4.7 Instant Corrections
  •   11.4 Advanced uses of Surface and Zone
  •   11.5 Aspects of Layout
    •   11.5.1 Space
    •   11.5.2 Lines
  •   11.6 Headers, Footers, and Similar Matter
  •   11.7 Changes
  •   11.8 Other Primary Source Features not Covered in these Guidelines
  •   11.9 Module for Transcription of Primary Sources
• 12 Critical Apparatus
  •   12.1 The Apparatus Entry, Readings, and Witnesses
    •   12.1.1 The Apparatus Entry
    •   12.1.2 Readings
    •   12.1.3 Indicating Subvariation in Apparatus Entries
    •   12.1.4 Witness Information
      •   12.1.4.1 Witness Detail Information
      •   12.1.4.2 Witness Information in the Source
      •   12.1.4.3 The Witness List
    •   12.1.5 Fragmentary Witnesses
  •   12.2 Linking the Apparatus to the Text
    •   12.2.1 The Location-referenced Method
    •   12.2.2 The Double End-Point Attachment Method
    •   12.2.3 The Parallel Segmentation Method
    •   12.2.4 Other Linking Methods
  •   12.3 Using Apparatus Elements in Transcriptions
  •   12.4 Module for Critical Apparatus
• 13 Names, Dates, People, and Places
  •   13.1 Attribute Classes Defined by this Module
    •   13.1.1 Linking Names and their Referents
    •   13.1.2 Dating Attributes
  •   13.2 Names
    •   13.2.1 Personal Names
    •   13.2.2 Organizational Names
    •   13.2.3 Place Names
      •   13.2.3.1 Geo-political Place Names
      •   13.2.3.2 Geographic Names
      •   13.2.3.3 Relative Place Names
  •   13.3 Biographical and Prosopographical Data
    •   13.3.1 Basic Principles
    •   13.3.2 The Person Element
      •   13.3.2.1 Personal Characteristics
      •   13.3.2.2 Personal Events
      •   13.3.2.3 Personal Relationships
    •   13.3.3 Organizational Data
    •   13.3.4 Places
      •   13.3.4.1 Varieties of Location
      •   13.3.4.2 Multiple Places
      •   13.3.4.3 States, Traits, and Events
      •   13.3.4.4 Relations Between Places
    •   13.3.5 Names and Nyms
    •   13.3.6 Dates and Times
      •   13.3.6.1 Relative Dates and Times
      •   13.3.6.2 Absolute Dates and Times
      •   13.3.6.3 More Expressive Normalizations
  •   13.4 Module for Names and Dates
• 14 Tables, Formulæ, Graphics and Notated Music
  •   14.1 Tables
    •   14.1.1 TEI Tables
    •   14.1.2 Other Table Schemas
  •   14.2 Formulæ and Mathematical Expressions
  •   14.3 Notated music in written text
  •   14.4 Specific Elements for Graphic Images
  •   14.5 Overview of Basic Graphics Concepts
  •   14.6 Graphic Image Formats
    •   14.6.1 Vector Graphic Formats
    •   14.6.2 Raster Graphic Formats
    •   14.6.3 Photographic and Motion Video Formats
  •   14.7 Module for Tables, Formulæ, Notated Music, and Graphics
• 15 Language Corpora
  •   15.1 Varieties of Composite Text
  •   15.2 Contextual Information
    •   15.2.1 The Text Description
    •   15.2.2 The Participant Description
    •   15.2.3 The Setting Description
  •   15.3 Associating Contextual Information with a Text
    •   15.3.1 Combining Corpus and Text Headers
    •   15.3.2 Declarable Elements
    •   15.3.3 Summary
  •   15.4 Linguistic Annotation of Corpora
    •   15.4.1 Levels of Analysis
  •   15.5 Recommendations for the Encoding of Large Corpora
  •   15.6 Module for Language Corpora
• 16 Linking, Segmentation, and Alignment
  •   16.1 Links
    •   16.1.1 Pointers and Links
    •   16.1.2 Using Pointers and Links
    •   16.1.3 Groups of Links
    •   16.1.4 Intermediate Pointers
  •   16.2 Pointing Mechanisms
    •   16.2.1 Pointing Elsewhere
    •   16.2.2 Pointing Locally
    •   16.2.3 Using Abbreviated Pointers
    •   16.2.4 W3C element() Scheme
    •   16.2.5 TEI XPointer Schemes
      •   16.2.5.1 Introduction to TEI Pointers
      •   16.2.5.2 xpath1(Expr)
      •   16.2.5.3 left() and right()
      •   16.2.5.4 range()
      •   16.2.5.5 string-range(fragmentIdentifier, offset [, length])
      •   16.2.5.6 match(fragmentIdentifier, string [, index])
    •   16.2.6 Canonical References
      •   16.2.6.1 Worked Example
      •   16.2.6.2 Complete and Partial URI Examples
      •   16.2.6.3 Miscellaneous Usages
  •   16.3 Blocks, Segments, and Anchors
  •   16.4 Correspondence and Alignment
    •   16.4.1 Correspondence
    •   16.4.2 Alignment of Parallel Texts
    •   16.4.3 A Three-way Alignment
  •   16.5 Synchronization
    •   16.5.1 Aligning Synchronous Events
    •   16.5.2 Placing Synchronous Events in Time
  •   16.6 Identical Elements and Virtual Copies
  •   16.7 Aggregation
  •   16.8 Alternation
  •   16.9 Stand-off Markup
    •   16.9.1 Introduction
    •   16.9.2 Overview of XInclude
    •   16.9.3 Stand-off Markup in TEI
    •   16.9.4 Well-formedness and Validity of Stand-off Markup
    •   16.9.5 Including Text or XML Fragments
  •   16.10 Connecting Analytic and Textual Markup
  •   16.11 Module for Linking, Segmentation, and Alignment
• 17 Simple Analytic Mechanisms
  •   17.1 Linguistic Segment Categories
    •   17.1.1 Words and above
    •   17.1.2 Below the word level
  •   17.2 Global Attributes for Simple Analyses
  •   17.3 Spans and Interpretations
  •   17.4 Linguistic Annotation
  •   17.5 Module for Analysis and Interpretation
• 18 Feature Structures
  •   18.1 Organization of this Chapter
  •   18.2 Elementary Feature Structures and the Binary Feature Value
  •   18.3 Other Atomic Feature Values
  •   18.4 Feature Libraries and Feature-Value Libraries
  •   18.5 Feature Structures as Complex Feature Values
  •   18.6 Re-entrant Feature Structures
  •   18.7 Collections as Complex Feature Values
  •   18.8 Feature Value Expressions
    •   18.8.1 Alternation
    •   18.8.2 Negation
    •   18.8.3 Collection of Values
  •   18.9 Default Values
  •   18.10 Linking Text and Analysis
  •   18.11 Feature System Declaration
    •   18.11.1 Linking a TEI Text to Feature System Declarations
    •   18.11.2 The Overall Structure of a Feature System Declaration
    •   18.11.3 Feature Declarations
    •   18.11.4 Feature Structure Constraints
    •   18.11.5 A Complete Example
  •   18.12 Formal Definition and Implementation
• 19 Graphs, Networks, and Trees
  •   19.1 Graphs and Digraphs
    •   19.1.1 Transition Networks
    •   19.1.2 Family Trees
    •   19.1.3 Historical Interpretation
  •   19.2 Trees
  •   19.3 Another Tree Notation
  •   19.4 Representing Textual Transmission
  •   19.5 Module for Graphs, Networks, and Trees
• 20 Non-hierarchical Structures
  •   20.1 Multiple Encodings of the Same Information
  •   20.2 Boundary Marking with Empty Elements
  •   20.3 Fragmentation and Reconstitution of Virtual Elements
  •   20.4 Stand-off Markup
  •   20.5 Non-XML-based Approaches
• 21 Certainty, Precision, and Responsibility
  •   21.1 Levels of Certainty
    •   21.1.1 Using Notes to Record Uncertainty
    •   21.1.2 Structured Indications of Uncertainty
      •   21.1.2.1 Contingent conditions
      •   21.1.2.2 Pervasive conditions
      •   21.1.2.3 Content uncertainty
      •   21.1.2.4 Target or Match?
  •   21.2 Indications of Precision
  •   21.3 Attribution of Responsibility
  •   21.4 The Certainty Module
• 22 Documentation Elements
  •   22.1 Phrase Level Documentary Elements
    •   22.1.1 Phrase Level Terms
    •   22.1.2 Element and Attribute Descriptions
  •   22.2 Modules and Schemas
  •   22.3 Specification Elements
  •   22.4 Common Elements
    •   22.4.1 Description of Components
    •   22.4.2 Exemplification of Components
    •   22.4.3 Classification of Components
    •   22.4.4 Element Specifications
      •   22.4.4.1 Content models
      •   22.4.4.2 Additional constraints
    •   22.4.5 Attribute List Specification
      •   22.4.5.1 Datatypes
      •   22.4.5.2 Value Specification
      •   22.4.5.3 Examples
    •   22.4.6 Element Classes
    •   22.4.7 Pattern Documentation
  •   22.5 Building a Schema
  •   22.6 Combining TEI and Non-TEI Modules
  •   22.7 Linking Schemas to XML Documents
  •   22.8 Module for Documentation Elements
• 23 Using the TEI
  •   23.1 Serving TEI files with the TEI media type
  •   23.2 Obtaining the TEI Schemas
  •   23.3 Personalization and Customization
    •   23.3.1 Kinds of Modification
      •   23.3.1.1 Deletion of Elements
      •   23.3.1.2 Renaming of Elements
      •   23.3.1.3 Modification of Content Models
      •   23.3.1.4 Modification of Attribute and Attribute Value Lists
      •   23.3.1.5 Class Modification
      •   23.3.1.6 Addition of New Elements
    •   23.3.2 Modification and Namespaces
    •   23.3.3 Documenting the Modification
    •   23.3.4 Examples of Modification
  •   23.4 Conformance
    •   23.4.1 Well-formedness criterion
    •   23.4.2 Validation Constraint
    •   23.4.3 Conformance to the TEI Abstract Model
      •   23.4.3.1 Semantic Constraints
      •   23.4.3.2 Mandatory Components of a TEI Document
    •   23.4.4 Use of the TEI Namespace
    •   23.4.5 Documentation Constraint
    •   23.4.6 Varieties of TEI Conformance
  •   23.5 Implementation of an ODD System
    •   23.5.1 Making a Unified ODD
    •   23.5.2 Generating Schemas
    •   23.5.3 Names and Documentation in Generated Schemas
    •   23.5.4 Making a RELAX NG Schema
      •   23.5.4.1 Macros
      •   23.5.4.2 Classes
      •   23.5.4.3 Elements
    •   23.5.5 Making a DTD
    •   23.5.6 Generating Documentation
    •   23.5.7 Using TEI Parameterized Schema Fragments
      •   23.5.7.1 Selection of Modules
      •   23.5.7.2 Inclusion and Exclusion of Elements
      •   23.5.7.3 Changing the Names of Generic Identifiers
      •   23.5.7.4 Embedding Local Modifications (DTD only)