2.1 The Header

Attached to every document we create is a "header," which holds essential information about who is responsible for creating and publishing the document, the source of the text we are marking up, and the electronic title page. The header is analogous to the first few pages of a book that inform you of the author, publisher, copyright date, terms of publication, etc.

The template we provide will help you complete this portion of the document. Since the header stays quite stable regardless of the specific manuscript, we recommend you utilize the template to aid your encoding.

Below, you will find descriptions of the core elements of the header, or, click here to work from an annotated version of the template.


The <teiHeader> supplies the descriptive and declarative information making up an "electronic title page" prefixed to every TEI-conformant text. The <teiHeader> has three principal components (each of which is described in greater detail in the sections which follow):

  • <fileDesc>:
  • contains a full bibliographic description of an electronic file
  • <profileDesc>:
  • provides a detailed description of non-bibliographic aspects of a text, specifically the situation in which it was produced, the participants, and their setting
  • <revisionDesc>:
  • summarizes the revision history for a file

The overall structure of the <teiHeader> looks like this:

Example:

<TEI.2 id="uva.00023" type="doc">
<teiHeader>
<fileDesc></fileDesc>
<profileDesc></profileDesc>
<revisionDesc></revisionDesc>
</teiHeader>


File description<fileDesc>: TEI Guidelines

This should contain the following components:

  • Title statement <titleStmt>: This section should include the <title> given to the electronic work (see the section on titling in another section of these guidelines), information about those "responsible" for the text <respStmt> and the name of the project's <funder>. <respStmt> contains a specific responsibility <resp> and the name <name> of the individual who performed it. To avoid ambiguity, use a separate <respStmt> for each task. An example in which the title is given by Whitman:

<titleStmt>
<title level="m" type="main">Song of Myself</title>
<title level="m" type="sub"&gta machine readable transcription</title>
<respStmt>
<author>Walt Whitman</author>
<editor>Ed Folsom</editor>
<editor>Kenneth M. Price</editor>
<resp>Transcription and encoding</resp>
<name>The Walt Whitman Archive Staff</name>
</respStmt>
<sponsor>The Institute for Advanced Technology in the Humanities</sponsor>
<sponsor>University of Iowa</sponsor>
<sponsor>University of Nebraska-Lincoln</sponsor>
<funder>The National Endowment for the Humanities</funder>
<funder>The United States Department of Education</funder>
</titleStmt>

Example of ms. for which we have assigned a title (for the guidelines for assigning titles, click here.):

<titleStmt>
<title level="m" type="main" rend="bracketed">I see who you are</title>
<title level="m" type="sub">a machine readable transcription</title>
. . .
</titleStmt>
etc.

Note that a rend attribute has been assigned to the title element to indicate that it has been supplied by us and should therefore be displayed with brackets.

Example:

<editionStmt> <edition>
<date>2000</date>
</edition><
/editionStmt>

Example:

<publicationStmt>
<idno>uva.00023</idno>
<distributor>The Walt Whitman Archive</distributor>
<address>
<addrLine>The Institute for Advanced Technology in the Humanities</addrLine>
<addrLine>Alderman Library</addrLine>
<addrLine>University of Virginia</addrLine>
<addrLine>P.O. Box 400115</addrLine>
<addrLine>Charlottesville, VA 22904-4115</addrLine>
<addrLine>[email protected]</addrLine>
</address>
<availability>
Copyright © 2002 by Ed Folsom and Kenneth M. Price, all rights reserved. Items in the Archive may be shared in accordance with the Fair Use provisions of U.S. copyright law. Redistribution or republication on other terms, in any medium, requires express written consent from the editors and advance notification of the publisher, The Institute for Advanced Technology in the Humanities. Permission to reproduce the graphic images in this archive has been granted by the owners of the originals for this publication only.
</availability>
</publicationStmt>

Example:

<sourceDesc>
<bibl>
<author>Walt Whitman</author>
<title>Calamus Leaves</title>
<orgName type="repository">Valentine-Barrett Collection, Alderman Library, University of Virginia </orgName>
<note>Transcribed from our own digital image of original manuscript.</note>
</bibl>
</sourceDesc>

Notes on description of source: Because this information is about the copy text, the <title> here (as opposed to the one in titleStmt) should contain the exact title used by the library or other institution cited in <orgName>, no matter how imprecise or wrong-headed their conventions may seem. Many times, this will be the title given to a folder, since libraries often don't assign titles to each individual item.

We tend to work primarily from our own digital images, but we have also worked from Joel Myerson's facsmile reproductions of Whitman manuscripts published in The Walt Whitman Archive : A Facsimile of the Poet's Manuscripts, (New York: Garland, 1993) and from Major Author's on CD-ROM: Walt Whitman, ed. Ed Folsom and Kenneth M. Price (Woodbridge, CT : Primary Source Media, 1997). Whatever you use should be cited in <note>, and if you rely on more than one thing, mention everything you use, separated by semicolons. Please note that when citing Myerson, the volume number, part number, and page number change poem by poem.

By the way, we say "our own digital image" rather than, say, the Whitman Archive's digital image so as to avoid any confusion with Myerson's volume, also called--somewhat confusingly--the Whitman Archive.

Profile description <profileDesc>: TEI Guidelines

We use <profileDesc> to record all hands other than Whitman's that are cited within the markup as responsible, typically as the value of a "resp" attribute in a <note>, <unclear>, or <gap> element.

For example, if you are noting Fredson Bowers's note on a Whitman manuscript at the University of Virginia within the markup, the header must have a <profileDesc> that reads like this:

<profileDesc>
<handList>
<hand scribe="Fredson Bowers" id="fb">
</handList>
</profileDesc>

(For more on this topic and how to actually represent an editor's notes, see editorial insertions.)

If the markup includes <unclear> or <gap> elements, which require a "resp" attribute, you'll need to include a "hand" id within the <profileDesc>. For example, if Andy Jewell is encoding a manuscript with an unclear word and inserts this markup:

<unclear reason="cut away" cert="60%" resp="awj">
he will need to include this <profileDesc>:
Example:

<profileDesc>
<handList>
<hand scribe="Andrew Jewell" id="awj">
</handList>
</profileDesc>

Revision Description <revisionDesc>:TEI Guidelines

This is the place to summarize the work we've done. In this section you can specify the changes you've made <item>, note when you made them <date>, and claim responsibility for the changes <resp>. IMPORTANT: TEI only allows one <item> per <change>. If changes are performed at the same time, insert additional changes within the same <item> and use semicolons. If changes are performed at different times, add another <change> at the top, so that changes are listed in reverse chronological order (most recent change first). To describe the tasks in our routine workflow, choose from the following terms for the content of <item>: transcribed, encoded, checked, edited, blessed. If the task is in addition to these, any descriptive phrase can be used.

Example:

<revisionDesc>
<change>
<date>2002-09-14</date>
<respStmt>
<name>Kenneth M. Price</name>
</respStmt>
<item>Edited</item>
</change>
<change>
<date>2002-09-07</date>
<respStmt>
<name>Andrew Jewell</name>
</respStmt>
<item>Checked</item>
</change>
<change>
<date>2000-08-22</date>
<respStmt>
<name>Matt Miller</name>
</respStmt>
<item>Transcribed; encoded</item>
</change>
</revisionDesc>