ESDS Qualidata project recommendations

1 Project Documentation

1.1 Introduction

The first deliverable was the selection of TEI P5 elements suitable for encoding ESDS materials, the recommendation for how best to store the required metadata and structure the encoded documents. In addition a Relax NG schema was produced along with customised TEI documentation for this schema. This schema may be modified later in response to the evolving needs of the project. This file is authored as a TEI ODD XML file which then is passed through TEI Roma to produce schemas (RNG/RNC/XSD/DTD) and documentation (PDF/HTML). All changes should be made in the TEI ODD file rather than in the generated schemas or documentation.

1.2 Scope of Schema

In deciding the metadata scheme and forms of markup that should be used to encode the interviews, it was agreed that a very light encoding should be used. However, to allow for later expansion and re-purposing of the materials, and re-use of the schema, a number of extra elements have been included. While these certainly can be cut out now, it was thought that it might be more straightforward to include them now, rather than introduce them at a later date. The elements included number around 130, and while this may seem like a lot, it is a great reduction from the almost 500 elements the TEI currently contains. It could easily be further constrained to an extremely minimal schema if desired.

1.3 Processing of Files

As the project files are already producing them in a set XML format, it was recommended that they continue to produce these files in that format. The resulting files could then be converted en masse at an appropriate time in the future. Of the sample files provided, none were found to have structures that would not be able to be easily converted to the proposed TEI format. The recommendation was also that this should be done through XSLT. This also impacted the decision to not worry as much about the tightness of the schema, since the conversion will be under the control of ESDS.

1.4 Later Deliverables

It is believed that this inital proposed schema is robust enough to deal with the majority of the other deliverables, and the TEI ODD file will be edited to document these in due course and the documentation and schemas regenerated at that point.

1.5 Elements Included

Text Structure:: TEI, body, div, group, text.
TEI Header:: authority, availability, change, distributor, editorialDecl, equiment, extent, fileDesc, funder, idno, keywords, langUsage, language, noteStmt, principal, profileDesc, projectDesc, publicationStmt, recording, recordingStmt, revisionDesc, sourceDesc, sponsor, state, teiHeader, titleStmt.
Core:: abbr, addrLine, address, author, bibl, corr, date, desc, distinct, divGen, editor, emph, equiv, expan, foreign, gap, gloss, graphic, head, measure, mentioned, milestone, name, note, orig, p, pb, ptr, pubPlace, q, ref, reg, resp, respStmt, rs, sic, teiCorpus, term, title, unclear.
Corpus:: activity, firstLang, locale, particDesc, setting, settingDesc, textDesc.
Linking:: anchor, join, joinGrp, link, linkGrp, seg.
Names&Dates:: addName, affiliation, age, birth, death, education, faith, floruit, forename, genName, langKnowledge, langKnown, listPerson, nameLink, nationality, occasion, occupation, orgDivn, orgName, orgTitle, orgType, particLinks, persEvent, persName, persState, persTrait, person, personGrp, placeName, relation, residence, roleName, sex socecStatus, surname.
Spoken:: event, kinesic, pause, shift, u, vocal, writing.

1.6 Structure of Files

The recommendation is to use a single file per interview and any grouping of these to be done at a later stage if necessary. The basic structure should be:

Here the <TEI> element is in the TEI namespace, and XML comments are used to indicate missing data or notes. Each file should have a <teiHeader> (discussed below), followed by a <text> element. This should contain a <body> element and one <div> for the entire interview or for each section if it is segmented. Each utterance (in this kind of interview meant to mean speech by one person in usual turn-taking), is marked with a <u> element. This element must have a who attribute which should be a URI pointer pointing back up to the header where a <person> element has an xml:id defined for that person. Either generic xml:id's such as interviewer and subject can be used (and referenced in the <u> element's who attribute as #interviewer since it is a URI fragment) or specific ones relating solely to that file could be used.

These elements can be defined as:

<TEI> (TEI document) contains a single TEI-conformant document, comprising a TEI header and a text, either in isolation or as part of a teiCorpus element.
<teiHeader> (TEI Header) supplies the descriptive and declarative information making up an electronic title page prefixed to every TEI-conformant text.
<text> contains a single text of any kind, whether unitary or composite, for example a poem or drama, a collection of essays, a novel, a dictionary, or a corpus sample.
<body> (text body) contains the whole body of a single unitary text, excluding any front or back matter.
<div> (text division) contains a subdivision of the front, body, or back of a text.

<u> (utterance) a stretch of speech usually preceded and followed by silence or by a change of speaker.

who

indicates the person, or group of people, to whom the element content is ascribed.

1.7 The teiHeader

The <teiHeader> element should contain all the metadata for that particular interview. There are two major child elements of <teiHeader> for the purpose of this project:

<fileDesc> (File Description) contains a full bibliographic description of an electronic file.
<profileDesc> (text-profile description) provides a detailed description of non-bibliographic aspects of a text, specifically the languages and sublanguages used, the situation in which it was produced, the participants and their setting.

A template <fileDesc> might look like:

<fileDesc>
  <titleStmt>
   <title>


   </title>
   <title type="collection">


   </title>
  </titleStmt>
  <publicationStmt>
   <authority>


   </authority>
   <distributor>ESDS Qualidata</distributor>
   <idno type="intNum">


   </idno>
  </publicationStmt>
  <sourceDesc>
   <bibl>


   </bibl>
  </sourceDesc>
</fileDesc>

As much information as is available should be included. There are places for a lot more detail not shown in this simple template, consult the TEI guidelines for further information. The most important pieces of information here are the <title> and the <idno>, since these are what identify the file.

The <profileDesc> for this project will usually contain two important child elements:

<particDesc> (participation description) describes the identifiable speakers, voices, or other participants in a linguistic interaction.
<settingDesc> (setting description) describes the setting or settings within which a language interaction takes place, either as a prose description or as a series of setting elements.

The <particDesc >element should contain a listPerson element with at least two <person> elements defined, one for the subject and one for the interviewer. The <person> element for the subject should contain as much information as is available for the interviewee. Some pieces of information which can be recorded here include:

<affiliation> (affiliation) contains an informal description of a person's present or past affiliation with some organization, for example an employer or sponsor.
<age> specifies the age of a person.
<birth> (Birth details) contains information about a person's birth, such as its date and place.
<death> contains information about a person's death, such as its date and place.
<education> contains a description of the educational experience of a person.
<faith> specifies the faith, religion, or belief set of a person.
<floruit> contains information about a person's period of activity.
<langKnowledge> summarizes the state of a person's linguistic knowledge, either as prose or by a list of langKnown elements.
<nationality> contains an informal description of a person's present or past nationality or citizenship.
<occupation> contains an informal description of a person's trade, profession or occupation.
<sex> specifies the sex of a person.
<socecStatus> (socio-economic status) contains an informal description of a person's perceived social or economic status.
<persState> contains a description of some ongoing status or quality attributed to a person.
<persTrait> contains a description of a personal or culturally-determined characteristic attributed to a person.

For the purposes of this project, where known <age>, <birth>, <sex>, and <occupation> will be most commonly recorded. A template <person> element for a subject might look like this:

<person xml:id="subject">
  <persName type="unanonymised">


   <roleName type="honorific">


   </roleName>
   <forename>


   </forename>
   <surname>


   </surname>
  </persName>
  <birth date="1887">


  </birth>
  <occupation>


  </occupation>
  <sex value="1">


  </sex>
  <persState type="marriage">
   <p>


   </p>
  </persState>
</person>

There should always be a <person> element for both subject and interviewer even if there is no data available for the interviewer. This can consist merely of:

<person xml:id="interviewer">
<p>Interviewer Unknown</p>
</person>

The <settingDesc> element is a place to record information concerning the <setting> of the interview. A template of this might look like:

In addition to the <date> and <locale>, the <activity> a subject is undertaking whilst being interviewed (e.g. 'sewing', 'driving', 'skiing') amongst other information can be recorded if known.

1.8 Transcription of Speech

As mentioned above each utterance should be in a <u> element. This should look something like:

The important aspects are: the who attribute (which should point to the xml:id of a <person> in the header), and the xml:id which should be consecutively numbered from u1.

There are various optional phrase-level elements available if the project's needs eventually call for them.

These include phenomena of interest in spoken corpora such as:

<event> (Event) any phenomenon or occurrence, not necessarily vocalized or communicative, for example incidental noises or other events affecting communication.
<kinesic> (Non-vocalized quasi-lexical) any communicative phenomenon, not necessarily vocalized, for example a gesture, frown, etc.
<pause> a pause either between or within utterances.
<shift> (Shift) marks the point at which some paralinguistic feature of a series of utterances by any one speaker changes.
<vocal> (Vocalized semi-lexical) any vocalized but not necessarily lexical phenomenon, for example voiced pauses, non-lexical backchannels, etc.
<writing> (Writing) a passage of written text revealed to participants in the course of a spoken text.
<gap> (omitted material) indicates a point where material has been omitted in a transcription, whether for editorial reasons described in the TEI header, as part of sampling practice, or because the material is illegible or inaudible.

As well as those commonly used in such transcriptions:

<abbr> (abbreviation) contains an abbreviation of any sort.
<corr> (correction) contains the correct form of a passage apparently erroneous in the copy text.
<distinct> (distinct) identifies any word or phrase which is regarded as linguistically distinct, for example as archaic, technical, dialectal, non-preferred, etc., or as forming part of a sublanguage.
<emph> (emphasized) marks words or phrases which are stressed or emphasized for linguistic or rhetorical effect.
<expan> (expansion) contains the expansion of an abbreviation.
<foreign> (foreign) identifies a word or phrase as belonging to some language other than that of the surrounding text.
<gap> (omitted material) indicates a point where material has been omitted in a transcription, whether for editorial reasons described in the TEI header, as part of sampling practice, or because the material is illegible or inaudible.
<mentioned> marks words or phrases mentioned, not used.
<orig> (original form) contains a reading which is marked as following the original, rather than being normalized or corrected.
<ref> defines a reference to another location, possibly modified by additional text or comment.
<reg> (regularization) contains a reading which has been regularized or normalized in some sense.
<sic> contains text reproduced although apparently incorrect or inaccurate.
<soCalled> (so called) contains a word or phrase for which the author or narrator indicates a disclaiming of responsibility, for example by the use of scare quotes or italics.
<unclear> contains a word, phrase, or passage which cannot be transcribed with certainty because it is illegible or inaudible in the source.

1.9 Name and Dates

There are a variety of elements available for recording names and dates both in the header and outside it. In general the <date> element should be given W3C or ISO standard values, these also have an existing standard formulation for date ranges and durations. Some of the elements available include:

<addName> (additional name) contains an additional name component, such as a nickname, epithet, or alias, or any other descriptive phrase used within a personal name.
<address> contains a postal or other address, for example of a publisher, an organization, or an individual.
<addrLine> contains one line of a postal or other address.
<date> contains a date in any format.
<forename> (forename) contains a forename, given or baptismal name.
<genName> contains a name component used to distinguish otherwise similar names on the basis of the relative ages or generations of the persons named.
<name> (name, proper noun) contains a proper noun or noun phrase.
<nameLink> (name link) contains a connecting phrase or link used within a name but not regarded as part of it, such as van der or of.
<orgDivn> (organizational division) indicates a division, branch or department specified in an organizational name.
<orgName> (organization name) contains an organizational name.
<orgTitle> (organization title) contains the proper name component of an organizational name.
<orgType> (organization type) indicates a part of the organization name which contains information about the organization's structure or function.
<persName> (personal name) contains a proper noun or proper-noun phrase referring to a person, possibly including any or all of the person's forenames, surnames, honorifics, added names, etc.
<placeName> (place name) contains an absolute or relative place name.
<roleName> (roleName) contains a name component which indicates that the referent has a particular role or position in society, such as an official title or rank.
<surname> (surname) contains a family (inherited) name, as opposed to a given, baptismal, or nick name.

1.10 ID references with xml:id

As mentioned previously, the who attribute on the <u> element should refer back to an xml:id reference in the header. If generalised xml:id's are used (e.g. interviewer and subject), then a possible problem occurs if all the interviews are later treated as a corpus and collected into a separate file under a <teiCorpus> structure. (If this is done, the TEI recommends that this should be done using XInclude, rather than physically copying the files into one large file.) However this is done, the various xml:id's would no longer be unique, and thus the master file would fail to validate.

A simple transformation would be recommended before any such gathering together of the files. What this would do is replace all xml:id's with a compound based on the unique <idno> element in the header. Thus, if an interview's <idno> might be int0004, then the xml:id's in this file might be transformed simply to such things as int0004-interviewer and int0004-subject. Care must also be taken to transform any references to these, most notably in the who attribute of each utterance. This entire process is quite easily scriptable with XSLT, so should be of little concern, however I felt it worth mentioning here.

2 Schema Documentation

Classes defined

att.ascribed

att.ascribed provides attributes for elements representing speech or action that can be ascribed to a specific individual.

Attributes

(In addition to global attributes)

who	indicates the person, or group of people, to whom the element content is ascribed.
	Status:
	Datatype: `data.pointers`
	Values: For transcribed speech, this will typically identify a participant or participant group; in other contexts, it will point to any identified `<person>` element.

Members change event kinesic pause q setting u vocal writing

Module tei

att.datable

att.datable provides attributes for normalization of elements that contain datable events.

Attributes

(In addition to global attributes)

notBefore	specifies the earliest possible date for the event in standard form, e.g. yyyy-mm-dd.
	Status: Optional
	Datatype: `data.temporal`
	Values: Any string representing a date in a standard W3C date format
notAfter	specifies the latest possible date for the event in standard form, e.g. yyyy-mm-dd.
	Status: Optional
	Datatype: `data.temporal`
	Values: Any string representing a date in a standard W3C date format
from	indicates the starting point of the period in standard form.
	Status: Optional
	Datatype: `data.temporal`
	Values: A normalized form of temporal expression conforming to the W3C XML Schema Part 2: Datatypes Second Edition, except that times may be expressed with reduced precision (i.e., to the minute or the hour).
to	indicates the ending point of the period in standard form.
	Status: Optional
	Datatype: `data.temporal`
	Values: A normalized form of temporal expression conforming to the W3C XML Schema Part 2: Datatypes Second Edition, except that times may be expressed with reduced precision (i.e., to the minute or the hour).

Members affiliation age birth date death education faith floruit langKnowledge langKnown nationality persEvent persName persState persTrait relation residence sex socecStatus

Module tei

att.datePart

att.datePart (attributes for temporal expression) attributes for component elements of temporal expressions involving dates and time

Attributes

(In addition to global attributes)

value	supplies the value of a date or time in a standard form.
	Status: Optional
	Datatype: `data.temporal`
	Values: Any string representing a valid date, time, or one of a variety of combinations.
	Example: Examples of W3C date, time, and date & time formats. <date value="1945-10-24">24 Oct 45</date> <date value="1996-09-24T07:25Z">September 24th, 1996 at 3:25 in the morning</date> <time value="1999-01-04T20:42-05:00">Jan 4 1999 at 8 pm</time> <time value="14:12:38">fourteen twelve and 38 seconds</time> <date value="1962-10">October of 1962</date> <date value="--06-12">June 12th</date> <date value="---01">the first of each month</date> <date value="--08">August</date> <date value="2006">MMVI</date>
	Example: Examples of time formats with reduced precision. <date value="2006-05-18T10:03+09:00">a few minutes after ten in the morning on Thu 18 May</date> <time value="03:00">3 A.M.</time> <time value="12">around noon</time> Software intended for use with W3C XML Schema datatypes may be unable to properly process times expressed with reduced precision.
	Example: A usage example of `<date>`. This list begins in the year 1632, more precisely on Trinity Sunday, i.e. the Sunday after Pentecost, in that year the <date calendar="Julian" value="1632-06-06">27th of May (old style)</date>.
	Example: A usage example of `<time>`. He likes to be punctual. I said <q> <time value="12">around noon</time> </q>, and he showed up at <time value="12:00:00">12 O'clock</time> on the dot.
	The value of the value attribute is a string representing a date, date & time, or time, in any one of the following forms: a date in any of the standard formats described by XML Schema Part 2: Datatypes Second Edition a time in the standard format described by XML Schema Part 2: Datatypes Second Edition, i.e. `hh:mm:ss` a combined date and time in any of the standard formats described by XML Schema Part 2: Datatypes Second Edition a time or combined date & time in the standard format as above, but with reduced precision (the minutes or minutes & seconds may be omitted — e.g., 12 and 12:00 are permitted to indicate noon, in addition to 12:00:00) The value of value is constrained to be in one of the date, time, or combined date & time formats recognized by the W3C XML Schema Part 2: Datatypes specification, except that times may be expressed with reduced precision. This is true whether the date component (if any) is a Gregorian or a proleptic Gregorian date.
dur	(duration) indicates the length of this element in time.
	Status: Optional
	Datatype: `xsd:duration`
	Example: Examples of W3C durations. <distance dur="PT45M">forty-five minutes</distance> <distance dur="P1DT12H">a day and a half</distance> <distance dur="P7D">a week</distance> <distance dur="PT0.02S">20 ms</distance>
	If both value and dur are specified, the values should be interpreted as indicating a span of time by its starting time (or date) and duration. These Guidelines do not provide a method for expressing a time range by a duration and its ending time.

Note

In providing a ‘regularized’ form, no claim is made that the form in the source text is incorrect; the regularized form is simply that chosen as the main form for purposes of unifying variant forms under a single heading.

Members date occasion

Module tei

att.declarable

att.declarable provides attributes for those elements in the TEI Header which may be independently selected by means of the specialpurpose decls attribute.

Attributes

(In addition to global attributes)

default indicates whether or not this element is selected by default when its parent is selected.

Status: Mandatory when applicable

Datatype: xsd:boolean

Default: false

Legal values are:

true	(This element is selected if its parent is selected)
false	(This element can only be selected explicitly, unless it is the only one of its kind, in which case it is selected if its parent is selected.)

Note

The rules governing the association of declarable elements with individual parts of a TEI text are fully defined in chapter . Only one element of a particular type may have a default attribute with a value of true.

Members bibl editorialDecl equipment langUsage listPerson particDesc projectDesc recording settingDesc sourceDesc textDesc

Module tei

att.declaring

att.declaring provides attributes for elements which may be independently associated with a particular declarable element within the header, thus overriding the inherited default for that element.

Attributes

(In addition to global attributes)

decls	identifies one or more declarable elements within the header, which are understood to apply to the element bearing this attribute and its content.
	Status: Mandatory when applicable
	Datatype: `data.pointers`
	Values: must identify a set of declarable elements of different types.

Note

The rules governing the association of declarable elements with individual parts of a TEI text are fully defined in chapter .

Members body div gloss group ptr ref term text u

Module tei

att.divLike

att.divLike provides a set of attributes common to all elements which behave in the same way as divisions.

Class att.metrical

Attributes

(In addition to global attributes and those inherited from [att.metrical ] )

type specifies a name conventionally used for this level of subdivision, e.g. act, volume, book, section, canto, etc.

Status: Recommended

Datatype: data.enumerated

Values: any string of characters

org specifies how the content of the division is organized.

Status: Optional

Default: uniform

Legal values are:

composite	(composite content: i.e. no claim is made about the sequence in which the immediate contents of this division are to be processed, or their inter-relationships.)
uniform	(uniform content: i.e. the immediate contents of this element are regarded as forming a logical unit, to be processed in sequence.)

sample indicates whether this division is a sample of the original source and if so, from which part.

Status: Optional

Default: complete

Legal values are:

initial	(division lacks material present at end in source.)
medial	(division lacks material at start and end.)
final	(division lacks material at start.)
unknown	(position of sampled material within original unknown.)
complete	(division is not a sample.)

part specifies whether or not the division is fragmented by some other structural element, for example a speech which is divided between two or more verse stanzas.

Status: Mandatory when applicable

Default: N

Legal values are:

Y	(the division is incomplete in some respect)
N	(either the division is complete, or no claim is made as to its completeness.)
I	(the initial part of an incomplete division)
M	(a medial part of an incomplete division)
F	(the final part of an incomplete division)

The values I, M, or F should be used only where it is clear how the division is to be reconstituted.

Members div

Module tei

att.editLike

att.editLike provides attributes describing the nature of a encoded scholarly intervention or interpretation of any kind.

Attributes

(In addition to global attributes)

cert signifies the degree of certainty associated with the intervention or interpretation.

Status: Optional

Datatype: data.enumerated

Values are:

high	(a high degree of certainty is associated with the encoded intervention.)
medium	(the encoder is reasonably certain of the appropriateness of the intervention)
low	(the encoded intervention is doubtful or uncertain)

resp indicates the agency responsible for the intervention or interpretation, for example an editor or transcriber.

Status: Optional

Datatype: data.pointer

Values: A pointer to an element in the document header that is associated with a person asserted as responsible for some aspect of the text's creation, transcription, editing, or encoding.

evidence indicates the nature of the evidence supporting the reliability or accuracy of the intervention or interpretation.

Status: Optional

Datatype: data.enumerated

Sample values include:

internal	(there is internal evidence to support the intervention.)
external	(there is internal evidence to support the intervention.)
conjecture	(the intervention or interpretation has been made by the editor, cataloguer, or scholar on the basis of their expertise.)

Note

The members of this attribute class are typically used to represent any kind of editorial intervention in a text, for example a correction or interpretation, or to date or localize manuscripts etc.

Members affiliation age birth corr date death education expan faith floruit gap langKnowledge langKnown nationality persEvent persName persState persTrait reg relation residence sex socecStatus unclear

Module tei

att.global

att.global provides a set of attributes common to all elements in the TEI encoding scheme.

Class att.global.linking att.global.analytic

Attributes

(In addition to global attributes and those inherited from [att.global.linking att.global.analytic ] )

xml:space signals an intention that white space should be preserved by applications

Status: Optional

Legal values are:

default
preserve

The XML specification provides further guidance on the use of this attribute.

xml:id provides a unique identifier for the element bearing the attribute.

Status: Optional

Datatype: xsd:ID

Values: any valid XML identifier .

The xml:id attribute may be used to specify a canonical reference for an element; see section .

n gives a number (or other label) for an element, which is not necessarily unique within the document.

Status: Optional

Datatype: data.words

Values: any string of characters; often, but not necessarily, numeric.

The n attribute may be used to specify the numbering of chapters, sections, list items, etc.; it may also be used in the specification of a standard reference system for the text.

xml:lang indicates the language of the element content using the codes from RFC 3066

Status: Optional

Datatype: data.language

Values: The value must conform to RFC 3066 or its succesor. If the value is a private use code (i.e., starts with x-) it should, and if not it may, match the value of an ident attribute of a <language> element supplied in the TEI Header of the current document.

If no value is specified for xml:lang, the xml:lang value for the immediately enclosing element is inherited; for this reason, a value should always be specified on the outermost element (<TEI>).

rend indicates how the element in question was rendered or presented in the source text.

Status: Optional

Datatype: data.words

Values: any string of characters; if the typographic rendition of a text is to be systematically recorded, a systematic set of values for the rend attribute should be defined.

Example:

<head rend="align(center) slant(upright) case(allcaps)">
<lb/>To The
<lb/>Duchesse
<lb/>of
<lb/>Newcastle,
<lb/>On Her
<lb/>
<hi rend="case(mixed)">New Blazing-World</hi>.
</head>

[Note: From the forward by William Newcastle in Margaret Cavendish, Duchess of Newcastle's The description of a new world, called the blazing-world, WWP TR00253]

These Guidelines make no binding recommendations for the values of the rend attribute; the characteristics of visual presentation vary too much from text to text and the decision to record or ignore individual characteristics varies too much from project to project. Some potentially useful conventions are noted from time to time at appropriate points in the Guidelines.

xml:base provides a base URI reference with which applications can resolve relative URI references into absolute URI references.

Status: Optional

Datatype: data.pointer

Values: any syntactically valid URI reference.

Example:

<div type="bibl">
  <head>Bibliography</head>
  <listBibl xml:base="http://www.lib.ucdavis.edu/BWRP/Works/">
   <bibl n="1">
    <author>
     <name>Landon, Letitia Elizabeth</name>
    </author>
    <ref target="LandLVowOf.sgm">
     <title>The Vow of the Peacock</title>
    </ref>
   </bibl>
   <bibl n="2">
    <author>
     <name>Compton, Margaret Clephane</name>
    </author>
    <ref target="NortMIrene.sgm">
     <title>Irene, a Poem in Six Cantos</title>
    </ref>
   </bibl>
   <bibl n="3">
    <author>
     <name>Taylor, Jane</name>
    </author>
    <ref target="TaylJEssay.sgm">
     <title>Essays in Rhyme on Morals and Manners</title>
    </ref>
   </bibl>
  </listBibl>
</div>

Note

The global attributes described here are made part of the attribute definition list declaration of each element by including a reference to the pattern att.global.attributes in each such declaration. Some global attributes are made available when certain additional tag sets are selected; these are incorporated into the global attributes by references to the appropriate patterns. When the tag sets in question have not been selected, the patterns in question expand to the empty string.

Members

Module tei

att.global.linking

att.global.linking defines a set of attributes for hypertext and other linking, which are enabled for all elements when the additional tag set for linking is selected.

Attributes

(In addition to global attributes)

corresp	points to elements that correspond to the current element in some way.
	Status: Optional
	Datatype: `data.pointers`
	Values: one or more URIs, separated by white space.

synch	points to elements that are synchronous with the current element.
	Status: Optional
	Datatype: `data.pointers`
	Values: one or more URIs, separated by white space.

sameAs	points to an element that is the same as the current element.
	Status: Optional
	Datatype: `data.pointer`
	Values: a URI.
copyOf	points to an element of which the current element is a copy.
	Status: Optional
	Datatype: `data.pointer`
	Values: a URI.
	Any content of the current element should be ignored. Its true content is that of the element being pointed at.
next	points to the next element of a virtual aggregate of which the current element is part.
	Status: Optional
	Datatype: `data.pointer`
	Values: a URI.
prev	points to the previous element of a virtual aggregate of which the current element is part.
	Status: Optional
	Datatype: `data.pointer`
	Values: a URI.
exclude	points to elements that are in exclusive alternation with the current element.
	Status: Optional
	Datatype: `data.pointers`
	Values: one or more URIs, separated by white space.
select	selects one or more alternants; if one alternant is selected, the ambiguity or uncertainty is marked as resolved. If more than one alternant is selected, the degree of ambiguity or uncertainty is marked as reduced by the number of alternants not selected.
	Status: Optional
	Datatype: `data.pointers`
	Values: one or more URIs, separated by white space.
	This attribute should be placed on an element which is superordinate to all of the alternants from which the selection is being made.

Members att.global

Module linking

att.measurement

att.measurement provides attributes to represent a regularized or normalized measurement.

Attributes

(In addition to global attributes)

unit indicates the units used for the measurement, usually using the standard symbol for the desired units.

Status: Optional

Datatype: data.enumerated

Suggested values include:

m	(metre) SI base unit of length
kg	(kilogram) SI base unit of mass
s	(second) SI base unit of time
Hz	(hertz) SI unit of frequency
Pa	(pascal) SI unit of pressure or stress
Ω	(ohm) SI unit of electric resistance
L	(litre) 1 dm³
t	(tonne) 10³ kg
ha	(hectare) 1 hm²
Å	(ångström) 10⁻¹⁰ m
mL	(millilitre)
cm	(centimetre)
dB	(decibel) see remarks, below
kbit	(kilobit) 10³ or 1000 bits
Kibit	(kibibit) 2¹⁰ or 1024 bits
kB	(kilobyte) 10³ or 1000 bytes
KiB	(kibibyte) 2¹⁰ or 1024 bytes
MB	(megabyte) 10⁶ or 1 000 000 bytes
MiB	(mebibyte) 2²⁰ or 1 048 576 bytes

If the measurement being represented is not expressed in a particular unit, but rather is a number of discrete items, the unit count should be used, or the unit attribute may be left unspecified.

Wherever appropriate, a recognised SI unit name should be used (see further http://www.bipm.org/en/si/ ; http://physics.nist.gov/cuu/Units/ ). The list above is indicative rather than exhaustive.

quantity specifies the number of the specified units that comprise the measurement

Status: Optional

Datatype: data.numeric

commodity indicates the substance that is being measured

Status: Optional

Datatype: data.words

In general, when the commodity is made of discrete entities, the plural form should be used, even when the measurement is of only one of them.

Note

This attribute class provides a triplet of attributes that may be used either to regularize the values of the measurement being encoded, or to normalize them with respect to a standard measurement system.

<l>So weren't you gonna buy <measure quantity="0.5" unit="gal" commodity="ice cream">half a gallon</measure>, baby</l>
<l>So won't you go and buy <measure quantity="1.893" unit="L" commodity="ice cream">half a gallon</measure>, baby?</l>

Members measure

Module tei

att.naming

att.naming provides attributes common to elements which refer to named persons, places, organizations etc.

Attributes

(In addition to global attributes)

key	provides a means of locating a full definition for the entity being named such as a database record key or a URI.
	Status: Optional
	Datatype: `data.key`
	Values: any string of Unicode characters
	The value may be a unique identifier from a database, or any other externally-defined name for the referent.

Members affiliation birth death education name nationality persEvent persName persState persTrait placeName pubPlace relation residence rs socecStatus

Module tei

att.personal

att.personal (attributes for components of personal names) common attributes for those elements which form part of a personal name.

Attributes

(In addition to global attributes)

type provides more culture- linguistic- or application- specific information used to categorize this name component.

Status: Mandatory when applicable

Datatype: data.enumerated

Values: one of a set of codes defined for the application.

full indicates whether the name component is given in full, as an abbreviation or simply as an initial.

Status: Optional

Default: yes

Legal values are:

yes	(the name component is spelled out in full.)
abb	(the name component is given in an abbreviated form.)
init	(the name component is indicated only by one initial.)

sort specifies the sort order of the name component in relation to others within the personal name.

Status: Optional

Datatype: xsd:nonNegativeInteger

Values: A positive number indicating the sort order.

Members addName forename genName nameLink roleName surname

Module namesdates

att.placement

att.placement provides attributes for describing where on the source page or object a textual element appears.

Attributes

(In addition to global attributes)

place

Status: Recommended

Datatype: data.enumerated

Suggested values include:

infralinear	(below the line)
margin-bot	(in bottom margin)
margin-left	(in left margin)
margin-right	(in right margin)
margin-top	(in top margin)
opposite	(on opposite page)
overleaf	(on the other side of the leaf)
supralinear	(above the line)
verso	(on verso of sheet)
app	(note appears in the apparatus at the foot of the page.)
end	(note appears at end of chapter or volume.)
foot	(note appears at foot of page.)
inline	(note appears as a marked paragraph in the body of the text.)
interlinear	(note appears between lines of the text; a less precise form of either infralinear or supralinear.)
inline	(addition is made in a space left in the witness by an earlier scribe.)
mixed	(one or more of the other values)

Members note

Module tei

att.pointing

att.pointing defines a set of attributes used by all elements which point to other elements by means of one or more URI references.

Attributes

(In addition to global attributes)

type categorizes the pointer in some respect, using any convenient set of categories.

Status: Optional

Datatype: data.word

Values: Any string of XML name characters. The type should indicate the intended function of the pointer, or the rhetorical relationship between its source and target.

evaluate specifies the intended meaning when the target of a pointer is itself a pointer.

Status: Optional

Legal values are:

all	(if the element pointed to is itself a pointer, then the target of that pointer will be taken, and so on, until an element is found which is not a pointer.)
one	(if the element pointed to is itself a pointer, then its target (whether a pointer or not) is taken as the target of this pointer.)
none	(no further evaluation of targets is carried out beyond that needed to find the element specified in the pointer's target.)

If no value is given, the application program is responsible for deciding (possibly on the basis of user input) how far to trace a chain of pointers.

Members att.pointing.group [joinGrp linkGrp ] join link ptr ref

Module linking

att.pointing.group

att.pointing.group defines a set of attributes common to all elements which enclose groups of pointer elements.

Class att.pointing

Attributes

(In addition to global attributes and those inherited from [att.pointing ] )

domains	optionally specifies the identifiers of the elements within which all elements indicated by the contents of this element lie.
	Status: Optional
	Datatype: `list { data.name, data.name+ }`
	Values: a list of at least two generic identifiersnames, separated by whitespace.
	If this attribute is supplied every element specified as a target must be contained within the element or elements named by it. An application may choose whether or not to report failures to satisfy this constraint as errors, but may not access an element of the right identifier but in the wrong context. If this attribute is not supplied, then target elements may appear anywhere within the target document.
targFunc	describes the function of each of the values of the targets attribute of the enclosed link, join or alt tags.
	Status: Optional
	Datatype: `list { data.word, data.word+ }`
	Values: a list of at least two valid names, separated by whitespace.
	The number of separate values must match the number of values in the targets attribute in the enclosed `<link>`, `<join>` or `<alt>` tags (an intermediate `<ptr>` element may be needed to accomplish this). It should also match the number of values in the targType and domains attributes of the current tag, if those have been specified.

Members joinGrp linkGrp

Module linking

att.segLike

att.segLike provides attributes for elements used for arbitrary segmentation.

Class att.metrical

Attributes

(In addition to global attributes and those inherited from [att.metrical ] )

type characterizes the type of segment.

Status: Optional

Datatype: data.enumerated

Values: For a <cl> may take values such as finite, nonfinite, declarative, interrogative, relative etc. For a <phr> or <w>, values such as noun, verb, preposition, etc., may be used. For an <m> element, values such as clitic, prefix, stem will be more appropriate. For a <c> element, values such as letter, punctuation, digit may be used.

function characterizes the function of the segment.

Status: Optional

Datatype: data.enumerated

Values: For a <cl>, may take values such as coordinate, subject, adverbial etc. For a <phr>, such values as subject, predicate etc. may be more appropriate.

part specifies whether or not the segment is fragmented by some other structural element, for example a clause which is divided between two or more sentences.

Status: Mandatory when applicable

Default: N

Legal values are:

Y	(the segment is incomplete in some respect)
N	(either the segment is complete, or no claim is made as to its completeness)
I	(the initial part of an incomplete segment)
M	(a medial part of an incomplete segment)
F	(the final part of an incomplete segment)

The values I, M, or F should be used only where it is clear how the segment is to be reconstituted.

Members seg

Module tei

att.spanning

att.spanning provides attributes for elements which delimit a span of text by pointing mechanisms rather than by enclosing it.

Attributes

(In addition to global attributes)

spanTo	indicates the end of a span initiated by the element bearing this attribute.
	Status: Mandatory when applicable
	Datatype: `data.pointer`
	Values: points to an element following this one in the current document.

Note

The span is defined as running in document order from the start of the content of the pointing element (if any) to the end of the content of the element pointed to by the spanTo attribute (if any). If no value is supplied for the attribute, the assumption is that the span is coextensive with the pointing element.

Members index

Module tei

att.timed

att.timed provides a set of attributes common to those elements which have a duration in time, expressed either absolutely or by reference to an alignment map.

Attributes

(In addition to global attributes)

start	indicates the location within a temporal alignment at which this element begins.
	Status: Optional
	Datatype: `data.pointer`
	Values: contains the identifier of a previously defined `<loc>` element
	If no value is supplied, the element is assumed to follow the immediately preceding element at the same hierarchic level.
end	indicates the location within a temporal alignment at which this element ends.
	Status: Optional
	Datatype: `data.pointer`
	Values: contains the identifier of a previously defined `<loc>` element
	If no value is supplied, the element is assumed to precede the immediately following element at the same hierarchic level.
dur	(duration) indicates the length of this element in time
	Status: Optional
	Datatype: `xsd:duration`

Members event kinesic pause u vocal

Module tei

att.translatable

att.translatable provides attributes used to indicate the status of a translatable portion of an ODD document.

Attributes

(In addition to global attributes)

version	specifies the version name or number of the source from which the translated version was derived
	Status: Optional
	Datatype: `data.word`
	The version may be a number, a letter, or a date

Members desc gloss

Module tei

att.typed

att.typed provides generic attributes which can be used to classify or subclassify elements in any way.

Attributes

(In addition to global attributes)

type	characterizes the element in some sense, using any convenient classification scheme or typology.
	Status: Optional
	Datatype: `data.word`
subtype	provides a sub-categorization of the element, if needed
	Status: Optional
	Datatype: `data.word`
	The subtype attribute may be used to provide any sub-classification for the element, additional to that provided by its type attribute.

Note

The typology used may be formally defined using the the <classification> element of the <encodingDesc> within the associated TEI header, or informally as descriptive prose within the <encodingDesc> element.

Members anchor date listPerson occasion pause persEvent persState persTrait term

Module tei

model.addrPart

model.addrPart	(address part) groups elements which may constitute a postal or other form of address.
Members	addrLine model.nameLike [model.nameLike.agent placeName rs ]
Module	tei

model.assertLike

model.assertLike	the class of elements concerning which assertions are made, for example as parts of a biographical element.
Class	model.personPart
Members	model.persEventLike [birth death persEvent ] model.persStateLike [affiliation education floruit occupation persName persState residence ] model.persTraitLike [age faith langKnowledge nationality persTrait sex socecStatus ]
Module	tei

model.biblLike

model.biblLike	groups elements containing a bibliographic description.
Class	model.inter model.common
Members	bibl listPerson
Module	tei

model.biblPart

model.biblPart	(bibliographic citation part) groups elements which can appear only within bibliographic citation elements.
Note	This class is used in defining the content model of the `<bibl>` and `<biblItem>` elements.
Members	distributor extent idno model.imprintPart [pubPlace publisher ] model.respLike [author editor respStmt ] note
Module	tei

model.blockLike

model.blockLike	groups segmenting elements.
Members	seg
Module	tei

model.catDescPart

model.catDescPart	groups elements which may be used inside catDesc and appear multiple times
Members	textDesc
Module	tei

model.choicePart

model.choicePart	groups those elements (other than choice itself) which can be used in choice alternation
Members	abbr corr expan orig reg seg sic unclear
Module	tei

model.common

model.common	groups common chunk- and inter-level elements.
Note	This class defines the set of chunk- and inter-level elements available in all bases; it is used in defining the standard models chunk.seq and macro.specialPara in the general and mixed bases.
Members	model.biblLike [bibl listPerson ] model.divPart [p ] model.listLike model.noteLike [note ] model.oddDecl model.oddRef model.qLike [q ]
Module	tei

model.dateLike

model.dateLike	(dates and date ranges) groups elements containing a date specifications.
Class	model.pPart.data model.recordingPart
Note	This class allows certain content models to allow either a single date or a date-range element.
Members	date
Module	tei

model.datePart

model.datePart	(temporal expression) groups component elements of temporal expressions involving dates and time.
Members	occasion
Module	tei

model.divPart

model.divPart	groups elements which can occur between, but not within, paragraphs and other chunks.
Class	model.common
Note	Note that this element class does not include members of the inter class, which can appear either within or between chunks. Unlike elements of that class, chunks cannot occur within chunks.
Members	p
Module	tei

model.divPart.spoken

model.divPart.spoken	groups those elements which appear at the component level in spoken texts only.
Members	event kinesic pause shift u vocal writing
Module	spoken

model.divWrapper

model.divWrapper	(top-of-div elements) groups elements which can occur at the start of any division class element.
Members	head
Module	tei

model.encodingPart

model.encodingPart	groups elements which may be used inside encodingDesc and appear multiple times
Members	editorialDecl projectDesc
Module	header

model.entryParts.top

model.entryParts.top	(dictionary high-level elements) groups related parts of a dictionary entry forming a coherent subdivision, for example a particular sense, homonym, etc.
Members	note
Module	tei

model.featureVal

model.featureVal	(feature values) groups all elements which represent feature values in feature structures.
Members	model.complexVal model.singleVal
Module	tei

model.frontPart

model.frontPart	groups elements which appear at the level of divisions within front or back matter.
Members	divGen model.frontPart.drama
Module	tei

model.global

model.global	(global inclusions) groups empty elements which may appear at any point within a TEI text.
Members	anchor model.global.edit [gap ] model.global.meta [index join joinGrp link linkGrp ] model.milestoneLike [milestone pb ]
Module	tei

model.global.edit

model.global.edit	groups empty elements which perform a specifically editorial function, for example by indicating the start of a span of text added, deleted, or missing in a source.
Class	model.global
Note	Members of this class can appear anywhere within a document, between or within components or phrases.
Members	gap
Module	tei

model.global.meta

model.global.meta	groups empty elements which describe the status of other elements, for example by holding groups of links or of abstract interpretations, or by providing indications of certainty etc., and which may appear at any point in a document.
Class	model.global
Note	Encoders may find it convenient to localize all metadata elements, for example to contain them within the same divison as the elements that they relate to; or to locate them all to a division of their own. They may however appear at any point in a TEI text.
Members	index join joinGrp link linkGrp
Module	tei

model.glossLike

model.glossLike	groups elements which provide an alternative name, explanation, or description for any markup construct.
Members	desc gloss
Module	tei

model.graphicLike

model.graphicLike	(images, formulae, examples, etc.) groups elements containing images, formulae, examples, and similar objects
Class	model.phrase
Members	graphic
Module	tei

model.headerPart

model.headerPart	groups elements which may be used inside teiHeader and appear multiple times
Members	profileDesc
Module	header

model.hiLike

model.hiLike	groups phrase-level elements related to highlighting.
Class	model.phrase
Members	distinct emph foreign gloss mentioned soCalled term title
Module	tei

model.imprintPart

model.imprintPart	groups the bibliographic elements which occur inside imprints.
Class	model.biblPart
Members	pubPlace publisher
Module	tei

model.inter

model.inter	groups elements of the intermediate (inter-level) class: these elements can occur both within and and between paragraphs or other chunk-level elements.
Note	This element class contains a subset of those elements which can appear in the unstructured ‘soup’ with which paragraph and other elements at the lowest level of crystal structures are filled: specifically all the elements which can also occur as structural elements in their own right. In prose, this means the elements in this class can appear both within and between paragraphs. This class is thus distinct from the purely phrase-level elements which can appear only within soup, and not on their own; the latter class, in keeping with this metaphor, is called ‘broth’; it is represented by the class phrase. Cf. also the class chunks.
Members	model.biblLike [bibl listPerson ] model.listLike model.noteLike [note ] model.oddDecl model.oddRef model.qLike [q ] model.stageLike text
Module	tei

model.measureLike

model.measureLike	(numbers, amounts, measurements, etc.) groups elements which denote a number, a quantity, a measurement, or similar piece of text that conveys some numerical meaning
Class	model.pPart.data
Members	measure
Module	tei

model.milestoneLike

model.milestoneLike	(reference system elements) groups milestone-style elements used to represent reference systems
Class	model.global
Members	milestone pb
Module	tei

model.msItemPart

model.msItemPart	The class of elements which can appear within a manuscript item description.
Members	bibl model.respLike [author editor respStmt ] note q title
Module	tei

model.nameLike

model.nameLike	(names of people, places, or organizations, or refering strings) groups those elements which name or refer to a person, place (man-made or geographic), or organization
Class	model.addrPart model.pPart.data
Note	A superset of the naming elements that may appear in datelines, addresses, statements of responsibility, etc.
Members	model.nameLike.agent [name orgName persName ] placeName rs
Module	tei

model.nameLike.agent

model.nameLike.agent	groups elements which contain names of individuals or corporate bodies.
Class	model.nameLike
Note	This class is used in the content model of elements which reference names of people or organizations.
Members	name orgName persName
Module	tei

model.noteLike

model.noteLike	groups all note-like elements.
Class	model.inter model.common
Members	note
Module	tei

model.pLike

model.pLike	The class of elements which are paragraphs for the purpose of interchange.
Members	p
Module	tei

model.pLike.front

model.pLike.front	(Front matter chunk elements) groups elements which can occur as direct constituents of front matter, when a full title page is not given.
Members	head
Module	tei

model.pPart.data

model.pPart.data	groups phrase-level elements containing names, dates, numbers, measures, and similar data.
Class	model.phrase
Members	address model.dateLike [date ] model.measureLike [measure ] model.nameLike [model.nameLike.agent placeName rs ] model.timeLike
Module	tei

model.pPart.edit

model.pPart.edit	groups phrase-level elements for simple editorial correction and transcription.
Class	model.phrase
Members	abbr corr expan orig reg sic unclear
Module	tei

model.persEventLike

model.persEventLike	the class of elements describing specific events in a person's history, for example birth, marriage, appointment... These are not characteristics of an individual, but often cause an individual to gain such characteristics, or to enter a new state.
Class	model.assertLike
Members	birth death persEvent
Module	tei

model.persNamePart

model.persNamePart	(components of personal names) groups those elements which form part of a personal name.
Members	addName forename genName nameLink roleName surname
Module	namesdates

model.persStateLike

model.persStateLike	the class of elements describing changeable characteristics of a person which have a definite duration, for example occupation, residence, name... These characteristics of an individual are typically a consequence of their own action or that of others.
Class	model.assertLike
Members	affiliation education floruit occupation persName persState residence
Module	tei

model.persTraitLike

model.persTraitLike	the class of elements describing generally unchanging physical or socially-constructed characteristics of a person, for example hair-colour, ethnicity, sex... These characteristics of an individual are typically independent of their volition or action.
Class	model.assertLike
Members	age faith langKnowledge nationality persTrait sex socecStatus
Module	tei

model.personLike

model.personLike	the class of elements used to provide information about people and thir relationships.
Note	This class is referenced in the header module, but is not populated unless the namesdates module is loaded.
Members	listPerson person personGrp relation
Module	tei

model.personPart

model.personPart	groups elements which describe characteristics of the people referenced by a text, or participating in a language interaction.
Note	This class is used to define the content model for the `<person>` and `<personGrp>` elements.
Members	bibl model.assertLike [model.persEventLike model.persStateLike model.persTraitLike ] note
Module	tei

model.phrase

model.phrase	groups those elements which can occur at the level of individual words or phrases.
Note	This class of elements can occur only within larger elements of the class inter or chunk. In prose, this means these elements can occur within paragraphs, list items, lines of verse, etc.
Members	model.graphicLike [graphic ] model.hiLike [distinct emph foreign gloss mentioned soCalled term title ] model.lPart model.oddPhr model.pPart.data [address model.dateLike model.measureLike model.nameLike model.timeLike ] model.pPart.edit [abbr corr expan orig reg sic unclear ] model.pPart.msdesc model.ptrLike [ptr ref ] model.segLike [seg ]
Module	tei

model.profileDescPart

model.profileDescPart	groups elements which may be used inside profileDesc and appear multiple times
Members	langUsage particDesc settingDesc textDesc
Module	header

model.ptrLike

model.ptrLike	groups elements used for purposes of location and reference
Class	model.phrase
Members	ptr ref
Module	tei

model.publicationStmtPart

model.publicationStmtPart	(publication statement elements) groups the children of publicationStmt
Members	address authority availability date distributor idno pubPlace publisher
Module	tei

model.qLike

model.qLike	groups elements related to highlighting which can appear either within or between chunk-level elements.
Class	model.inter model.common
Members	q
Module	tei

model.recordingPart

model.recordingPart	(dates and date ranges) groups elements used to describe details of an audio or video recording
Members	equipment model.dateLike [date ] respStmt
Module	tei

model.respLike

model.respLike	groups elements which are used to indicate intellectual responsibility, for example within a bibliographic element.
Class	model.biblPart model.msItemPart
Members	author editor respStmt
Module	tei

model.segLike

model.segLike	groups elements used for arbitrary segmentation.
Class	model.phrase
Note	The principles on which segmentation is carried out, and any special codes or attribute values used, should be defined explicitly in the `<segmentation>` element of the `<encodingDesc>` within the associated TEI header.
Members	seg
Module	tei

model.settingPart

model.settingPart	elements used to describe the setting of a linguistic interaction.
Members	activity locale
Module	tei

model.sourceDescPart

model.sourceDescPart	groups elements which may be used inside sourceDesc and appear multiple times
Members	recordingStmt
Module	header

model.titlepagePart

model.titlepagePart	(Title page elements) groups those elements which can occur as direct constituents of a title page (docTitle, docAuth, docImprint, epigraph, etc.)
Members	graphic
Module	tei

Elements defined

<TEI>

TEI

(TEI document) contains a single TEI-conformant document, comprising a TEI header and a text, either in isolation or as part of a teiCorpus element.

Declaration

element TEI
{
   att.global.attribute.xmlspace,
   att.global.attribute.xmlid,
   att.global.attribute.n,
   att.global.attribute.xmllang,
   att.global.attribute.rend,
   att.global.attribute.xmlbase,
   att.global.linking.attribute.corresp,
   att.global.linking.attribute.synch,
   att.global.linking.attribute.sameAs,
   att.global.linking.attribute.copyOf,
   att.global.linking.attribute.next,
   att.global.linking.attribute.prev,
   att.global.linking.attribute.exclude,
   att.global.linking.attribute.select,
   attribute version { xsd:decimal }?,
   ( teiHeader, text )
}

A TEI Project

ESDS Qualidata project recommendations

1 Project Documentation

1.1 Introduction

1.2 Scope of Schema

1.3 Processing of Files

1.4 Later Deliverables

1.5 Elements Included

1.6 Structure of Files

1.7 The teiHeader

1.8 Transcription of Speech

1.9 Name and Dates

1.10 ID references with xml:id

2 Schema Documentation

Classes defined

Elements defined