TEI Header
Abstract
General notes on the TEI header and its use at the WWP
metadata
document analysis
fileDesc
editorialDecl
projectDesc
tagsDecl
revisionDesc
profileDesc
teiHeader
Encoding Instructions (old P4 version)
The WWP captures metadata about its encoded files using the TEI header. We use the following components of the TEI header:
1. The fileDesc, and in particular the sourceDesc with detailed documentation of the source text from which the WWP file was transcribed.
2. The profileDesc, to capture the languages which appear in the text and also the owners of any handwriting the text contains.
3. The encodingDesc, with boilerplate descriptions of the WWP (in projectDesc), its sampling methods (in samplingDecl), its editorial methods and transcriptional practices (in editorialDecl), and renditional defaults (in tagsDecl).
4. The revisionDesc, to capture a detailed log of the file’s progress.
The encoding of the TEI header is constrained by a template which is used as the basis for all new WWP files, and which includes internal documentation describing how it is to be filled out. Brief additional documentation is given here on a few special topics:
--use of IDs in the TEI header
--treatment of document titles in the TEI header
Examples
Example 1.
<?xml version='1.0' encoding='UTF-8'
standalone='no' ?>
<!DOCTYPE TEI.2 PUBLIC “-//Brown University Women Writers
Project//DTD WWP Textbase Storage DTD//EN”
“/opt/local/sgml/WWP/wwp-store.dtd”>
<!-- ******************************************************** -->
<!-- encoder: -->
<!-- * fill in those areas marked with $$$$$ -->
<!-- * remove comments as you go, except for the very first -->
<!-- one on line 2 (“Header: /home/...”)
-->
<!-- * choose one of each set of possibilities that are -->
<!-- separated by “||”
-->
<!-- * when you’re done with your header, there should be no
-->
<!-- dollar signs, and this comment and all below it should -->
<!-- have been removed (the very first comment, line number -->
<!-- two, should stay) -->
<!-- ******************************************************** -->
<TEI.2>
<teiHeader xml:id="$$$$$ TR number with .hdr appended
$$$$$">
<fileDesc>
<titleStmt>
<title type="main">$$$$$</title>
<title
type="sub">&subtitle;</title>
<author><name key="$$$$$"
type="person-female">$$$$$</name></author>
<sponsor>Brown University</sponsor>
</titleStmt>
<editionStmt>
<edition>%%%%% unreleased work-in-progress
%%%%%</edition>
</editionStmt>
<publicationStmt>
<publisher>Brown University Women Writers
Project</publisher>
<address>
<addrLine>Box 1841</addrLine>
<addrLine>Brown University</addrLine>
<addrLine>Providence, RI
02912-1841</addrLine>
<addrLine>USA</addrLine>
<addrLine>url:mailto:wwp@brown.edu</addrLine>
<addrLine>url:http://www.wwp.brown.edu</addrLine>
<addrLine>401-863-3619</addrLine>
</address>
<idno type="WWP">$$$$$ TR number goes
here $$$$$</idno>
<idno
type="URL">http://www.wwp.brown.edu/texts/[$$$$$
author.title goes here $$$$$.html</idno>
<availability>&legalese;</availability>
<date value="%%%%%"></date>
</publicationStmt>
<notesStmt>
<note type="WWP">
<p>$$$$$ unless you really have special notes
to put here,
(in which case put them in NOTEs here),
delete this entire
NOTESTMT. It’s here mostly just to show
you where it would
go if you needed it. (I.e., if you ever need
to know, edit
this template.) $$$$$</p>
</note>
</notesStmt>
<!--
********************************************************** -->
<!--
-->
<!-- Insert one of the three template SOURCEDESC elements
here. -->
<!-- First put the cursor at the beginning of the comment
line -->
<!-- and issue C-x i. Then at the prompt enter one of the
-->
<!-- following:
-->
<!-- template-sourceDesc-simple.sgm
-->
<!-- template-sourceDesc-excerpt.sgm
-->
<!-- template-sourceDesc-part.sgm
-->
<!-- Then go back and fill in the various SOURCEDESC
elements -->
<!-- and remove comments.
-->
<!--
-->
<!-- Choose your SOURCEDESC template as follows:
-->
<!--
-->
<!-- * Use the “simple” SOURCEDESC for texts
published as -->
<!-- independent units. (This is the most usual case.)
-->
<!--
-->
<!-- * Use the “excerpt” SOURCEDESC for excerpts
from -->
<!-- independently published texts, as long as the
excerpt -->
<!-- does not have its own title.
-->
<!--
-->
<!-- * Use the “part” SOURCEDESC for separately
titled parts -->
<!-- of independently published works.
-->
<!--
-->
<!--
********************************************************** -->
<?xml version='1.0' encoding='UTF-8'
standalone='no' ?>
<!-- $Header:
/opt/local/projects/wwp/tb/under_construction/RCS/template-sourceDesc-simple.xml,v
1.11 2003-06-11 08:06:04-04 sbauman Exp $ -->
<!-- **************************************************** -->
<!-- encoders: remove *all* comments after inserting this -->
<!-- template SOURCEDESC into your document (of course, -->
<!-- you should do what the comments say, first :-) -->
<!-- DOCTYPE sourceDesc PUBLIC “-//TEI P3//DTD
Auxiliary -->
<!-- Document Type: Independent TEI Header 1994-05//EN”
-->
<!-- **************************************************** -->
<sourceDesc n="$$$$$ OT number goes here $$$$$">
<biblStruct>
<monogr>
<author><name reg="$$$$$"
type="person-female" key="$$$$$">$$$$$ name
from title page $$$$$</name></author>
<title>$$$$$</title>
<edition></edition>
<imprint>
<pubPlace>$$$$$</pubPlace>
<publisher><name reg="$$$$$"
type="person-male"
key="$$$$$">$$$$$</name></publisher>
<date value="$$$$$"></date>
</imprint>
<extent type="pagination"
unit="pages" value="$$$$$">$$$$$
pp.</extent>
<extent
type="format">broadsheet||folio||quarto||octavo||duodecimo</extent>
</monogr>
<!-- ********************************************* -->
<!-- Library code goes on type= attribute of IDNO; -->
<!-- call number goes inside IDNO -->
<!-- ********************************************* -->
<idno type="$$$$$">$$$$$ library call
number for the text</idno>
<idno type="Wing||STC">$$$$$ Wing or STC #
here; if none, delete element</idno>
</biblStruct>
</sourceDesc>
</fileDesc>
<encodingDesc>
<projectDesc>&projDesc;</projectDesc>
<samplingDecl>&sampling;</samplingDecl>
<editorialDecl>&editorial;</editorialDecl>
<tagsDecl>
<!--
************************************************** -->
<!-- these are just examples; change to suit your
needs -->
<!-- or delete, but do not leave them here!
-->
<!--
************************************************** -->
<rendition
xml:id="r.it">slant(italic)</rendition>
<rendition
xml:id="r.break">break(yes)</rendition>
<rendition
xml:id="r.nobreak">break(no)</rendition>
<rendition
xml:id="r.head">break(yes)align(center)case(allcaps)</rendition>
<tagUsage gi="head"
render="r.head"></tagUsage>
<tagUsage gi="$$$$$"
render="r.$$$$$"></tagUsage>
<tagUsage gi="$$$$$"
render="r.$$$$$"></tagUsage>
</tagsDecl>
</encodingDesc>
<profileDesc>
<langUsage>
<!--
************************************************ -->
<!-- be sure to choose “British” or
“American”, below -->
<!--
************************************************ -->
<language xml:id="eng">American||British
English circa <date
value="yyyy"></date></language>
<!-- ****************************************************** -->
<!-- add a new LANGUAGE element (get xml:id= value from the -->
<!-- Compilation of ISO639 Language xml:id= "list" on training -->
<!-- web page) for each different language in your text -->
<!-- ****************************************************** -->
</langUsage>
</profileDesc>
<revisionDesc>
<change>
<date value="yyyy-mm-dd">$$$$$ dd Mon
yy $$$$$</date>
<respStmt>
<name key="$$$$$">$$$$$</name>
<resp
type="encoder">Encoder</resp>
</respStmt>
<!--
********************************************** -->
<!-- you can get DTD version from training web
page -->
<!--
********************************************** -->
<item>Began capture using emacs with psgml on
Unix with
version $$$$$ of wwp-store DTD.</item>
</change>
</revisionDesc>
</teiHeader>
<text xml:id="$$$$$ TR number $$$$$">
<hyperDiv>
<!-- $$$$$ Notes, etc., go here $$$$$ -->
</hyperDiv>
<front></front>
<body></body>
<back></back>
</text>
</TEI.2>