Use of electronic facsimile data elements in TEI markup

• Last Updated: 2007-10-08
• Editor: Peter C. Gorman
• Version:5.0
• Previous Version: v.4.0
• Current Version: http://uwdcc.library.wisc.edu/resources/efacs/efacsimile.sgml.shtml
• Related Documents:
  • Use of electronic facsimile data elements in TEI markup: image entity definition files
  • Use of electronic facsimile data elements in TEI markup: text entity definition files^9*
  • UW–Madison Digital Library Data Dictionary: Electronic Facsimiles

Names of data elements from UW–Madison Digital Library Data Dictionary: Electronic Facsimiles are enclosed in [square brackets].

SGML File

<!doctype TEI.2 PUBLIC  "-//TEI P4//DTD TEI Lite 1.6//EN" [
<!entity % [Collection-ID]entities  system "[Collection-ID].[Issue-ID].ent">
<!entity % [Collection-ID]textentities  system "[Collection-ID].[Issue-ID]text.ent">
%[Collection-ID]entities;
%[Collection-ID]textentities;
]>

<tei.2 id="[Issue-ID]">
<teiHeader>
<fileDesc>
    <titleStmt>
        <title type="245" level="[Issue-Title-Level]" rend="nfc:[Issue-Title-NFC]">[Issue-Title]: electronic facsimile</title>
        <author>[Issue-Author]1*</author>
        <author>[Issue-Author]1*</author>
        <editor>[Issue-Editor]1*</editor>
        <respStmt>
            <resp>Submitter</resp>
            <name>[Issue-Submitter]</name>
        </respStmt>
    </titleStmt>
    <publicationStmt>
        <publisher>University of Wisconsin-Madison Libraries</publisher>
        <pubPlace>Madison, Wisconsin</pubPlace>
        <idno type="Issue-Printed">[Issue-Printed-No]</idno>
        <idno type="Issue-ID">[Collection-ID].[Issue-ID]</idno>
        <availability><p>[Issue-Availability]2*</p></availability>
        <date>2000-11-06</date><!-- use build date? -->
    </publicationStmt>
    <seriesStmt><!-- this statement applies to our electronic project, not the source publication -->
        <title type="Collection" id="[Collection-ID]" rend="nfc:[Collection-Title-NFC]">[Collection-Title]</title>
        <title type="Subcollection" id="[Collection-ID].[Subcoll-ID]" rend="nfc:[Subcoll-Title-NFC]">[Subcoll-Title]</title>1*
        <title type="Subcollection" id="[Collection-ID].[Subcoll-ID]" rend="nfc:[Subcoll-Title-NFC]">[Subcoll-Title]</title>1*
    </seriesStmt>
    <notesStmt>
        <note type="Abstract">
            <p>[Issue-Abstract]</p>
        </note>
        <note type="Contents">
        <listBibl>
            <bibl>8*
                <author>[Item-Author]1*</author>
                <title level="a" rend="nfc:[Item-Title-NFC]">[Item-Title]</title>
                <idno type="[Item-Std-No3*]">[Item-Std-No3*]</idno>
                <idno type="Item-ID">[Collection-ID].[Issue-ID].[Item-ID]</idno>
                <note type="Abstract">
                    <p>[Item-Abstract]</p>
                </note>
                <ptr type="content" targType="div1" target="[Collection-ID].[Issue-ID].[Item-ID]">
            </bibl>
            <bibl>
                <author>[Item-Author]1*</author>
                <title level="a" rend="nfc:[Item-Title-NFC]">[Item-Title]</title>
                <idno type="[Item-Std-No3*]">[Item-Std-No3*]</idno>
                <idno type="Item-ID">[Collection-ID].[Issue-ID].[Item-ID]</idno>
                <note type="Abstract">
                    <p>[Item-Abstract]</p>
                </note>
                <ptr type="content" targType="div1" target="[Collection-ID].[Issue-ID].[Item-ID]">
            </bibl>
        </listBibl>
        </note>
    </notesStmt>
    <sourceDesc>
        <biblFull>
            <titleStmt>
                <title type="245" level="[Issue-Title-Level]" rend="nfc:[Issue-Title-NFC]">[Issue-Title]</title>
                <author>[Issue-Author]1*</author>
                <editor>[Issue-Editor]1*</editor>
            </titleStmt>
            <extent>[Issue-Extent]</extent>
            <publicationStmt>
                <publisher>[Issue-Publisher]</publisher>
                <pubPlace>[Issue-PubPlace]</pubPlace>
                <idno type="Issue-Printed">[Issue-Printed-No]</idno>
                <idno type="[Issue-Std-No3*]">[Issue-Std-No3*]</idno>
                <date>[Issue-Chron]</date>
            </publicationStmt>
            <seriesStmt>
                <title type="440"4* level="[Aggregate-Title-Level]" id="[Collection-ID].[Aggregate-ID]" rend="nfc:[Aggregate-Title-NFC]">[Aggregate-Title]</title>
                <respStmt>1*
                    <resp>Author</resp>
                    <name>[Aggregate-Author]</name>
                </respStmt>
                <respStmt>
                    <resp>Editor</resp>
                    <name>[Aggregate-Editor]</name>
                </respStmt>
            </seriesStmt>
        </biblFull>
    </sourceDesc>
</fileDesc>
<encodingDesc>
    <editorialDecl>
        <p id="EFacs.5.0">Encoded according to Digital Library Data Dictionary: Electronic Facsimile Collections, version 5.0.</p>
    </editorialDecl>
</encodingDesc>
<revisionDesc>
    <change>
        <date value="[Issue-Last-Update]">[Issue-Last-Update]</date>
        <respStmt>
            <resp>Automatic build</resp>
            <name>sgml_genr, v.5</name>
        </respStmt>
        <item>[Issue-Last-Update-Reason]</item>
    </change>
</revisionDesc>
</teiHeader>
<text>
<body>
    <div1
        next="[Collection-ID].[Issue-ID].[Item-ID]"
        id="[Collection-ID].[Issue-ID].[Item-ID]"
        type="[Item-Type]">
    <note type="Abstract">
        <p>[Item-Abstract]</p>
    </note>
    <p>
        <pb n="[Page-Printed-No5*]">
        <figure
            next="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"6*
            entity="[Collection-ID].[Issue-ID].[Page-ID]"
            id="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            n="[Page-Printed-No]"
            rend="page">
            <p>[Page-Text]9*</p>
            <figDesc>[Page-Description]7*</figDesc>
        </figure>
        <pb n="[Page-Printed-No5*]">
        <figure
            next="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"6*
            prev="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            entity="[Collection-ID].[Issue-ID].[Page-ID]"
            id="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            n="[Page-Printed-No]"
            rend="page">
            <p>[Page-Text]9*</p>
            <figDesc>[Page-Description]7*</figDesc>
        </figure>
    </p>
    </div1>
    <div1
        next="[Collection-ID].[Issue-ID].[Item-ID]"
        prev="[Collection-ID].[Issue-ID].[Item-ID]"
        id="[Collection-ID].[Issue-ID].[Item-ID]"
        type="[Item-Type]">
    <head>[Item-Title]</head>
    <byline>[Item-Author]1*</byline>
    <note type="Abstract">
        <p>[Item-Abstract]</p>
    </note>
    <p>
        <pb n="[Page-Printed-No5*]">
        <figure
            next="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"6*
            prev="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            entity="[Collection-ID].[Issue-ID].[Page-ID]"
            id="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            n="[Page-Printed-No]"
            rend="page">
            <p>[Page-Text]9*</p>
            <figDesc>[Page-Description]7*</figDesc>
        </figure>
        <pb n="[Page-Printed-No5*]">
        <figure
            next="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"6*
            prev="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            entity="[Collection-ID].[Issue-ID].[Page-ID]"
            id="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            n="[Page-Printed-No]"
            rend="page">
            <p>[Page-Text]9*</p>
            <figDesc>[Page-Description]7*</figDesc>
        </figure>
    </p>
    </div1>
    <div1
        prev="[Collection-ID].[Issue-ID].[Item-ID]"
        id="[Collection-ID].[Issue-ID].[Item-ID]"
        type="[Item-Type]">
    <head>[Item-Title]</head>
    <byline>[Item-Author]1*</byline>
    <note type="Abstract">
        <p>[Item-Abstract]</p>
    </note>
    <p>
        <pb n="[Page-Printed-No5*]">
        <figure
            prev="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            entity="[Collection-ID].[Issue-ID].[Page-ID]"
            id="[Collection-ID].[Issue-ID].[Item-ID].[Page-ID]"
            n="[Page-Printed-No]"
            rend="page">
            <p>[Page-Text]9*</p>
            <figDesc>[Page-Description]7*</figDesc>
        </figure>
    </p>
    </div1>
</body>
</text>
</tei.2>

Notes

^1* If multiple values are specified in the source field, they will be delimited by a pipe character and space ("| "). In this event, multiple TEI elements should be created, one for each value.

^2* If no value is supplied for Issue-Availability, use the value of Collection-Availability instead. If there are multiple values, put each in a separate <p> within a single <availability> element.

^3* The data elements Issue-Std-No and Item-Std-No consist of two subelements, type and value, that will be concatenated into a semicolon-delimited string. This will have to be parsed at build time, and the subelements should be used as shown here.

^4* Values for the type attribute should correspond to those of Aggregate-Title-Level:

Aggregate-Title-Level	Type attribute
s	440
m, u	245
j	772

^5* When a figure entity is reused, e.g. because of a mid-page Item (<div1>) break, a page break element should not be generated along with the repeated figure.

^6* Next and previous Page IDs should be determined by the closest next and previous IDs for <figure> elements which have a distinct entity atttribute.

^7* If no value is supplied for Page-Description, use the default value Page image.

^8* A <bibl> should be created only for those Items whose Item-Type is "Article" or "Work".

^9* External entities will no longer be created for OCR text. If no text is present in the data element Page-Text, text should be inserted into the TEI file from the OCR file found at:

[Root Path][Page-Location][Page-Filename].txt, where

• [Root Path] is a constant known to the processing software
• [Page-Location] is always entered with a trailing slash in the source metadata.

Note that the original OCR files will need to be retained in case the TEI needs to be rebuilt.