Project Gutenberg TEI Header Specification

by Joshua Hutchinson


This document will provide a "dummy" teiHeader, marking each line as either MANDATORY, RECOMMENDED or OPTIONAL.

For fuller descriptions of what each part of the teiHeader, please see the original TEILite documentation for the Electronic Title Page (<teiHeader>) located here (http://www.tei-c.org/Lite/teiu5_en.html#U5-header).




<teiHeader>
  <fileDesc>  <-- MANDATORY SECTION -->

    <titleStmt>  <-- MANDATORY SECTION -->
      <title>The Title of the EText</title>  <-- MANDATORY SECTION -->
      <author><name reg="LastName, FirstName">FirstName LastName</name></author>  <-- MANDATORY SECTION -->
      <respStmt><resp>Illustrator, Editor, etc.</resp>
             <name reg="LastName, FirstName">FirstName LastName</name></resp></respStmt>  <-- MANDATORY SECTION (if it exists for this text) -->
    </titleStmt>

<-- Multiple entries are allowed.  For instance, co-authors for a text
would result in multiple <author></author> entries, one for each author. -->

    <editionStmt>  <-- OPTIONAL -->
      <edition n="1">First edition</edition>  <-- OPTIONAL -->
    </editionStmt>

<-- This is information specifically about the PG edition.  For instance,
in the past, a major update of a text would often result in a number increment
of a text's file name.  This information could be tracked here.  I'm not
certain that this type of information is captured anymore. -->

    <publicationStmt>  <-- MANDATORY SECTION -->
      <publisher>Project Gutenberg</publisher>  <-- MANDATORY SECTION -->
      <date value="2004-11">November, 2004</date>  <-- MANDATORY SECTION -->
      <idno type="etext-number">12345</idno>  <-- MANDATORY SECTION -->
    </publicationStmt>

<-- This information pertains to the posting of the etext in PG archives.
The <publisher> field won't ever change.  (Should it be something else,
like PGLAF?)  The <date> field is the month and year it was posted.  The 
<idno> field is the file number assigned to the text by the whitewashers 
before posting to the archive. (NOTE: PG could also list itself as a
distributor instead of a publisher.)

Possible future addition here:  There has been sporadic talk in the past
of getting ISBN numbers for PG posted works.  This would go here as another 
<idno> field. -->

    <sourceDesc>  <-- MANDATORY SECTION -->
      <bibl>A short description of the etext (i.e., The first folio of Shakespeare, prepared by Charlton Hinman)</bibl>  <-- OPTIONAL -->
      <biblFull>  <-- MANDATORY SECTION -->
        <titleStmt>  <-- MANDATORY SECTION -->
          <title>The Title of the Source Text</title>  <-- MANDATORY SECTION -->
          <author><name reg="LastName, FirstName">FirstName LastName</name></author>  <-- MANDATORY SECTION -->
          <respStmt><resp>Illustrator, Editor, etc.</resp><name reg="LastName, FirstName">FirstName LastName</name></resp></respStmt>  <-- MANDATORY SECTION (if it exists for this text) -->
        </titleStmt>
        <publicationStmt>  <-- MANDATORY SECTION -->
          <publisher>Original Source Publisher</publisher>  <-- MANDATORY SECTION -->
          <date value="1923-01">January, 1922</date>  <-- MANDATORY SECTION -->
          <pubPlace>Place of Publication</pubPlace>  <-- MANDATORY SECTION -->
        </publicationStmt>
      </biblFull>
    </sourceDesc>

<-- The observant will notice that the fields from the beginning of
<fileDesc> are duplicated in the <sourceDesc> section.  The information 
will not necessarily be identical, though. The <fileDesc> information 
refers to our etext, while the <sourceDesc> refers back to the original 
source document. -->

  </fileDesc>

  <encodingDesc>  <-- OPTIONAL -->
    <projectDesc>The etext was produced by the Distributed Proofreaders at http://www.pgdp.net.</projectDesc>  <-- OPTIONAL -->
  </encodeDesc>

<-- This section is optional.  In fact, for the example given, it is 
largely redundant because DP will be given credit in the <revisionDesc> 
section detailed below. -->

  <profileDesc>  <-- MANDATORY SECTION -->
    <langUsage>  <-- MANDATORY SECTION -->
      <language id="en-us">English (United States)</language>
      <language id="xx">Written out language title</language>
    </langUsage>
    <textClass>  <-- RECOMMENDED SECTION -->
      <keywords>
        <list>
          <item>KEYWORD</item>
        </list>
      </keywords>
    </textClass>
  </profileDesc>

<-- This section is fairly straight forward, just listing the languages used in the etext and some search keywords. -->

  <revisionDesc>  <-- MANDATORY SECTION -->
    <change>
      <date value="2004-11">November 2004</date>
      <respStmt>
        <name>Scans provided by Cornell University</name>
        <name>Joshua Hutchinson</name>
        <name>Juliet Sutherland</name>
        <name>Distributed Proofreaders</name>
       </respStmt>
       <item>Etext created</item>
    </change>
    <change>
      <date value="2005-11">November 2005</date>
      <respStmt>
        <name>Jim Tinsley</name>
      </respStmt>
      <item>Fixed missing chapter headers and minor typos</items>
    </change>
  </revisionDesc>

<-- This section will be added to each time something is done to the
text, so we have a running record of changes.  The order should be
in the order the changes were done, the original creation first and 
each additional change listed in order below.  Because some volunteers
wish to remain anonymous, it is perfectly acceptable to simply list 
ANONYMOUS in a name line. -->