Xml Case Learns 2008

Introduction to Text Encoding and the Text Encoding Initiative (TEI) Richard Wisneski Head, Bibliographic/Metadata Services Kelvin Smith Library Case Western Reserve University 2009-2010

This stuff can get difficult. This stuff takes time to learn, practice, and patience We can only cover so much in this session, but there are further resources to consult after this session… First, Some Ground Rules

P5 Guidelines, PDF link (The current “Bible” for text encoding): http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index.html P5 Guidelines, esp. Appendix C: http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index-toc.html Women Writers Project Guide to Scholarly Encoding: http://www.wwp.brown.edu/encoding/guide/index.html Sources to Consult

PART 1: Overview of Text Encoding

Text encoding marks up a document in XML to capture metadata (administrative, descriptive, technical, preservation) AND represent textual features important for research. Examples: The Poetess Archive Women Writers Online The Dolly Madison Digital Edition The Walt Whitman Archive What Is Text Encoding?

Quick Example <lg> <head>After <del>an</del><add>the <del>unsolv’d</del></add> argument</head> <l><del>The</del><add><del>Coming in,</del> A group of</add> little children, and their <lb/>ways and chatter, flow in <del>upon me</del></l> <l>Like <add>welcome</add> rippling water o'er my <lb>heated <add>nerves and</add> flesh.</l> </lg>

Text encoding does NOT attempt to provide one unique, authoritative version of a work. It often pairs the document with interpretation (markup and metadata) Text encoding does NOT provide one static, permanent markup for a document. While there can be alternative markup in certain instances, there can be incorrect markup Text encoding (TEI) is NOT meant to have an encoding recommendation for all possibilities, but rather intends to be customized and modified within TEI guidelines What Text Encoding Is NOT

To allow researchers to have access to an electronic text that does not require special-purpose software or hardware To analyze information – provide a standard text-encoding scheme and metadata language which accommodates searching, retrieval, etc. To share information – have a standard format for data interchange in humanities research Why Do Text Encoding?

Tailor searching under specific genres (e.g. verse, drama, prose) Search different formats (e.g. chronicle, diary) Search across collections Search by mode (e.g. satire, pastoral) Search by historical or geographic period Search by title, author, and subject headings Search via structural features of text itself, including: Sections Headings Paragraphs Quotations Highlighting Footnotes Captions Text Encoding Allows Users To…

Digital libraries and digital archives Anthropology and social sciences Literary and cultural materials Scholarly editions Manuscript collections and descriptions Dictionaries Language corpora Historical documents Authoring Linguistics Who Does Text Encoding? Where Is It Found?

Technically : a standards organization for humanities text encoding Organizationally : an international membership consortium Socially : a community of people and projects Web site: http://www.tei-c.org/ What Is the Text Encoding Initiative (TEI)?

Texts are encoded using eXtensible Markup Language (XML) XML is… Easy to understand. Non-proprietary plain-text: Human readable Software independent Hardware independent (relatively) easy to write a parser for. Widespread: Well-supported by commercial and open-source software. Text Encoding and XML

XML Documents Must Be: Well-formed: Have no syntax errors and conform to XML code specifications <title>Little Memoirs of the Nineteenth Century</title> <author>George Paston</author> Valid: Satisfy the rules of a DTD, Schema, or RELAX NG If DTD or Schema says that author name must come before the title, then content above would be rejected

XML Vocabulary Elements, Content, Attributes, Values <titleStmt> <title type=“m”>Little Memoirs</title> Element Attribute Value Content </titleStmt> Nested <titleStmt> is PARENT ELEMENT. <title> is the CHILD ELEMENT for <titleStmt>

<biblStruct> <titleStmt> <title level="m">Early history of the Cleveland Public Schools</title> <author><persName>Freese, Andrew</persName></author> </titleStmt> <extent>128 p. : ill. ; 23 cm.</extent> <publicationStmt>  <pubPlace>Cleveland, Ohio</pubPlace> <publisher>Robison, Savage & Co., Book Printers</publisher> <date>1876</date>  </publicationStmt> <notesStmt> <note>by Andrew Freese ; Published by order of the Board of Education.</note> </notesStmt> </biblStruct> Quick Example

A valid TEI document follows the rules of a schema that describes it. The Schema (or DTD) ensures that all required elements are present in the document The schema may prevent undefined elements from being used The schema may enforce a specific data structure The schema may specify the use of attributes and define their possible values The schema may define default values for attributes An XML document can be well-formed but NOT valid An XML document can never be valid without being well-formed Validity

Schema Examples <book measure=“centimeters”>21</book>  <xs:element name=“book"> <xs:complexType> <xs:simpleContent> <xs:extension base=“xs:string”> <xs:attribute name=“measure” type=“xs:string” /> </xs:extension> </xs:simpleContent> </xs:complexType> </xs:element> <book bookISBN=“152-32-29359535”>Go Tell It on the Mountain</book> <authorLastName>Baldwin</authorLastName> <authorFirstName>James</authorFirstName>  <xs:element name=“book"> <xs:complexType> <xs:sequence> <xs:element ref=“authorLastName" /> <xs:element ref=“authorFirstName" /> </xs:sequence> <xs:attribute ref=“bookISBN" use="required" /> </xs:complexType> </xs:element>

PART 3: Levels of TEI Encoding

Latest iteration of TEI is Protocol 5 (a.k.a. P5) Current TEI Consortium Best Practices Group (formed in Summer 2008) has been establishing best practices and standards for: TEI headers Level One encoding: Fully Automated Conversion and Encoding Level Two: Minimal Encoding Level Three: Simple Analysis Level Four: Basic Content Analysis Level Five: Scholarly Encoding Projects The BPG will present its work at the Digital Library Federation conference in early May, get feedback, and publish a final document later in 2009 Five Levels

Level 1 Encoding: Fully Automated Conversion and Encoding To create electronic text with the primary purpose of keyword searching and linking to page images The text is subordinate to the page image, and is not intended to stand alone as an electronic text (without page images). Most suitable for: A large volume of material to be made available online quickly When a digital image of each page is desired No manual intervention is performed in the text creation process material is of interest to a large community of users who wish to read texts that allow keyword searching sophisticated search and display capabilities based on the structure of the text are not necessary

Level 1 Encoding: Characteristics <div1> or <div> There should be only one child of <body>: a single <div> (or <div1>) <ab> There should be only one child of the <div> (or <div1>): a single <ab> wrapping all text OCR text. If the text is ever “upgraded” to a Level 3 or higher, the <ab> element will be replaced by structural elements like <p> and <table>. <pb> Required in Level 1. Page images can be linked to the text by specifying a jpeg or other image file as the value of the facs= attribute. Page numbers can be supplied with the n= attribute to record the number that is on the page. The Task Force sees the use of METS here as having a tremendous advantage. METS/TEI page turning documentation will be included in the near future.

Level 2 Encoding: Minimal Encoding To create electronic text for full-text searching, linking to page images, and identifying simple structural hierarchy to improve navigation. (For example, you can create a table of contents from such encoding.) The text is mainly subordinate to the page image, though navigational markers (textual divisions, headings) are captured. However, the text could stand alone as electronic text (without page images) Requires some human intervention to identify each textual division and heading. Most suitable for: A large volume of material to be made available online quickly When a digital image of each page is desired material is of interest to a large community of users who wish to read texts that allow keyword searching Rudimentary search and display capabilities based on the large structures of the text are desired Each text is checked to ensure that divisions and headers are properly identified

Level 2 Encoding: Characteristics All elements specified in Level 1 plus the following: <front>, <back> Optional <div1> or <div> If no type= attribute is specified, a type= value of "section" should be presumed. <head> Required if present. <ab> At least one container element is required. <fw> Running heads; can be automatically generated

<?oxygen RNGSchema="http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rng" type="xml"?> <TEI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tei-c.org/ns/1.0"> <TEI xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader type="text"> [stuff] </teiHeader> <text> <front> [title page information, table of contents, prefaces, etc.] [optional] </front> <body> <div type="section"> <pb n="1" facs=" [URI of page 1 image] "/> <head> [heading of section 1] </head> <ab> [entire contents of section 1 here, with interspersed <pb /> elements pointing to page images; in this example there are 26 more pages to section 1] </ab> </div> <div type="section"> <pb n="27" facs=" [URI of page 27 image] "/> <div type="subsection"> <head >[heading of section 2 subsection 1]</head> <ab>[all the paragraphs of subsection one go here with page breaks inserted] </ab> </div> </div> </body> <back> [optional] </back> </text> </TEI> P5 Level 2 Encoding Template

<?oxygen RNGSchema="http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rng" type="xml"?> <TEI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tei-c.org/ns/1.0"> <TEI xml:id="someid" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader> [Source and processing information goes here] </teiHeader> <text> <body> <div1> <pb n="113" facs=" 00000001.tif "/> <head>POINT VIII: BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; ALTERNATIVELY, DISCOVERY AND A HEARING SHOULD BE ORDERED.</head> <ab> POINT VIII. BECAUSE OF UNLAWFUL SURVEILLANCE, PETITIONER'S CONVICTION SHOULD BE VACATED; … <pb n="114" facs="00000002.tif"/> on the Hiss mail in 1945, … <pb n="115" facs="00000003.tif"/> occurred from December 13, 1945 until the Hisses moved from Washington, D.C. to New York City on September 13, 1947. … </ab> </div1> </body> </text> </TEI> P5 Level 2 Encoding Example

Level 3 Encoding: Simple Analysis To create text that can stand alone as electronic text Identifies hierarchy (logical structure) and typography without content analysis being of primary importance Features to be encoded are determined by the logical structure and appearance of the text can stand alone as text without page images Most suitable for: Some sophistication of display, delivery, and searching based on structure of the text is desired Texts will be checked to ensure that encoding decisions have been made appropriately material is of interest to a large community of users who wish to read texts that allow keyword searching

Level 3 Encoding: Characteristics All elements specified in Levels 1 and 2 plus the following : <front>, <back> Required if present <div> Required if present; type attribute is recommended <floatingText> Recommended if present. <p> Required for paragraph breaks in prose. <lg> and <l> Required for identifying groups of lines and lines, respectively <list> and <item> May be used in this level to indicate ordered and unordered list structures <table>, <row>, and <cell> May be used to indicate table structures. <figure> Required to indicate figures other than page images <hi> Required to indicate changes in typeface; rend attribute is optional <note> All notes must be encoded. It is also recommended that notes that extend beyond one page be combined into one <note> element. Marginal notes, without reference, should occur at the beginning of the paragraph to which they refer, with the value of the place attribute as "margin"

Level 3 Encoding: General Recommendations Front matter <div type="contents"> : Use lists to mark up the table of contents with the <ptr> tag used to reference the starting page number. The <ptr> tag can reference the <pb> identifier OR an identifier (e.g., @xml:id) placed in the corresponding division of text. Body <note> Inline. The note is inserted at the point of reference. An n attribute records the value of the note reference if there is one Back <div type="index"> : Use lists to mark up index entries with the <ref> tag used to reference the corresponding page number. Add the "target" attribute (@target) to reference the <pb> identifier to generate links from the index into the text proper Running heads, catch words, and other such forme work information should NOT be included in Level 3, with the exception of page numbers, which are recorded using pb

Level 3 Encoding: Prose Example <TEI xmlns="http://www.tei-c.org/ns/1.0" xml:id="VAA2383"> <teiHeader> [stuff] </teiHeader> <text> <front> <div type="frontispiece">[figure]</div1> <titlePage>[text]</titlePage> <div type="dedication">[text]</div1> <div type="contents">[text]</div1> </front> <body> <div type="book"> <head>[book title]</head> <div type="chapter“> <pb n=“5” xml:id=“freear-p03” />[text] </div2> <div type="chapter"> <pb n=“12” xml:id=“freear-p12” />[text] </div2> <div type="chapter">[text]</div2> </div> </body> <back> <div type="appendix">[text]</div1> <div type="index">[text]</div1> </back> </text></TEI> Table of Contents:  <div type="contents"> <head>CONTENTS</head> <list type="simple"> <item>I. A Boy and His Dog <hi rend="right">3</hi> <ptr target="#freear-p03"/> </item> <item>II. Romance <hi rend="right">12</hi> <ptr target="#freear-p12"/> </item> </div>

Level 3 Encoding: Verse Example <TEI xmlns="http://www.tei-c.org/ns/1.0" xml:id="VAA2383"> <teiHeader> [stuff] </teiHeader> <text> <front> <titlePage>[text]</titlePage> <div type="dedication">[text]</div1> <div type="contents">[text]</div1> </front> <body> <div type="book"> <head>[book title]</head> <div type="part"> <head>[section title]</head> <div type="poem"> <head>THE DAYS GONE BY.</head> <lg> <l n="1">O the days gone by! O the days gone by!</l> <l n="2">The apples in the orchard, and the pathway through the rye;</l> <l n="3">The chirrup of the robin, and the whistle of the quail</l> <l n="4">As he piped across the meadows sweet as any nightingale;</l> </lg> <lg>[lines of poetry]</lg> <lg>[lines of poetry]</lg> </div> </div> </div> </body> </text> </TEI>

Level 4 Encoding: Basic Content Analysis To create text that can stand alone as electronic text identifies hierarchy and typography specifies function of textual and structural elements describes the nature of the content and not merely its appearance. Features of the text that may contribute to meaning, such as indentation of verse lines and typographic change, are preserved Most suitable for: sophisticated search and retrieval capabilities are desired texts will be used for textual analysis users of the texts may have limited storage or display capabilities

Level 4 Encoding: Characteristics All elements specified in Levels 1, 2 and 3 plus the following : Et cetera; see TEI BPG Guidelines <titlePage> and child elements Required if present <group> Required to encode a collection of independent texts that are regarded as a single group for processing or other purposes <emph>, <foreign>, <gloss>, <term>, or <title> Recommended to identify typographically distinct text <epigraph>, <quote>, <said>, <mentioned>, or <soCalled> Recommended to represent speech, thought, quotation, etc. <sic>, <corr>, or <choice> Recommended to encode errors or typos. <add>, <del>, <gap>, and <unclear> Recommended to encode material that is omitted, added, marked for deletion, or is illegible, invisible, or inaudible <opener>, <dateline>, <salute> <closer>, <signed>, <postscript> Required to indicate specific parts of letters <sp>, <speaker>, and <stage> Required to encode different dramatic structures. <sp> and <speaker> Required to encode oral histories interviews

<p> But it is well authenticated by the observation of every one, that <del rend="overstrike" hand="JHL"> their manner </del> <add rend="sup" hand="JHL"> this way—i.e. the above </add> of writing influences the style of compos. of those who practise it considerably, when they grow up to years of manhood; for their productions, <del hand="JHL" rend="overstrike"> instead </del> far from being terse, argumentative, convincing, are without head or tail & are generally an incongruous mass mixed up in the most disgusting manner, without divisions or heads & in short without a subject (so to speak). </p> Example of Level 4 Encoding

Level 5 Encoding: Scholarly Encoding Projects Level 5 texts are those that require subject knowledge, and encode semantic, linguistic, prosodic, or other elements beyond a basic structural level

<l>So hath myn <app> <lem wit=“#msB #msC”>herte</lem> <rdg wit=“#msA”>hert</rdg> <rdg wit=“#msD”>minde</rdg> <rdg wit=“#msE>mynde</rdg> </app> Caught in remembraunce</l> Example: Variant Readings in Level 5 Apparatus; critical apparatus Lemma, or base text

General Recommendations An encoding project should strive for internal consistency and for use of standards so that the data can be modified or enhanced in the future with ease When reformatting to digital media using any level of encoding, the electronic text should begin with the transcription of the first word on the first leaf of the original work Certain features of the text, such as publisher's advertisements or indexes, should be included as links to page images Any omissions of material found in the original work should be noted in the <editorialDecl> in the TEI header An encoding project should use only numbered divisions (i.e., <div1>, <div2>, etc.) or unnumbered divisions (i.e., <div>) but not both Whether numbered or unnumbered divisions are used, the @type attribute of the division element is not recommended at level 1, is optional at level 2, is recommended at level 3, and required at levels 4 and 5 Page breaks should be encoded using the <pb> element, which should demark the top of a page (i.e. the text of page seven should immediately follow <pb n="7"/>), and should always be contained within a div for ease of retrieval with indexing software

PART 4: Short Practice in Text Encoding

Author: James Wallen Title: Cleveland’s Golden Story Publishing Place and Publisher : [Cleveland, OH]: Wm. Taylor Son & Co. Year : 1920 93 pp. CONTENTS TEXT ETC . Chapter 1. The Kingdom of God. 1 Chapter 2. Lincoln-Hearted Men 9 Chapter 3. Taming the Wilderness 19

Chapter 1: The Kingdom of Gold Gold is the symbol of adventure—the unresting urge that stirs men’s souls. Francois de Orlenna, who crossed the South American continent from ocean to ocean in 1540, wrote, “Having eaten our boots and saddles, boiled with a few wild herbs, we set out to reach the Kingdom of Gold.” His catalog of iritations included: 1. The weather 2. The peacocks 3. His meagre grasp of Hamlet, Prince of Denmark Chapter Heading and Paragraph

<?oxygen RNGSchema="http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rng" type="xml"?> <TEI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader type="text"> [stuff goes here] </teiHeader> <text> <front> <list> <item> Chapter 1. The Kingdom of God. 1 </item> <item> Chapter 2. Lincoln-Hearted Men. 9 </item> [ETC.] </list> </front> <body> <div type=“section"> <pb n=“1" facs="p1.jpg"/> <head> The Kingdom of God </head> <ab> [a whole section is contained within this anonymous block tag; interspersed with <pb> elements pointing to page images] <pb xml:id="p21198-zz0002mpwb" n="2"/> </ab> </div> </body> <back> [optional] </back> </text> </TEI> P5 Level 2 Encoding

<?oxygen RNGSchema="http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rng" type="xml"?> <TEI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.tei-c.org/ns/1.0"> <teiHeader type="text">[stuff goes here]</teiHeader> <text> <front> <pb n=“1” xml:id=“walcle01-00” /> <div type=“contents”> <list> <item>Chapter 1. The Kingdom of God. <hi rend="right"> 1 </hi> <ptr target=“#walcle01-p1”/> </item> <item>Chapter 2. Lincoln-Hearted Men. <hi rend="right"> 9 </hi><ptr target=“# walcle01-p1”/> </item> [ETC.] </list> </div> </front> <body> <div type=“ chapter "> <pb n=“1" xml:id="walcle01-p1"/> <head type=“main”> Chapter 1 </head> <head type=“subtitle”> The Kingdom of God </head> <p> [FIRST PARAGRAPH GOES HERE] </p> </div> </body> <back> [optional] </back> </text></TEI> P5 Level 3 Encoding

<p> Gold is the symbol of adventure—the unresting urge that stirs men’s souls. Francois de Orlenna, who crossed the South American continent from ocean to ocean in 1540, wrote, “Having eaten our boots and saddles, boiled with a few wild herbs, we set out to reach the Kingdom of Gold.” </p> <p> His catalog of iritations included: <list> <item> 1. The weather </item> <item> 2. The peacocks </item> <item> 3. His meagre grasp of <hi> Hamlet, Prince of Denmark </hi> </item> </list> </p> P5 Level 3 Continued

<p>Gold is the symbol of adventure—the unresting urge that stirs men’s souls. <name type=“person” key=“FDO1”> Francois de Orlenna </name> , who crossed the South American continent from ocean to ocean in <date when=“1540”> 1540 </date> , wrote, <q> Having eaten our boots and saddles, boiled with a few wild herbs, we set out to reach the Kingdom of Gold. </q> </p> <p>His catalog of <sic> iritations <sic><corr> irritations </corr> included: <list> <item> 1. The weather</item> <item> 2. The peacocks </item> <item> 3. His meagre grasp of <hi> <bibl><title ref=“hamlet1”> Hamlet, Prince of Denmark </title></bibl> </hi> </item> </list> </p> … <bibStruct xml:id=“hamlet1”> <monogr> <author> Shakespeare, William </author> <title> Hamlet, Prince of Denmark </title> <date> </monogr> </bibStruct> P5 Level 4 Encoding

Provides administrative, descriptive, and preservation metadata Administrative : who created the metadata? When was it created? Where is the original item located? Etc. Descriptive : title, author, publication info, subject headings, number of pages, etc. Preservation : file size, identifier, format, etc. TEI Header

Electronic Version Information Information about the ELECTRONIC version of the work(s) Electronic Distributor Information Information about the publisher of the ELECTRONIC version of the work(s) E.g. William Taylor & Co. published the original work, but Kelvin Smith Library is publishing the electronic version Original Document Bibliographic Information Bibliographic information of the text from which the electronic version was derived. May be generated from MARC record (but does not have to be). Encoding Description Includes project description, encoding level declaration, what classification structure is used (e.g. LCSH), etc. Profile Description Includes text language, subject terms Revision Description If any revision was done to the TEI document, this is where that information is recorded, included revision details, party(ies) involved, and date(s) Basic Components of TEI Header

Can reflect a text center’s standards, serve as the basis for other types of metadata system records, Can function in detached form as records in a catalog, as a title page inherent to the document, or as a source for index displays May describe a collection of documents, a single item, or a portion of an item A TEI header may NOT necessarily have a one to one correspondence with a MARC record. One TEI header may have multiple MARC analytic records, or one MARC record may be used to describe a collection of TEI documents with individual headers May contain an historical background on how the file has been treated and extend the information of a classic catalog record There is no ONE header template. Modification needed depending on project, text type. TEI Header (continued)

Example: MARC to TEI Header LEADER 00000nam 2200000Ia 4500 001 49237829 003 OCoLC 005 20020305071435.0 008 020305s1905 ohu r 000 0 eng d 040 CWR|cCWR 049 CWRR 090 BJ1161|b.G6 1905a 100 1 Given, Charles Stewart 245 12 A fleece of gold :|bfive lessons from the fable of Jason and the Golden Fleece /|cby Charles Stewart Given 260 Cincinnati [Ohio] :|bJennings and Graham ;|aNew York [N.Y.] :|bEaton and Mains,|cc1905 300 103 p. ;|c18 cm 533 Photocopy.|bLaCrosse, Wis. :|cBrookhaven Press : digital production by Northern Micrographics, Inc.,|d2001.|e18 cm 650 0 Success 650 0 Conduct of life 650 0 Jason (Greek mythology) <sourceDesc> <biblStruct> <titleStmt> <title type="main">A fleece of gold</title> <title type="sub">five lessons from the fable of Jason and the Golden Fleece</title>  <author> <persName>Given, Charles Stewart <persName> </author> </titleStmt> <extent>103 p.</extent> <publicationStmt>  <pubPlace>Cincinnati [Ohio]</pubPlace> <publisher>Jennings and Graham</publisher> <date>1905</date> <idno>BJ1161 .G6 1905a</idno> </publicationStmt> </biblStruct> </sourceDesc> … <profileDesc> <keywords scheme="LCSH">  <term>Success</term> <term>Conduct of life</term> <term>Jason (Greek mythology)</term> </keywords> </textClass> </profileDesc>

Session 2: Text Encoding and the Text Encoding Initiative (TEI) Richard Wisneski Head, Bibliographic/Metadata Services Kelvin Smith Library Case Western Reserve University 2009-2010

PART 6: Basic Text Type Structures

Before encoding a text, skim through it and mark out its structure. For books, take note of: Volumes Parts Chapters Section breaks Table of contents End matter (indices, endnotes, bibliography, glossary, appendices, colophon, etc.) Front matter (title page, dedication, epigraph, preface, introduction, etc.) Introduction

Sample Book Structure This book has: A. An Introduction, B. Two chapters – each with a heading and two sections – and C. an Index

Basic Document Structure <text> <front> <div type="preface">  </div> <div type="introduction">  </div> </front> <body> <div type=“chapter” n=“1”> <heading type =“main”>Chapter 1</heading> <heading type=“subtitle”>Wines</heading> <div type=“section”>White wines ... </section> <div type=“section”>Red wines ... </section> </div> </body> <back> <div type="index">  </div> </back> </text> Un-numbered Division

Numbered Divisions within Body <body> <div1 type="part" n="1“> <div2 type="chapter" n="1“>  </div2> </div1> <div1 type="part" n="2“> <div2 type="chapter" n="2“>  </div2> </div1> </body> The largest possible subdivision of the body is <div1> and the smallest possible is <div7>. You CANNOT mix unnumbered and numbered divisions (i.e. <div> with <div1> etc.) Regardless, a good practice is to use n= and/or xml:id= attributes. For example: <div type=“chapter” n=“1”>  NOTE: n= is optional, and repeatable

<text> <front></front> <group> <text></text> <text></text> <text></text> </group> <back></back> </text> Using <group> for Editions

<div1 n=“I” type=“Act”> <head> Act I </head> <div2 type="scene"> <head> Scene 1 </head> <stage type="entrance"> Enter Fay </stage> <sp> <speaker> Fay </speaker> <p> I say, Dinah, has anyone seen my gloves? </p> </sp> <stage type="entrance"> Enter Dinah </stage> <sp> <speaker> Dinah </speaker> <p> No, miss, perhaps the parakeet has got them again? </p> </sp> <stage type="exit"> Exit Fay and Dinah </stage> </div2> </div1> Drama

<div type="letter"> <opener> <dateline> <date when="1865-08-05"> August the 5th </date> <name type="place"> Cape Cod </name> </dateline> <salute> My dear <name type="person"> Becky </name></salute> </opener> <p> How lovely the oysters are this evening! </p> <closer> <salute> Yours very truly </salute> <signed><name type="person"> Maria </name></signed> </closer> </div> Letters

<lg type="sonnet"> <head>On First Looking into Chapman’s Homer</head> <lg type="quatrain"> <l>Much have I travell’d in the realms of gold,</l> <l>And many goodly states and kingdoms seen;</l> <l>Round many western islands have I been</l> <l>Which bards in fealty to <persName>Apollo</persName> hold.</l> </lg> <lg type="quatrain"> <l>Oft of one wide expanse had I been told</l> <l>That deep-brow’d <persName>Homer</persName> ruled as his demesne;</l> <l>Yet did I never breathe its pure serene</l> <l>Till I heard <persName>Chapman</persName> speak out loud and bold:</l> </lg> <lg type="sestet"> <l>Then felt I like some watcher of the skies</l> <l>When a new planet swims into his ken;</l> <l>Or like stout <persName>Cortez</persName> when with eagle eyes</l> <l>He star’d at the <placeName>Pacific</placeName>—and all his men</l> <l>Look’d at each other with a wild surmise—</l> <l>Silent, upon a peak in <placeName>Darien</placeName>.</l> </lg> </lg> Verse <persName> and <placeName> are optional for Level 3; Used in Level 4.

Warp Speed, Ms. Bright! There was a young lady named Bright, Who travelled much faster than light, She departed one day, In a relative way way, And returned on the previous night. Verse Example

<?xml version="1.0" encoding="UTF-8"?> <lg type="limerick" rhyme="aabba" n="3"> <head>Warp Speed, Ms Bright!</head> <l>There was a young lady named <rhyme label="a">Bright</rhyme>,</l> <l>Who travelled much faster than <rhyme label="a">light</rhyme>,</l> <l>She departed one <rhyme label="b">day</rhyme>,</l> <l>In a relative <rhyme label="b">way</rhyme>,</l> <l>And returned on the previous <rhyme label="a">night</rhyme>.</l> </lg> TEI P5 Level 5 Rendering

PART 7: Some Common Practices in Text Encoding

Make sure you are linked to a schema <?oxygen RNGSchema=" http://www.tei-c.org/release/xml/tei/custom/schema/relaxng/tei_all.rng " type=“xml"?> 2. Include as much of the header elements as possible – including <editorialDecl> <editorialDecl> <hyphenation eol="none"> <p>Hyphenated words that appear at the end of a line have been removed</p> </hyphenation> </editorialDecl> 3. Make use of spell-check: F4 key 4. Delete hyphens within all words – except in special cases (e.g. poetry, dramatic verse) Institu-tion becomes Institution Using oXygen

5. Include <respStmt> in header for any emendations or corrections you later make to a text that has been previously encoded <respStmt> <name xml:id="rlw54">Richard Wisneski</name>  <resp>TEI Header creator</resp>  </respStmt> 6. Page breaks must be inserted, using <pb n=“[page number]” xml:id=“” /> <pb xml:id="fleboo-032" n="33"/> OR, if one desires to have page reference the specific page image: <pb facs=“fleboo-032.jp2“ n="33"/> xml:id attribute MUST be (a) unique and (b) start with a letter facs attribute MAY link to a permanent URL or URI Common Practices (continued)

As part of a page: <figure> <figDesc>An illuminated page from the de Brailes Hours, containing a historiated initial with a signed self-portrait of William de Brailes </figDesc> <graphic url="./gfx/debrailes_ms.jpg" height="600px"/> </figure> Inserting Images <figDesc> is not required in Level 3, but we are using it to capture either an image caption or to describe the image if a caption is not present

<p>FIRST ANNUAL REPORT<note place="foot" rend="*">This was the first report made after the schools were regularly organized under the ordinance. The Bethel School mentioned in the opening paragraph had existed through a part of the previous year, the year 1836, and a Board appointed to look after its interests, had made an informal— probably oral — report.</note> OF THE- BOARD OF MANAGERS OF COMMON SCHOOLS.</p> Footnote Encoded (and Marginalia) If this note were in the MARGIN of the page, it would be encoded, for example: <note type=“auth” place=“margin-left”> text, text,text </note> Type= and rend= attributes are optional

In the body of the text: <p>He liked to eat pie<ptr target="#note1" rend="1"/>.</p> OR… <p>See <ref target="#note1">Note 30</ref></p> At the end of the text: <div type="endnotes"> <pb n="130" /> <p xml:id=“note1">Pie is a dessert often eaten.</p> </div> Endnotes

<l>(Diff'rent our parties, but with equal grace</l> <l>The Goddess smiles on Whig and Tory race, <ptr rend="unmarked" target="#note3.284"/> </l> <l>'Tis the same rope at sev'ral ends they twist,</l> <l>To Dulness, Ridpath is as dear as Mist)</l> <note xml:id="note3.284" type="imitation" place="foot" anchored="false"> <bibl>Virg. Æn. 10.</bibl> <quote> <l>Tros Rutulusve fuat; nullo discrimine habebo.</l> <l>—— Rex Jupiter omnibus idem.</l> </quote> </note> Encode with Pointer and Link

Definition : Things we know about the content of the text that we want to be able to state explicitly to add value to the text or assist the reader in understanding it better, such as: Authority control: information about the identity of things named in the text: people, places, books, etc. Additional information about: birthdates, geographical locations, date published, etc. Interpretive information: themes, keywords Normalization of measurements, dates, etc. Encoding Contextual Information

Names <persName>Baron Olivier of Brighton</persName> <placeName>New York</placeName> <orgName>Podunk Sewing Club</orgName> Linguistic: <foreign>, <distinct>, <soCalled>, <mentioned>, <term>, <emph> <distinct>dinna ken</distinct> why that <foreign xml:lang="fr">soi-disant</foreign> <soCalled>expert</soCalled> must be <emph>so</emph> particular about pronouncing <mentioned xml:lang="cy">Llandaff</mentioned> using a <term>voiceless lateral fricative</term> Common Tags for Contextual Information

’ Ographies: prosopography (personography) gazetteers (placeography) orgography, bibliography These are like local authority lists that you create Keywords applied to the text as a whole Thematic or interpretive information applied to specific places in the text Types of Contextual Information

Like a local name authority file Can be simple or very detailed Can be kept in your encoded file or externally Includes specific elements for the most common data Also includes general elements for the unforeseen Personography

<teiHeader>  <particDesc> <listPerson> <person xml:id="andrew_j_steere"> <persName>Steere, Andrew J.</persName> <birth when="1844"> <placeName ref="#l_scituate">Scituate, RI</placeName> </birth> <death notBefore="1918"/> </person> <person xml:id="george_pope_morris"> <persName>Morris, George Pope</persName> <birth when="1802"> <placeName>Philadelphia, PA</placeName> </birth> <death when="1864"/> </person> </listPerson> </particDesc> </teiHeader> <text> <p>...However, the plea of Woodman spare that tree and the patriotic pride of the owner, <persName ref="#andrew_j_steere">Mr. Andrew J. Steere</persName>, had guaranteed its safety from the woodsman’s axe. </p> </text> Personography Encoding TEI header Participation description listPerson person

Very similar to personography...but for places Can be linked to maps via geographic information data Placeography (Gazetteer)

<body> <p>The tree stood about a mile east of <placeName ref="#l_chepachet">Chepachet</placeName> and a mile north of <placeName ref="#l_spring_grove">Spring Grove</placeName> ... </p>  </body> <back> <div type="editorial"> <listPlace> <place type="state" xml:id="l_rhode_island"> <placeName>The State of Rhode Island and Providence Plantations</placeName> <country>United States of America</country> <region>New England</region> </place> <place type="settlement" xml:id="l_chepachet"> <placeName>Chepachet</placeName> <region ref="#l_rhode_island"/> <location> <geo>41.915131 -71.671397</geo> </location> </place> <place type="settlement" xml:id="l_spring_grove"> <placeName>Spring Grove</placeName> <region ref="#l_rhode_island"/> <location> <geo>41.905583 -71.656219</geo> </location> </place> </listPlace> </div> </back> Placeography Encoding back div place

To associate a keyword or interpretive concept with a word, phrase, or passage of text: <body> <div type="section"> <p>However, the plea of <quote>Woodman spare that tree</quote> and the <seg ana="#patriotism">patriotic pride of the owner</seg>, <persName>Mr. Andrew J. Steere</persName>, had <seg ana="#conservation">guaranteed its safety from the woodsman’s axe</seg>...</p> </div> </body> <back> <div type="editorial"> <interpGrp> <interp xml:id="ri_history">Rhode Island local history</interp> <interp xml:id="patriotism">Patriotism and references to the war effort</interp> <interp xml:id="commercial">References to commercial harvesting and use of trees</interp> <interp xml:id="conservation">Conservation efforts and protection of trees</interp> <interp xml:id="arboriculture">References to tree species and their cultivation</interp> </interpGrp> </div> </back> Interpretative Keywords and Themes

PART 9: Some Complex Situations in Text Encoding

Overlapping occurs especially with older texts. XML elements may not overlap, but document structures often do. Examples include: Physical features like pages, columns, and lines, and textual things like paragraphs or names Verse lines and quotations, names, other phrasal elements Verse lines and linguistic features Dramatic speeches and verse lines Handwritten additions or deletions and other structures Typographical features and linguistic features Overlapping

Mortal, she said, "I'm sent to you, Then hold my precepts fast; Remember earth’s best joys are few, And can’t for ever last." Example

<lg type="stanza"> <l>Mortal, she said, <said xml:id="s01" next="#s02">I'm sent to you,</said></l> <l><said xml:id="s02" next="#s03" prev="#s01">Then hold my precepts fast;</said></l> <l><said xml:id="s03" prev="#s02" next="#s04">Remember earth’s best joys are few,</said></l> <l><said xml:id="s04" prev="#s03">And can’t for ever last.</said></l> </lg> One Possible Solution

Transcriptional Complexities <p>Johnston etc 1764 Mr Nikl<unclear>e</unclear> <supplied>s</supplied><gap reason="folded" extent="unknown"/> Brown <unclear>&Co</unclear> to me George <unclear>Beverly juner</unclear> to ten Rum Barels at Four pound &per; Barel — — — £40</p>

Marks a boundary point separating any kind of section of a text where the change is not represented by a structural element Regarding page breaks, signatures, line breaks, and column breaks Example: <pb n="249"/> <milestone unit="sig" n="R5r"/> <lb/>digested. Its long trunk, as seen slanting down from <lb/>out of the building across the wharf and into the ship, … <lb/>will have been—a farthing.</p> <pb n="250"/> <milestone unit="sig" n="R5v"/> Milestones

Available on every element when additional tagset for segmentation & alignment is used To count lines, or indicate metrical patterns, etc. --> divide into parts <sp> <speaker>Leo.</speaker> <l part="F">Go on, go on:</l> <l>Thou canst not speake too much, I have deserv’d</l> <l part="I">All tongues to talk their bittrest.</l> </sp> <sp> <speaker>Lord.</speaker> <l part="F">Say no more;</l> <l>How ere the business goes, you have made fault</l> <l part="I">I’th boldnesse of your speech.</l> </sp> <sp> <speaker>Pauline.</speaker> <l part="F">I am sorry for’t;</l> <l>All faults I make, when I shall come to know them</l>  </sp> Fragmentation

Encoding Parallel Structures <lg type="stanza" xml:lang="fr"> <l xml:id="fr2.01" corresp="#en2.01">Nos péchés sont têtus, nos repentirs sont lâches;</l> <l xml:id="fr2.02" corresp="#en2.02">Nous nous faisons payer grassement nos aveux,</l> <l xml:id="fr2.03" corresp="#en2.04">Et nous rentrons gaiement dans le chemin bourbeux,</l> <l xml:id="fr2.04" corresp="#en2.03">Croyant par de vils pleurs laver toutes nos taches.</l> </lg> <lg type="stanza" xml:lang="en"> <l xml:id="en2.01" corresp="#fr2.01">Our sins are stubborn, craven our repentance.</l> <l xml:id="en2.02" corresp="#fr2.02">For our weak vows we ask excessive prices.</l> <l xml:id="en2.03" corresp="#fr2.04">Trusting our tears will wash away the sentence,</l> <l xml:id="en2.04" corresp="#fr2.03">We sneak off where the muddy road entices.</l> </lg>

<p>...with them, bycause they woulde <lb/>not be <choice> <abbr>boūde</abbr> <expan>bounde</expan> </choice> also for an other wo[see below] <lb/>mā at theyr pleasure, whom they <lb/>knewe not, nor yet what matter <lb/>was layed unto her charge. Not <lb/>wythstandynge at the laste, after <lb/>moche a do and reasonyng to and <lb/>fro, they toke a bonde of them of <lb/>recognisaunce for my fourth com <lb/>mynge. And thus I was at the <lb/>last, <choice> <orig>delyuered</orig> <reg>delyvered</reg> </choice>. Written by me An <lb/>ne Askewe. </p> Textual Splitting CHOICE

Textual Splitting (continued) … <choice> <abbr> <choice> <sic>wo<lb/>mā</sic> <corr>wo-<lb/>mā</corr> </choice> </abbr> <expan> <choice> <sic>wo<lb/>man</sic> <corr>wo-<lb/>man</corr> </choice> </expan> </choice> also for an other wo[see below] <lb/>mā at theyr pleasure, whom they You can put CHOICE inside name, or outside (nesting)

For an unclear reading, you can put multiple clear elements within choice Use <unclear>, <supplied>, and <gap> element for what you can't read from the written manuscript Example: Brown <unclear>&Co</unclear> to me George <unclear>Beverly juner</unclear> Unclear Texts

<teiHeader> <fileDesc>  <notesStmt> <note>The historiated capital on folio 43r contains a signed self-portrait of William de Brailes. The text is richly illuminated ...</note> </notesStmt>  </fileDesc> </teiHeader> Descriptive Prose for Images

Formalization for Images <physDesc> <objectDesc form="codex"> <supportDesc material="vellum"> <extent> <dimensions> <height quantity="150" unit="mm"/> <width quantity="124" unit="mm"/> </dimensions> </extent> </supportDesc> <layoutDesc> <layout columns="1" ruledLines="12"/> </layoutDesc> </objectDesc> <handDesc> <handNote scribe="william_debrailes" script="carolingian" medium="ink" scope="sole"/> </handDesc> </physDesc> practice

The outward expression of TEI to the user is the TEI guidelines: http://www.tei-c.org/release/doc/tei-p5-doc/en/html/index-toc.html These guidelines include schemas – formal rules for encoding documents – and documentation to explain how to apply these rules Customization is possible to apply TEI markup as strict or as loose as one wishes TEI Guidelines = Your instruction manual TEI Guidelines

Topically – into chapters and modules Semantically and functionally – into classes Pedagogically – into discussion and reference TEI provides the tools. You have to ask: What is my project? What are my needs? What level of granularity do I want? TEI Guidelines Divisions

Some modules (e.g. TEI header) are required – core elements Some modules provide genre- or discipline-specific elements : e.g., the verse module contains <rhyme> and <caesura> Some modules provide functionality : e.g., the linking module contains markup for encoding arbitrary passages and noting links between them Chapters and Modules

Classes are functional or semantic groups of elements. Two kinds: model class: elements that appear in the same place in the logical structure e.g., model.milestoneLike contains those milestone elements used to describe the physical and typographic structure of a codex: pb, cb, lb, and milestone attribute class: elements that share a common attribute e.g., att.ascribed is the class of elements that share the who attribute, i.e. can be attributed to an individual, including change, q, and sp Classes

Classes are composed of elements and sometimes other classes: elements and attribute classes can be members of attribute classes a given element (or attribute class) may be a member of more than one attribute class elements, model classes, or attribute classes can be members of model classes a given element (or class) may be a member of more than one model class Class Constituency

Datatypes are constraints on (attribute) values. May limit values to things like: a supplied list of possible values: e.g. sex of person a user-provided list of possible values: e.g. type of div strings that conform to a specific format: e.g. when of date, extent of gap, or xml:lang Datatypes

contain a prose discussion of: Encoding topics, A reference section, and Schemas that constrain encoding One Document Does It All (ODD) TEI Guidelines…

TEI Under the hood http://www.tei-c.org/Roma/

Roma , the web interface to the TEI customization mechanism, performs two functions: Provides a user interface for editing TEI ODD files Provides a user interface for generating TEI schemas and documentation ROMA, The Web Tool

Select which modules to use and not to use Choose what elements in those modules to use and not to use Choose what attributes on those elements to use and not to use Change element or attribute names Restrict the values of attributes – IMPORTANT Constrain structure Add new elements Add new attributes Produce an internationalized version of the TEI Customization Options

Customize: Values for Type= Attributes Values for any kind of information for which a controlled vocabulary exists However: Do NOT remove the header Do NOT remove required elements from the header Do NOT duplicate things which the TEI has already provided What To Customize and Not Customize

STEP 1: Enter a (1) title, (2) filename (all one word, no characters), (3) author name, and (4) description. Leave everything else as is. STEP 2: Click “submit” STEP 3: Click the MODULES tab MODULES tab

Do NOT remove the “List of selected Modules” given to you (but click link to change attributes) Click links under “Module Name” to: a. See what elements are available b. Exclude elements c. Rename elements d. Change attributes 3. To change values for attributes, click the attribute itself. 4. Click “add” on left-hand side to add elements with their attributes

Clicking “add” inserts this module here. Next, click “namedates”

You can exclude elements Click to change attributes

Click on these links to change the values for the attributes When you’re done changing elements and attributes, click here

Change the values for the attributes (type= ) Click if no changes are made (bypass “ submit query”) Click when finished

Return to your list; note that if you changed any attributes, the “changes” column indicates this. Click the “Schema” tab

Best is to choose either “Relax NG schema (compact syntax) or “W3C schema” Click “Documentation” to save documentation for this schema Click “Sanity Checker” to make sure your schema validates NOTE: You can return to the Roma tool to later edit your schema

More and better documentation More use (and support for use) by individuals More discipline-specific customizations Future Trends in TEI

Historical Event Markup Language (HEML): http://www.heml.org/heml-cocoon/ Music Markup Language: http://www.musicmarkup.info/ Multi-Element Coding System: http://helmer.hit.uib.no/claus/mecs/mecs.htm Other Encoding Possibilities

WWP Guide to Scholarly Text Encoding: http://www.wwp.brown.edu/encoding/guide/index.html TEI web site: http://www.tei-c.org/index.xml The TEI listserv (TEI-L) TEI Wiki: http://www.tei-c.org/wiki/index.php/Main_Page Teach Yourself TEI: http://www.tei-c.org/Support/Learn/tutorials.xml Guidelines for Text Encoding and Interchange: http://quod.lib.umich.edu/t/tei/ A Gentle Introduction to XML: http://www.tei-c.org/release/doc/tei-p4-doc/html/SG.html A Companion to Digital Literary Studies: http://www.digitalhumanities.org/companion/DLS/ References

Xml Case Learns 2008

More Related Content

What's hot

Viewers also liked

Similar to Xml Case Learns 2008

Recently uploaded

Xml Case Learns 2008

Editor's Notes