Recommended Practices

Introduction
''This is an interesting document, but who are its authors, and for whom are its recommendations made? And is there an ODD associated with it?'' --LouBurnard 09:36, 3 March 2011 (EST)


 * As in the page history, it was written by Reedkm, who I happen to know to be Kenneth Reed, formerly the convenor of the SIG on Scholarly Publishing. He meant it as the basis for a Customization to be developed by the SIG, as mentioned in a message to the SIG's email list.  I'm unsure of whether an ODD exists in any form. (Kshawkin 17:51, 11 September 2012 (EDT))

This document describes the specifications for the encoding of textual matter in accordance with the Text Encoding Initiative’s Guidelines for Text Encoding and Interchange (P5)

We will be using the following modules as part of our schema:


 * core
 * header
 * textstructure
 * figures
 * linking
 * analysis
 * tagdocs
 * namesdates
 * textcrit
 * verse
 * transcr

This is a working document and as such assumes that further explication will be added as the need arises. Not every element nor attribute has been covered in this document, and the TEI online documentation should be able to assist in clarification. When in doubt, the authors of this document will provide updates to ensure best practices.

Unicode Characters
XML documents following these recommended practices should be stored in UTF-8 format. All non-ASCII characters should either be stored using the appropriate Unicode character or a hexadecimal entity reference to the character. Entity references are especially useful in cases of ambiguity, where a character is easily confused with another when viewed in the font in use in the XML editor.

Do not use decimal entity references or mnemonic entity references. The only allowed mnemonic entity references are the five reserved XML entities:

quot (double quotation mark)

amp (ampersand)

apos (apostrophe)

lt (less-than sign)

gt (greater-than sign)

= TEI Structure = The structure of a XML document based on the TEI schema is as follows:

  [ TEI Header information ]  [ front matter ... ] [ body of text ... ] [ back matter ... ] 

&lt;TEI&gt;: Root element
The root element is &lt;TEI&gt; with the namespace declaration and the xml:id of the particular book. The xml:id is format has the uncp prefix, then the book ISBN, and then the book suffix to show that it is the complete title. Please refer to section 4.2 for further discussion on xml:id.



= &lt;teiHeader&gt; = The header element has four distinct parts:

   

&lt;fileDesc&gt;</tt>
The &lt;fileDesc&gt;</tt> element is mandatory. It contains a full bibliographic description of the ﬁle with the following elements, as well as the book abstract and keywords.

&lt;titleStmt&gt;</tt> groups information about the title of a work and those responsible for its intellectual content. This is further broken down into the following elements:

&lt;title&gt;</tt> with attributes for main and subtitle

&lt;author&gt;</tt> includes the following elements:

<name xml:id="surnamePlusInitialForename">

&lt;reg&gt;</tt> regularized author name: surname, forename type="given", forename type="middle".

&lt;editionStmt&gt;</tt> groups information relating to one edition of a text. This can include the following elements:

<respStmt>

&lt;extent&gt;</tt> describes the approximate size of the electronic text as stored on some carrier medium, speciﬁed in any convenient units.

&lt;publicationStmt&gt;</tt> groups information concerning the publication or distribution of an electronic or other text.

<pubPlace>

&lt;seriesStmt&gt;</tt> groups information about the series, if any, to which a publication belongs.

&lt;notesStmt&gt;</tt> collects together the book abstract and keywords.

&lt;sourceDesc&gt;</tt> supplies a bibliographic description of the copy text(s) from which an electronic text was derived or generated.

&lt;fileDesc&gt;</tt> Example
<fileDesc> <titleStmt> A Stone of Hope Prophetic Religion and The Death of Jim Crow <author xml:id="chappelld"> David L. Chappell Chappell, David L. <respStmt> Text encoder: cM </respStmt> </titleStmt> 1.4 MB <publicationStmt> The University of North Carolina Press <pubPlace>Chapel Hill, NC</pubPlace> 2004 <idno type="ISBN">9780807828199 <idno type="DOI">10.5149/uncp/9780807828199 <availability xml:id="notCleared" status="restricted"> This image has not been cleared for online publication. </publicationStmt>

Reference Articles
Articles in reference works should be encoded using &lt;div&gt;</tt> and &lt;head&gt;</tt> elements for structure. All other elements should be encoded similarly to monographs: paragraphs using &lt;p&gt;</tt>, attributions using &lt;byline&gt;</tt>, bibliographic references using <tt>&lt;bibl&gt;</tt>, etc.

For reference articles where the entry terms run in to the descriptive paragraph, either with or without punctuation, the term or phrase should be repeated in a <tt>&lt;head&gt;</tt> element, as in the second example below.

Reference <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> Examples
<head type="entryName.A">Southern Zigzag Salamander <head type="entryName.B">Plethodon ventralis 64 to 111 mm (2.5 to 4.5 in.) This small salamander has a reddish orange to reddish brown stripe down the brown back and tail with wavy or zigzag edges at least on its anterior half. The belly is heavily mottled with black, white, and reddish orange. Many individuals in our area have no stripe, and both color phases have a variable amount of red pigment on the back, sides, and belly. Red-backed Salamanders have a straight-edged reddish dorsal stripe and a salt-and-pepper belly (if ventral reddish orange pigment is present, it is confined to the area between the front limbs).

<head type="entryName.A">Museum of the Cape Fear Museum of the Cape Fear</hi> in Fayettville is the third regional... References:  Angela Fracaro, "A Fast Start at Looking Back,"  The State <biblScope type="vol">57</biblScope> ( June 1989 ) ;  Karen Rosalinde Zimmer , "An Audience Development Plan for the Museum of the Cape Fear in Fayetteville" (M.A. thesis, <pubPlace>UNC-Chapel Hill</pubPlace>, 1989 ). Angelyn H. Patteson

= <tt>&lt;back&gt;</tt> = The <tt>&lt;back&gt;</tt> element includes all the backmatter material present in the book, including appendices, bibliography, and index. The sections are made up of <tt>&lt;div&gt;</tt> elements with the type indicating the section name: e.g., bibliography, index, etc.

Backmatter <tt>&lt;div&gt;</tt> Sections
Sections other than the bibliography and index will be encoded in the same manner as the frontmatter sections, using <tt>&lt;div&gt;</tt>.

<tt>&lt;div&gt;</tt> Example: Acknowledgments
<pb xml:id="pg287" n="287"/> <head type="chapterTitle">Acknowledgments This book has been an unusually. ..

<tt>&lt;div&gt;</tt> Endnotes
Endnotes and footnotes should be captured in a backmatter <tt>&lt;div&gt;</tt>

<tt>&lt;div&gt;</tt> Example: Endnotes
<pb xml:id="pg255" n="255"/> <head type="chapterTitle">Notes CHAPTER ONE <note xml:id="note1.2-1" n="1" type="endnote"> 1 Brown v. Board of Education,</hi> 347 U.S. 483 (1954). <note xml:id="note1.2-2" n="2" type="endnote"> 2 Laws of North Carolina</hi> (1838–39), chap. 8, sec. 3, p. 13; North Carolina Advisory Committee, Equal Protection of the Laws,</hi> p. 99.

<tt>&lt;div&gt;</tt> Bibliography
Please see the documentation at http://www.tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COBI for complete guidance on encoding bibliographic citations and references. There are three levels for encoding: <tt>&lt;bibl&gt;</tt> as the most basic level, <tt>&lt;biblStruct&gt;</tt> as more structured, and <tt>&lt;biblFull&gt;</tt> as the fully-structured ciation, having all the components of a TEI file description and as seen in the TEI header. <tt>&lt;listBibl&gt;</tt> can be used when encoding a list of citations, as in a bibliography.

Citations using the <tt>&lt;bibl&gt;</tt> element are loosely structured, with the major elements being encoded with elements such as <tt>&lt;author&gt;</tt>, <tt>&lt;editor&gt;</tt>, <tt>&lt;title&gt;</tt>, <tt>&lt;pubPlace&gt;</tt>, <tt>&lt;publisher&gt;</tt>, and <tt>&lt;biblScope&gt;</tt>.

Because of the flexibility of <tt>&lt;bibl&gt;</tt>, the majority of bibliographic references should be encoded using this element. Only use <tt>&lt;biblStruct&gt;</tt> when the citation is too complex to be encoded using <tt>&lt;bibl&gt;</tt>.

Use the attribute level to indicate the bibliographic level for a title: whether it identifies an article, book, journal, series, or unpublished material. The values are in the following table.

<tt>&lt;biblScope&gt;</tt> will be used for chapter, issue, volume, and part numbers, as well as for page ranges. Use the attribute type to indicate which item is encoded. The values are in the following table.

All bibliographic items should have unique IDs.

<tt>&lt;div&gt;</tt> Example: Bibliography
<head type="chapterTitle">Bibliography <listBibl> <bibl xml:id="bibItem1"> Bohannon, Paul, and George Dalton , eds. Markets in Africa. [<pubPlace>Evanston, Ill.</pubPlace>]: Northwestern University Press, 1962. <bibl xml:id="bibItem111"> Lockert B. Mason, ”Babies Hospital, 1920–1978” , North Carolina Medical Journal <biblScope type="issue">45</biblScope> January 1984 ): <biblScope type="pp">65&#x2013;81</biblScope>. </listBibl>

<tt>&lt;div&gt;</tt> Index
The index will consist of a primary <tt>&lt;list&gt;</tt> element, with each entry encoded using the <tt>&lt;item&gt;</tt> element. All index entries will have unique IDs, to facilitate linking, especially when one entry refers to another.

Sub-entries will be in an additional <tt>&lt;list&gt;</tt> element within the initial <tt>&lt;item&gt;</tt>, as will further levels.

Page references will be tagged with <tt>&lt;ref&gt;</tt>, as will “see also” references to other index entries.

<tt>&lt;div&gt;</tt> Example: Index
<pb xml:id="pg292" n="292"/> <head type="chapterTitle">Index <item xml:id="indexItem1">Abolition,, <reftarget="#pg47" type="pageref">47 , ; <item xml:id="indexItem2">and Northern whites,, , ; <item xml:id="indexItem3">in Ohio,, (n. 23). See also</hi> <item xml:id="indexItem735">Underground Railroad,, ,. See also</hi> Abolition