<?tei:SOF p2hd6.odd ?>
<!-- $Id: p2hd6.odd,v 1.5 1994/03/24 22:14:56 msmcq Exp $ -->
<!-- $Log: p2hd6.odd,v $
# Revision 1.5  1994/03/24  22:14:56  msmcq
# typo corrections from David Barnard, Peter Robinson, and others
#
# Revision 1.4  1994/01/04  13:02:04  lou
# change resp to respstmt
#
# Revision 1.3  1993/08/18  21:31:24  msmcq
# name shift (role/resp, resp/respStmt) on account of DR role
#
# Revision 1.2  1993/06/22  14:29:49  msmcq
# Changes post Eynsham and for DTD generation
# -->
<!-- Revisions:                                               -->
<!-- 94-03-22 : CMSMcQ : typos, TEI - &tei, code, ident tags  -->
<!-- 93-08-18 : MSM : new names for respStmt, role/resp       -->
<!-- 93-06-01 : MSM : change change log post Eynsham          -->
<!-- 93-02-10 : MSM : update xref targets                     -->
<!-- 92-08-17 : MSM : change BY to NAME                       -->
<!-- 25 Jul 92 : MSM : names updated, ids updated             -->
<div2 id='HD6'><head>The Revision Description</head>

<p>The final subelement of the &tei; header, the <gi>revisionDesc</gi>
element, provides a detailed change log in which each change made to a
text may be recorded.  Its use is optional but highly recommended.
It provides essential information for the administration of large
numbers of files which are being updated, corrected, or otherwise
modified as well as extremely useful documentation for files being
passed from researcher to researcher or system to system. Without
change logs, it is easy to confuse different versions of a file, or to
remain unaware of small but important changes made in the file by some
earlier link in the chain of distribution.  No change should be made in
any &tei;-conformant file without corresponding entries being made in the
change log.

<tagList>
<tagDesc tagDoc=REVDESC>
<tagDesc tagDoc=CHANGE>
</tagList>

<p>The log consists of a list of entries, one for each change.  This
may be encoded using either the regular <gi>list</gi> element,
as described in section <xref target='COLI'> or as a series of
<!-- was:  target='P2.233'> -->
<!-- or :  target='COLIST'> -->
special purpose <gi>change</gi> elements, each of which has
the following constituents:
<tagList>
<tagDesc tagDoc="DATE">
<tagDesc tagDoc="RESP">
<tagDesc tagDoc="ITEM">
</tagList>
The <gi>date</gi> element indicates the date of the change.
The <gi>respStmt</gi> element indicates who made the change, and in what
role.
The <gi>item</gi> element indicates what change was made; it can
range from a simple phrase to a series of paragraphs.
If a number is to be associated with one or more changes (for
example, a revision number), use the global <att>n</att>
attribute on the <gi>change</gi> element to supply it.

<p>It is recommended to give changes in reverse chronological order,
most recent first.

<!-- if i had time i'd replace by, what, date with            -->
<!-- name, date, item.  perhaps in p3.  -msm                  -->
<!-- i agree that BY could usefully be replaced by NAME. Less clear -->
<!-- about ITEM, since this is already implied by use of LIST -lb -->
<p>For example:
<!-- is this example perhaps not a bit over long? -->
<!-- possibly, i just took a real one from a file -->
<eg>
<![ CDATA [
<revisionDesc>
<change><date>6/3/91:</date>
        <respStmt><name>EMB</name><resp>ed.</></respStmt>
        <item> < > changes completed.</item>
<change><date>5/25/91:</date>
        <respStmt><name>EMB</name><resp>ed.</></respStmt>
        <item>File format updated.</item>
<change><date>9/3/90:</date>
        <respStmt><name>EMB</name><resp>ed.</></respStmt>
        <item>Changes to make a prettier printed version.</item>
<change><date>5/25/90:</date>
        <respStmt><name>EMB</name><resp>ed.</></respStmt>
        <item>Stuart's corrections entered</item>
<change><date>2/90: </date>
        <respStmt><name>N.N.</name><resp>admin.</></respStmt>
        <item>Sent to Stuart Curran for proofreading.</item>
<change><date>1/22/90:</date>
        <respStmt><name>N.N.</name><resp>data entry</></respStmt>
        <item>Corrections made to file;</item>
<change><date>10/89:</date>
        <respStmt><name>John G. Fitzgerald, Julia M. Deisler
            and Deborah Hirsch.</name><resp>staff</></respStmt>
        <item>Proofread.</item>
<change><date>8/89:</date>
        <respStmt><name>Amy E. Frisch</><resp>data entry</></respStmt>
        <item>Input begun</item>
</revisionDesc>
]]>
</eg>

<p>The formal definition of the <gi>revisionDesc</gi> element is thus as
follows:

<dtdFrag id=D226 file=teihdr2 n='The Revision Description'>
<tagDecl tagDoc=REVDESC>
<tagDecl tagDoc=CHANGE>
<commDecl>respStmt, item, and date are declared in teicore2.</commDecl>

</dtdFrag>
<!>
<?tei:EOF p2hd6.odd ?>
