Best Practices for TEI in Libraries


 * TEI in Libraries: Home
 * BPG Feedback on Complete Draft (required, polishing before release for public comment)
 * Copyediting Feedback (optional, helpful pointers to our copy editor)

= TEI Text Encoding in Libraries: Guidelines for Best Encoding Practices =

Introduction
These recommendations are for libraries using the Text Encoding Initiative’s Guidelines for Text Encoding and Interchange (P5). They are intended for use in large, library-based digitization projects, but may be useful in other scenarios as well. Consult the full TEI Guidelines for guidance beyond what is described below.

There are many different library text digitization projects, for different purposes. With this in mind, the recommendations are as inclusive as possible by specifying a series of encoding levels. These levels are meant to allow for a range of practice, from wholly automated text creation and encoding, to encoding that requires expert content knowledge, analysis, and editing.

Recommendations for Levels 1-4 are intended for projects wishing to create encoded electronic text with structural markup, but minimal semantic or content markup. Also, the encoding levels are cumulative: encoding requirements at each level incorporate the requirements of lower levels. Levels 1-4 allow the conversion and encoding of texts to be performed without the assistance of deep content knowledge and can be enriched with more markup at any time. Level 5, in contrast, requires scholarly analysis.

These recommendations are meant to complement the TEI Tite customization of the TEI Guidelines. Whereas TEI Tite is meant for vendors who need exact specifications for encoding without room for interpretation or local practice, these guidelines document how a library or other large-scale encoding project might create TEI documents that conform as closely as possible both to common TEI practice and to library standards. If a library uses TEI Tite to outsource its encoding, it should find conversion of TEI Tite files to Level 4 in these recommendations to be trivial.

Standards and local practice
An encoding project should strive for internal consistency and for use of standards so that the data can be modified or enhanced in the future with ease. In cases where local practice deviates from standards, there should at least be internal consistency in the local practice.

Transcription
When reformatting to digital media using any level of encoding, the electronic text should begin with the transcription of the first word on the first leaf of the original work. It may be impractical or undesirable to transcribe and encode certain features of the text, such as publisher’s advertisements or indexes, but if at all possible, they should be included as links to page images. Any omissions of material found in the original work should be noted in the &lt;editorialDecl&gt; in the TEI header.

Filenames
A filename scheme that is internally consistent should be established for the project. If it is likely that the files will need to be used on more primitive devices (MS-DOS computers or unextended ISO 9660 CDs) it may be useful to limit names to 8 characters (limited to the 26 lower case letters of ASCII, digits, hyphens, and underscore), a dot, and an extension of 3 alphanumeric characters.

URIs
A number of attributes take a URI (Uniform Resource Identifier) as their value. Note that in addition to the full form of reference defined by URI syntax, these attributes can take a relative reference (e.g., filename.ext) or a fragment identifier (e.g., #foo).

Text divisions
An encoding project should use only numbered divisions (i.e., &lt;div1&gt;, &lt;div2&gt;, etc.) or unnumbered divisions (i.e., &lt;div&gt;) but not both. This applies both within a TEI document (i.e., within &lt;front&gt;, &lt;body&gt;, &lt;back&gt;</tt>, even if nested within &lt;group&gt;</tt> or &lt;floatingText&gt;</tt>) and across TEI documents in any given collection. Keep in mind that numbering of &lt;div&gt;</tt>s starts over (at &lt;div1&gt;</tt>) within &lt;floatingText&gt;</tt>, so any software that expects to process nested numbered divisions within a document will need to account for this.

Whether numbered or unnumbered divisions are used, the type</tt> attribute of the division element is not recommended at level 1, is optional at level 2, is recommended at level 3, and required at levels 4 and 5.

Page breaks
Page breaks should be encoded using the pb</tt> element, which should demark the top of a page (i.e. the text of page seven should immediately follow &lt;pb n="7"/&gt;</tt>), and should always be contained within a text division for ease of retrieval with indexing software. For example, a page break that occurs between chapters 2 and 3 should be encoded soon after the &lt;div></tt> that opens chapter 3 (rather than before the &lt;/div></tt> that ends chapter 2).

Linking between encoded text and images of source documents
There are two recommended mechanisms for linking between the encoded text and facsimile page images of source documents. Projects may either:

<ol style="list-style-type: upper-alpha;"> <li>Use the facs</tt> attribute on each pb</tt> element to point to the corresponding page image using a URI.</li> <li>Use the xml:id</tt> attribute on each pb</tt> element and a METS document to provide correspondence between pb</tt> elements and one or more facsimile page images (e.g., master, web derivatives, etc.).</li> </ol>

For those projects relying on the Metadata Encoding and Transmission Standard (METS), the <tt>xml:id</tt> attribute is used as a conceptual identifier for content as opposed to an explicit pointer (i.e., <tt>facs</tt> attribute) to a specific representation of that content. These identifiers are then used to generate a METS document that bundles the various content types (e.g., master image files, derivative image files for Web delivery, PDFs, etc.), explicitly lists all versions of the content, and defines the relationships between the constituent parts. This is achieved through the use of the <tt><mets:fileSec></tt> and <tt><mets:structMap></tt> sections of the METS document (see sample METS document for a TEI project).

General Guidelines for Attribute Usage
Some general advice on the use of particular attributes follows. (All of these attributes are commonly used on various elements, but not every element requires or even allows these attributes.)

type
Constructing a list of acceptable attribute values for the <tt>type</tt> attribute for each element, on which everyone could agree, is impossible. Instead, it is recommended that projects describe the <tt>type</tt> attribute values used in their texts in the project ODD file and that this list be made available to people using the texts. It is worth noting that, at present, Roma, the web front-end editor for ODD files, does not have a mechanism for providing this documentation — it should be added to the ODD file directly. For a list of standard names and definitions of bibliographic features of printed books, see ABC for Book Collectors by John Carter (8th edition, New Castle, Del. and London: Oak Knoll Books and the British Library, 2004, available online at http://www.ilab.org/images/abcforbookcollectors.pdf).

n
This element is sometimes used to number elements for machine processing, but it often includes data represented in the source document, such as page numbers or footnote numbers. Example: <tt>&lt;pb n="456"/&gt;</tt>

xml:id
See the full TEI guidelines for how to use this attribute: http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ST.html#STGA.

target
See the full TEI guidelines for how to use this attribute: http://www.tei-c.org/release/doc/tei-p5-doc/en/html/ST.html#STGA.

rend
The <tt>rend</tt> attribute may be used when it is desirable to record information about how the content object was displayed in the source document.

If a project is normalizing the rendering of text objects (for example, such that all titles should be italicized, regardless of how they appeared in the source document), there is no need to use this attribute; instead, a stylesheet will determine that all titles are displayed in italics.

However, if a project is faithfully recording the rendering in the source document, this element should be used to indicate this rendering, either on all elements to be rendered differently from the surrounding text or on all elements whose rendering does not follow the default stylesheet.

Difficulty using <tt>rend</tt> attributes occurs when it is desirable to record more than one rendition feature. With this in mind, projects should use the following adaptation of “rendition ladders,” a concept developed at the Brown University Women Writers Project. This system allows for sets of multiple renditional features to be included in one <tt>rend</tt> value. Rendition ladders consist of categories of renditional features with values of each of those features enclosed in parentheses.

<tt>rend</tt> should only be used to override a default value. For instance, if all text encoded as <tt>&lt;hi&gt;</tt> is defined as being rendered in italics, there is no reason to encode text as <tt>&lt;hi rend="slant(italics)"&gt;</tt>. Combining renditional features would result in an element with attributes such as <tt>&lt;l rend="slant(italics)align(right)"&gt;</tt>.

xml:lang
Used to indicate the natural language of the content of an element. Generally not used at levels 1 or 2. At levels 3 or 4, it should contain the appropriate language subtag; further subtags (script, region, variant, extension, private use) are rarely appropriate. If only the language subtag is present (the most common case), a corresponding <tt>language</tt> element should not be present in the TEI header. If a private use subtag is present, a corresponding <tt>language</tt> element must be present in the TEI header. See the TEI documentation.

Structure of a TEI Document
A valid TEI XML document must contain the following elements: <ul><li>a root <tt>TEI</tt> element, containing:<ul> <li>a <tt>teiHeader</tt> element</li> <li>a <tt>text</tt> element </li></ul></li></ul>

Within those two elements, there are additional requirements, which are discussed in these guidelines and in the complete TEI P5 Guidelines. The <tt>teiHeader</tt> element serves as a description of the document presented in the <tt>text</tt> element. The <tt>text</tt> element contains the transcription of the source document.

Reference

 * Chapter 2, TEI Header, P5 Guidelines

The TEI Header
The TEI header is a metadata record that describes an electronic text encoded according to the TEI specification. The purpose of the TEI header is to declare the bibliographic information related to the electronic document and, if appropriate, the bibliographic data for the original analog source document from which the electronic edition was created. The TEI header often includes a description of the encoding decisions or practices used to create the electronic document. Since the advent of the TEI in the late 1980s, many people have described the TEI header as a title page for the electronic edition, and many librarians have compared it to traditional library catalog records (MARC).

As with any descriptive metadata, the metadata in the TEI header can serve multiple audiences. In the local context, a TEI header provides metadata about the TEI document, its source, and its provenance. The TEI header may be used for metadata exchange, to automatically create indexes (author lists, title lists) for a collection of TEI documents, and to aid in browsing heterogeneous TEI documents. TEI headers may also be used as a basis for other metadata records (such as MARC or Dublin Core), though generation of other formats may require human intervention because they often are more granular, or have different granularity, than TEI headers.

The TEI Header and MARC
While a TEI header is often perceived as similar to or at least related to a MARC record, a TEI header does not typically have a one-to-one correspondence with a MARC record. One TEI header may be described by multiple MARC analytic records, or one MARC record may be used to describe a collection of TEI documents with individual headers. Furthermore, while a MARC record captures metadata about a bibliographic entity in a library’s collection, a TEI header records information both about an encoded text and about the source document for that encoded text.

Each institution and even each project may have a different approach to the way electronic texts are created in TEI and then represented in a larger public catalog through MARC. At one institution, the same unit (e.g., a cataloging department) may be responsible for creating both TEI Headers and MARC records, while at other institutions the work may be distributed among different units. Within the library domain, metadata or cataloging experts are usually required for at least review and standardization of both the TEI header and the MARC record.

The TEI Header and Other Metadata Schemas
Several other descriptive metadata schemas are prevalent within the library domain, including Dublin Core (DC), Dublin Core Qualified (DCQ), and the Metadata Object Description Schema (MODS). Each of these schemas contains elements that capture the same data as many of the elements in the TEI header. As with MARC, a variety of automated or manual workflows can be implemented to crosswalk metadata from one standard to another and provide for increased sharing of metadata about electronic texts in larger contexts. In particular, DC and MODS are common schemas used by the Open Archives Initiative (OAI) and may be particularly valuable for sharing metadata across institutions.

Determining Data Values for the TEI Header
Within the library domain, there are several authoritative publications on how to create bibliographic and descriptive metadata for objects. These are usually called “content standards”; two prominent examples are the Anglo-American Cataloging Rules Second Edition (AACR2) and the International Standard Bibliographic Description for Electronic Resources (ISBD(ER)). These standards are extensive and outline a set of rules that enforce consistency across a voluminous amount of metadata.

Perhaps the primary purpose of these content standards is to give rules for what sources of information may be used in transcribing or generating metadata about a bibliographic entity. Within an electronic context, the analog object may not be available, so the TEI header creator will need access to digitized images or other verifiable information to create accurate metadata.

The following sources of information are recommended in creating the TEI header:

<ol> <li> For an electronic document with a digitized title page and title page verso:<ol style="list-style: lower-alpha;"> <li> Chief source of information is the information coded as title page.</li> <li> Use added information from an originating paper document if absolutely certain it is the source.</li></ol></li> <li>If there is no digitized title page but the header creator has satisfactory evidence of the source document, the header creator should refer to the source document for metadata creation. The lack of a title page may be for one of many reasons: for example, the original document is a manuscript item, or the electronic edition is a portion of the original object (a poem or short story that was published in a collection or an article from a serial). In all cases, it is recommended that important bibliographic evidence, such as a digitized image of the title page and title page verso for a collection, be provided to the header creator, even if just a piece of the collection is used.</li>

<li>If no title page is present and there is no evidence from a source document, the header creator may assign a title and author, if appropriate, enclosing the information in square brackets (using the standard English-language convention for editorial interjections).</li></ol>

Element Recommendations for the <tt>&lt;teiHeader&gt;</tt>


│  └  <tt>&lt;classDecl&gt;&lt;taxonomy xml:id="____"&gt;&lt;bibl&gt;</tt> Use to document classification schemes used in the header or body of the TEI document. For example:

├  <tt>&lt;profileDesc&gt;</tt>

└ <tt>&lt;textClass&gt;</tt>

│   ├   <tt>&lt;classCode scheme="___"&gt;</tt> True classification numbers as opposed to call numbers can be entered here. The value of the scheme attribute corresponds to a classification scheme defined previously in <tt>&lt;classDecl&gt;</tt>. Example:

│  └  <tt>&lt;keywords scheme="____"&gt;</tt> Repeat this element as many times as there are keyword schemes. If the child <tt>term</tt> elements contain terms from a controlled vocabulary, indicate that controlled vocabulary through the scheme attribute. The value of the scheme attribute corresponds to a classification scheme defined previously in <tt>&lt;classDecl&gt;</tt>. Example:

│  └  <tt>&lt;term&gt;</tt> Use for terms from controlled or uncontrolled vocabularies, as indicated in the parent <tt>keywords</tt> element.

└ <tt>&lt;revisionDesc&gt;</tt>

└ <tt>&lt;change when="YYYY-MM-DD" who="URI"&gt;</tt> Create a <tt>change</tt> element to record each significant change to the TEI document, in reverse chronological order (i.e., most recent first). A prose description of the change is recorded as the content of each <tt>change</tt> element. This prose may contain lists for organization, and phrase-level markup (like <tt>&lt;gi&gt;</tt>, <tt>&lt;ptr&gt;</tt>, or <tt>&lt;date&gt;</tt>), but not paragraphs.

The date of the change, in ISO 8601 form (YYYY-MM-DD), should be recorded using the <tt>when</tt> attribute.

The person who is responsible for making the change is indicated by the <tt>who</tt> attribute of <tt>&lt;change&gt;</tt>. Its value is a URI that points to a <tt>&lt;respStmt&gt;</tt> or <tt>&lt;person&gt;</tt> element that encodes information about the responsible party. Note that this reference is a URI reference and not an ID/IDREF reference, and thus is not checked by validation software. Small projects sometimes take advantage of this by putting information into the URI itself, and not having a <tt>respStmt</tt> or <tt>person</tt> element. E.g., <tt>who="#Kevin_Hawkins"</tt>.

Sample TEI Header
<teiHeader> <fileDesc> <titleStmt> Lincoln and Seward. <persName>Welles, Gideon, 1802-1878.</persName> </titleStmt> <publicationStmt> University of Michigan, Digital Library Initiatives These pages may be freely searched and displayed. Permission must be received for subsequent distribution in print or electronically. Please go to           http://www.umdl.umich.edu/ for more information. </publicationStmt> <seriesStmt> <title level="s" type="main">Making of America </seriesStmt>

Level 1 Example: Alger Hiss document
<TEI xml:id="someid" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> </teiHeader> <ab> <pb n="113" facs="00000001.tif"/>

POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; ALTERNATIVELY, DISCOVERY AND A HEARING SHOULD BE ORDERED. The nature and extent of surveillance of Hiss, his family and associates was not known at the time of trial by the defense. Even now, with the release of some of the government documents concerning FBI investigative techniques regarding Hiss, the full extent of surveillance -- wiretapping, mail openings, mail covers, physical surveillance, and other intrusive techniques -- is still not 'clear. Nevertheless, it is apparent that information gathered through the exploitation of unlawful wiretaps and other illegal surveillance was used at trial and consequently the conviction must be reversed. Alternatively, further discovery and a hearing is essential to a fair determination regarding these issues. FBI surveillance of Hiss began in earnest in 1941 with the institution of a mail cover on his incoming correspondence at his home in connection with an FBI investigation of possible Hatch Act violations. CN Ex. 98A. Another mail cover was placed

-113 -

<pb n="114" facs="00000002.tif"/>

on the Hiss mail in 1945, and at the same time the FBI obtained toll call records from the Hiss residence Telephone for the years 1943 and 1944 as well. CN Ex. 99. In September, 1945, the FBI intercepted telegrams to Hiss as well. CN Ex. 100. In late November, 1945, FBI surveillance of the Hiss residence in Washington, D.C., escalated. For the third time, a mail cover was instituted beginning on November 28, 1945, which was continued at least until 1946. CN Ex. 101 at p. 70; CN Ex. 102. Continuous physical surveillance of Hiss was begun as well. CN Ex. 101 at p. 72. Although this twenty-four-hour surveillance was discontinued on December 14, 1945, physical surveillance was conducted frequently at various times until September, 1947. CN Ex. 102; CN Ex. 103. The most intrusive invasion of petitioner's rights 68/ Also before 1947, a letter from Priscilla Hiss addressed to her son, Timothy Hobson, was intercepted and its contents read. CN Ex. 100A at p. 167. In approximately March, 1947, a letter from a Michael Greenberg addressed to petitioner regarding an application for employment with the United Nations was also intercepted, in a manner not revealed by the documents. CN Ex. 100B

-114 -

<pb n="115" facs="00000003.tif"/>

occurred from December 13, 1945 until the Hisses moved from Washington, D.C. to New York City on September 13, 1947. A "technical surveillance," -- a wiretap -- was placed on the Hiss telephone at their residence on P Street-in Washington, D.C. The logs of this surveillance constitute twenty-nine volumes of FBI serials and are roughly 2,500 pages in length, in which an enormous amount of information concerning the Hisses' personal lives, relationships with friends and associates, and habits is recorded. The wiretap was installed following FBI Director Hoover's application to the Attorney General for authorization, although no written authorization appears in the documents released to Hiss. The purpose of the application was to gather information regarding Hiss' alleged contacts with Soviet espionage agents and communists in government service, general allegations which had been made by Elizabeth Bentley and Chambers. As one would expect, the interception of every telephone h9/      Hoover's initial request was answered by a note requesting information on Hiss. CN Ex. 104. Additional information was furnished by letter dated November 30, 1945. CN Ex. 105.

-115 -

</ab> </TEI>

Reference

 * Chapter 3, Elements Available in All TEI Documents
 * Chapter 4, Default Text Structure

Purpose
To create electronic text for full-text searching, linking to page images, and identifying simple structural hierarchy to improve navigation. (For example, you can create a table of contents from such encoding.)

Rationale
The text is mainly subordinate to the page image, though navigational markers (textual divisions, headings) are captured. However, the text could stand alone as electronic text (without page images) if the accuracy of its contents is suitable to its intended use and it is not necessary to display low-level typographic or structural information. Level 2 requires a set of elements more granular than those of Level 1, including bibliographic or structural information below the monographic or volume level. One of the motivations for using Level 2 is to avoid expensive analysis of textual elements and/or the expense of accurate text conversion, e.g., double-keying or detailed proofreading of automatic OCR.

Level 2 generally can be created and encoded by automated means. Pagination is identified as in Level 1, and metadata for the <tt>&lt;div&gt;</tt> structure is created, likely based on the page images. The <tt>&lt;div&gt;</tt> structure metadata might contain the page number on which the division begins and a transcription of that <tt>&lt;div&gt;</tt>’s heading. This metadata is inserted into the raw OCR at the appropriate points, forming a valid XML document. Level 2 texts do not require any special knowledge or manual intervention below the section level.

For the most part, Level 2 texts are not intended to be displayed separately from their page images. Level 2 encoding of sections and headings provides greater navigational possibilities than Level 1 encoding, and enables searching to be restricted within particular textual divisions (for example, searching for two phrases within the same chapter).

Level 2 is most suitable for projects in which:


 * a large volume of material is to be made available online quickly
 * a digital image of each page is desired
 * the material is of interest to a large community of users who wish to read texts that allow keyword searching
 * rudimentary search and display capabilities based on the large structures of the text are desired
 * each text is checked to ensure that divisions and headers are properly identified
 * extensibility is desired; that is, one desires to keep open the option for a higher level of encoding to be added at a later date

Element Recommendations for Level 2
Use all elements specified in Level 1 plus the following:

Level 2 Example: Basic Structure
<TEI xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> </teiHeader> [title page information, table of contents, prefaces, etc.] [optional] <pb n="1" facs="[URI of page 1 image]"/> [heading of section 1] <ab>[entire contents of section 1 here, with interspersed &lt;pb> elements pointing to page images; in this example there are 26 more pages to section 1]</ab> <pb n="27" facs="[URI of page 27 image]"/> [heading of section 2 subsection 1] <ab>[all the paragraphs of subsection one go here with page breaks inserted]</ab> [optional] </TEI>

Level 2 Example: Alger Hiss document
<TEI xml:id="someid" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> </teiHeader> <pb n="113" facs="00000001.tif"/> POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; ALTERNATIVELY, DISCOVERY AND A HEARING SHOULD BE ORDERED. <ab>

POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; ALTERNATIVELY, DISCOVERY AND A HEARING SHOULD BE ORDERED. The nature and extent of surveillance of Hiss, his family and associates was not known at the time of trial by the defense. Even now, with the release of some of the government documents concerning FBI investigative techniques regarding Hiss, the full extent of surveillance -- wiretapping, mail openings, mail covers, physical surveillance, and other intrusive techniques -- is still not 'clear. Nevertheless, it is apparent that information gathered through the exploitation of unlawful wiretaps and other illegal surveillance was used at trial and consequently the conviction must be reversed. Alternatively, further discovery and a hearing is essential to a fair determination regarding these issues. FBI surveillance of Hiss began in earnest in 1941 with the institution of a mail cover on his incoming correspondence at his home in connection with an FBI investigation of possible Hatch Act violations. CN Ex. 98A. Another mail cover was placed

-113 -

<pb n="114" facs="00000002.tif"/>

on the Hiss mail in 1945, and at the same time the FBI obtained toll call records from the Hiss residence Telephone for the years 1943 and 1944 as well. CN Ex. 99. In September, 1945, the FBI intercepted telegrams to Hiss as well. CN Ex. 100. In late November, 1945, FBI surveillance of the Hiss residence in Washington, D.C., escalated. For the third time, a mail cover was instituted beginning on November 28, 1945, which was continued at least until 1946. CN Ex. 101 at p. 70; CN Ex. 102. Continuous physical surveillance of Hiss was begun as well. CN Ex. 101 at p. 72. Although this twenty-four-hour surveillance was discontinued on December 14, 1945, physical surveillance was conducted frequently at various times until September, 1947. CN Ex. 102; CN Ex. 103. The most intrusive invasion of petitioner's rights 68/ Also before 1947, a letter from Priscilla Hiss addressed to her son, Timothy Hobson, was intercepted and its contents read. CN Ex. 100A at p. 167. In approximately March, 1947, a letter from a Michael Greenberg addressed to petitioner regarding an application for employment with the United Nations was also intercepted, in a manner not revealed by the documents. CN Ex. 100B

-114 -

<pb n="115" facs="00000003.tif"/>

occurred from December 13, 1945 until the Hisses moved from Washington, D.C. to New York City on September 13, 1947. A "technical surveillance," -- a wiretap -- was placed on the Hiss telephone at their residence on P Street-in Washington, D.C. The logs of this surveillance constitute twenty-nine volumes of FBI serials and are roughly 2,500 pages in length, in which an enormous amount of information concerning the Hisses' personal lives, relationships with friends and associates, and habits is recorded. The wiretap was installed following FBI Director Hoover's application to the Attorney General for authorization, although no written authorization appears in the documents released to Hiss. The purpose of the application was to gather information regarding Hiss' alleged contacts with Soviet espionage agents and communists in government service, general allegations which had been made by Elizabeth Bentley and Chambers. As one would expect, the interception of every telephone h9/      Hoover's initial request was answered by a note requesting information on Hiss. CN Ex. 104. Additional information was furnished by letter dated November 30, 1945. CN Ex. 105.

-115 -

</ab> </TEI>

Reference

 * Chapter 4, Default Text Structure, P5 Guidelines
 * Chapter 6, Verse, P5 Guidelines
 * Chapter 14, Tables, Formulæ, and Graphics, P5 Guidelines
 * Chapter 16, Linking, Segmentation, and Alignment, P5 Guidelines (for handling notes)

Purpose
To create a stand-alone electronic text and identify hierarchy (logical structure) and typography without content analysis being of primary importance.

Rationale
Level 3 texts can be created by conversion from an electronic source such as HTML or word-processed documents or a print source with the automatic generation of full text by optical character recognition software. Level 3 texts can also be created from scratch (e.g., transcription, born digital, etc.). Encoding at this level offers the advantage of the TEI header, interoperability with other TEI collections, and extensibility to higher levels of encoding. Level 3 generally requires some human editing, but the features to be encoded are determined by the logical structure and appearance of the text and not specialized content analysis.

Level 3 texts identify front and back matter, divisions within the text, and all paragraph breaks. Floating texts, or sub-texts like a poem or letter embedded in the greater text, are supported in this level. The finer granularity of encoding these features, as well as figures, notes, and all changes of typography, allows a range of options for display, delivery, and searching. For example, one has the option of identifying, and therefore specifying, the display characteristics of different typographic styles, and regularizing the display and placement of note text.

Level 3 texts can stand alone as text without page images, and therefore can be uploaded, downloaded, and delivered quickly, and require less storage space than digital collections with page images. However, the simple level of structural analysis and absence of specialized content analysis reflected in Level 3 encoding may make it desirable for some, depending on project priorities, to include page images in order to provide users with a fuller set of resources.

Level 3 is most suitable for projects with the following characteristics:

<ul> <li>the material is of interest to a large community of users who wish to read texts that allow for keyword searching</li> <li>some sophistication of display, delivery, and searching based on structure of the text is desired</li> <li>each text will undergo quality control to ensure that encoding decisions have been made appropriately</li> <li>the users of the texts may have limited storage or display capabilities</li> <li>the creator of the texts has limited or no ability to provide content expertise to analyze, tag, or review texts</li> <li>extensibility is desired; that is, one desires to keep open the option for a higher level of encoding to be added at a later date</li> </ul>

Element Recommendations for Level 3
Use all elements specified in Levels 1 and 2, plus the following:

Forme Work
Running heads, catch words, page numbers, signatures, and other artifacts derived from printing should not be included in Level 3, with the exception of page numbers, which are recorded using <tt>&lt;pb&gt;</tt>. If upgrading a text from Level 1 or Level 2 that was generated using OCR, discard the forme work information.

Front Matter
<tt>&lt;div type="contents"&gt;</tt>: Use lists to mark up the table of contents with the <tt>ptr</tt> element used to reference the starting page number. The <tt>ptr</tt> element can reference the <tt>&lt;pb&gt;</tt> identifier or an identifier (e.g., an <tt>xml:id</tt> attribute) placed in the corresponding division of text.

Body
<tt>&lt;note&gt;</tt>: It may be desirable to move footnotes from their original location in the text. If left at the bottom of a page, a note may become included in another paragraph or section of the encoded text, and thus separated from its reference. There are two options for placement of footnotes if they are moved:

<ul> <li>Inline. The note itself is inserted at the point of reference. (See Alger Hiss example below.)</li> <li>End-of-Division. All notes in a division are group together at the end of the division for ease of conversion from OCR, with a <tt>ref</tt> element inserted at each point of reference. For example: at the point of the footnote reference, pointing to <note place="bottom" anchored="true" xml:id="foo" n="68">Also before 1947, [. . .] </li> </ul>

Level 3 Basic Structure: Prose
<TEI xmlns="http://www.tei-c.org/ns/1.0" xml:id="VAA2383"> <teiHeader> </teiHeader> [figure] <titlePage>[text]</titlePage> [text] [text] [book title] [text] [text] [text] [text] [text] [text] [text] </TEI>

Level 3 Basic Structure: Verse
<TEI xmlns="http://www.tei-c.org/ns/1.0" xml:id="VAA2383"> <teiHeader> </teiHeader> <titlePage>[text]</titlePage> [text] [text] [book title] [section title] THE DAYS GONE BY. <lg> <l>O the days gone by! O the days gone by!</l> <l>The apples in the orchard, and the pathway through the rye;</l> <l>The chirrup of the robin, and the whistle of the quail</l> <l>As he piped across the meadows sweet as any nightingale;</l> <l>When the bloom was on the clover, and the blue was in the sky,</l> <l>And my happy heart brimmed overin the happy days gone by.</l> </lg> <lg>[lines of poetry]</lg> <lg>[lines of poetry]</lg> <lg>[lines of poetry]</lg> </TEI>

Level 3 Table of Contents
CONTENTS I. A Boy and His Dog 3</hi> <ptr target="#VAA2383_011"/> II. Romance 12</hi> <ptr target="#VAA2383_020"/> III. The Costume 21</hi> <ptr target="#VAA2383_029"/> IV. Desperation 30</hi> <ptr target="#VAA2383_038"/> V. The Pageant of the Table Round 38</hi> <ptr target="#VAA2383_046"/>

Level 3 Chapter with Letter
<pb xml:id="VAA2383_126" n="118"/> CHAPTER XIV MAURICE LEVY'S CONSTITUTION L</hi>O, SAM!" said Maurice cautiously. "What you doin'?"          Penrod at that instant had a singular experiencean intellectual shock like a flash of fire in the                    brain. Sitting in darkness, a great light flooded him with wild brilliance. He gasped!            "What you doin'?" asked Maurice for the third time, Sam Williams not having decided upon a reply.            <pb xml:id="VAA2383_127" n="119"/>           It was Penrod who answered.            "Drinkin' lickrish water," he said simply, and wiped his mouth with such delicious enjoyment that                        Sam's jaded thirst was instantly stimulated. He took the bottle eagerly from Penrod.             "A-a-h!" exclaimed Penrod, smacking his lips. "That was a good un!"                     Penrod uttered some muffled words and then waved both armseither in response or as an expression of his condition of mind; it may have been a gesture of despair. How much intention there was in                       this actobviously so rash, considering the position he occupiedit is impossible to say. Undeniably there must remain a suspicion of deliberate purpose. <pb xml:id="VAA2383_138" n="130"/> The damsel curtsied again and handed him the following communication, addressed to herself: <floatingText> "Dear madam Please excuse me from dancing the cotilo with you                                   this afternoon as I have fell off the barn                                 "Sincerly yours<lb/> "P ENROD</hi> S CHOFIELD</hi>." </floatingText>

Level 3 Alger Hiss document
<TEI xml:id="someid" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> </teiHeader> <pb n="113" facs="00000001.tif"/> POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; ALTERNATIVELY, DISCOVERY AND A HEARING SHOULD BE ORDERED. The nature and extent of surveillance of Hiss, his family and associates was not known at the time of trial by the defense. Even now, with the release of some of the government documents concerning FBI investigative techniques regarding Hiss, the full extent of surveillance -- wiretapping, mail openings, mail covers, physical surveillance, and other intrusive techniques -- is still not 'clear. Nevertheless, it is apparent that information gathered through the exploitation of unlawful wiretaps and other illegal surveillance was used at trial and consequently the conviction must be reversed. Alternatively, further discovery and a hearing is essential to a fair determination regarding these issues.

FBI surveillance of Hiss began in earnest in 1941 with the institution of a mail cover on his incoming correspondence at his home in connection with an FBI investigation of possible Hatch Act violations. CN Ex. 98A. Another mail cover was placed

<pb n="114" facs="00000002.tif"/> on the Hiss mail in 1945, and at the same time the FBI obtained toll call records from the Hiss residence Telephone for the years 1943 and 1944 as well. CN Ex. 99. In September, 1945, the FBI intercepted telegrams to Hiss as well. CN Ex. 100.

In late November, 1945, FBI surveillance of the Hiss residence in Washington, D.C., escalated. For the third time, a mail cover was instituted beginning on November 28, 1945, which was continued at least until 1946. CN Ex. 101 at p. 70; CN Ex. 102. Continuous physical surveillance of Hiss was begun as well. CN Ex. 101 at p. 72. Although this twenty-four-hour surveillance was discontinued on December 14, 1945, physical surveillance was conducted frequently at various times until September, 1947.

<note place="bottom" anchored="true" n="68">Also before 1947, a letter from Priscilla Hiss addressed to her son, Timothy Hobson, was intercepted and its contents read. CN Ex. 100A at p. 167. In approximately March, 1947, a letter from a Michael Greenberg addressed to petitioner regarding an application for employment with the United Nations was also intercepted, in a manner not revealed by the documents. CN Ex. 100B

CN Ex. 102; CN Ex. 103.

The most intrusive invasion of petitioner's rights

<pb n="115" facs="00000003.tif"/> occurred from December 13, 1945 until the Hisses moved from Washington, D.C. to New York City on September 13, 1947. A "technical surveillance," -- a wiretap -- was placed on the Hiss telephone at their residence on P Street-in Washington, D.C. The logs of this surveillance constitute twenty-nine volumes of FBI serials and are roughly 2,500 pages in length, in which an enormous amount of information concerning the Hisses' personal lives, relationships with friends and associates, and habits is recorded.

The wiretap was installed following FBI Director Hoover's application to the Attorney General for authorization,

<note place="bottom" anchored="true" n="69">Hoover's initial request was answered by a note requesting information on Hiss. CN Ex. 104. Additional information was furnished by letter dated November 30, 1945. CN Ex. 105.

although no written authorization appears in the documents released to Hiss. The purpose of the application was to gather information regarding Hiss' alleged contacts with Soviet espionage agents and communists in government service, general allegations which had been made by Elizabeth Bentley and Chambers.

As one would expect, the interception of every telephone </TEI>

Reference

 * Chapter 3.3 Highlighting and Quotation, P5 Guidelines
 * Chapter 3.4 Simple Editorial Changes, P5 Guidelines
 * Chapter 3.5 Names, Numbers, Dates, Abbreviations, and Addresses, P5 Guidelines
 * Chapter 3.12.1 Core Tags for Verse, P5 Guidelines
 * Chapter 3.12.2 Core Tags for Drama, P5 Guidelines
 * Chapter 4, Default Text Structure, P5 Guidelines
 * Chapter 6, Verse, P5 Guidelines
 * Chapter 7.1.4 Performance Texts: castLists and castItems, P5 Guidelines
 * Chapter 7.2.1 Performance Texts: Major Structural Divisions, P5 Guidelines
 * Chapter 7.2.2 Performance Texts: Speeches and Speakers, P5 Guidelines
 * Chapter 7.2.3 Performance Texts: Stage Directions, P5 Guidelines
 * Chapter 13, Names, Dates, People, and Places, P5 Guidelines
 * Chapter 14, Tables, Formulæ, and Graphics, P5 Guidelines
 * Chapter 14.3 Specific Elements for Graphic Images, P5 Guidelines
 * Chapter 16, Linking, Segmentation, and Alignment, P5 Guidelines

Purpose
To create text that can stand alone as electronic text, identifies hierarchy and typography, specifies function of textual and structural elements, and describes the nature of the content and not merely its appearance. This level is not meant to encode or identify all structural, semantic, or bibliographic features of the text.

Rationale
Greater description of function and content allows for:

<ul> <li>flexibility of display and delivery</li> <li>sophisticated searching within specified textual and structural elements</li> <li>combining the broadest range of uses and audiences</li>

</ul>

Texts encoded at Level 4 are able to stand alone without page images in order for them to be read by students, scholars, and general readers. This level of TEI encoding allows them to be displayed or printed in a variety of ways suitable for classroom or scholarly use.

Level 4 texts contain elements and attributes that describe content. Features of the text that may contribute to meaning, such as indentation of verse lines and typographic change, are preserved. These are textual features that are not encoded at lower levels and that allow the text to be used and understood fully independent of images. The ability to stand alone as text means that Level 4 texts are more nimble and robust for exercises such as format repurposing and textual analysis.

Finally, functionally accurate encoding in Level 4 texts allows them to be searched or displayed in sophisticated ways. For example, a searcher could limit his or her search in a     dramatic text to stage directions or in a verse text to only first lines. In a political tract published by subscription, a     search could be confined to names that appear in lists, thus limiting a search to names of people who subscribed to a     particular volume. This ability to limit searches becomes more significant as textbases become larger, and thus is of great importance to the library community as it attempts to build into the initial design and implementation of textbases the features needed to enhance interoperability.

Level 4 is most suitable for projects with the following characteristics:

<ul> <li>sophisticated search and retrieval capabilities are desired</li>

<li>the texts will be used for textual analysis</li> <li>extensibility is desired; that is, one desires to keep open the option for a higher level of      encoding to be added by the scholarly community at a later date</li> <li>the users of the texts may have limited storage or display capabilities</li> </ul>

Element Recommendations for Level 4
Use all elements specified in Levels 1, 2, and 3, plus elements in the following table. Note that some of these elements are defined in Level 3 as well, but their use in Level 4 is more strict.

General Level 4 Recommendations and Examples

 * The use of &lt;group&gt; is required when you need to encode a body of distinct texts that are grouped together and are regarded as a unit. Most typical examples of such composite texts would be anthologies, collected works of an author, etc. Section 4.3.1 Grouped Texts states, “The presence of common front matter referring to the whole collection, possibly in addition to front matter relating to each individual text, is a good indication that a given text might usefully be encoded in this way.”


 * Typographically distinct text may be encoded using the following elements:
 * to represent speech, thought, quotation, etc.:
 * epigraph
 * quote
 * said
 * mentioned
 * soCalled
 * to represent foreign words or phrases, linguistically emphatic or stressed words or phrases, words regarded as technical terms, etc.:
 * emph
 * foreign (e.g. <tt>&lt;foreign xml:lang="fr"&gt;</tt>)
 * gloss
 * term
 * title


 * Any ambiguous typographically distinct text should be encoded as hi (e.g. <tt>&lt;hi rend="bold"&gt;</tt>). This element may also be used if more specific elements are not used, as above.


 * Any of the following three methods may be used to encode errors or typos in original texts:
 * the sic element used alone is recommended to indicate errors without correcting them
 * the corr element used alone is recommended to provide corrections without indicating the initial error
 * the choice element allows both the apparent error and its editorial correction to be recorded, as in the following examples:

He has no Scruple about Fish; but won't touch a bit of Pork, it being expresly expressly forbidden by their Law. Source: Thomas Bluett. ''Some Memoirs of the Life of Job, the Son of Solomon, the High Priest of Boonda in Africa; Who was a Slave About Two Years in Maryland; and Afterwards Being Brought to England, was Set Free, and Sent to His Native Land in the Year 1734.'' London: Printed for R. Ford, 1734.

or

4. The art of writing she obtained by her own industry and curiosity, and in so short a time that in the year 1765, when she was not more than twelve years of age,she age, she was capable of writing letters to her friends <pb xml:id="p11" n="11"/> on various subjects. She also wrote to several persons in high stations. Source: Abigail Mott, 1766-1851. ''Biographical Sketches and Interesting Anecdotes of Persons of Colour. To Which is Added, a Selection of Pieces in Poetry.'' New-York: M. Day, 1826.


 * Use <tt>&lt;argument&gt;</tt> to encode a prefatory list or prose description of the topics usually discovered at the beginning of a chapter. The content within the <tt>argument</tt> element can be presented as a list or as a paragraph:

<pb xml:id="albert14" n="14"/> CHAPTER I.<lb/>CHARLOTTE BROOKS. Causes of immorality among colored people - Charlotte Brooks - She is sold South - Sunday work. ... Source: Octavia V. Rogers Albert. The House of Bondage, or, Charlotte Brooks and Other Slaves, Original and Life Like, As They Appeared in Their Old Plantation and City Slave Life; Together with Pen-Pictures of the Peculiar Institution, with Sights and Insights into Their New Relations as Freedmen, Freemen, and Citizens. New York: Hunt & Eaton, 1890.

[book title] [chapter title] [text] Here ends the Chapter 1. [chapter title] [text] Here ends the Chapter 2. FINIS.
 * The <tt>trailer</tt> element is recommended to encode a heading- or title-like content at the end of a division (i.e. chapter, book, etc.):


 * The elements <tt>add</tt>, <tt>del</tt>, <tt>unclear</tt>, <tt>gap</tt> may be used to indicate instances when a text (i.e. word or part of it, phrase or part of it) has been added, marked for deletion, or to indicate cases where transcription is difficult (<tt>&lt;unclear></tt>) or impossible (<tt>&lt;gap></tt>) because the material is illegible, invisible, or inaudible (i.e. while transcribing oral history interviews):

But it is well authenticated by the observation of every one, that <del rend="overstrike" hand="JHL">their manner <add rend="sup" hand="JHL">this way—i.e. the above of writing influences the style of compos. of those who practise it considerably, when they grow up to years of manhood; for their productions, <del hand="JHL" rend="overstrike">instead far from being terse, argumentative, convincing, are without head or tail &amp; are generally an incongruous mass mixed up in the most disgusting manner, without divisions or heads &amp; in short without a subject (so to speak). Source: Class Composition of J. Horace Lacy, [January 1851] 1. Lacy, James Horace, 1834-1852 But I still hope for & trust in God and I believe he will animate our brave defenders with a superhuman power and we will yet drive from our soil the hated invaders whose tread profanation, but this is an hour to try men's souls—Fort Donelson has been taken by the enemy. Frank was there and covered himself with honor but his bravery cost him a wound; he was wounded in the leg slightly—a flesh wound only, you must not be uneasy. Source: Kimberly Family Personal Correspondence, 1862-1864. Transcript of the manuscript, UNC-Chapel Hill, Southern Historical Collection.

Level 4 Front and Back Matter

 * The use of the <tt>titlePage</tt> element with appropriate child elements describing the major features of most title pages is required. The child elements are listed in Section 4.6 "Title Pages".


 * <tt>&lt;titlePage&gt;</tt> should include the verso if present, divided by <tt>&lt;pb n="verso"/&gt;</tt>.


 * Frontispieces should be encoded as a <tt>&lt;figure&gt;</tt>, within a separate division (numbered or unnumbered, depending on the general editorial decision for a specific encoding project) and <tt>&lt;p&gt;</tt>.


 * Tables of contents, errata, subscription lists, “other titles by the same author” should be included in a separate division (numbered or unnumbered, depending on the general editorial decision for a specific encoding project), as a <tt>&lt;list&gt;</tt> with <tt>&lt;item&gt;</tt>s.


 * It is recommended that all prefaces, tables of contents, afterwords, appendices, endnotes, and apparatus be encoded with phrase-level elements.


 * For publishers’ advertisements, indexes, and glossaries, or other front or back matter that are not considered of primary importance to the text, there are three options:
 * Fully transcribe and encode. For an index, use <tt>type="index"</tt> on the <tt>&lt;div&gt;</tt>, with <tt>&lt;list&gt;</tt>s to mark up index entries. Use <tt>&lt;ref target="____"&gt;</tt> to mark up page numbers given in the index, with the value of <tt>target</tt> referring to the <tt>xml:id</tt> attribute of the <tt>&lt;pb&gt;</tt> of the referenced page.
 * Link to page images (may omit encoded transcription)
 * Fully omit and note the omission in <tt>&lt;samplingDecl&gt;</tt>

Level 4 Name Tagging
Names should be encoded using <tt>persName</tt>, <tt>placeName</tt>, <tt>geogName</tt>, and <tt>orgName</tt> elements with the <tt>ref</tt> or <tt>key</tt> attribute providing a reference to a <tt>person</tt>, <tt>place</tt>, or <tt>org</tt> element in an external file or database for managing name normalization and compilation of additional information such as biographical or geospatial information. The <tt>ref</tt> attribute should be used when pointing to web-accessible files and the <tt>key</tt> used for pointing to databases or files not generally web accessible.

For example, a web-accessible external TEI file may contain an entry for each name, grouped accordingly under <tt>&lt;listPerson&gt;</tt>, <tt>&lt;listPlace&gt;</tt>, and <tt>&lt;listOrg&gt;</tt>, which is uniquely identified with an <tt>xml:id</tt> attribute. The <tt>ref</tt> value in the source file references the <tt>xml:id</tt> value in the external file. (In the examples below, the external file is named <tt>context.xml</tt> for “contextual information,” and is in the same directory as the source file, but it may be named anything and placed anywhere, including elsewhere on the web.) When pointing to a database or a non–web-accessible file, the <tt>key</tt> attribute points to the unique key in the database table or, as with the <tt>ref</tt> attribute, the <tt>key</tt> attribute can point to the <tt>xml:id</tt> value in the external file (see example below).

When referencing external files or databases, it is strongly recommended to provide an explanation in the <tt>&lt;editorialDecl&gt;</tt> section of the TEI header. References to controlled vocabularies and national or local authority files may be signified by a prefix in the <tt>xml:id</tt> attribute (e.g., <tt>tgn_0000000</tt> for the Getty Thesaurus of Geographic Names). When referencing a controlled vocabulary be sure to specify this information in the <tt>&lt;classDecl&gt;</tt> section of the TEI header.

The first Jews arrived in <placeName ref="context.xml#tgn_7012924">Indianapolis</placeName> in the middle of the 19th century. Primarily immigrants from <placeName ref="context.xml#tgn_7000084" > Germany</placeName> and other points in central Europe (though many had lived elsewhere in the   <placeName ref="context.xml#tgn_7012149">United States</placeName> before they arrived in the  city), they were drawn from throughout the Midwest by the growth of commerce and rail lines in    <placeName ref="context.xml#tgn_7012924">Indianapolis</placeName>.
 * Place-name tagging example in source file:

<listPlace> <place xml:id="tgn_7012924"> <placeName> Indianapolis Indiana </placeName> <place xml:id="tgn_7000084"> <placeName> <country xml:lang="de">Deutschland </placeName> <place xml:id="tgn_7012149"> <placeName> United States </placeName> </listPlace>
 * In the external file <tt>context.xml</tt>, for maintaining place name normalization and additional information:

PRIZE LIBRARY GIFT-Indiana University President <persName ref="context.xml#lcnaf_82134365" >Elvis J. Stahr</persName> (right), a former law dean and practicing attorney, reminisces with Professor of Law <persName ref="context.xml#lcnaf_00113347">W. Howard Mann</persName> as the two inspect some of the nearly 3,000 volumes of <orgName ref="context.xml#lcnaf_79006848">U.S.     Supreme Court</orgName> records recently transferred to I.U. from the <orgName ref="context.xml#lcnaf_79109178">Indiana Supreme Court Library</orgName>. The collection, dating back to 1925, is one of the oldest and most complete sets in existence.
 * Personal and organizational name tagging example in source file:

<listPerson> <person xml:id="lcnaf_82134365"> <persName> Stahr Elvis J.      </persName> <person xml:id="lcnaf_00113347"> <persName> Mann W.        Howard </persName> </listPerson> <listOrg> <org xml:id="lcnaf_79006848"> <orgName>United States. Supreme Court</orgName> <org xml:id="lcnaf_79109178"> <orgName>Indiana. Supreme Court</orgName> </listOrg>
 * In the external file <tt>context.xml</tt>, for maintaining personal and organization name normalization and additional information:

When Harry Byrd "retired" to his orchards and Rosemont, his new house outside <placeName key="1498453">Berryville</placeName> in 1930, he was still an energetic young man with a long political career ahead of him.
 * For example, the <tt>key</tt> attribute points to a unique key in a MySQL table that stores information like county name, FIPS county code, and latitude/longitude values:

Level 4 Figures
<tt>&lt;figure&gt;</tt> groups elements representing or containing graphic information such as an illustration or figure; in this context <tt>&lt;figure&gt;</tt> typically contains the following elements:


 * <tt>&lt;head&gt;</tt>, containing a literal transcription of a caption on a figurative image.


 * <tt>&lt;figDesc&gt;</tt>, containing a free text description of the image used, potentially, for searching the images themselves.


 * <tt>&lt;graphic&gt;</tt>, pointing to the URI of the image itself using a <tt>url</tt> attribute and containing other presentation instructions such as dimension at which the graphic should be displayed, etc.

An example of frontispiece encoding:

Sojourner Truth. <figDesc>Woodcut of Sojourner Truth.</figDesc> <graphic url="http://docsouth.unc.edu/neh/truth50/frontis.html" scale="0.5"/> [Etc ...]

Source: Narrative of Sojourner Truth, a Northern Slave, Emancipated from Bodily Servitude by the State of New York, in 1828.

Level 4 Embedded Texts
At Level 4, texts embedded within other texts must be marked as such.

In the case of a quotation from another text, use <tt>&lt;quote&gt;</tt>, and do not include quotation marks in the content of this element or just outside the opening and closing tags. If the rendering of this quotation needs to be recorded, use the <tt>rend</tt> attribute to describe how this quotation is set off from the rest of the text.

If the embedded text is more than a short quotation, use <tt>&lt;floatingText&gt;</tt> even if only an excerpt of the embedded texts is provided. If your project uses <tt>&lt;quote&gt;</tt> to identify quotations, surround instances of floating texts which are quotations with <tt>quote</tt> tags.

Personal letters are a common example of an embedded text. While a collection of letters would use a <tt>div</tt> element for each letter, if a letter is quoted as part of a larger text, use <tt>&lt;floatingText&gt;</tt> <tt>&lt;body&gt;</tt> <tt>&lt;div1 type="letter"&gt;</tt> with <tt>&lt;opener&gt;</tt>, <tt>&lt;dateline&gt;</tt>, <tt>&lt;salute&gt;</tt>, <tt>&lt;signed&gt;</tt>, <tt>&lt;closer&gt;</tt>, <tt>&lt;postscript&gt;</tt> included as appropriate. For example:

She opened and read as follows: <floatingText> AUGUSTA, March 4th, 18— Mrs. A. Mitten:</hi> "Having recently understood that you have procured a private teacher, we have ventured to stop your advertisement, though ordered to continue it until forbid,</hi> under the impression that you have probably forgotten to have it stopped. If, however, we have been misinformed, we will promptly resume the publication of it. You will find our account below; which as we are much in want of funds, you will oblige us by settling as soon as convenient. Hoping your teacher is all that you could desire in one,                    "We remain, your ob't. serv'ts, "H—&amp;amp; B—&rdquo;         </floatingText> Source: Augustus Baldwin Longstreet, 1790-1870. Master William Mitten: or, A Youth of Brilliant Talents, Who Was Ruined by Bad Luck. Macon, Ga.: Burke, Boykin, 1864.

Level 4 Drama

 * Within the front matter (<tt>&lt;front&gt;</tt>) of a performance text, cast lists should be encoded as <tt>&lt;castList&gt;</tt>s, with each item in that list encoded as <tt>&lt;castItem&gt;</tt>s. If desired, each <tt>&lt;castItem&gt;</tt> may be uniquely identified with the <tt>xml:id</tt> attribute.

For example,

<castList> Dramatis Personae <castItem xml:id="kllear">LEAR king of Britain</castItem> <castItem xml:id="klfrance">KING OF FRANCE</castItem> <castItem xml:id="klburgundy">DUKE OF BURGUNDY</castItem> <castItem xml:id="klcornwall">DUKE OF CORNWALL</castItem> <castItem xml:id="klalbany">DUKE OF ALBANY</castItem> <castItem xml:id="klkent">EARL OF KENT</castItem> <castItem xml:id="klgloucester">EARL OF GLOUCESTER</castItem> <castItem xml:id="kledgar">EDGAR son to Gloucester.</castItem> <castItem xml:id="kledmund">EDMUND bastard son to Gloucester.</castItem> [. . .]   </castList>

Source: Shakespeare’s King Lear


 * Within the body of performative texts, speeches are encoded as <tt>&lt;sp&gt;</tt> and speakers identified by the <tt>speaker</tt> element, which is a child of <tt>&lt;sp&gt;</tt>.
 * Stage directions are encoded as <tt>&lt;stage&gt;</tt> and enclose content describing scenery, stage directions, etc.
 * When encoding the actual speech content itself, utilize elements and attributes that correspond to the type of dramatic speech presented (e.g. <tt>&lt;p&gt;</tt> for prose speech with <tt>&lt;lb&gt;</tt> to designate a new line in a particular edition of the text or <tt>&lt;lg&gt;</tt> and <tt>&lt;l&gt;</tt> to describe dramatic verse structures).
 * If referencing the <tt>xml:id</tt> defined in the <tt>&lt;castList&gt;</tt> is desired, use the <tt>who</tt> attribute for the IDREF datatype.

Act 1 Scene 1 King Lear's palace. Enter KENT, GLOUCESTER, and EDMUND

KENT I thought the king had more affected the Duke of<lb/> Albany than Cornwall. </sp> GLOUCESTER It did always seem so to us: but now, in the<lb/> division of the kingdom, it appears not which of<lb/> the dukes he values most; for equalities are so<lb/> weighed, that curiosity in neither can make choice<lb/> of either's moiety. </sp> KENT Is not this your son, my lord? </sp> [. . .]

Source: Shakespeare’s King Lear

Level 4 Oral History
Speakers in oral history interviews, i.e. interviewee(s) and interviewer(s), may be identified in the <tt>&lt;teiHeader&gt;</tt> in several ways:


 * In the <tt>&lt;profileDesc&gt;</tt>, in the <tt>&lt;particDesc&gt;</tt>, using the <tt>list</tt> element, with <tt>&lt;name&gt;</tt> inside of <tt>&lt;item&gt;</tt>s
 * As a list of author <tt>&lt;name&gt;</tt>s within <tt>&lt;fileDesc&gt;</tt> / <tt>&lt;titleStmt&gt;</tt>

In either method, use an <tt>xml:id</tt> on the <tt>name</tt> element to uniquely identify the individual participant:

Interview Participants <name xml:id="spk1" key="wf" reg="Friday, William C." type="interviewee">WILLIAM C. FRIDAY , interviewee <name xml:id="spk2" key="wl" reg="Link, William" type="interviewer">WILLIAM LINK, interviewer
 * The list of an interview’s participants can be also listed within the body of the interview (see example below).
 * Questions and answers from interviewees and interviewers are encoded as <tt>&lt;sp&gt;</tt>, with speakers identified within <tt>speaker</tt> elements with a <tt>who</tt> attribute the value of which corresponds to the <tt>xml:id</tt> in the list of interview participants.

[. . . ]

WILLIAM LINK: Last time we were talking about Frank Porter Graham. And I have a couple of questions about Graham, and I wonder if you could clear them up for me. You have mentioned that you had worked with him as a student at North Carolina State, had you met him before? </sp> WILLIAM C. FRIDAY: No. That budget hearing was the first that I knew of him, of course, but the first time that I ever encountered him. I was president of class at N.C. State, and that through me into this kind of public adventure. And so I went merrily on downtown and sat there in the budget hearing, along with the president of the student body, and some others. </sp>

One possible way to synchronize audio and transcript has been introduced in Oral Histories of the American South, using <tt>&lt;milestone&gt;</tt> with a timestamp attribute: <milestone n="7248" unit="empty" type="stop" timestamp="00:08:54"/>

Level 4 Verse
Use <tt>&lt;lg&gt;</tt> and <tt>&lt;l&gt;</tt> as in Level 3. In addition, use the <tt>rend</tt> attribute to indicate lines that are indented.

For example, Fit the First: THE LANDING

<l n="1.1">"Just the place for a Snark!" the Bellman cried,</l> <l rend="indent(1)" n="1.2">As he landed his crew with care;</l> <l n="1.3">Supporting each man on the top of the tide</l> <l rend="indent(1)" n="1.4">By a finger entwined in his hair.</l> </lg>

<l n="2.1">"Just the place for a Snark! I have said it twice:</l>       <l rend="indent(1)" n="2.2">That alone should encourage the crew.</l>        <l n="2.3">Just the place for a Snark! I have said it thrice:</l>        <l rend="indent(1)" n="2.4">What I tell you three times is true."</l> </lg>

[ETC....]

Source: Lewis Carroll’s The Hunting of the Snark

Level 4 Milestones
Instead of using the <tt>milestone</tt> element available in TEI, use <tt>&lt;ab type="typography"&gt;</tt>. The content of this element is the character(s) or device used to mark the milestone in the source document. For example:

*****</ab>

Level 4 Example: Alger Hiss document
<TEI xml:id="project_document_identifier" xmlns:xi="http://www.w3.org/2001/XInclude" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> <fileDesc> <titleStmt> Title </titleStmt> <publicationStmt> Publication Information </publicationStmt> <sourceDesc> Information about the source </sourceDesc> </fileDesc> </teiHeader> <pb n="113" facs="./pageImages/AH4_0113.jpg" ed="typed"/> <pb n="118" ed="subsequent"/> POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S           <lb/>CONVICTION SHOULD BE VACATED; ALTERNATIVELY, <lb/>DISCOVERY AND A HEARING SHOULD BE ORDERED. The nature and extent of surveillance of Hiss, his <lb/>family and associates was not known at the time of trial by           <lb/>the defense. Even now, with the release of some of the govern&#xAD; <lb/>ment documents concerning FBI investigative techniques regarding <lb/>Hiss, the full extent of surveillance -- wiretapping, mail open&#xAD; <lb/>ings, mail covers, physical surveillance, and other intrusive <lb/>techniques -- is still not 'clear. Nevertheless, it is apparent <lb/>that information gathered through the exploitation of unlawful <lb/>wiretaps and other illegal surveillance was used at trial and <lb/>consequently the conviction must be reversed. Alternatively, <lb/>further discovery and a hearing is essential to a fair deter&#xAD; <lb/>mination regarding these issues. FBI surveillance of Hiss began in earnest in 1941 with <lb/>the institution of a mail cover on his incoming correspondence <lb/>at his home in connection with an FBI investigation of possible <lb/>Hatch Act violations. CN Ex. 98A. Another mail cover was placed <pb n="114" facs="./pageImages/AH_0114.jpg"/> <pb n="119" ed="subsequent"/> on the Hiss mail in 1945, and at the same time the FBI obtained <lb/>toll call records from the Hiss residence Telephone for the <lb/>years 1943 and 1944 as well. CN Ex. 99. In September, 1945, <lb/>the FBI intercepted telegrams to Hiss as well. CN Ex. 100. In late November, 1945, FBI surveillance of the Hiss <lb/>residence in Washington, D.C., escalated. For the third time, <lb/>a mail cover was instituted beginning on November 28, 1945, <lb/>which was continued at least until 1946. CN Ex. 101 at p. 70; <lb/>CN Ex. 102. Continuous physical surveillance of Hiss was begun <lb/>as well. CN Ex. 101 at p. 72. Although this twenty-four-hour <lb/>surveillance was discontinued on December 14, 1945, physical <lb/>surveillance was conducted frequently at various times until <lb/>September, 1947.<note place="foot" anchored="true" n="68">Also before 1947, a letter from Priscilla Hiss addressed <lb/>to her son, Timothy Hobson, was intercepted and its contents <lb/>read. CN Ex. 100A at p. 167. In approximately March, 1947, <lb/>a letter from a Michael Greenberg addressed to petitioner re&#xAD; <lb/>garding an application for employment with the United Nations <lb/>was also intercepted, in a manner not revealed by the docu&#xAD; <lb/>ments. CN Ex. 100B CN Ex. 102; CN Ex. 103. The most intrusive invasion of petitioner's rights <pb n="115" facs="./pageImages/AH_0115.jpg"/> <pb n="120" ed="subsequent"/> <lb/>occurred from December 13, 1945 until the Hisses moved from <lb/>Washington, D.C. to New York City on September 13, 1947. A           <soCalled>technical surveillance</soCalled>, -- a wiretap -- was placed on the Hiss <lb/>telephone at their residence on P Street-in Washington, D.C.           <lb/>The logs of this surveillance constitute twenty-nine volumes <lb/>of FBI serials and are roughly 2,500 pages in length, in which <lb/>an enormous amount of information concerning the Hisses' per&#xAD; <lb/>sonal lives, relationships with friends and associates, and <lb/>habits is recorded. The wiretap was installed following FBI Director Hoover's           <lb/>application to the Attorney General for authorization,<note place="bottom" anchored="true" n="69">Hoover's              initial request was answered by a note reques&#xAD; <lb/>ting information on Hiss. CN Ex. 104. Additional information <lb/>was furnished by letter dated November 30, 1945. CN Ex. 105. <lb/>although no written authorization appears in the documents released to           <lb/>Hiss. The purpose of the application was to gather information <lb/>regarding Hiss' alleged contacts with Soviet espionage agents and <lb/>communists in government service, general allegations which had <lb/>been made by Elizabeth Bentley and Chambers. As one would expect, the interception of every telephone </TEI>

LEVEL 5: Scholarly Encoding Projects
Level 5 texts are those that require subject knowledge, and encode semantic, linguistic, prosodic, or other elements beyond a basic structural level. It is difficult to make recommendations for encoding at this level since the scholarly analysis required is usually quite specific to the project.

Lemmatization and Thematic Keyword Tagging
<lg> High</w> things</w> <seg type="keyword" xml:id="ke39" corresp="#kw-song"> the</w> high</w> song</w> taught</w> him</w>; how</w> the</w> breath</w></l> Too</w> frail</w> for</w> life</w> may</w> be</w> more</w> strong</w> than</w> death</w>;</l> And</w> this</w> poor</w> flash</w> of</w> sense</w> in</w> life</w>, that</w> gleams</w></l> </lg> Source: the Swinburne Project

Prosodic Analysis
Little House in Kolomna <epigraph xml:lang="la"> Modo vir, modo femina. Ov. <lg type="octave" xml:id="st1" n="1"> I.    <l rhyme="a" met="m" xml:id="l1.1" n="1">By now I'm all fed up with four-foot verse;</l> <l rhyme="B" met="f" xml:id="l1.2" n="2">Each scribbler writes it. It's a mere diversion</l> <l rhyme="a" met="m" xml:id="l1.3" n="3">For children — let them keep it. I could do worse</l> <l rhyme="B" met="f" xml:id="l1.4" n="4">Than in the octave's measure make excursion.</l> <l rhyme="a" met="m" xml:id="l1.5" n="5">It's true, in triple rhyme I'm little versed —</l> <l rhyme="B" met="f" xml:id="l1.6" n="6">But let me try it. To fame I've no aversion!</l> <l rhyme="c" met="m" xml:id="l1.7" n="7">For rhymes have ever echoed in my song!</l> <l rhyme="c" met="m" xml:id="l1.8" n="8">Two come themselves: the third they'll bring along.</l> </lg> <lg type="octave" xml:id="st2" n="2"> II. <l rhyme="A" met="f" xml:id="l2.1" n="1">And so with types of rhyme I can't be choosy:</l> <l rhyme="b" met="m" xml:id="l2.2" n="2">To verbal rhyme I'll grant the widest play.</l> <l rhyme="A" met="f" xml:id="l2.3" n="3">You know, our poets past have oft refused it,</l> <l rhyme="b" met="m" xml:id="l2.4" n="4">As though ashamed of it. Why so, I say?</l> <l rhyme="A" met="f" xml:id="l2.5" n="5">True, S. of pious memory never used it,</l> <l rhyme="b" met="m" xml:id="l2.6" n="6">And I eschew it too, whene'er I may,</l> <l rhyme="C" met="f" xml:id="l2.7" n="7">Why should we so? Of rhymes we've scarce sufficient;</l> <l rhyme="C" met="f" xml:id="l2.8" n="8">Without the verbs our rhyme will be deficient.</l> </lg> Source: William Harkins’s translation of Pushkin's “Little House in Kolomna”

Analytical Structures and Translation Markup
<title rend="case(allcaps)">An Evidence <l rend="indent(1)">Ricardo,</l> <l rend="indent(1)">when power is</l> <l rend="indent(3)">rooted</l> <l rend="indent(1)">in the land</l> <l rend="indent(3)"> <foreign xml:lang="es">la tierra <note type="translation" resp="#trans" place="foot" xml:lang="en">the earth, soil </l> <l rend="indent(1)">it is evident</l> <l rend="indent(3)">and true.</l> <l rend="indent(1)">Land, in some languages</l> <l rend="indent(4)">is earth--</l> <l rend="indent(1)">And this earth</l> <l rend="indent(3)">(the planet...</l>   <l rend="indent(2)">all of it</l>    <l rend="indent(1)">is nurturing your powers</l>  </lg>    Lorenzo Thomas   <dateline rend="case(allcaps)">    <placeName>Amsterdam</placeName>, <placeName>The Netherlands</placeName>    <lb/><date when="1978-09-11">11 Sep 1978 Source: a poem from the Notebooks of Ricardo Sanchez

Acknowledgements
This document is the result of a group of individuals with a range of experience with TEI text encoding, which formed together under the TEI Special Interest Group on Libraries and Digital Library Federation umbrellas. We would like to thank and acknowledge all of those who have given their time and expertise to develop these best practices.

The individuals who have contributed to the writing of this document are:


 * Syd Bauman, Brown University
 * Michelle Dalmau, Indiana University
 * Matthew Gibson, University of Virginia
 * Kevin Hawkins, University of Michigan
 * Lisa McAulay, University of California, Los Angeles
 * Melanie Schlosser, Ohio State University
 * Natasha Smith, University of North Carolina, Chapel Hill
 * Richard Wisneski, Case Western University

The individuals who have contributed to the planning of this document are:


 * Syd Bauman, Brown University
 * Michelle Dalmau, Indiana University
 * Matthew Gibson, University of Virginia
 * Kevin Hawkins, University of Michigan
 * Lisa McAulay, University of California, Los Angeles
 * Chris Powell, University of Michigan
 * Andrew Rouner, Washington University in St. Louis
 * Melanie Schlosser, Ohio State University
 * Natasha Smith, University of North Carolina, Chapel Hill
 * Perry Willett, California Digital Library
 * Richard Wisneski, Case Western University
 * Glen Worthey, Stanford University

Lastly, we would like to thank the Digital Library Federation (DLF) for sponsoring two in-person meetings as part of the Spring 2008 Forum in Minneapolis, Minnesota, and the Spring 2009 Forum in Raleigh, North Carolina, in support of our revision work. The DLF also provided teleconferencing support for our regularly scheduled meetings.

Appendix A: History of This Document
The Text Encoding Initiative Guidelines for Electronic Text Encoding and Interchange (referred to as    the TEI Guidelines) were first published in 1994 and represent a tremendous achievement in electronic text standards by providing a highly sophisticated structure for encoding electronic text. Digital librarians have benefited greatly from the standardization provided by these guidelines, and the potential for interoperability and long-term preservation of digital collections facilitated by their wide adoption.

In 1998, the Digital Library Federation (DLF) sponsored the TEI and XML in Digital Libraries Workshop at the Library of Congress to discuss the use of the TEI Guidelines in libraries for electronic text, and to create a set of best practices for librarians implementing them. From this workshop, three working groups were formed, the members of which represented some of the largest and most mature digital library programs in the U.S.

Group 1 was charged to recommend some best practices for TEI header content and to review the relationship between the Text Encoding Initiative header and MARC. To this end, representatives of the University of Virginia Library and the University of Michigan Library gathered in Ann Arbor in early October 1998 to develop a recommended practice guide. This work was assisted by similar efforts that had taken place in the United Kingdom under the auspices of the Oxford Text Archive the previous year. The section on the header is based on a draft of those recommended practices. It was submitted to various constituencies for comment. In 2008 and 2009, it was heavily revised by Melanie Schlosser, Kevin Hawkins, and other members of the TEI SIG on Libraries.

Group 2 was charged with developing a set of recommendations for libraries using the TEI Guidelines in electronic text encoding. This group included the following representatives from six libraries: <ul> <li>LeeEllen Friedland, Library of Congress</li> <li>Nancy Kushigian, University of California, Davis</li> <li>Chris Powell, University of Michigan</li> <li>David Seaman, University of Virginia</li> <li>Natasha Smith, University of North Carolina, Chapel Hill</li> <li>Perry Willett, Indiana University (chair)</li> </ul> At the ALA Midwinter Meeting (January 1999), the DLF task force revised a draft set of best practices, called TEI Text Encoding in Libraries: Guidelines for Best Practices (referred to as <i>TEI in Libraries     Guidelines</i>). The revised recommendations were circulated to the conference working group in May 1999 and presented at the joint annual meeting of the Association of Computers and the Humanities and Association of Literary and Linguistic Computing in June 1999. Version 1.0 was circulated for comments in    August 1999. These guidelines were endorsed by the DLF, and have been used by many digital libraries, including those of the task force members, as a model for their own local best practices. Libraries, museums, and end-users have benefitted from a set of best practices for electronic text in a number of    ways, including better interoperability between electronic text collections, better documented practices among digital libraries, and a starting point for discussion of best practices with commercial publishers regarding electronic text creation.

Written in 1998, this first iteration of TEI in Libraries Guidelines made no mention of XML, XSLT, or any of the other powerful tools that have now become common parlance and practice in creating digital documents and collections. Based on these important changes in markup technology, it came to the attention of the DLF and members of the original Task Force that the TEI in Libraries Guidelines required substantial revision. In 2002, the TEI Consortium published a new edition of the complete TEI Guidelines that conformed to XML specifications. In order to remain useful, the <i>TEI in     Libraries Guidelines</i> had to be updated to reflect these developments.

Furthermore, librarians need more guidance than the original TEI in Libraries Guidelines provided. There are many library-specific encoding issues which need to be addressed and documented to    ensure consistency. The intention of this document is to provide recommended paths of encoding for these issues.

In addition, these library guidelines have the potential to be much more useful if they can serve as a    training document from which librarians can learn about text encoding and addressing particular encoding challenges. To fulfill this role, the guidelines require more examples and detailed explanations, giving documentation of the use of TEI in a library context. Librarians also need a set of standards and best practices for vendors and publishers who create electronic text for digital libraries, so that these collections adhere to the same archival standards as locally-created electronic text collections. With detailed guidelines that could serve as an encoding specification, librarians might encourage vendors to follow the principles in these standards, to facilitate the long-term preservation of    commercially published electronic text collections, and more readily allow for cross-collection searching.

In order to facilitate the evolution of this document, another DLF-sponsored Task Force&mdash;some of the representatives of which were on the original Task Force&mdash;met on October 24-25, 2003 at    the Cosmos Club in Washington, D.C.: <ul> <li>Richard Gartner, Oxford University Library</li> <li>Matthew Gibson, University of Virginia Library</li> <li>Kirk Hastings, California Digital Library</li> <li>Chris Powell, University of Michigan</li> <li>Merrilee Proffitt, RLG</li> <li>David Seaman, Digital Library Federation</li> <li>Natasha Smith, University of North Carolina, Chapel Hill</li> <li>Perry Willett, Indiana University (chair)</li> </ul> These representatives met to revise the original TEI in Libraries Guidelines in order that they: <ul> <li>reflect changes occuring within the text encoding world generally and within the TEI community specifically</li> <li>further illuminate the different levels of encoding by offering clearer and more robust examples.</li> </ul> After producing Version 2.0 of the Guidelines, this group (with some changes in membership) met again at the Cosmos Club on February 13-14, 2006. Those in attendance were: <ul> <li>Syd Bauman, The TEI Consortium</li> <li>Richard Gartner, Oxford University Library (by phone)</li> <li>Matthew Gibson, Virginia Foundation for the Humanities (chair)</li> <li>Chris Powell, University of Michigan</li> <li>Merrilee Proffitt, RLG</li> <li>David Seaman, Digital Library Federation</li> <li>Natasha Smith, University of North Carolina, Chapel Hill</li> <li>Perry Willett, University of Michigan</li> </ul>