Difference between revisions of "Recommended Practices"

From TEIWiki
Jump to navigation Jump to search
(Introduction)
m
 
(9 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 +
[[Category:SIG:Scholarly Publishing]]
 
==Introduction==
 
==Introduction==
These recommended practices are for publishers intending to use TEI P5 as their encoding schema. They are intended to highlight features necessary for publishing both journal articles and books.
 
  
==General Recommendations==
+
''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?'' --[[User:LouBurnard|LouBurnard]] 09:36, 3 March 2011 (EST)
  
==Introduction==
+
: As in the page history, it was written by [[User:Reedkm|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. ([[User:Kshawkin|Kshawkin]] 17:51, 11 September 2012 (EDT))
  
 
This document describes the specifications for the encoding of textual matter in accordance with the [http://www.tei-c.org/ Text Encoding Initiative]’s [http://www.tei-c.org/Guidelines/P5/ Guidelines for Text Encoding and Interchange (P5)]
 
This document describes the specifications for the encoding of textual matter in accordance with the [http://www.tei-c.org/ Text Encoding Initiative]’s [http://www.tei-c.org/Guidelines/P5/ Guidelines for Text Encoding and Interchange (P5)]
Line 24: Line 24:
 
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.
 
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.
  
== 1.1 Unicode Characters ==
+
== Unicode Characters ==
Unicode characters should be used throughout the document for all non-ASCII character references. For instance, all diacritics, quotation marks, and em dashes should be Unicode characters. '''Note:''' This does not preclude the use of hex values. Please do use hex values if there is any confusion about the character.
+
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)
  
The only exceptions are the five reserved XML entities:
+
amp (ampersand)
  
quot double quotation mark
+
apos (apostrophe)
amp ampersand
 
apos apostrophe
 
lt less-than sign
 
gt greater-than sign
 
  
= 2. TEI Structure =
+
lt (less-than sign)
 +
 
 +
gt (greater-than sign)
 +
 
 +
= TEI Structure =
 
The structure of a XML document based on the TEI schema is as follows:
 
The structure of a XML document based on the TEI schema is as follows:
  
Line 57: Line 61:
 
</pre>  
 
</pre>  
  
== 2.1 <tt>&lt;TEI&gt;</tt>: Root element ==
+
== <tt>&lt;TEI&gt;</tt>: Root element ==
 
The root element is <tt>&lt;TEI&gt;</tt> 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.
 
The root element is <tt>&lt;TEI&gt;</tt> 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.
  
Line 64: Line 68:
 
</pre>
 
</pre>
  
= 3. <tt>&lt;teiHeader&gt;</tt>  =
+
= <tt>&lt;teiHeader&gt;</tt>  =
 
The header element has four distinct parts:
 
The header element has four distinct parts:
  
Line 73: Line 77:
 
<revisionDesc> </pre>
 
<revisionDesc> </pre>
  
== 3.1 <tt>&lt;fileDesc&gt;</tt> ==
+
== <tt>&lt;fileDesc&gt;</tt> ==
 
The <tt>&lt;fileDesc&gt;</tt> element is mandatory. It contains a full bibliographic description of the file with the following elements, as well as the book abstract and keywords.  
 
The <tt>&lt;fileDesc&gt;</tt> element is mandatory. It contains a full bibliographic description of the file with the following elements, as well as the book abstract and keywords.  
  
Line 118: Line 122:
  
  
=== 3.1.1 <tt>&lt;fileDesc&gt;</tt> Example ===
+
=== <tt>&lt;fileDesc&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<fileDesc>
 
<fileDesc>
Line 173: Line 177:
  
  
== 3.2 <tt>&lt;encodingDesc&gt;</tt> ==
+
== <tt>&lt;encodingDesc&gt;</tt> ==
 
Documents the relationship between an electronic text and the source(s) from which it was derived.  
 
Documents the relationship between an electronic text and the source(s) from which it was derived.  
  
=== 3.2.1 <tt>&lt;encodingDesc&gt;</tt> Example ===
+
=== <tt>&lt;encodingDesc&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<encodingDesc>
 
<encodingDesc>
Line 199: Line 203:
  
  
== 3.3 <tt>&lt;profileDesc&gt;</tt> ==
+
== <tt>&lt;profileDesc&gt;</tt> ==
 
Provides a detailed description of non-bibliographic aspects of the text, specifically the languages and sublanguages used, the situation in which it was produced, the participants and their setting. Keywords will be listed in this section as well.
 
Provides a detailed description of non-bibliographic aspects of the text, specifically the languages and sublanguages used, the situation in which it was produced, the participants and their setting. Keywords will be listed in this section as well.
  
=== 3.3.1 <tt>&lt;profileDesc&gt;</tt> Example ===
+
=== <tt>&lt;profileDesc&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<profileDesc>
 
<profileDesc>
Line 242: Line 246:
  
  
== 3.4 <tt>&lt;revisionDesc&gt;</tt> ==
+
== <tt>&lt;revisionDesc&gt;</tt> ==
 
Summarizes the revision history for a document.
 
Summarizes the revision history for a document.
  
=== 3.4.1 <tt>&lt;revisionDesc&gt;</tt> Example ===
+
=== <tt>&lt;revisionDesc&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<revisionDesc>
 
<revisionDesc>
Line 260: Line 264:
 
</pre>
 
</pre>
  
= 4. <tt>&lt;text&gt;</tt> =
+
= <tt>&lt;text&gt;</tt> =
 
The <tt>&lt;teiHeader&gt;</tt> is followed directly by the mandatory <tt>&lt;text&gt;</tt> element, which contains the textual matter being encoded. The <tt>&lt;text&gt;</tt> element is broken down into three subelements: <tt>&lt;front&gt;</tt> for frontmatter, <tt>&lt;body&gt;</tt> for the main body of the work, and <tt>&lt;back&gt;</tt> for backmatter. Only the <tt>&lt;body&gt;</tt> element is required. Additionally, groups of discrete texts can be packaged together in one document using the <tt>&lt;group&gt;</tt> element as a parent for the separate <tt>&lt;text&gt;</tt> elements.
 
The <tt>&lt;teiHeader&gt;</tt> is followed directly by the mandatory <tt>&lt;text&gt;</tt> element, which contains the textual matter being encoded. The <tt>&lt;text&gt;</tt> element is broken down into three subelements: <tt>&lt;front&gt;</tt> for frontmatter, <tt>&lt;body&gt;</tt> for the main body of the work, and <tt>&lt;back&gt;</tt> for backmatter. Only the <tt>&lt;body&gt;</tt> element is required. Additionally, groups of discrete texts can be packaged together in one document using the <tt>&lt;group&gt;</tt> element as a parent for the separate <tt>&lt;text&gt;</tt> elements.
  
  
== 4.1 <tt>&lt;div&gt;</tt> ==
+
== <tt>&lt;div&gt;</tt> ==
 
The <tt>&lt;front&gt;</tt>, <tt>&lt;body&gt;</tt>, and <tt>&lt;back&gt;</tt> elements all use the nested <tt>&lt;div&gt;</tt> structure to organize primary sections as well as child sections. The <tt>&lt;div&gt;</tt> elements are identified by a unique xml:id, and also have an n attribute to aid in reference.  
 
The <tt>&lt;front&gt;</tt>, <tt>&lt;body&gt;</tt>, and <tt>&lt;back&gt;</tt> elements all use the nested <tt>&lt;div&gt;</tt> structure to organize primary sections as well as child sections. The <tt>&lt;div&gt;</tt> elements are identified by a unique xml:id, and also have an n attribute to aid in reference.  
  
Line 437: Line 441:
  
  
== 4.2 xml:id Attribute ==
+
== xml:id Attribute ==
 
In addition to the the root element, the xml:id shall be used on all <tt>&lt;div&gt;</tt> elements, including <tt>&lt;titlePage&gt;</tt>, all <tt>&lt;pb&gt;</tt> elements, all <tt>&lt;figure&gt;</tt> elements, all <tt>&lt;table&gt;</tt> elements, and all <tt>&lt;note&gt;</tt> elements. The form is different than the root element, and should reflect the element type or name. Examples follow:
 
In addition to the the root element, the xml:id shall be used on all <tt>&lt;div&gt;</tt> elements, including <tt>&lt;titlePage&gt;</tt>, all <tt>&lt;pb&gt;</tt> elements, all <tt>&lt;figure&gt;</tt> elements, all <tt>&lt;table&gt;</tt> elements, and all <tt>&lt;note&gt;</tt> elements. The form is different than the root element, and should reflect the element type or name. Examples follow:
  
Line 566: Line 570:
 
|}
 
|}
  
== 4.2 n Attribute ==
+
== n Attribute ==
 
In addition to the xml:id attribute, the n attribute should be used to add further information on specific elements. The elements requiring the n attribute generally are those that have the xml:id attribute and have more than one of its kind. These include <tt>&lt;pb&gt;</tt>, chapter <tt>&lt;div&gt;</tt>, <tt>&lt;table&gt;</tt>, <tt>&lt;figure&gt;</tt>, <tt>&lt;note&gt;</tt>. Other <tt>&lt;div&gt;</tt> sections that have multiple instances, such as appendices, should be encoded as well. See the xml:id example for clarification.
 
In addition to the xml:id attribute, the n attribute should be used to add further information on specific elements. The elements requiring the n attribute generally are those that have the xml:id attribute and have more than one of its kind. These include <tt>&lt;pb&gt;</tt>, chapter <tt>&lt;div&gt;</tt>, <tt>&lt;table&gt;</tt>, <tt>&lt;figure&gt;</tt>, <tt>&lt;note&gt;</tt>. Other <tt>&lt;div&gt;</tt> sections that have multiple instances, such as appendices, should be encoded as well. See the xml:id example for clarification.
  
  
== 4.3 <tt>&lt;pb&gt;</tt> ==
+
== <tt>&lt;pb&gt;</tt> ==
 
It is important to maintain correct pagination so that the encoded version directly matches the print version. The empty <tt>&lt;pb&gt;</tt> element is used to mark the beginning of each physical page of the print document (including the frontmatter, first page, and blank pages). The <tt>&lt;pb&gt;</tt> element should be placed at the beginning of each physical page, and should be inside <tt>&lt;div&gt;</tt> elements. Never place a <tt>&lt;pb&gt;</tt> outside of a <tt>&lt;div&gt;</tt> element. If a page break occurs in the middle of a smaller element (e.g., <tt>&lt;p&gt;</tt>), it can be encoded there. There are two mandatory attributes required: xml:id, which has the same structure as other xml:id attributes, with uncp as the prefix, the ISBN as the root, and the page number, beginning with a ''pg'' as the suffix; n as the number of the page, which is the actual page number.
 
It is important to maintain correct pagination so that the encoded version directly matches the print version. The empty <tt>&lt;pb&gt;</tt> element is used to mark the beginning of each physical page of the print document (including the frontmatter, first page, and blank pages). The <tt>&lt;pb&gt;</tt> element should be placed at the beginning of each physical page, and should be inside <tt>&lt;div&gt;</tt> elements. Never place a <tt>&lt;pb&gt;</tt> outside of a <tt>&lt;div&gt;</tt> element. If a page break occurs in the middle of a smaller element (e.g., <tt>&lt;p&gt;</tt>), it can be encoded there. There are two mandatory attributes required: xml:id, which has the same structure as other xml:id attributes, with uncp as the prefix, the ISBN as the root, and the page number, beginning with a ''pg'' as the suffix; n as the number of the page, which is the actual page number.
  
=== 4.3.1 <tt>&lt;pb&gt;</tt> Examples ===
+
=== <tt>&lt;pb&gt;</tt> Examples ===
 
<pre>
 
<pre>
 
<div type="contents" xml:id="contents">
 
<div type="contents" xml:id="contents">
Line 582: Line 586:
  
  
== 4.4 <tt>&lt;fw&gt;</tt>: Running Heads ==
+
== <tt>&lt;fw&gt;</tt>: Running Heads ==
 
Running heads should be encoded using the forme work <tt>&lt;fw&gt;</tt> element, with verso and recto as the type attribute values. For sections and chapters where there is one verso and one recto running head, the information should be captured once, immediately after the first <tt>&lt;pb&gt;</tt> of the <tt>&lt;div&gt;</tt>. For sections and chapters where the running heads change depending on the context of the page—encyclopedias, end note sections, etc—then the data will be captured immediately following the <tt>&lt;pb&gt;</tt> for each new running head.
 
Running heads should be encoded using the forme work <tt>&lt;fw&gt;</tt> element, with verso and recto as the type attribute values. For sections and chapters where there is one verso and one recto running head, the information should be captured once, immediately after the first <tt>&lt;pb&gt;</tt> of the <tt>&lt;div&gt;</tt>. For sections and chapters where the running heads change depending on the context of the page—encyclopedias, end note sections, etc—then the data will be captured immediately following the <tt>&lt;pb&gt;</tt> for each new running head.
  
  
=== 4.4.1 <tt>&lt;fw&gt;</tt> Example ===
+
=== <tt>&lt;fw&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<pb xml:id="pg15" n="15"/>
 
<pb xml:id="pg15" n="15"/>
Line 594: Line 598:
  
  
== 4.5 <tt>&lt;ref&gt;</tt> ==
+
== <tt>&lt;ref&gt;</tt> ==
 
All references internal to a particular document as well as external references will be encoded using the <tt>&lt;ref&gt;</tt> element. Attributes for this element include id, target, type, and corresp. Id will use a unique identifier coupled with the ISBN of the book. Target will reference the id of the relevant element. Type includes the following values:
 
All references internal to a particular document as well as external references will be encoded using the <tt>&lt;ref&gt;</tt> element. Attributes for this element include id, target, type, and corresp. Id will use a unique identifier coupled with the ISBN of the book. Target will reference the id of the relevant element. Type includes the following values:
  
Line 657: Line 661:
 
All internal references to sections, chapters, or other major division found in the text should be encoded to provide links.
 
All internal references to sections, chapters, or other major division found in the text should be encoded to provide links.
  
=== 4.5.1 pageref Example ===
+
=== pageref Example ===
 
<pre>
 
<pre>
 
<ref target="#pg1" type="pageref">1</ref>
 
<ref target="#pg1" type="pageref">1</ref>
Line 663: Line 667:
  
  
=== 4.5.2 uriref Example ===
+
=== uriref Example ===
 
<pre>
 
<pre>
 
<p>. . . Law 106–380 created the Veterans History Project in 2000. For more information on the project, see [<ref target="http://www.loc.gov/vets/" type="uriref">http://www.loc.gov/vets/</ref>] (August 2, 2006).</p>
 
<p>. . . Law 106–380 created the Veterans History Project in 2000. For more information on the project, see [<ref target="http://www.loc.gov/vets/" type="uriref">http://www.loc.gov/vets/</ref>] (August 2, 2006).</p>
Line 669: Line 673:
  
  
=== 4.5.3 divref Example ===
+
=== divref Example ===
 
<pre>
 
<pre>
 
<p>You can read more about this in <ref type="divref" target="#c2">Chapter 2</ref>.</p>
 
<p>You can read more about this in <ref type="divref" target="#c2">Chapter 2</ref>.</p>
Line 675: Line 679:
  
  
== 4.6 <tt>&lt;figure&gt;</tt> and <tt>&lt;graphic&gt;</tt> ==
+
== <tt>&lt;figure&gt;</tt> and <tt>&lt;graphic&gt;</tt> ==
 
Figures are encoded using a combination of <tt>&lt;figure&gt;</tt> and <tt>&lt;graphic&gt;</tt> elements. Generally speaking, <tt>&lt;graphic&gt;</tt> is used by itself to indicate the location of an inline graphic, illustration, or figure. When textual matter such as a figure number of caption is available, the compound element <tt>&lt;figure&gt;</tt> will be used, together with <tt>&lt;graphic&gt;</tt> which refers to the image file and elements such as <tt>&lt;head&gt;</tt> for figure number and <tt>&lt;p&gt;</tt> for figure caption. <tt>&lt;figDesc&gt;</tt> is used for alternate text describing the figure when the image is not used or seen.
 
Figures are encoded using a combination of <tt>&lt;figure&gt;</tt> and <tt>&lt;graphic&gt;</tt> elements. Generally speaking, <tt>&lt;graphic&gt;</tt> is used by itself to indicate the location of an inline graphic, illustration, or figure. When textual matter such as a figure number of caption is available, the compound element <tt>&lt;figure&gt;</tt> will be used, together with <tt>&lt;graphic&gt;</tt> which refers to the image file and elements such as <tt>&lt;head&gt;</tt> for figure number and <tt>&lt;p&gt;</tt> for figure caption. <tt>&lt;figDesc&gt;</tt> is used for alternate text describing the figure when the image is not used or seen.
  
  
=== 4.6.1 <tt>&lt;figure&gt;</tt> Example ===
+
=== <tt>&lt;figure&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<figure xml:id="fig3" n="3"><graphic url="figures/fig03.png" decls="#notCleared"/>
 
<figure xml:id="fig3" n="3"><graphic url="figures/fig03.png" decls="#notCleared"/>
Line 687: Line 691:
  
  
=== 4.6.2 <tt>&lt;graphic&gt;</tt> Example ===
+
=== <tt>&lt;graphic&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<p>. . . and then you can see in this image <graphic url="figures/inline-image.png"/> the characteristics of . . .</p>
 
<p>. . . and then you can see in this image <graphic url="figures/inline-image.png"/> the characteristics of . . .</p>
Line 693: Line 697:
  
  
== 4.7 <tt>&lt;milestone&gt;</tt> ==
+
== <tt>&lt;milestone&gt;</tt> ==
 
The <tt>&lt;milestone&gt;</tt> element should be used to indicate space or section breaks that are part of the typeset book, but otherwise not marked by a subhead. The unit attribute is used to indicate the type of break, and the n attribute can be used to indicate ornaments or other symbols.
 
The <tt>&lt;milestone&gt;</tt> element should be used to indicate space or section breaks that are part of the typeset book, but otherwise not marked by a subhead. The unit attribute is used to indicate the type of break, and the n attribute can be used to indicate ornaments or other symbols.
  
=== 4.7.1 <tt>&lt;milestone&gt;</tt> Example ===
+
=== <tt>&lt;milestone&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<milestone unit="line" n="***"/>
 
<milestone unit="line" n="***"/>
 
</pre>
 
</pre>
  
== 4.8 <tt>&lt;date&gt;</tt> ==
+
== <tt>&lt;date&gt;</tt> ==
 
Dates should be encoded using the <tt>&lt;date&gt;</tt> element.
 
Dates should be encoded using the <tt>&lt;date&gt;</tt> element.
  
  
=== 4.9.1 <tt>&lt;date&gt;</tt> Example ===
+
=== <tt>&lt;date&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<date>1865–1898</date>
 
<date>1865–1898</date>
Line 712: Line 716:
 
</pre>
 
</pre>
  
= 5. <tt>&lt;front&gt;</tt> =
+
= <tt>&lt;front&gt;</tt> =
 
The front element contains the typical frontmatter elements, including half title, title, copyright, dedication, contents, acknowledgments.
 
The front element contains the typical frontmatter elements, including half title, title, copyright, dedication, contents, acknowledgments.
  
== 5.1 <tt>&lt;titlePage&gt;</tt> ==
+
== <tt>&lt;titlePage&gt;</tt> ==
 
Includes the formal title page as well as half titles, indicated by the attribute type.
 
Includes the formal title page as well as half titles, indicated by the attribute type.
  
=== 5.1.1 <tt>&lt;titlePage&gt;</tt> Example ===
+
=== <tt>&lt;titlePage&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<titlePage type="fulltitle">
 
<titlePage type="fulltitle">
Line 737: Line 741:
  
  
== 5.2 Frontmatter Elements ==
+
== Frontmatter Elements ==
 
Frontmatter elements will be contained within <tt>&lt;div&gt;</tt> elements, with a type attribute indicating the name. <tt>&lt;head&gt;</tt> will be used when the frontmatter name is displayed on the print page. Various elements will be used to indicate children elements on the page, including <tt>&lt;l&gt;</tt> when line breaks are important, <tt>&lt;list&gt;</tt> elements for items like table of contents, and <tt>&lt;p&gt;</tt> for paragraph based text. Please see section 6.6 on lists as well as section 4.3 on linking for more information on those topics.
 
Frontmatter elements will be contained within <tt>&lt;div&gt;</tt> elements, with a type attribute indicating the name. <tt>&lt;head&gt;</tt> will be used when the frontmatter name is displayed on the print page. Various elements will be used to indicate children elements on the page, including <tt>&lt;l&gt;</tt> when line breaks are important, <tt>&lt;list&gt;</tt> elements for items like table of contents, and <tt>&lt;p&gt;</tt> for paragraph based text. Please see section 6.6 on lists as well as section 4.3 on linking for more information on those topics.
  
  
=== 5.2.1 <tt>&lt;div&gt;</tt> Example: Copyright ===
+
=== <tt>&lt;div&gt;</tt> Example: Copyright ===
 
<pre>
 
<pre>
 
<div type="copyright">
 
<div type="copyright">
Line 759: Line 763:
  
  
=== 5.2.2 <tt>&lt;div&gt;</tt> Example: Dedication ===
+
=== <tt>&lt;div&gt;</tt> Example: Dedication ===
 
<pre>
 
<pre>
 
<div type="dedication">
 
<div type="dedication">
Line 774: Line 778:
  
  
=== 5.2.3 <tt>&lt;div&gt;</tt> Example: Contents ===
+
=== <tt>&lt;div&gt;</tt> Example: Contents ===
 
<pre>
 
<pre>
 
<div xml:id="contents" type="contents">
 
<div xml:id="contents" type="contents">
Line 790: Line 794:
 
</pre>
 
</pre>
  
=== 5.2.4 <tt>&lt;div&gt;</tt> Example: Halftitle ===
+
=== <tt>&lt;div&gt;</tt> Example: Halftitle ===
 
<pre>
 
<pre>
 
<div type="halftitle">
 
<div type="halftitle">
Line 799: Line 803:
 
</pre>
 
</pre>
  
= 6. <tt>&lt;body&gt;</tt> =
+
= <tt>&lt;body&gt;</tt> =
 
The <tt>&lt;body&gt;</tt> of the document contains the main text of the work, including any introductory or concluding chapters or sections.  
 
The <tt>&lt;body&gt;</tt> of the document contains the main text of the work, including any introductory or concluding chapters or sections.  
  
  
== 6.1 <tt>&lt;div&gt;</tt> ==
+
== <tt>&lt;div&gt;</tt> ==
 
<tt>&lt;div&gt;</tt> elements are used for each major section and subsection of the work, including parts, chapters, and subheads. The type attribute is used to identify the sections and is mandatory. Other mandatory attributes include xml:id and n.
 
<tt>&lt;div&gt;</tt> elements are used for each major section and subsection of the work, including parts, chapters, and subheads. The type attribute is used to identify the sections and is mandatory. Other mandatory attributes include xml:id and n.
  
  
== 6.2 <tt>&lt;head&gt;</tt> ==
+
== <tt>&lt;head&gt;</tt> ==
 
Every chapter is contained within <tt>&lt;div&gt;</tt> elements, and generally includes a chapter number and chapter title. These will be encoded using the <tt>&lt;head&gt;</tt> element. Other chapter level <tt>&lt;head&gt;</tt> elements include subtitles and chapter authors in <tt>&lt;byline&gt;</tt> elements.
 
Every chapter is contained within <tt>&lt;div&gt;</tt> elements, and generally includes a chapter number and chapter title. These will be encoded using the <tt>&lt;head&gt;</tt> element. Other chapter level <tt>&lt;head&gt;</tt> elements include subtitles and chapter authors in <tt>&lt;byline&gt;</tt> elements.
  
Line 886: Line 890:
  
  
=== 6.2.1 <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> Example: Chapter ===
+
=== <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> Example: Chapter ===
 
<pre>
 
<pre>
 
<body>
 
<body>
Line 903: Line 907:
 
</pre>
 
</pre>
  
=== 6.2.2 <tt>&lt;head&gt;</tt> Example: A head and B head ===
+
=== <tt>&lt;head&gt;</tt> Example: A head and B head ===
 
<pre>
 
<pre>
 
<div xml:id="a3.1" type="ahead" n="3.1">  
 
<div xml:id="a3.1" type="ahead" n="3.1">  
Line 914: Line 918:
  
  
== 6.3 <tt>&lt;epigraph&gt;</tt> ==
+
== <tt>&lt;epigraph&gt;</tt> ==
 
Epigraphs should be encoded using the <tt>&lt;epigraph&gt;</tt> element, an any point in the data: at the start of a part, chapter, section, or other major division. When the epigraph is attributed, <tt>&lt;cit&gt;</tt> should be used to associate the <tt>&lt;quote&gt;</tt> with the <tt>&lt;bibl&gt;</tt>. For multi-paragraph quotes, <tt>&lt;p&gt;</tt>s should be used; for poems <tt>&lt;lg&gt;</tt> can be used with <tt>&lt;l&gt;</tt> for individual lines.
 
Epigraphs should be encoded using the <tt>&lt;epigraph&gt;</tt> element, an any point in the data: at the start of a part, chapter, section, or other major division. When the epigraph is attributed, <tt>&lt;cit&gt;</tt> should be used to associate the <tt>&lt;quote&gt;</tt> with the <tt>&lt;bibl&gt;</tt>. For multi-paragraph quotes, <tt>&lt;p&gt;</tt>s should be used; for poems <tt>&lt;lg&gt;</tt> can be used with <tt>&lt;l&gt;</tt> for individual lines.
  
Line 920: Line 924:
  
  
=== 6.3.1 <tt>&lt;epigraph&gt;</tt> Examples ===
+
=== <tt>&lt;epigraph&gt;</tt> Examples ===
 
<pre>
 
<pre>
 
<epigraph>
 
<epigraph>
Line 954: Line 958:
  
  
== 6.4 <tt>&lt;lg&gt;</tt> ==
+
== <tt>&lt;lg&gt;</tt> ==
 
Poems, lyrics, and other verse passages in text should have <tt>&lt;lg&gt;</tt> with a type of “verse” and <tt>&lt;l&gt;</tt> for individual lines.
 
Poems, lyrics, and other verse passages in text should have <tt>&lt;lg&gt;</tt> with a type of “verse” and <tt>&lt;l&gt;</tt> for individual lines.
  
  
=== 6.4.1 <tt>&lt;lg&gt;</tt> Verse Example ===
+
=== <tt>&lt;lg&gt;</tt> Verse Example ===
 
<pre>
 
<pre>
 
<lg type="verse">  
 
<lg type="verse">  
Line 967: Line 971:
  
  
== 6.5 Extracts ==
+
== Extracts ==
 
Extracted material should be encoded using the <tt>&lt;quote&gt;</tt> element, with <tt>&lt;p&gt;</tt> elements for paragraphs within the extract.  
 
Extracted material should be encoded using the <tt>&lt;quote&gt;</tt> element, with <tt>&lt;p&gt;</tt> elements for paragraphs within the extract.  
  
  
=== 6.5.1 Extract Example ===
+
=== Extract Example ===
 
<pre>
 
<pre>
 
<quote>
 
<quote>
Line 979: Line 983:
  
  
== 6.6 Dialogues ==
+
== Dialogues ==
 
Dialogues and other text that is primarily speech should be encoded using the <tt>&lt;sp&gt;</tt>, <tt>&lt;speaker&gt;</tt>, and <tt>&lt;said&gt;</tt> elements. Dialogues without headings can rely on just these elements. If a heading referring to the dialogue precedes the dialogue then the dialogue should be encoded in a <tt>&lt;div&gt;</tt> element.  
 
Dialogues and other text that is primarily speech should be encoded using the <tt>&lt;sp&gt;</tt>, <tt>&lt;speaker&gt;</tt>, and <tt>&lt;said&gt;</tt> elements. Dialogues without headings can rely on just these elements. If a heading referring to the dialogue precedes the dialogue then the dialogue should be encoded in a <tt>&lt;div&gt;</tt> element.  
  
 
If the optional who attribute is used to identify speakers, the value of who must refer to the  
 
If the optional who attribute is used to identify speakers, the value of who must refer to the  
  
=== 6.6.1 Dialogue Example ===
+
=== Dialogue Example ===
 
<pre>
 
<pre>
 
<div xml:id="d1.1" type="ahead" n="1.1">  
 
<div xml:id="d1.1" type="ahead" n="1.1">  
Line 1,015: Line 1,019:
  
  
== 6.7 <tt>&lt;list&gt;</tt> ==
+
== <tt>&lt;list&gt;</tt> ==
 
The <tt>&lt;list&gt;</tt> element is used for lists, and has four specific attributes: ordered, bulleted, gloss, simple. The item element is used for each new item in a list. Ordered lists will have a number in the content, while a simple list will not. A bulleted list will have the bullet character in the content as well.
 
The <tt>&lt;list&gt;</tt> element is used for lists, and has four specific attributes: ordered, bulleted, gloss, simple. The item element is used for each new item in a list. Ordered lists will have a number in the content, while a simple list will not. A bulleted list will have the bullet character in the content as well.
  
Line 1,021: Line 1,025:
  
  
=== 6.7.1 <tt>&lt;list&gt;</tt> Examples ===
+
=== <tt>&lt;list&gt;</tt> Examples ===
 
<pre>
 
<pre>
 
<list type="ordered">  
 
<list type="ordered">  
Line 1,052: Line 1,056:
  
  
== 6.8 <tt>&lt;table&gt;</tt> ==
+
== <tt>&lt;table&gt;</tt> ==
 
Tables will be contained by the <tt>&lt;table&gt;</tt> element, and should follow the TEI Guidelines, using <tt>&lt;row&gt;</tt> and <tt>&lt;cell&gt;</tt> for table structure. Table <tt>&lt;cell&gt;</tt>s have roles of “label” for headings and “data” for data. More can be found at  
 
Tables will be contained by the <tt>&lt;table&gt;</tt> element, and should follow the TEI Guidelines, using <tt>&lt;row&gt;</tt> and <tt>&lt;cell&gt;</tt> for table structure. Table <tt>&lt;cell&gt;</tt>s have roles of “label” for headings and “data” for data. More can be found at  
 
[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/FT.html#FTTAB1 http://www.tei-c.org/release/doc/tei-p5-doc/en/html/FT.html#FTTAB1].  
 
[http://www.tei-c.org/release/doc/tei-p5-doc/en/html/FT.html#FTTAB1 http://www.tei-c.org/release/doc/tei-p5-doc/en/html/FT.html#FTTAB1].  
Line 1,061: Line 1,065:
  
  
=== 6.8.1 <tt>&lt;table&gt;</tt> Example ===
+
=== <tt>&lt;table&gt;</tt> Example ===
 
<pre>
 
<pre>
 
<table xml:id="table1.1" n="1.1">  
 
<table xml:id="table1.1" n="1.1">  
Line 1,083: Line 1,087:
  
  
== 6.9 Reference Articles ==
+
== Reference Articles ==
 
Articles in reference works should be encoded using <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> elements for structure. All other elements should be encoded similarly to monographs: paragraphs using <tt>&lt;p&gt;</tt>, attributions using <tt>&lt;byline&gt;</tt>, bibliographic references using <tt>&lt;bibl&gt;</tt>, etc.
 
Articles in reference works should be encoded using <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> elements for structure. All other elements should be encoded similarly to monographs: paragraphs using <tt>&lt;p&gt;</tt>, attributions using <tt>&lt;byline&gt;</tt>, bibliographic references using <tt>&lt;bibl&gt;</tt>, etc.
  
Line 1,089: Line 1,093:
  
  
=== 6.9.1 Reference <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> Examples ===
+
=== Reference <tt>&lt;div&gt;</tt> and <tt>&lt;head&gt;</tt> Examples ===
 
<pre>
 
<pre>
 
<div type="article" xml:id="article1" n="1">
 
<div type="article" xml:id="article1" n="1">
Line 1,107: Line 1,111:
 
</pre>
 
</pre>
  
= 7. <tt>&lt;back&gt;</tt> =
+
= <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.  
 
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.  
  
  
== 7.1 Backmatter <tt>&lt;div&gt;</tt> Sections ==
+
== 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>.
 
Sections other than the bibliography and index will be encoded in the same manner as the frontmatter sections, using <tt>&lt;div&gt;</tt>.
  
  
=== 7.1.1 <tt>&lt;div&gt;</tt> Example: Acknowledgments  ===
+
=== <tt>&lt;div&gt;</tt> Example: Acknowledgments  ===
 
<pre>
 
<pre>
 
<div type="acknowledgments" xml:id="ack">  
 
<div type="acknowledgments" xml:id="ack">  
Line 1,122: Line 1,126:
 
<p>This book has been an unusually. . . </pre>
 
<p>This book has been an unusually. . . </pre>
  
== 7.2 <tt>&lt;div&gt;</tt> Endnotes ==
+
== <tt>&lt;div&gt;</tt> Endnotes ==
 
Endnotes and footnotes should be captured in a backmatter <tt>&lt;div&gt;</tt>
 
Endnotes and footnotes should be captured in a backmatter <tt>&lt;div&gt;</tt>
  
=== 7.2.1 <tt>&lt;div&gt;</tt> Example: Endnotes  ===
+
=== <tt>&lt;div&gt;</tt> Example: Endnotes  ===
 
<pre>
 
<pre>
 
<div xml:id="endnotes" type="endnotes">
 
<div xml:id="endnotes" type="endnotes">
Line 1,138: Line 1,142:
  
  
== 7.3 <tt>&lt;div&gt;</tt> Bibliography ==
+
== <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 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.
 
Please see the documentation at [http://www.tei-c.org/release/doc/tei-p5-doc/en/html/CO.html#COBI 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.
  
Line 1,202: Line 1,206:
 
All bibliographic items should have unique IDs.
 
All bibliographic items should have unique IDs.
  
=== 7.3.1 <tt>&lt;div&gt;</tt> Example: Bibliography  ===
+
=== <tt>&lt;div&gt;</tt> Example: Bibliography  ===
 
<pre>
 
<pre>
 
<div type="bibliography" xml:id="bib">  
 
<div type="bibliography" xml:id="bib">  
Line 1,215: Line 1,219:
  
  
== 7.4 <tt>&lt;div&gt;</tt> Index ==
+
== <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.  
 
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.  
  
Line 1,223: Line 1,227:
  
  
=== 7.4.1 <tt>&lt;div&gt;</tt> Example: Index  ===
+
=== <tt>&lt;div&gt;</tt> Example: Index  ===
 
<pre>
 
<pre>
 
<div type="index" xml:id="index">  
 
<div type="index" xml:id="index">  
Line 1,240: Line 1,244:
 
<ref type="indexItem" target="indexItem1"></ref>Abolition</item>
 
<ref type="indexItem" target="indexItem1"></ref>Abolition</item>
 
</pre>
 
</pre>
 
==text==
 
 
The <teiHeader> is followed directly by the mandatory <text> element, which contains the textual matter being encoded. The <text> element is broken down into three subelements: <front> for frontmatter, <body> for the main body of the work, and <back> for backmatter. Only the <body> element is required. Additionally, groups of discrete texts can be packaged together in one document using the <group> element as a parent for the separate <text> elements.
 
 
==div==
 
 
The <tt>&lt;front&gt;</tt>, <tt>&lt;body&gt;</tt>, and <tt>&lt;back&gt;</tt> elements all use the nested <tt>&lt;div&gt;</tt> structure to organize primary sections as well as child sections. The <tt>&lt;div&gt;</tt> elements are identified by a unique <tt>@xml:id</tt>, and also have an <tt>@n</tt> attribute to aid in reference. A <tt>@type</tt> attribute is also used to describe the kind of division. <tt>@type</tt> includes the following values:
 
 
<table border="1">
 
<tr>
 
<th>Value</th>
 
<th>Description</th>
 
</tr>
 
<tr>
 
<td>copyright</td>
 
<td>copyright information</td>
 
</tr>
 
<tr>
 
<td>dedication</td>
 
<td>dedication</td>
 
</tr>
 
<tr>
 
<td>contents</td>
 
<td>table of contents</td>
 
</tr>
 
<tr>
 
<td>frontispiece</td>
 
<td>frontispiece</td>
 
</tr>
 
<tr>
 
<td>acknowledgments</td>
 
<td>acknowledgments</td>
 
</tr>
 
<tr>
 
<td>preface</td>
 
<td>preface</td>
 
</tr>
 
<tr>
 
<td>introduction</td>
 
<td>frontmatter or body introduction</td>
 
</tr>
 
<tr>
 
<td>epigraph</td>
 
<td>epigraph</td>
 
</tr>
 
<tr>
 
<td>halftitle</td>
 
<td>halftitle</td>
 
</tr>
 
<tr>
 
<td>volume</td>
 
<td>volume</td>
 
</tr>
 
<tr>
 
<td>part</td>
 
<td>part</td>
 
</tr>
 
<tr>
 
<td>chapter</td>
 
<td>chapter</td>
 
</tr>
 
<tr>
 
<td>appendix</td>
 
<td>appendix</td>
 
</tr>
 
<tr>
 
<td>endnotes</td>
 
<td>endnote section</td>
 
</tr>
 
<tr>
 
<td>glossary</td>
 
<td>glossary</td>
 
</tr>
 
<tr>
 
<td>bibliography</td>
 
<td>bibliography</td>
 
</tr>
 
<tr>
 
<td>index</td>
 
<td>index</td>
 
</tr>
 
<tr>
 
<td>colophon</td>
 
<td>colophon</td>
 
</tr>
 
<tr>
 
<td>illustrations</td>
 
<td>illustrations</td>
 
</tr>
 
<tr>
 
<td>maps</td>
 
<td>maps</td>
 
</tr>
 
<tr>
 
<td>ahead</td>
 
<td>ahead</td>
 
</tr>
 
<tr>
 
<td>bhead</td>
 
<td>bhead</td>
 
</tr>
 
<tr>
 
<td>chead</td>
 
<td>chead</td>
 
</tr>
 
<tr>
 
<td>fmhead</td>
 
<td>frontmatter head</td>
 
</tr>
 
<tr>
 
<td>bmhead</td>
 
<td>backmatter head</td>
 
</tr>
 
<tr>
 
<td>halftitle</td>
 
<td>halftitle</td>
 
</tr>
 
<tr>
 
<td>other</td>
 
<td>other</td>
 
</tr>
 
</table>
 
 
The examples for <tt>&lt;div&gt;</tt> elements can be found in other relevant sections.
 

Latest revision as of 20:50, 10 March 2017

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>
<teiHeader>
 [ TEI Header information ] 
</teiHeader>
<text>
<front>
 [ front matter ... ] 
</front>
<body>
 [ body of text ... ] 
</body>
<back>
 [ back matter ... ] 
</back>
</text>
</TEI>

<TEI>: Root element

The root element is <TEI> 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.

<TEI xmlns="http://www.tei-c.org/ns/1.0" xml:id="uncp-9780807845295-book">

<teiHeader>

The header element has four distinct parts:

<fileDesc>
<encodingDesc>
<profileDesc>
<revisionDesc> 

<fileDesc>

The <fileDesc> element is mandatory. It contains a full bibliographic description of the file with the following elements, as well as the book abstract and keywords.

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

<title> with attributes for main and subtitle

<author> includes the following elements:

<name xml:id="surnamePlusInitialForename">
<forename type="given">
<forename type="middle">
<surname>

<reg> regularized author name: surname, forename type="given", forename type="middle".

<editionStmt> groups information relating to one edition of a text. This can include the following elements:

<edition>
<date>
<respStmt>

<extent> describes the approximate size of the electronic text as stored on some carrier medium, specified in any convenient units.

<publicationStmt> groups information concerning the publication or distribution of an electronic or other text.

<publisher>
<distributor>
<pubPlace>
<address>
<idno>

<seriesStmt> groups information about the series, if any, to which a publication belongs.

<notesStmt> collects together the book abstract and keywords.

<sourceDesc> supplies a bibliographic description of the copy text(s) from which an electronic text was derived or generated.


<fileDesc> Example

<fileDesc>
<titleStmt>
<title type="main">A Stone of Hope</title>
<title type="sub">Prophetic Religion and The Death of Jim Crow</title>
<author xml:id="chappelld">
<name><forename type="given">David</forename>
<forename type="middle">L.</forename>
<surname>Chappell</surname>
</name>
<reg>Chappell, David L.</reg>
</author>
<respStmt>
<resp>Text encoder:</resp>
<name type="corporate">cM</name>
</respStmt>
</titleStmt>
<extent>1.4 MB</extent>
<publicationStmt>
<publisher>The University of North Carolina Press</publisher>
<pubPlace>Chapel Hill, NC</pubPlace>
<date>2004</date>
<idno type="ISBN">9780807828199</idno>
<idno type="DOI">10.5149/uncp/9780807828199</idno>
<availability xml:id="notCleared" status="restricted">
<p>This image has not been cleared for online publication.</p>
</availability>
</publicationStmt>
<sourceDesc>
<biblFull>
<titleStmt>
<title type="main">A Stone of Hope</title>
<title type="sub">Prophetic Religion and The Death of Jim Crow</title>
<author>
<ptr target="#chappelld"/></author>
</titleStmt>
<extent>360 pp., 6.125 x 9.25, 24 illus., appends., notes, bibl., index</extent>
<publicationStmt>
<publisher>The University of North Carolina Press</publisher>
<pubPlace>Chapel Hill, NC</pubPlace>
<date>2004</date>
<idno type="ISBN">9780807828199</idno>
</publicationStmt>
<notesStmt>
<note type="abstract">
<p>In this new assessment of the civil rights movement, David Chappell argues that its success was not due to the triumph of liberal ideas after decades of gradual progress, but to the tradition of prophetic religion that brought the vitality of a religious revival to the integrationist cause. Although segregationists outvoted and outgunned black integrationists, the segregationists lost, Chappell concludes, largely because they did not have a religious commitment to their cause and because they did not have support in their white southern religious denominations.</p>
</note>
</notesStmt>
</biblFull>
</sourceDesc>
</fileDesc>


<encodingDesc>

Documents the relationship between an electronic text and the source(s) from which it was derived.

<encodingDesc> Example

<encodingDesc>
<projectDesc>
<p>The electronic edition is part of the <emph>Long Civil Rights Movement</emph> digitization project, a collaboration between UNC-Chapel Hill and the University of North Carolina Press.</p>
</projectDesc>
<editorialDecl>
<p>The text has been encoded using the recommendations for TEI P5.</p>
<p>Any hyphens occurring in line breaks have been removed, and the trailing part of a word has been joined to the preceding line.</p>
<p>All special characters have been transcribed as Unicode characters, except for the five reserved XML entities.</p>
<p>Indentation in lines has not been preserved.</p>
</editorialDecl>
<classDecl>
<taxonomy>
<bibl>
<title>Library of Congress Cataloging-in-Publication Data</title>
</bibl>
</taxonomy>
</classDecl>
</encodingDesc>


<profileDesc>

Provides a detailed description of non-bibliographic aspects of the text, specifically the languages and sublanguages used, the situation in which it was produced, the participants and their setting. Keywords will be listed in this section as well.

<profileDesc> Example

<profileDesc>
<langUsage>
<language ident="a" xml:lang="eng">English</language>
<language ident="a" xml:lang="lat">Latin</language>
</langUsage>
<textClass>
<classCode scheme="http://purl.org/eprint/type">Book</classCode>
<keywords scheme="LCSH">
<list type="simple">
<item>African Americans--Civil rights--History--20th century.</item>
<item>African Americans--Segregation--History--20th century.</item>
<item>Civil rights movements--United States--History--20th century.</item>
<item>Civil rights workers--Religious life--United States--History--20th century.</item>
<item>Civil rights--United States--Religious aspects--Christianity--History--20th century.</item>
<item>Christianity and politics--United States--History--20th century.</item>
<item>Church and social problems--United States--History--20th century.</item>
<item>United States--Race relations.</item>
<item>United States--Church history--20th century.</item>
</list>
</keywords>
<keywords scheme="UNCP">
<list type="simple">
<item>civil rights movement</item>
<item>prejudice</item>
<item>Martin Luther King Jr.</item>
<item>Fannie Lou Hamer</item>
<item>segregation</item>
<item>Protestantism</item>
<item>Jim Crow</item>
<item>revivalism</item>
<item>African American</item>
</list>
</keywords>
</textClass>
</profileDesc>


<revisionDesc>

Summarizes the revision history for a document.

<revisionDesc> Example

<revisionDesc>
<change>
<date>2009-12-09</date>
<name>codeMantra</name>
</change>
<change>
<date>2010-01-04</date>
<name>Kenneth Reed</name>
<affiliation>The University of North Carolina Press</affiliation>
</change>
</revisionDesc>

<text>

The <teiHeader> is followed directly by the mandatory <text> element, which contains the textual matter being encoded. The <text> element is broken down into three subelements: <front> for frontmatter, <body> for the main body of the work, and <back> for backmatter. Only the <body> element is required. Additionally, groups of discrete texts can be packaged together in one document using the <group> element as a parent for the separate <text> elements.


<div>

The <front>, <body>, and <back> elements all use the nested <div> structure to organize primary sections as well as child sections. The <div> elements are identified by a unique xml:id, and also have an n attribute to aid in reference.

A type attribute is also used to describe the kind of division. Type includes the following values:

Value Description
copyright copyright information
dedication dedication
series series page
contents table of contents
frontispiece frontispiece
acknowledgments acknowledgments
contributors list of contributors
illustrations list of illustrations
preface preface
foreword foreword
introduction frontmatter or body introduction
prologue prologue
epigraph epigraph
halftitle halftitle
volume volume
part part
chapter chapter
epilogue epilogue
conclusion conclusion
coda coda
afterword afterword
appendix appendix
endnotes endnote section
footnotes footnotes section
abbreviations list of abbreviations
glossary glossary
bibliography bibliography
index index
colophon colophon
illustrations illustrations
maps maps
ahead ahead
bhead bhead
chead chead
dhead dhead
fmhead frontmatter head
bmhead backmatter head
halftitle halftitle
article reference article
other other

The examples for <div> elements can be found in other relevant sections.


xml:id Attribute

In addition to the the root element, the xml:id shall be used on all <div> elements, including <titlePage>, all <pb> elements, all <figure> elements, all <table> elements, and all <note> elements. The form is different than the root element, and should reflect the element type or name. Examples follow:

<pb xml:id="pgi" n="i"/>

<div xml:id="contents" type="contents">

<div xml:id="c2" n="2" type="chapter">

<table xml:id="table1" n="1">

<figure xml:id="fig3" n="3">

<note xml:id="note1.3-34" n="34" type="endnote">

For unnumbered sections, such as frontmatter <div>s, the xml:id will be the descriptive name of the section. For numerated sections, the xml:id will start with either an abbreviated form of the descriptive name, or with the complete name. Examples are detailed in the table below.

Element or Section Suffix
halftitle halftitle
title title
copyright copyright
dedication dedication
acknowledgments ack
preface preface
introduction intro
illustrations illus
maps maps
volume volume
appendix appendix
endnotes endnotes
glossary glossary
bibliography bib
index index
colophon colophon
Enumerated elements suffix
part p1
chapter c1
endnote n1
footnote fn1
index indexItem1
bibliography bibItem1
figure fig1
table table1
article article1

n Attribute

In addition to the xml:id attribute, the n attribute should be used to add further information on specific elements. The elements requiring the n attribute generally are those that have the xml:id attribute and have more than one of its kind. These include <pb>, chapter <div>, <table>, <figure>, <note>. Other <div> sections that have multiple instances, such as appendices, should be encoded as well. See the xml:id example for clarification.


<pb>

It is important to maintain correct pagination so that the encoded version directly matches the print version. The empty <pb> element is used to mark the beginning of each physical page of the print document (including the frontmatter, first page, and blank pages). The <pb> element should be placed at the beginning of each physical page, and should be inside <div> elements. Never place a <pb> outside of a <div> element. If a page break occurs in the middle of a smaller element (e.g., <p>), it can be encoded there. There are two mandatory attributes required: xml:id, which has the same structure as other xml:id attributes, with uncp as the prefix, the ISBN as the root, and the page number, beginning with a pg as the suffix; n as the number of the page, which is the actual page number.

<pb> Examples

<div type="contents" xml:id="contents">
<pb xml:id="pgvii" n="vii"/>
<head type="chapterTitle">Contents</head>
<p>at the Office at the University of California, Berkeley, gave me the <pb id="pg22" n="22"/>acknowledgments chance to share my ideas for this project in their speaker series. At the Berkeley talk, Martin Meeker,. . . </p>


<fw>: Running Heads

Running heads should be encoded using the forme work <fw> element, with verso and recto as the type attribute values. For sections and chapters where there is one verso and one recto running head, the information should be captured once, immediately after the first <pb> of the <div>. For sections and chapters where the running heads change depending on the context of the page—encyclopedias, end note sections, etc—then the data will be captured immediately following the <pb> for each new running head.


<fw> Example

<pb xml:id="pg15" n="15"/>
<fw type="verso">H. Leon Prather Sr.</fw>
<fw type="recto">We Have Taken a City</fw>


<ref>

All references internal to a particular document as well as external references will be encoded using the <ref> element. Attributes for this element include id, target, type, and corresp. Id will use a unique identifier coupled with the ISBN of the book. Target will reference the id of the relevant element. Type includes the following values:

Value Type of Reference
citeref bibliographic citation reference
figref figure reference
footref footnote reference
noteref endnote reference
pageref page number reference
divref section or div reference
tableref table reference
displayref equation or other displayed material reference
boxmatterref boxed matter reference
uriref URI reference
tablenote table note reference
indexItem index entry
other other

All internal references to sections, chapters, or other major division found in the text should be encoded to provide links.

pageref Example

<ref target="#pg1" type="pageref">1</ref>


uriref Example

<p>. . . Law 106–380 created the Veterans History Project in 2000. For more information on the project, see [<ref target="http://www.loc.gov/vets/" type="uriref">http://www.loc.gov/vets/</ref>] (August 2, 2006).</p>


divref Example

<p>You can read more about this in <ref type="divref" target="#c2">Chapter 2</ref>.</p>


<figure> and <graphic>

Figures are encoded using a combination of <figure> and <graphic> elements. Generally speaking, <graphic> is used by itself to indicate the location of an inline graphic, illustration, or figure. When textual matter such as a figure number of caption is available, the compound element <figure> will be used, together with <graphic> which refers to the image file and elements such as <head> for figure number and <p> for figure caption. <figDesc> is used for alternate text describing the figure when the image is not used or seen.


<figure> Example

<figure xml:id="fig3" n="3"><graphic url="figures/fig03.png" decls="#notCleared"/>
<figDesc>Billingsville School, Grier Heights neighborhood, Charlotte, 1951. (Courtesy of the <emph>Charlotte Observer)</emph></figDesc>
</figure>


<graphic> Example

<p>. . . and then you can see in this image <graphic url="figures/inline-image.png"/> the characteristics of . . .</p>


<milestone>

The <milestone> element should be used to indicate space or section breaks that are part of the typeset book, but otherwise not marked by a subhead. The unit attribute is used to indicate the type of break, and the n attribute can be used to indicate ornaments or other symbols.

<milestone> Example

<milestone unit="line" n="***"/>

<date>

Dates should be encoded using the <date> element.


<date> Example

<date>1865–1898</date>
<date>January 2, 1955</date>
<date>1998</date>

<front>

The front element contains the typical frontmatter elements, including half title, title, copyright, dedication, contents, acknowledgments.

<titlePage>

Includes the formal title page as well as half titles, indicated by the attribute type.

<titlePage> Example

<titlePage type="fulltitle">
<pb xml:id="pgiii" n="iii"/>
<docTitle>
<titlePart type="main">Reading, Writing, & Race</titlePart>
<titlePart type="sub">The Desegregation of the Charlotte Schools</titlePart>
</docTitle>
<byline>
<docAuthor>Davison M. Douglas</docAuthor>
</byline>
<docImprint>
<publisher>THE UNIVERSITY OF NORTH CAROLINA PRESS</publisher>
<pubPlace>Chapel Hill & London</pubPlace>
</docImprint>
</titlePage>


Frontmatter Elements

Frontmatter elements will be contained within <div> elements, with a type attribute indicating the name. <head> will be used when the frontmatter name is displayed on the print page. Various elements will be used to indicate children elements on the page, including <l> when line breaks are important, <list> elements for items like table of contents, and <p> for paragraph based text. Please see section 6.6 on lists as well as section 4.3 on linking for more information on those topics.


<div> Example: Copyright

<div type="copyright">
<pb xml:id="pgiv" n="iv"/>
<lg>
<l>© <date>2007</date> The University of North Carolina Press</l>
<l>All rights reserved</l>
<l>Set in Scala, The Sans, and Campaign types by</l>
<l>Keystone Typesetting, Inc.</l>
<l>Manufactured in the United States of America</l>
<l>This book was published with the assistance of</l>
<l>the Thornton H. Brooks Fund of the University of</l>
<l>North Carolina Press.</l>
</lg>
</div>


<div> Example: Dedication

<div type="dedication">
<pb xml:id="pgv" n="v"/>
<lg>
<l><hi rend="italic">To my parents</hi></l>
<l>J<hi rend="sc">ohn</hi> M<hi rend="sc">unroe</hi> D<hi rend="sc">ouglas</hi></l>
<l>&</l>
<l>M<hi rend="sc">arjorie</hi> L<hi rend="sc">utz</hi> D<hi rend="sc">ouglas</hi></l>
<l><hi rend="italic">who taught me the value of education</hi></l>
</lg>
<pb xml:id="pgvi" n="vi"/></div>


<div> Example: Contents

<div xml:id="contents" type="contents">
<pb xml:id="pgvii" n="vii"/>
<head type="chapterTitle">Contents</head>
<list type="simple">
<item>Acknowledgments, <ref target="#pgxi" type="pageref">xi</ref></item>
<item>Introduction, <ref target="#pg1" type="pageref">1</ref></item>
<item><hi rend="italic">Chapter</hi> 1 Challenging Separate and Unequal Education in North Carolina before <hi rend="italic">Brown</hi>, <ref target="#pg6" type="pageref">6</ref></item>. . .<item>Epilogue, <ref target="#pg245" type="pageref">245</ref></item>
<item>Notes, <ref target="#pg255" type="pageref">255</ref></item>
<item>Bibliography, <ref target="#pg325" type="pageref">325</ref></item>
<item>Index, <ref target="#pg343" type="pageref">343</ref></item>
</list>
<pb xml:id="pgviii" n="viii"/></div>

<div> Example: Halftitle

<div type="halftitle">
<pb xml:id="pgi" n="i"/>
<head type="halftitle">Reading, Writing, & Race</head>
<pb xml:id="pgii" n="ii"/>
</div>

<body>

The <body> of the document contains the main text of the work, including any introductory or concluding chapters or sections.


<div>

<div> elements are used for each major section and subsection of the work, including parts, chapters, and subheads. The type attribute is used to identify the sections and is mandatory. Other mandatory attributes include xml:id and n.


<head>

Every chapter is contained within <div> elements, and generally includes a chapter number and chapter title. These will be encoded using the <head> element. Other chapter level <head> elements include subtitles and chapter authors in <byline> elements.

The head elements will always have a type, as noted in this table:

Head Type Value Reference
chapterNumber chapter number
chapterTitle chapter title
chapterSubtitle chapter subtitle
partNumber part number
partTitle part title
partSubtitle part subtitle
seriesTitle series title
seriesEditor series editor
ahead ahead
bhead bhead
chead chead
dhead dhead
fmhead frontmatter head
bmhead backmatter head
halftitle halftitle
entryName.A article head

If a chapter author is listed, the <byline> element will be used to encode this, as well as <name> for each author.

For reference works, all <head> elements will be encoded using the type above, with the suffix incrementing for multi-level heads. For instance, the first head will be entryName.A. The second head would be entryName.B. See section 6.9 below.


<div> and <head> Example: Chapter

<body>
<pb xml:id="pg1" n="1"/> 
<div xml:id="c1" n="1" type="chapter"> 
<head type="chapterNumber">3</head>
<head type="chapterTitle">Chapter Title</head>
<head type="chapterSubtitle">Chapter subtitle</head>
<byline>
<name>John Smith</name>
</byline>
<p>The men and women who served in the military during World War II have become known as “the greatest generation.” Although there are exceptions, the majority of these veterans have been exceedingly humble about the sacrifices that they made in service to the United States. When asked why they served, almost every one of them answers: “I was just doing my duty.”<ref type="noteref" n="1" target="#n1" rend="superscript">1</ref>.</p>
<quote>
<p>Extracted text.</p>
</quote>

<head> Example: A head and B head

<div xml:id="a3.1" type="ahead" n="3.1"> 
<head type="ahead">Ahead</head>
<p>Text.</p>
<div xml:id="b3.1.1" type="bhead" n="3.1.1"> 
<head type="bhead">Bhead</head>
<p>Text.</p>


<epigraph>

Epigraphs should be encoded using the <epigraph> element, an any point in the data: at the start of a part, chapter, section, or other major division. When the epigraph is attributed, <cit> should be used to associate the <quote> with the <bibl>. For multi-paragraph quotes, <p>s should be used; for poems <lg> can be used with <l> for individual lines.

For unattributed quotes, there is no need for <cit>. The <quote> element will still be used, whether with <p>s or with <lg>s, but as there is no attribution <bibl> is unnecessary.


<epigraph> Examples

<epigraph>
<cit>
<quote>
<lg>
<l>On Santiago's bloody field</l>
<l>Where Spanish hosts were made to yield</l>
<l>The Negro like a phalanx great</l>
<l>Fought hard to save the ship of state</l>
<l>And Wilmington with her disgrace</l>
<l>Stares Santiago in the face</l>
<l>And shows her heartless feelings clear</l>
<l>For those who fought without a fear.</l>
</lg>
</quote>
<bibl>—<author>F. B. Coffin</author>, <title>"Santiago de Wilmington</title>," <date>1899</date></bibl>
</cit>
</epigraph>
<epigraph>
<cit>
<quote>
<p>No man, no race will preserve its rights that fears to die to maintain them. Nor will the world regard him as worthy of freedom who will not give his life if necessary in its defense.</p>
<p>The greatness of every man and of every race, in its last analysis, is to be measured by indifference to death.</p>
</quote>
<bibl>—Editorial in <title>The Herald</title> (<pubPlace>Brunswick Georgia</pubPlace>), <date>1898</date></bibl>
</cit>
</epigraph>


<lg>

Poems, lyrics, and other verse passages in text should have <lg> with a type of “verse” and <l> for individual lines.


<lg> Verse Example

<lg type="verse"> 
<l>Freedom, freedom, freedom’s coming, and it won’t be long</l>
<l>Freedom, freedom, freedom’s coming, and it won’t be long.</l>
</lg>


Extracts

Extracted material should be encoded using the <quote> element, with <p> elements for paragraphs within the extract.


Extract Example

<quote>
<p>He appeared to be vain of its beauty as he tossed it carelessly off his forehead, or suffered it to fall heavily and half conceal his eyes. These were twinkly and slippery, and nearly always half shut, for he laughed much, and then they partly closed of themselves, and at other times he had a way of watching from under his dropped lids. He was a wellshaped man, but it was hardly to be discovered as he lolled in his seat, or from the insufferably lazy manner of his walking. When he spoke, however, he stood erect, using forcible and graceful gestures.</p>
</quote>


Dialogues

Dialogues and other text that is primarily speech should be encoded using the <sp>, <speaker>, and <said> elements. Dialogues without headings can rely on just these elements. If a heading referring to the dialogue precedes the dialogue then the dialogue should be encoded in a <div> element.

If the optional who attribute is used to identify speakers, the value of who must refer to the

Dialogue Example

<div xml:id="d1.1" type="ahead" n="1.1"> 
<head type="ahead">Interview with Rufus A. Lewis, by Donald T. Ferron</head>
<p>Date: Friday, January 20, 1956</p>
<p>Time: 11:00 <hi rend="smallcaps">a.m.</hi> to 2:15 <hi rend="smallcaps">p.m.</hi></p>
<p>Place: Respondent's home, 801 Bolivar Street, Montgomery, Alabama</p>
<sp>
<speaker>
[Ferron]:
</speaker>
<said>
[. . .] What is your relation to the Montgomery Improvement Association?
</said>
</sp>
<sp>
<speaker>
[Lewis]:
</speaker>
<said>I belong to the executive committee as a result of being co-chairman of the transportation committee. The executive committee is composed of the transportation committee, the committee for strategy, committee for public relations, and the finance committee.</said>
</sp>
<sp>
<speaker>
[Ferron]:
</speaker>
<said>Who is the other chairman?</said>
</sp>


<list>

The <list> element is used for lists, and has four specific attributes: ordered, bulleted, gloss, simple. The item element is used for each new item in a list. Ordered lists will have a number in the content, while a simple list will not. A bulleted list will have the bullet character in the content as well.

A gloss is a list of terms, and will use <label> to identify the term being defined. <item> will follow with the definition.


<list> Examples

<list type="ordered"> 
<item>1. Papers through 1959</item>
<item>2. Papers, 1960–84</item>
<item>3. Papers, 1985–2000</item>
<item>4. Men of Annapolis Papers</item>
<item>5. Papers on Women</item>
</list>
<list type="bulleted"> 
<item>· Papers through 1959</item>
<item>· Papers, 1960–84</item>
<item>· Papers, 1985–2000</item>
<item>· Men of Annapolis Papers</item>
<item>· Papers on Women</item>
</list>
<list type="gloss"> 
<label>DTD</label>
<item>Document Type Definition-the set of rules that specifies how the SGML or XML grammar will be applied in a particular document instance.</item>
<label>XML</label>
<item>eXtensible Markup Language, a simplified subset of SGML (q.v.), developed by the World Wide Web Consortium.For a gentle introduction to XML, see <ref type="uriref" target="http://www.tei-c.org/P4X/SG.html">http://www.tei-c.org/P4X/SG.html</ref></item>
</list>


<table>

Tables will be contained by the <table> element, and should follow the TEI Guidelines, using <row> and <cell> for table structure. Table <cell>s have roles of “label” for headings and “data” for data. More can be found at http://www.tei-c.org/release/doc/tei-p5-doc/en/html/FT.html#FTTAB1.

Table heads should be encoded using a <head> element with the type of tableHead.

Table footnotes and source elements shall be encoded using <note> and <p> elements. There are two types of notes: one with a reference in the table body, and one without. The first should have a type of tablenote, and the second a type of source.


<table> Example

<table xml:id="table1.1" n="1.1"> 
<head type="tableHead">TABLE 1. South Carolina Expenditures on Pupils and Teacher Salaries</head>
<row>
<cell role="label">Year</cell>
<cell role="label">Average per Pupil Spent<ref type="noteref" n="1" target="#note-tn1" rend="superscript">*</ref></cell>
<cell role="label">Average Teacher Salary</cell>
<cell role="label">Differential</cell>
</row>
<row>
<cell role="data">1920–21</cell>
<cell role="data">White: $39.26<lb/>Black: $4.84</cell>
<cell role="data">White: $773.33<lb/>Black: $225.47</cell>
<cell role="data">State spends 8.1 times more per white pupil; white teachers earn  3.4 times more</cell>
</row>
<note type="source"> <p>Sources: All figures from the <hi rend="italic">Annual Report of the State Superintendent of Education of the State of South Carolina</hi>.</p></note>
<note xml:id="note-tn1" n="*" type="tablenote"><p>All per-pupil expenditures are according to enrollment, with the exception of 1942–43.</p></note>
</table>


Reference Articles

Articles in reference works should be encoded using <div> and <head> elements for structure. All other elements should be encoded similarly to monographs: paragraphs using <p>, attributions using <byline>, bibliographic references using <bibl>, 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 <head> element, as in the second example below.


Reference <div> and <head> Examples

<div type="article" xml:id="article1" n="1">
<head type="entryName.A">Southern Zigzag Salamander</head>
<head type="entryName.B">Plethodon ventralis</head>
<p>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).</p>
</div>
<div type="article" xml:id="article22" n="22">
<head type="entryName.A">Museum of the Cape Fear</head>
<p><hi rend="bold">Museum of the Cape Fear</hi> in Fayettville is the third regional...</p>
<p>References: <bibl><author>Angela Fracaro</author>, <title level="a">"A Fast Start at Looking Back,"</title> <title level="j">The State</title> <biblScope type="vol">57</biblScope> (<date>June 1989</date>)</bibl>; <bibl><author>Karen Rosalinde Zimmer</author>, <title level="u">"An Audience Development Plan for the Museum of the Cape Fear in Fayetteville"</title> (M.A. thesis, <pubPlace>UNC-Chapel Hill</pubPlace>, <date>1989</date>)</bibl>.</p>
<byline>Angelyn H. Patteson</byline>
</div>

<back>

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


Backmatter <div> Sections

Sections other than the bibliography and index will be encoded in the same manner as the frontmatter sections, using <div>.


<div> Example: Acknowledgments

<div type="acknowledgments" xml:id="ack"> 
<pb xml:id="pg287" n="287"/> 
<head type="chapterTitle">Acknowledgments</head>
<p>This book has been an unusually. . . 

<div> Endnotes

Endnotes and footnotes should be captured in a backmatter <div>

<div> Example: Endnotes

<div xml:id="endnotes" type="endnotes">
<pb xml:id="pg255" n="255"/>
<head type="chapterTitle">Notes</head>

<head type="ahead">CHAPTER ONE</head>

<note xml:id="note1.2-1" n="1" type="endnote"><num>1</num>

<hi rend="italic">Brown v. Board of Education,</hi> 347 U.S. 483 (1954).

</note> <note xml:id="note1.2-2" n="2" type="endnote"><num>2</num>

<hi rend="italic">Laws of North Carolina</hi> (1838–39), chap. 8, sec. 3, p. 13; North Carolina Advisory Committee, <hi rend="italic">Equal Protection of the Laws,</hi> p. 99.

</note>


<div> 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: <bibl> as the most basic level, <biblStruct> as more structured, and <biblFull> as the fully-structured ciation, having all the components of a TEI file description and as seen in the TEI header. <listBibl> can be used when encoding a list of citations, as in a bibliography.

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

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

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.

Title Level Value Type of Title
a (analytic) analytic title (article, poem, or other item published as part of a larger item)
m (monographic) monographic title (book, collection, or other item published as a distinct item, including single volumes of multi-volume works)
j (journal) journal title
s (series) series title
u (unpublished) title of unpublished material (including theses and dissertations unless published by a commercial press)

<biblScope> 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.


biblScope Type Value Description
vol the element contains a volume number
issue the element contains a issue number
part the element contains a part number
chap the element contains a chapter number
pp the element contains a page range

All bibliographic items should have unique IDs.

<div> Example: Bibliography

<div type="bibliography" xml:id="bib"> 
<head type="chapterTitle">Bibliography</head>
<listBibl>
<bibl xml:id="bibItem1"> <editor>Bohannon, Paul</editor>, and <editor>George Dalton</editor>, eds. <title level="m">Markets in Africa</title>. [<pubPlace>Evanston, Ill.</pubPlace>]: <publisher>Northwestern University Press</publisher>, <date>1962</date>.</bibl>
<bibl xml:id="bibItem111"> <author>Lockert B. Mason</author>, <title level="a">”Babies Hospital, 1920–1978”</title>, <title level="j">North Carolina Medical Journal</title> <biblScope type="issue">45</biblScope>
<date>January 1984</date>): <biblScope type="pp">65–81</biblScope>. </bibl>
</listBibl>


<div> Index

The index will consist of a primary <list> element, with each entry encoded using the <item> 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 <list> element within the initial <item>, as will further levels.

Page references will be tagged with <ref>, as will “see also” references to other index entries.


<div> Example: Index

<div type="index" xml:id="index"> 
<pb xml:id="pg292" n="292"/> 
<head type="chapterTitle">Index</head>
<list>
<item xml:id="indexItem1">Abolition, <ref target="#pg44" type="pageref">44</ref>, <reftarget="#pg47" type="pageref">47</ref>, <ref target="#pg48" type="pageref">48</ref>;
<list>
<item xml:id="indexItem2">and Northern whites, <ref target="#pg45" type="pageref">45</ref>, <ref target="#pg100" type="pageref">100</ref>, <ref target="#pg102" type="pageref">102</ref>;
</item>
<item xml:id="indexItem3">in Ohio, <ref target="#pg48" type="pageref">48</ref>, <ref target="#pg68" type="pageref">68</ref> (n. 23). <hi rend="italic">See also</hi> <ref type="indexItem" target="indexItem735">Underground Railroad</ref>
</item>
</list>
</item>  
<item xml:id="indexItem735">Underground Railroad, <ref target="#pg47" type="pageref">47</ref>, <ref target="#pg48" type="pageref">48</ref>, <ref target="#pg49" type="pageref">49</ref>. <hi rend="italic">See also</hi>
<ref type="indexItem" target="indexItem1"></ref>Abolition</item>