3 Elements Available in All TEI Documents
Table of contents
- 3.1 Paragraphs
- 3.2 Treatment of Punctuation
- 3.3 Highlighting and Quotation
- 3.4 Simple Editorial Changes
- 3.5 Names, Numbers, Dates, Abbreviations, and Addresses
- 3.6 Simple Links and Cross-References
- 3.7 Lists
- 3.8 Notes, Annotation, and Indexing
- 3.9 Graphics and other non-textual components
- 3.10 Reference Systems
- 3.11 Bibliographic Citations and References
- 3.12 Passages of Verse or Drama
- 3.13 Overview of the Core Module
This chapter describes elements which may appear in any kind of text and the tags used to mark them in all TEI documents. Most of these elements are freely floating phrases, which can appear at any point within the textual structure, although they must generally be contained by a higher-level element of some kind (such as a paragraph). A few of the elements described in this chapter (for example, bibliographic citations and lists) have a comparatively well-defined internal structure, but most of them have no consistent inner structure of their own. In the general case, they contain only a few words, and are often identifiable in a conventionally printed text by the use of typographic conventions such as shifts of font, use of quotation or other punctuation marks, or other changes in layout.
This chapter begins by describing the p tag used to mark paragraphs, the prototypical formal unit for running text in many TEI modules. This is followed, in section 3.2 Treatment of Punctuation, by a discussion of some specific problems associated with the interpretation of conventional punctuation, and the methods proposed by the Guidelines for resolving ambiguities therein.
The next section (section 3.3 Highlighting and Quotation) describes a number of phrase-level elements commonly marked by typographic features (and thus well-represented in conventional markup languages). These include features commonly marked by font shifts (section 3.3.2 Emphasis, Foreign Words, and Unusual Language) and features commonly marked by quotation marks (section 3.3.3 Quotation) as well as such features as terms, cited words, and glosses (section 3.3.4 Terms, Glosses, Equivalents, and Descriptions).
Section 3.4 Simple Editorial Changes introduces some phrase-level elements which may be used to record simple editorial interventions, such as emendation or correction of the encoded text. The elements described here constitute a simple subset of the full mechanisms for encoding such information (described in full in chapter 11 Representation of Primary Sources), which should be adequate to most commonly encountered situations.
The next section (section 3.5 Names, Numbers, Dates, Abbreviations, and Addresses) describes several phrase-level and inter-level elements which, although often of interest for analysis or processing, are rarely explicitly identified in conventional printing. These include names (section 3.5.1 Referring Strings), numbers and measures (section 3.5.3 Numbers and Measures), dates and times (section 3.5.4 Dates and Times), abbreviations (section 3.5.5 Abbreviations and Their Expansions), and addresses (section 3.5.2 Addresses).
In the same way, the following section (section 3.6 Simple Links and Cross-References) presents only a subset of the facilities available for the encoding of cross-references or text-linkage. The full story may be found in chapter 16 Linking, Segmentation, and Alignment; the tags presented here are intended to be usable for a wide variety of simple applications.
Sections 3.7 Lists, and 3.8 Notes, Annotation, and Indexing, describe two kinds of quasi-structural elements: lists and notes. These may appear either within chunk-level elements such as paragraphs, or between them. Several kinds of lists are catered for, of an arbitrary complexity. The section on notes discusses both notes found in the source and simple mechanisms for adding annotations of an interpretive nature during the encoding; again, only a subset of the facilities described in full elsewhere (specifically, in chapter 17 Simple Analytic Mechanisms) is discussed.
Section 3.9 Graphics and other non-textual components introduces some simple ways of representing graphic or other non-textual content found in a text. A fuller discussion of the multimedia facilities supported by these Guidelines may be found in chapters 14 Tables, Formulæ, and Graphics and 16 Linking, Segmentation, and Alignment.
Next, section 3.10 Reference Systems, describes methods of encoding within a text the conventional system or systems used when making references to the text. Some reference systems have attained canonical authority and must be recorded to make the text useable in normal work; in other cases, a convenient reference system must be created by the creator or analyst of an electronic text.
Like lists and notes, the bibliographic citations discussed in section 3.11 Bibliographic Citations and References, may be regarded as structural elements in their own right. A range of possibilities is presented for the encoding of bibliographic citations or references, which may be treated as simple phrases within a running text, or as highly-structured components suitable for inclusion in a bibliographic database.
Additional elements for the encoding of passages of verse or drama (whether prose or verse) are discussed in section 3.12 Passages of Verse or Drama.
The chapter concludes with a technical overview of the structure and organization of the module described here. This should be read in conjunction with chapter 1 The TEI Infrastructure, describing the structure of the TEI document type definition.
3.1 ParagraphsTEI: Paragraphs¶
The paragraph is the fundamental organizational unit for all prose texts, being the smallest regular unit into which prose can be divided. Prose can appear in all TEI texts, even those that are primarily of another genre (e.g., verse); thus the paragraph is described here, as an element which can appear in any kind of text.
Paragraphs can contain any of the other elements described within this chapter, as well as some other elements which are specific to individual text types. We distinguish phrase-level elements, which must be entirely contained within a paragraph and cannot appear except within one, from chunks, which can appear between, but not within, paragraphs, and from inter-level elements, which can appear either within a single paragraph or between paragraphs. The class of phrases includes emphasized or quoted phrases, names, dates, etc. The class of inter-level elements includes bibliographic citations, notes, lists, etc. The class of chunks includes the paragraph itself, and other elements which have similar structural properties, notably the ab (anonymous block) element described in 16.3 Blocks, Segments, and Anchors) which may be used as an alternative to the paragraph in some kinds of texts.
Because paragraphs may appear in different base or additional tag sets, their possible contents may differ in different kinds of documents. In particular, additional elements not listed in this chapter may appear in paragraphs in certain kinds of text. However, the elements described in this chapter are always by default available in all kinds of text.
If a consistent internal subdivision of paragraphs is desired, the s or seg (‘segment’) elements may be used, as discussed in chapters 16 Linking, Segmentation, and Alignment and 17 Simple Analytic Mechanisms respectively. More usually, however, paragraphs have no firm internal structure, but contain prose encoded as a mix of characters, entity references, phrases marked as described in the rest of this chapter, and embedded elements like lists, figures, or tables.
Since paragraphs are usually explicitly marked in Western texts, typically by indentation, the application of the p tag usually presents few problems.
<p>I fully appreciate Gen. Pope's splendid achievements with their
invaluable results; but you must know that Major Generalships in the
Regular Army, are not as plenty as blackberries.</p>
</body>
<p>Serbs seized more territory in this struggling new country today as
the United States Air Force ended a two-day airlift of humanitarian
aid into the capital, Sarajevo.</p>
<p>International relief workers called on European Community nations
to step up their humanitarian aid to the former Yugoslav republic,
in conjunction with new American aid flights if necessary.</p>
<p>A special envoy from the European Community, Colin Doyle, harshly
condemned the decision by Serbs to shell Sarajevo on Saturday night
during a visit to the Bosnian capital by a senior American official,
Deputy Assistant Secretary of State Ralph R. Johnson.</p>
<p>...</p>
There came to the castle the Crawling Louse. <q>Who,
who's in the castle? Who, who's in your house?</q>
said the Crawling Louse. <q>I, I, the Languishing Fly.
And who art thou?</q>
<q>I'm the Crawling Louse.</q>
</p>
<p>Then came to the castle the Leaping Flea. <q>Who,
who's in the castle?</q> said the Leaping Flea. <q>I,
I, the Languishing Fly, and I, the Crawling Louse. And
who art thou?</q>
<q>I'm the Leaping Flea.</q>
</p>
<p>Then came to the castle the Mischievous Mosquito.
<q>Who, who's in the castle?</q> said the Mischievous
Mosquito. <q>I, I, the Languishing Fly, and I, the
Crawling Louse, and I, the Leaping Flea. And who art
thou?</q>
<q>I'm the Mischievous Mosquito.</q>
</p>
3.2 Treatment of PunctuationTEI: Treatment of Punctuation¶
Punctuation marks cause two distinct classes of problem for text markup: the marks may not be available in the character set used, and they may be significantly ambiguous. To some extent, the availability of the Unicode character set addresses the first of these problems, since it provides specific code points for most punctuation marks, and also the second to the extent that it distinguishes glyphs (such as stop, comma, and hyphen) which are used with different functions. Thus, for example, different Unicode code points are available for the hyphen used as a minus sign (x2212), as a word breaking hyphen (x2010), and as a soft or ‘non-breaking’ hyphen (x00AD); such distinctions are not however made in all possible cases, particularly where older writing systems are concerned. Where punctuation itself is the subject of study, the element pc (punctuation character) may be used to mark it explicitly, as further discussed in 17.1.2 Below the word level. The g element and other facilities described in chapter 5 Representation of Non-standard Characters and Glyphs may also be used to define markup for non-standard punctuation characters.
Punctuation is itself a form of markup, historically introduced to provide the reader with an indication about how the text should be read. As such, it is unsurprising that encoders will often wish to encode directly the purpose for which punctuation was provided, as well as, or even instead of, the punctuation itself. We discuss some typical cases below.
The Full stop (period) may mark (orthographic) sentence boundaries, abbreviations, decimal points, or serve as a visual aid in printing numbers. These usages can be distinguished by tagging S-units, abbreviations, and numbers, as described in sections 16.3 Blocks, Segments, and Anchors, 3.5.5 Abbreviations and Their Expansions, and 3.5.3 Numbers and Measures respectively. However, there are independent reasons for tagging these, whether or not they are marked by full stops, and the polysemy of the full stop itself is perhaps no different from that of any other character in the writing system.
The Question mark and exclamation mark usually mark the end of orthographic sentences, but may also be used as a mid-sentence comment by the author (! to express surprise or some other strong feeling, ? to query a word or expression or mark a sentence as dubious in linguistic discussion). Such usages may be distinguished by marking S-units, in which case the mid-sentence uses of these punctuation marks may be left unmarked, or tagged using the pc element discussed in 17.1 Linguistic Segment Categories.
Dashes are used for a variety of purposes: as a mark of omission, insertion, or interruption; to show where a new speaker takes over (in dialogue); or to introduce a list item. In the latter two cases particularly, it is clearly desirable to mark the function as well as its rendition using the elements q or item, on which see section 3.3.3 Quotation, and section 3.7 Lists, respectively.
Quotation marks may be removed from text contained by q or quote elements on editorial grounds, or they may be marked in a variety of ways; see the discussion of quotation and related features in section 3.3.3 Quotation.
Apostrophes must be distinguished from single quote marks. As with hyphens, this disambiguation is best performed by selecting the appropriate Unicode character, though it may also be represented by using appropriate XML markup for quotations as suggested above. However, apostrophes have a variety of uses. In English they mark contractions, genitive forms, and (occasionally) plural forms. Full disambiguation of these uses belongs to the level of linguistic analysis and interpretation.
Parentheses and other marks of suspension such as dashes or ellipses are often used to signal information about the syntactic structure of a text fragment. Full disambiguation of their uses also belongs to the level of linguistic analysis and interpretation, and will therefore need to use the mechanisms discussed in chapter 17 Simple Analytic Mechanisms.
Where punctuation marks are disambiguated by tagging their assumed function in the text (for example, quotation), it may be debated whether they should be excluded or left as part of the text. In the case of quotation marks, it may be more convenient to distinguish opening from closing marks simply by using the appropriate Unicode character than to use the q element, with or without a rend attribute.
Where segmentation of a text is performed automatically, the accuracy of the result may be considerably enhanced by a first pass in which the function of different punctuation characters is explicitly marked. This need not be done for all cases, but only where the structural function of the punctuation markup (for example as a word or phrase delimiter) is ambiguous. Thus, dots indicating abbreviation might be distinguished from dots indicating sentence end, and exclamation or question marks internal to a sentence distinguished from those which terminate one. Furthermore, when encoding historical materials, it may be considered essential to retain the original punctuation, whether by using an appropriate character code, if this is available (or using the g element where it is not) or by an explicit encoding using pc. The particular method adopted will vary depending upon the feature concerned and upon the purpose of the project.
3.3 Highlighting and QuotationTEI: Highlighting and Quotation¶
- emphasis, foreign words and other linguistically distinct uses of highlighting
- representation of speech and thought, quotation, etc.
- technical terms, glosses, etc.
3.3.1 What Is Highlighting?TEI: What Is Highlighting?¶
By highlighting we mean the use of any combination of typographic features (font, size, hue, etc.) in a printed or written text in order to distinguish some passage of a text from its surroundings. 9 The purpose of highlighting is generally to draw the reader's attention to some feature or characteristic of the passage highlighted; this section describes the elements recommended by these Guidelines for the encoding of such textual features.
- distinct in some way — as foreign, dialectal, archaic, technical, etc.
- emphatic, and which would for example be stressed when spoken
- not part of the body of the text, for example cross-references, titles, headings, labels, etc.
- identified with a distinct narrative stream, for example an internal monologue or commentary.
- attributed by the narrator to some other agency, either within the text or outside it: for example, direct speech or quotation.
- set apart from the text in some other way: for example, proverbial phrases, words mentioned but not used, names of persons and places in older texts, editorial corrections or additions, etc.
The textual functions indicated by highlighting may not be rendered consistently in different parts of a text or in different texts. (For example, a foreign word may appear in italics if the surrounding text is in roman, but in roman if the surrounding text is in italics.) For this reason, these Guidelines distinguish between the encoding of rendering itself and the encoding of the underlying feature expressed by it.
- hi (highlighted) marks a word or phrase as graphically distinct from the surrounding text, for reasons concerning which no claim is made.
The possible values carried by the rend attribute are not formally defined in this version of the Guidelines. Since the rend attribute may be used to document any peculiarity of the way a given segment of text was rendered in the original source text, it may need to express a very large range of typographic features, by no means restricted to typeface, type size, etc.
- the same kind of highlighting may be used for different purposes in different contexts
- the same textual function may be highlighted in different ways in different contexts
- for analytic purposes, it is in general more useful to know the intended function of a highlighted phrase than simply that it is distinct.
In many, if not most, cases the underlying function of a highlighted phrase will be obvious and non-controversial, since the distinctions indicated by a change of highlighting correspond with distinctions discussed elsewhere in these Guidelines. The elements available to record such distinctions are, for the most part, members of the model.emphLike class. This and the model.hiLike class mentioned above constitute the model.highlighted class, which is a phrase level class. Members of this class may appear anywhere within paragraph level elements.
The distinction between the two classes is simple, and typified by the two elements hi and emph: the former marks simply that a passage is typographically distinct in some way, while the latter asserts that a passage is linguistically emphasized for some purpose. These two properties, though often combined, are not identical. It should however be recognized, however, that cases do exist in which it is not economically feasible to mark the underlying function (e.g. in the preparation of large text corpora), as well as cases in which it is not intellectually appropriate (as in the transcription of some older materials, or in the preparation of material for the study of typographic practice). In such cases, the hi element or some other element from the model.hiLike class should be used.
Elements which are sometimes realized by typographic distinction but which are not discussed in this section include title (discussed in section 3.11 Bibliographic Citations and References) and name (discussed in section 3.5.1 Referring Strings).
3.3.2 Emphasis, Foreign Words, and Unusual LanguageTEI: Emphasis, Foreign Words, and Unusual Language¶
- foreign (foreign) identifies a word or phrase as belonging to some language other than that of the surrounding text.
- emph (emphasized) marks words or phrases which are stressed or emphasized for linguistic or rhetorical effect.
- 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.
3.3.2.1 Foreign Words or ExpressionsTEI: Foreign Words or Expressions¶
hoc</foreign>?</q> said the Bee Master.
<q>Wax-moth only succeed when
weak bees let them in.</q>
pronounce with your mouth full.
piece of light, buttery, pastry that is usually eaten for
breakfast, especially in France.
Elements which do not explicitly state the language of their content by means of an xml:lang attribute are understood to inherit a value for it from their parent element. In the general case, therefore, it is recommended practice to supply a default value for xml:lang on the root TEI or text element, as further discussed in section 1.3.1.1.2 Language Indicators
3.3.2.2 Emphatic Words and PhrasesTEI: Emphatic Words and Phrases¶
<q>
<emph rend="italic">What does Christopher
Robin do in the morning nowadays?</emph>
</q>
whom three Realms obey,</l>
<l>Doth sometimes Counsel take —
and sometimes <emph rendition="#italic">Tea</emph>.</l>
<!-- in the header ... -->
<rendition xml:id="italic" scheme="css">text-style:italic</rendition>
The hi element is used to mark words or phrases which are highlighted in some way, but for which identification of the intended distinction is difficult, controversial, or impossible. It enables an encoder simply to record the fact of highlighting, possibly describing it by the use of a rend or rendition attribute, as discussed above, without however taking a position as to the function of the highlighting. This may also be useful if the text is to be processed in two stages: representing simply typographic distinctions during a first pass, and then replacing the hi elements with more specific elements in a second pass.
that the said <hi rend="italic">Walter Shandy</hi>, merchant,
in consideration of the said intended marriage ...
boast of the advantage over him in only one respect. They
often <hi rend="quoted">came down</hi> handsomely, and
Scrooge never did.
3.3.2.3 Other Linguistically Distinct MaterialTEI: Other Linguistically Distinct Material¶
For some kinds of analysis, it may be desirable to encode the linguistic distinctiveness of words and phrases with more delicacy than is allowed by the foreign element. The distinct element is provided for this purpose. Its attributes allow for additional information characterizing the nature of the linguistic distinction to be made in two distinct ways: the type attribute simply assigns a user-defined code of some kind to the word or phrase which assigns it to some register, sub-language, etc. No recommendations as to the set of values for this attribute are provided at this time, as little consensus exists in the field.
Alternatively, the remaining three attributes may be used in combination to place a word or phrase on a three-dimensional scale sometimes used in descriptive linguistics, as for example in Mattheier et al, 1988. The time attribute places a word diachronically, for example as archaic, old-fashioned, contemporary, futuristic, etc.; the space attribute places a word diatopically, that is, with respect to a geographical classification, for example as national, regional, international, etc.; the social attribute places a word diastatically, that is, with respect to a social classification, for example as technical, polite, impolite, restricted, etc. Again, no recommendations are made for the values of these attributes at this time; the encoder should provide a description of the scheme used in the appropriate section of the header (see section 2.3 The Encoding Description).
bosom friend, a <distinct type="psSlang">fag</distinct> of
Macrea's, that there was trouble in their midst which
King <distinct type="archaic">would fain</distinct> keep
secret.
bosom friend, a
<distinct time="1900" space="GB" social="publicschool">fag</distinct>
of Macrea's, that there was trouble in their midst which
King <distinct time="archaic">would fain</distinct> keep
secret.
3.3.3 QuotationTEI: Quotation¶
One form of presentational variation found particularly frequently in written and printed texts is the use of quotation marks. As with the typographic variations discussed in the preceding section, it is generally helpful to separate the encoding of the underlying textual feature (for example, a quotation or a piece of direct speech) from the encoding of its rendering (for example, the use of a particular style of quotation marks).
- q (separated from the surrounding text with quotation marks) contains material which is marked as (ostensibly) being somehow different than the surrounding text, for any one of a variety of reasons including, but not limited to: direct speech or thought, technical terms or jargon, authorial distance, quotations from elsewhere, and passages that are mentioned but not used.
- said (speech or thought) indicates passages thought or spoken aloud, whether explicitly indicated in the source or
not, whether directly or indirectly reported, whether by real people or fictional characters.
direct may be used to indicate whether the quoted matter is regarded as direct or indirect speech. aloud may be used to indicate whether the quoted matter is regarded as having been vocalized or signed. - quote (quotation) contains a phrase or passage attributed by the narrator or author to some agency external to the text.
- cit (cited quotation) contains a quotation from some other document, together with a bibliographic reference to its source. In a dictionary it may contain an example text with at least one occurrence of the word form, used in the sense being described, or a translation of the headword, or an example.
- mentioned marks words or phrases mentioned, not used.
- soCalled 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.
The most common and important use of quotation marks is, of course, to mark quotation, by which we mean simply any part of the text attributed by the author or narrator to some agency other than the narrative voice. The q element may be used if no further distinction beyond this is judged necessary. If however it is felt necessary to distinguish passages which are in some sense external to the work from passages of direct speech or thought, a more precise element may be chosen from the list above. Typical examples include passages cited from other works, for which the element quote may be used, and words or phrases spoken or thought by people or characters within the current work, for which the element said may be used. The soCalled element is used for cases where the author or narrator distances him or herself from the words in question without however attributing them to any other voice in particular. The mentioned element is appropriate for a case where a word or phrase is being discussed in the body of a text rather than forming part of the text directly.
As noted above, if the distinction among these various reasons why a passage is offset from surrounding text cannot be made reliably, or is not of interest, then all quoted matter may simply be marked using the q element.
Quotation may be indicated in a printed source by changes in type face, by special punctuation marks (single or double or angled quotes, dashes, etc.) and by layout (indented paragraphs, etc.). If these characteristics are of interest, one or other of the global rend or rendition attributes discussed in section 1.3.1.1 Global Attributes may be used to record them.
Quotation marks themselves may, like other punctuation marks, be felt for some purposes to be worth retaining within a text, quite independently of their description by the rend attribute. This should generally be done using the appropriate Unicode character, or, if this is not possible, a numeric character reference (see Character References).
you?</said> — he at last said —
<said rend="PRE lsquo POST rsquo">you no speak-e,
damme, I kill-e.</said> And so saying,
the lighted tomahawk began flourishing
about me in the dark.
<said>— Alors, Albert, quoi de neuf?</said>
<said>— Pas grand-chose.</said>
<said>— Il fait beau,</said> dit Robert.
<said rend="PRE mdash">Alors,
Albert, quoi de neuf ?</said>
<said rend="PRE mdash">Pas grand-chose.</said>
<said rend="PRE mdash">Il fait beau,</said>
dit Robert.
- att.ascribed provides attributes for elements representing speech or action that can be ascribed to a
specific individual.
who indicates the person, or group of people, to whom the element content is ascribed.
<said who="#Adolphe">— Alors, Albert,
quoi de neuf?</said>
<said who="#Albert">— Pas grand-chose.</said>
<said who="#Robert">— Il fait beau,</said>
dit Robert.
<!-- .... -->
<list type="speakers">
<item xml:id="Adolphe"/>
<item xml:id="Albert"/>
<item xml:id="Robert"/>
</list>
<said aloud="false">I mean
Gordon Macrae, for example…</said>
<said aloud="false">Jungian
Analyst with Winebox! That's what you called him, you callous bastard,
didn't you? Eh? Eh?</said>
eight weeks with this very paper in his hand, and he says:—
<said who="#WilsonSpaulding">I wish to the Lord, Mr. Wilson, that I was a
red-headed man.</said>
</said>
<!-- ... -->
<list type="speakers">
<item xml:id="Wilson">Wilson</item>
<item xml:id="WilsonSpaulding">Spaulding reported by Wilson</item>
<!-- ...-->
</list>
<said>The Lord! The Lord! It is Sakya Muni himself,</said> the lama half
sobbed; and under his breath began the wonderful Buddhist
invocation:-<said>
<quote>
<l>To Him the Way — the Law — Apart —</l>
<l>Whom Maya held beneath her heart</l>
<l>Ananda's Lord — the Bodhisat</l>
</quote>
And He is here! The Most Excellent Law is here also. My
pilgrimage is well begun. And what work! What work!</said>
</p>
<head>Chapter 1</head>
<epigraph>
<cit>
<quote>
<l>Since I can do no good because a woman</l>
<l>Reach constantly at something that is near it.</l>
</quote>
<bibl>
<title>The Maid's Tragedy</title>
<author>Beaumont and Fletcher</author>
</bibl>
</cit>
</epigraph>
<p>Miss Brooke had that kind of beauty which seems to be thrown into
relief by poor dress...</p>
</div>
work of followers of J.R. Firth, probably best summarized
in his slogan, <cit>
<quote>You shall know a word by the company it keeps.</quote>
<ref>(Firth, 1957)</ref>
</cit>
- the quotation is broken into segments, each of which is entirely contained within a paragraph
- the quotation is marked up using stand-off markup
- the quotation boundaries are represented by empty segment boundary delimiter elements
sentences are finite objects was never justified by arguments from
the attested properties of NLs, it did have a certain
<soCalled>social</soCalled> justification. It was commonly assumed in
works on logic until fairly recently that the notion
<mentioned>language</mentioned> is necessarily restricted to finite
strings.
3.3.4 Terms, Glosses, Equivalents, and DescriptionsTEI: Terms, Glosses, Equivalents, and Descriptions¶
This section describes a set of textual elements which are used to provide a gloss, alternate identification, or description of something.
- term contains a single-word, multi-word, or symbolic designation which is regarded as a technical term.
- gloss identifies a phrase or word used to provide a gloss or definition for some other word or phrase.
A term may appear with or without a gloss, as may a mentioned element. Where the gloss is present, it may be linked to the term it is glossing by means of its target attribute. To establish such a link, the encoder should give an xml:id value to the term or mentioned element and provide that id as the value of the target attribute on the gloss element. The following examples demonstrate this facility:
as
<gloss target="#TDPv">the relationship, expressed through discourse
structure, between the implied author or some other addresser,
and the fiction.</gloss>
structure from grammatical strings of words</gloss> is known as a
<term xml:id="PRSR">parser</term>, and much of the history of NLP over the
last 20 years has been occupied with the design of parsers.
form like <mentioned xml:id="cw234" xml:lang="grc">eluthemen</mentioned>
<gloss target="#cw234">we were released,</gloss> accented on the
second syllable of the word, and its participial derivative
<mentioned xml:id="cw235" xml:lang="grc">lutheis</mentioned>
<gloss target="#cw235">released,</gloss> accented on the last.
For technical terminology in particular, and generally in terminological studies, it may be useful to associate an instance of a term within a text with a canonical definition for it, which is stored either elsewhere in the same text (for example in a glossary of terms) or externally, for example in a database, authority file, or published standard. The attributes key and ref discussed in section 3.5.1 Referring Strings below are available on the term element for this purpose.
- altIdent (alternate identifier) supplies the recommended XML name for an element, class, attribute, etc. in some language.
- desc (description) contains a brief description of the object documented by its parent element, including its intended usage, purpose, or application where this is appropriate.
- equiv/ (equivalent) specifies a component which is considered equivalent to the parent element, either by
co-reference, or by external link.
uri (uniform resource identifier) references the underlying concept of which the parent is a representation by means of some external identifier filter references an external script which contains a method to transform instances of this element to canonical TEI name names the underlying concept of which the parent is a representation
<gloss>anonymous block</gloss>
<!--... -->
</elementSpec>
<valItem ident="susp">
<gloss>suspension</gloss>
<desc>the abbreviation provides the first letter(s)
of the word or phrase, omitting the remainder.</desc>
</valItem>
<valItem ident="contr">
<gloss>contraction</gloss>
<desc>the abbreviation omits some letter(s) in the middle.</desc>
</valItem>
<!--...-->
</valList>
<equiv name="E69" uri="http://cidoc.ics.forth.gr/"/>
<!--... -->
</elementSpec>
<equiv
filter="http://www.example.com/equiv-filter.xsl"
mimeType="text/xsl"
name="bold"/>
<gloss>bold</gloss>
<desc>contains a sequence of characters rendered in a bold face.</desc>
<!-- ... -->
</elementSpec>
<altIdent xml:lang="de">Abkürzung</altIdent>
<!--...-->
</elementSpec>
<attList>
<attDef mode="change" ident="url">
<altIdent>href</altIdent>
</attDef>
<!-- .... -->
</attList>
</elementSpec>
By default, the altIdent of a component is identical to the value of its ident attribute.
<!--... -->
<desc>identifies a word or phrase as belonging to some language other
than that of the surrounding text. </desc>
<!--... -->
</elementSpec>
3.3.5 Some Further ExamplesTEI: Some Further Examples¶
A first approximation to the encoding of this sentence might be simply to record the fact that the phrases printed above in italics are highlighted, as follows:On the one hand the Nibelungenlied is associated with the new rise of romance of twelfth-century France, the romans d'antiquité, the romances of Chrétien de Troyes, and the German adaptations of these works by Heinrich van Veldeke, Hartmann von Aue, and Wolfram von Eschenbach.
associated with the new rise of romance of twelfth-century France,
the <hi xml:lang="fr" rend="italic">romans d'antiquité</hi>,
the romances of Chrétien de Troyes, ...
is associated with the new rise of romance of twelfth-century France,
the <foreign rend="italic">romans d'antiquité</foreign>, the
romances of Chrétien de Troyes, ...
A pretty common case, I believe; in all vehement debatings. She says I am too witty; Anglicé, too pert; I, that she is too wise; that is to say, being likewise put into English, not so young as she has been: in short, she is grown so much into a mother, that she had forgotten she ever was a daughter. ...
Clearly, the word vehement is not italicized for the same reason as the phrase not so young as she has been; the former is emphasized, while the latter is proverbial. It also provides an ironic gloss for the words too wise, in the same way as too pert glosses too witty. The glossed phrases are not, however, technical terms or cited words, but quoted phrases, as if the writer were putting words into her own and her mother's mouths. Finally, the words mother and daughter are apparently italicized simply to oppose them in the sentence; certainly they do not fit into any of the categories so far proposed as reasons for italicizing. Note also that the word Anglicé is not italicized although it is not generally considered an English word.
debatings. She says I am <q rend="italic">too witty</q>;
<foreign xml:lang="la" rend="roman">Anglicé</foreign>,
<gloss rend="italic">too pert</gloss>; I, that she is
<q rend="italic"> too wise</q>; that is to say, being likewise
put into English, <gloss rend="italic">not so young as she has
been</gloss>: in short, she is grown so much into a
<hi rend="italic">mother</hi>, that she had forgotten she ever
was a <hi rend="italic">daughter</hi>.
3.4 Simple Editorial ChangesTEI: Simple Editorial Changes¶
As in editing a printed text, so in encoding a text in electronic form, it may be necessary to accommodate editorial comment on the text and to render account of any changes made to the text in preparing it. The tags described in this section may be used to record such editorial interventions, whether made by the encoder, by the editor of a printed edition used as a copy text, by earlier editors, or by the copyists of manuscripts.
The tags described here handle most common types of editorial intervention and stereotyped comment; where less structured commentary of other types is to be included, it should be marked using the note element described in section 3.8 Notes, Annotation, and Indexing. Systematic interpretive annotation is also possible using the various methods described in chapter 16 Linking, Segmentation, and Alignment. The examples given here illustrate only simple cases of editorial intervention; in particular, they permit economical encoding of a simple set of alternative readings of a short span of text. To encode multiple views of large or heterogenous spans of text, the mechanisms described in chapter 16 Linking, Segmentation, and Alignment should be used. To encode multiple witnesses of a particular text, a similar mechanism designed specifically for critical editions is described in chapter 12 Critical Apparatus.
- att.responsibility provides attributes indicating who is responsible for
something asserted by the markup and the degree of certainty
associated with it.
cert (certainty) signifies the degree of certainty associated with the intervention or interpretation. resp (responsible party) indicates the agency responsible for the intervention or interpretation, for example an editor or transcriber. - att.editLike provides attributes describing the nature of a encoded scholarly intervention or
interpretation of any kind.
evidence indicates the nature of the evidence supporting the reliability or accuracy of the intervention or interpretation. - att.dimensions provides attributes for describing the size of physical objects.
unit names the unit used for the measurement quantity specifies the length in the units specified extent indicates the size of the object concerned using a project-specific vocabulary combining quantity and units in a single string of words. precision characterizes the precision of the values specified by the other attributes. scope where the measurement summarizes more than one observation, specifies the applicability of this measurement.
- choice groups a number of alternative encodings for the same point in a text.
Elements which can be combined in this way constitute the model.choicePart class. The default members of this class are sic, corr, reg, orig, unclear, add, and del; their functions and usage are described further below.
- indication or correction of apparent errors
- indication or regularization of variant, irregular, non-standard, or eccentric forms
- editorial additions, suppressions, and omissions
A more extended treatment of the use of these tags in transcriptional and editorial work is given in chapter 11 Representation of Primary Sources.
3.4.1 Apparent ErrorsTEI: Apparent Errors¶
Another property of computer-assisted historical research is that data modelling must permit any one textual feature or part of a textual feature to be a part of more than one information model and to allow the researcher to draw on several such models simultaneously, for example, to select from a machine-readable text those marginal comments which indicate that the date's mentioned in the main body of the text are incorrect.
mentioned in the main body of the text are incorrect.
mentioned in the main body of the text are incorrect.
<choice>
<corr>dates</corr>
<sic>date's</sic>
</choice> mentioned in the main body of the text are
incorrect.
<choice>
<corr resp="#msm">dates</corr>
<sic>date's</sic>
</choice> mentioned in the main body of the text are
incorrect.
<!-- within the header for this document ... -->
<respStmt>
<resp>editor</resp>
<name xml:id="msm">C.M. Sperberg McQueen</name>
</respStmt>
<corr cert="high">Autumn</corr>
<sic>Antony</sic>
</choice> it was,
That grew the more by reaping
Where, as here, the correction takes the form of adding text not otherwise present in the text being encoded, the encoder should use the corr element. Where the correction is present in the text being encoded, and consists of some combination of visible additions and deletions, the elements add or del should be used: see further section 3.4.3 Additions, Deletions, and Omissions below. Where the correction takes the form of addition of material not present in the original because of physical damage or illegibility, the supplied element may be used. Where the ‘correction’ is simply a matter of expanding an abbreviation the ex element may be used. These and other elements to support the detailed encoding of authorial or scribal interventions of this kind are all provided by the module described in chapter 11 Representation of Primary Sources.
3.4.2 Regularization and NormalizationTEI: Regularization and Normalization¶
When the source text makes extensive use of variant forms or non-standard spellings, it may be desirable for a number of reasons to regularize it: that is, to provide ‘standard’ or ‘regularized’ forms equivalent to the non-standard forms. 11
Typical applications for these elements include the production of editions intended for student or lay readers, linguistic research in which spelling or usage variation is not the main question at issue, production of spelling dictionaries, etc.
how godly a dede it is to overthrowe so wicked a race the world may judge: for my part I thinke there canot be a greater sacryfice to God.
<orig>overthrowe</orig> so wicked a race the
world may judge: for my part I <orig>thinke</orig>
there <orig>canot</orig> be a greater
<orig>sacryfice</orig> to God</p>
<reg>deed</reg> it is to <reg>overthrow</reg> so wicked a race the
world may judge: for my part I <reg>think</reg>
there <reg>cannot</reg> be a greater
<reg>sacrifice</reg> to God.</p>
<orig>dede</orig>
<reg>deed</reg>
</choice> it is to
<choice>
<orig>overthrowe</orig>
<reg>overthrow</reg>
</choice> so wicked a race the
world may judge: for my part I <choice>
<orig>thinke</orig>
<reg>think</reg>
</choice>
there <choice>
<orig>canot</orig>
<reg>cannot</reg>
</choice> be a greater
<choice>
<orig>sacryfice</orig>
<reg>sacrifice</reg>
</choice> to God.</p>
As elsewhere, the resp attribute may be used to specify the agency responsible for the regularization.
3.4.3 Additions, Deletions, and OmissionsTEI: Additions, Deletions, and Omissions¶
- gap (gap) 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, invisible, or inaudible.
reason gives the reason for omission. Sample values include sampling, inaudible, irrelevant, cancelled. - unclear contains a word, phrase, or passage which cannot be transcribed with certainty because it
is illegible or inaudible in the source.
reason indicates why the material is hard to transcribe. - add (addition) contains letters, words, or phrases inserted in the text by an author, scribe, annotator, or corrector.
- del (deletion) contains a letter, word, or passage deleted, marked as deleted, or otherwise indicated as superfluous or spurious in the copy text by an author, scribe, annotator, or corrector.
<desc>irrelevant commentary</desc>
</gap>
<gap reason="sampling" extent="2" unit="cm">
<desc>astrological figure</desc>
</gap>
That is, there were two stars on the easterly side and one to the west; …
The add and del elements may be used to record where words or phrases have been added or deleted in the copy text. They are not appropriate where longer passages have been added or deleted, which span several elements; for these, the elements addSpan and delSpan described in chapter 11.3.4 Additions and Deletions must be used.
and as to the consequences <add place="above">of
these facts</add> from which this tale takes its title.
The add element should not be used to mark editorial changes, such as supplying a word omitted by mistake from the source text or a passage present in another version. In these cases, either the corr or supplied tags should be used, as discussed above in section 3.4.1 Apparent Errors, and in section 11.3.3 Correction and Conjecture, respectively.
The unclear element is used to mark passages in the original which cannot be read with confidence, or about which the transcriber is uncertain for other reasons, as for example when transcribing a partially inaudible or illegible source. Its reason and resp attributes are used, as with the gap element, to indicate the cause of uncertainty and the person responsible for the conjectured reading.
<l>
<unclear reason="ink blot">The</unclear> sea between
yet hence his pray'r prevail'd
</l>
Where the material affected is entirely illegible or inaudible, the gap element discussed above should be used in preference.
<l>I live in the middle of England</l>
<l>But!</l>
<l>Norway! My soul resides in your watery
<del rend="overstrike">fiords fyords fiiords</del>
</l>
<l>Inlets.</l>
<del rend="overtyped">Mein</del> Frisch
<del type="overstrike">schwebt</del> weht der Wind
</l>
<del rend="overstrike">Inviolable</del>
<add place="below">Inexplicable</add>
splendour of Corinthian white and gold
</l>
The del element should not be used where the deletion is such that material cannot be read with confidence, or read at all, or where the material has been omitted by the transcriber or editor for some other reason. Where the material deleted cannot be read with confidence, the unclear tag should be used with the reason attribute indicating that the difficulty of transcription is due to deletion. Where material has been omitted by the transcriber or editor, this may be indicated by use of the gap element. A deletion in which some parts may be read but not others may thus be represented by one or more gap elements intermingled with text, all contained by a del element.
3.5 Names, Numbers, Dates, Abbreviations, and AddressesTEI: Names, Numbers, Dates, Abbreviations, and Addresses¶
This section describes a number of textual features which it is often convenient to distinguish from their surrounding text. Names, dates, and numbers are likely to be of particular importance to the scholar treating a text as source for a database; distinguishing such items from the surrounding text is however equally important to the scholar primarily interested in lexis.
The treatment of these textual features proposed here is not intended to be exhaustive: fuller treatments for names, numbers, measures, and dates are provided in the names and dates module (see chapter 13 Names, Dates, People, and Places).
3.5.1 Referring StringsTEI: Referring Strings¶
- rs (referencing string) contains a general purpose name or referring string.
- name (name, proper noun) contains a proper noun or noun phrase.
- att.typed provides attributes which can be used to classify or subclassify elements in any way.
type characterizes the element in some sense, using any convenient classification scheme or typology. subtype provides a sub-categorization of the element, if needed
<q>My dear
<rs type="person">Mr. Bennet</rs>
</q>, said his lady to
him one day, <q>have you heard that <rs type="place">Netherfield Park</rs> is let at last?</q>
</p>
<rs type="organization">Watering Committee</rs>.
They were paid a commission not exceeding four per
cent, and gave bond.</p>
<rs type="org">Circumlocution Office</rs> never, on any
account whatsoever, to give a straightforward answer,
<rs type="person">Mr Barnacle</rs> said, <q>Possibly.</q>
</p>
<q>My dear <rs type="person">Mr. Bennet</rs>
</q>, said
<rs type="person">his lady</rs> to him one day ...
</p>
<q>My dear <name type="person">Mr. Bennet</name>,</q> said <rs type="person">his lady</rs> to him one day,
<q>have you heard that <name type="place">Netherfield Park</name> is let at last?</q>
</p>
Simply tagging something as a name is generally not enough to enable automatic processing of personal names into the canonical forms usually required for reference purposes. The name as it appears in the text may be inconsistently spelled, partial, or vague. Moreover, name prefixes such as van or de la may or may not be included as part of the reference form of a name, depending on the language and country of origin of the bearer.
Two issues arise in this context: firstly, there may be a need to encode a regularised form of a name, distinct from the actual form in the source to hand; secondly, there may be a need to identify the particular person, place, etc. referred to by the name, irrespective of whether the name itself is normalized or not. The element reg, introduced in 3.4.2 Regularization and Normalization is provided for the former purpose; the attributes key or ref for the latter.
- att.canonical provides attributes which can be used to associate a representation such as a name or title
with canonical information about the object being named or referenced.
key provides an externally-defined means of identifying the entity (or entities) being named, using a coded value of some kind. ref (reference) provides an explicit means of locating a full definition for the entity being named by means of one or more URIs.
<q>My dear <rs key="BENM1" type="person"> Mr. Bennet</rs>,</q> said <rs key="BENM2" type="person">his lady</rs> to him one day, <q>have you heard that <rs key="NETP1" type="place">Netherfield Park</rs> is let at
last?</q>
</p>
<name key="VOM1" type="person">Mme. de Volanges</name> marie <rs key="VOM2">sa fille</rs>: c'est encore un secret;
mais elle m'en a fait part hier.
</p>
<name
ref="http://en.wikipedia.org/wiki/Heathrow_airport"
type="airport">Heathrow</name>
</p>
the administration of <rs key="POJA1" type="person">Col. Polk
(<reg>Polk, James K.</reg>)</rs> has but poorly compensated me for the
suspended enjoyments and pursuits of private and professional
spheres</p>
<name key="WADLM1" type="person">
<choice>
<orig>Walter de la Mare</orig>
<reg>de la Mare, Walter</reg>
</choice>
</name>
was born at <name key="Ch1" type="place">Charlton</name>, in
<name key="KT1" type="county">Kent</name>, in 1873.
</p>
<name type="place">Montaillou</name> is not a large parish.
At the time of the events which led to
<name type="person">Fournier<index>
<term>Benedict XII, Pope of Avignon (Jacques Fournier)</term>
</index>
</name>'s
investigations, the local population consisted of between 200 and 250 inhabitants.
</p>
3.5.2 AddressesTEI: Addresses¶
- address contains a postal address, for example of a publisher, an organization, or an individual.
- email (electronic mail address) contains an e-mail address identifying a location to which e-mail messages can be delivered.
- addrLine (address line) contains one line of a postal address.
<addrLine>110 Southmoor Road,</addrLine>
<addrLine>Oxford OX2 6RB,</addrLine>
<addrLine>UK</addrLine>
</address>
- street a full street address including any name or number identifying a building as well as the name of the street or route on which it is located.
- name (name, proper noun) contains a proper noun or noun phrase.
- postCode (postal code) contains a numerical or alphanumeric code used as part of a postal address to simplify sorting or delivery of mail.
- postBox (postal box or post office box) contains a number or other identifier for some postal delivery point other than a street address.
- model.nameLike groups elements which name or refer to a person, place, or organization.
- model.persNamePart groups elements which form part of a personal name.
- model.placeNamePart groups elements which form part of a place name.
Where code letters are commonly used in addresses (for example, to identify regions or countries) a useful practice is to supply the full name of the region or country as the content of the element, but to supply the abbreviatory code as the value of the global n attribute, so that (for example) an application preparing formatted labels can readily find the required information. Other components of addresses may be represented using the general-purpose name element or (when the additional module for names and dates is included) the more specialized elements provided for that purpose.
<street>110 Southmoor Road</street>
<name type="city">Oxford</name>
<postCode>OX2 6RB</postCode>
<name type="country">United Kingdom</name>
</address>
<name type="org">Università di Bologna</name>
<name type="country">Italy</name>
<postCode>40126</postCode>
<name type="city">Bologna</name>
<street>via Marsala 24</street>
</address>
For further discussion of ways of regularizing the names of places, see section 3.5 Names, Numbers, Dates, Abbreviations, and Addresses. A full postal address may also include the name of the addressee, tagged as above using the general purpose name element.
<street>110 Southmoor Road</street>
<settlement>Oxford</settlement>
<postCode>OX2 6RB</postCode>
<country>United Kingdom</country>
</address>
3.5.3 Numbers and MeasuresTEI: Numbers and Measures¶
- num (number) contains a number, written in any form.
type indicates the type of numeric value. value supplies the value of the number in standard form. - measure contains a word or phrase referring to some quantity of an object or commodity, usually
comprising a number, a unit, and a commodity name.
type specifies the type of measurement in any convenient typology. - measureGrp (measure group) contains a group of dimensional specifications which relate to the same object, for example the height and width of a manuscript page.
Like names or abbreviations, numbers can occur virtually anywhere in a text. Numbers are special in that they can be written with either letters or digits (twenty-one, xxi, and 21) and their presentation is language-dependent (e.g. English 5th becomes Greek 5.; English 123,456.78 equals French 123.456,78).
For many kinds of application, e.g. natural-language processing or machine translation, numbers are not regarded as ‘lexical’ in the same way as other parts of a text. For these and other applications, the num element provides a convenient method of distinguishing numbers from the surrounding text. For other kinds of application, numbers are only useful if normalized: here the num element is useful precisely because it provides a standardized way of representing a numerical value.
<num type="cardinal" value="21">twenty-one</num>
<num type="percentage" value="10">ten percent</num>
<num type="percentage" value="10">10%</num>
<num type="ordinal" value="5">5th</num>
<num type="fraction" value="0.5">1/2</num>
- att.ranging provides attributes for describing numerical ranges.
atLeast gives a minimum estimated value for the approximate measurement. atMost gives a maximum estimated value for the approximate measurement.
In its fullest form, a measure consists of a number, a phrase expressing units of measure and a phrase expressing the commodity being measured, though not all of these components need be present in every case. It may be helpful to distinguish measures from surrounding text for two reasons. Firstly, a measure may be expressed using a particular notation or system of abbreviations which the encoder does not wish to regard as lexical. Secondly, a quantitative application may wish to distinguish and normalize the internal components of a measure, in order to perform calculations on them.
<list type="gloss">
<label>Age</label>
<item>Unimportant</item>
<label>Head</label>
<item>Small and round</item>
<label>Eyes</label>
<item>Green</item>
<label>Complexion</label>
<item>White</item>
<label>Hair</label>
<item>yellow</item>
<label>Features</label>
<item>Mobile</item>
<label>Neck</label>
<item>
<measure>13¾"</measure>
</item>
<label>Upper arm</label>
<item>
<measure>11"</measure>
</item>
<!--...-->
</list>
<!-- ... -->
</div>
<measure type="currency">12s 6d</measure>...</p>
- att.measurement provides attributes to represent a regularized or normalized measurement.
quantity specifies the number of the specified units that comprise the measurement unit indicates the units used for the measurement, usually using the standard symbol for the desired units. commodity indicates the substance that is being measured
<item>
<measure
type="volume"
quantity="2"
unit="bag"
commodity="hops"> ii bags hops </measure>
</item>
<item>
<measure
type="volume"
quantity="6"
unit="truss"
commodity="cloth"> six trusses Woolen and linen goods </measure>
</item>
<item>
<measure
type="weight"
quantity="5"
unit="ton"
commodity="coal"> 5 tonnes coale
</measure>
</item>
</list>
<measure type="height" quantity="14">xiv</measure>
<measure type="width" quantity="5">v</measure>
<measure type="depth" quantity="10">x</measure>
</measureGrp>
3.5.4 Dates and TimesTEI: Dates and Times¶
- date contains a date in any format.
calendar indicates the system or calendar to which the date represented by the content of this element belongs. - time contains a phrase defining a time of day in any format.
- att.datable.w3c provides attributes for normalization of elements that contain
datable events using the W3C datatypes.
when supplies the value of the date or time in a standard form, e.g. yyyy-mm-dd.
Dates can occur virtually anywhere in a text, but in some contexts (e.g. bibliographic citations) their encoding is recommended or required rather than optional. Times can also appear anywhere but are generally optional.
Partial dates or times (e.g. 1990, September 1990, twelvish) can be expressed in the when attribute by simply omitting a part of the value supplied. Imprecise dates or times (for example early August, some time after ten and before twelve) may be expressed as date or time ranges.
These mechanisms are useful primarily for fully specified dates or times known with certainty. If component parts of dates or times are to be marked up, or if a more complex analysis of the meaning of a temporal expression is required, the techniques described in chapter 13 Names, Dates, People, and Places should be used in preference to the simple method outlined here.
Where the certainty (i.e. reliability) of the date or time is in question, the encoder should record this fact using the mechanisms discussed in chapter 21 Certainty, Precision, and Responsibility. The same chapter also discusses various methods of recording the precision of numerical or temporal assertions.
in the Year of Our Lord One Thousand Nine Hundred and
Seventy-seven of the Republic the Two Hundredth and first
and of the University the Eighty-Sixth.</date>
year 2001</date>
<date when="2001-09">September 2001</date>
<date when="2001-09-11">11 Sept 01</date>
<date when="--09-11">9/11</date>
<date when="--09">September</date>
<date when="---11">Eleventh of the month</date>
<time when="08:48:00">8:48</time>
<date when="2001-09-11T12:48:00">Sept 11th, 12 minutes before 9 am</date>
<date from="1918" to="1923">1918 to 1923</date>
— had been, he suspected,
somehow very important.</p>
manuscript (Codex Regius 2365) from <date notBefore="1250" notAfter="1300">the second half of the thirteenth
century</date>, and <title>Hervarar
saga</title> dates from <date when="1300">around 1300</date>.</p>
The calendar attribute may be used to specify a date in any calendar system; if the when attribute is also supplied, it should specify the equivalent date in the Gregorian calendar.
3.5.5 Abbreviations and Their ExpansionsTEI: Abbreviations and Their Expansions¶
<abbr>CC</abbr> is defined by that calibration of values which
motivates the elements of its <abbr>GSP</abbr>; ...
languages is currently nailing on <abbr>OOP</abbr> extensions.
<abbr type="initial">M.</abbr> Deegan is
the Director of the <abbr type="acronym">CTI</abbr> Centre for Textual Studies.
the Director of the <abbr>CTI</abbr> Centre for Textual Studies.
<choice>
<expan>World Wide Web Consortium</expan>
<abbr>W3C</abbr>
</choice>
<abbr>RELAXNG</abbr>
<expan>regular
language for <choice>
<abbr>XML</abbr>
<expan>extensible markup
language</expan>
</choice>, next
generation</expan>
</choice>
Abbreviation is a particularly important feature of manuscript and other source materials, the transcription of which needs more detailed treatment than is possible using these simple elements. A more detailed set of recommendations is discussed in 11.3 Altered, Corrected, and Erroneous Texts, which includes additional elements made available for the purpose by the transcr module.
3.6 Simple Links and Cross-ReferencesTEI: Simple Links and Cross-References¶
Cross-references or links between one location in a document and one or more other locations, either in the same or different XML documents, may be encoded using the elements ptr and ref, as discussed in this section. These elements both ‘point’ from one location in a document, the place that the element itself appears, to another (or to several), specified by the target attribute. Linkages of several other kinds are also provided for in these guidelines; see further chapter 16 Linking, Segmentation, and Alignment.
to the use of links in general, see <ptr target="#SA"/>; for the
complete XPointer specification, see <ptr
target="http://www.w3.org/TR/xptr-framework/"/>,
<ptr target="http://www.w3.org/TR/xptr-element/"/>,
<ptr target="http://www.w3.org/TR/xptr-xmlns/"/>, and
<ptr
target="http://www.w3.org/TR/xptr-xpointer/#xpointer(id('chum')/quote)"/>;
for a discussion of TEI schemes for XPointer, see
<ptr target="#SATS"/>.</p>
For an introduction to the use of links in general, see 16 Linking, Segmentation, and Alignment; for the complete XPointer specification, see http://www.w3.org/TR/xptr-framework/, http://www.w3.org/TR/xptr-element/, http://www.w3.org/TR/xptr-xmlns/, and http://www.w3.org/TR/xptr-xpointer/#xpointer(id('chum')/quote); for a discussion of TEI schemes for XPointer, see 16.2.4 TEI XPointer Schemes.
- ptr/ (pointer) defines a pointer to another location.
target specifies the destination of the pointer by supplying one or more URI References cRef (canonical reference) specifies the destination of the pointer by supplying a canonical reference from a scheme defined in a refsDecl element in the TEI header - ref (reference) defines a reference to another location, possibly modified by additional text or comment.
target specifies the destination of the reference by supplying one or more URI References cRef (canonical reference) specifies the destination of the reference by supplying a canonical reference from a scheme defined in a refsDecl element in the TEI header
- att.pointing defines a set of attributes used by all elements which point
to other elements by means of one or more URI references.
type categorizes the pointer in some respect, using any convenient set of categories. evaluate specifies the intended meaning when the target of a pointer is itself a pointer.
<!-- ... -->
</div1>
<item>Saints aid rejected in mel. <ptr target="#p299"/>
</item>
<item>Sallets censured <ptr target="#p143 #p144"/>
</item>
<item>Sanguine mel. signs <ptr target="#p263"/>
</item>
<item>Scilla or sea onyon, a purger of mel. <ptr target="#p442"/>
</item>
</list>
...
<pb xml:id="p144"/>
...
<pb xml:id="p263"/>
...
<pb xml:id="p299"/>
...
<pb xml:id="p442"/>
...
<!-- ... -->
<note xml:id="a51" type="footnote">text of annotation</note>
<term rend="ldquo rdquo">rewriting systems</term>, have a long history
among mathematicians, but the specific form of <ptr target="#fig22"/>
was first studied extensively by Chomsky <ptr type="bibliog" target="#chom59"/>.
<!-- ... -->
<figure xml:id="fig22">
<!-- ... -->
</figure>
<!-- elsewhere, in the bibliography -->
<bibl xml:id="chom59">
<!-- citation for the book referenced above -->
</bibl>
The ptr and ref elements have many applications in addition to the simple cross-referencing facilities illustrated in this section. In conjunction with the analytic tools discussed in chapters 16 Linking, Segmentation, and Alignment, 17 Simple Analytic Mechanisms, and 18 Feature Structures, they may be used to link analyses of a text to their object, to combine corresponding segments of a text, or to align segments of a text with a temporal or other axis or with each other.
3.7 ListsTEI: Lists¶
- list (list) contains any sequence of items organized as a list.
- item contains one component of a list.
- label contains the label associated with an item in a list; in glossaries, marks the term being defined.
- head (heading) contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc.
- headLabel (heading for list labels) contains the heading for the label or term column in a glossary list or similar structured list.
- headItem (heading for list items) contains the heading for the item or gloss column in a glossary list or similar structured list.
The list element should be used to mark any kind of list: numbered, lettered, bulleted, or unmarked. Lists formatted as such in the copy text should in general be encoded using this element, with an appropriate value for the type attribute. Lists given as run-on text may also be encoded using this element, where this is felt to be appropriate.
the composition of six, or even five quartos.
<list rend="runon" type="ordered">
<label>(1)</label>
<item>My first rough manuscript, without any
intermediate copy, has been sent to the press.</item>
<label>(2)</label>
<item>Not a sheet has been seen by any human
eyes, excepting those of the author and the printer:
the faults and the merits are exclusively my own.</item>
</list>
the composition of six, or even five quartos.
<list rend="runon" type="ordered">
<item n="1">My first rough manuscript, without any
intermediate copy, has been sent to the press.</item>
<item n="2">Not a sheet has been seen by any human
eyes, excepting those of the author and the printer:
the faults and the merits are exclusively my own.</item>
</list>
divided into <list>
<item n="a">those that belong to the Emperor, </item>
<item n="b">embalmed ones, </item>
<item n="c">those that are trained, </item>
<item n="d">suckling pigs, </item>
<item n="e">mermaids, </item>
<item n="f">fabulous ones, </item>
<item n="g">stray dogs, </item>
<item n="h">those that are included in this classification, </item>
<item n="i">those that tremble as if they were mad, </item>
<item n="j">innumerable ones, </item>
<item n="k">those drawn with a very fine camel's-hair brush, </item>
<item n="l">others, </item>
<item n="m">those that have just broken a flower vase, </item>
<item n="n">those that resemble flies from a distance. </item>
</list>
<head>Report of the conduct and progress of Ernest Pontifex.
Upper Vth form — half term ending Midsummer 1851</head>
<label>Classics</label>
<item>Idle listless and unimproving</item>
<label>Mathematics</label>
<item>ditto</item>
<label>Divinity</label>
<item>ditto</item>
<label>Conduct in house</label>
<item>Orderly</item>
<label>General conduct</label>
<item>Not satisfactory, on account of his great
unpunctuality and inattention to duties</item>
</list>
<head>Unit Three — Vocabulary</head>
<label xml:lang="la">acerbus, -a, -um </label>
<item>bitter, harsh</item>
<label xml:lang="la">ager, agrī, M. </label>
<item>field</item>
<label xml:lang="la">audiō, īre,
īvī, ītus </label>
<item>hear, listen (to)</item>
<label xml:lang="la">bellum, -ī, N. </label>
<item>war</item>
<label xml:lang="la">bonus, -a, -um </label>
<item>good</item>
</list>
<head>Unit Three — Vocabulary</head>
<label>
<term xml:lang="la">acerbus, -a, -um</term>
</label>
<item>
<gloss>bitter, harsh</gloss>
</item>
<label>
<term xml:lang="la">ager, agrī, M. </term>
</label>
<item>
<gloss>field</gloss>
</item>
<label>
<term xml:lang="la">audiō, -īre, -īvī, -ītus</term>
</label>
<item>
<gloss>hear, listen (to)</gloss>
</item>
<label>
<term xml:lang="la">bellum, -ī, N. </term>
</label>
<item>
<gloss>war</gloss>
</item>
<label>
<term xml:lang="la">bonus, -a, -um</term>
</label>
<item>
<gloss>good</gloss>
</item>
</list>
preferable to the use of a worn-out expression.
<list type="gloss">
<headLabel>TRITE</headLabel>
<headItem>SIMPLE, STRAIGHTFORWARD</headItem>
<label>bury the hatchet </label>
<item>stop fighting, make peace</item>
<label>at loose ends </label>
<item>disorganized</item>
<label>on speaking terms </label>
<item>friendly</item>
<label>fair and square </label>
<item>completely honest</item>
<label>at death's door </label>
<item>near death</item>
</list>
<label>EVIL</label>
<item>
<list type="simple">
<item>I am cast upon a horrible desolate island, void
of all hope of recovery.</item>
<item>I am singled out and separated as it were from
all the world to be miserable.</item>
<item>I am divided from mankind — a solitaire; one
banished from human society.</item>
</list>
</item>
<label>GOOD</label>
<item>
<list type="simple">
<item>But I am alive; and not drowned, as all my
ship's company were.</item>
<item>But I am singled out, too, from all the ship's
crew, to be spared from death...</item>
<item>But I am not starved, and perishing on a barren place,
affording no sustenances....</item>
</list>
</item>
</list>
Lists of different types may be nested to arbitrary depths in this way.
3.8 Notes, Annotation, and IndexingTEI: Notes, Annotation, and Indexing¶
3.8.1 Notes and Simple AnnotationTEI: Notes and Simple Annotation¶
- note contains a note or annotation.
A note is any additional comment found in a text, marked in some way as being out of the main textual stream. All notes should be marked using the same tag, note, whether they appear as block notes in the main text area, at the foot of the page, at the end of the chapter or volume, in the margin, or in some other place.
Notes may be in a different hand or typeface, may be authorial or editorial, and may have been added later. Attributes may be used to specify these and other characteristics of notes, as detailed below.
A note is usually attached to a specific point or span within a text, which we term here its point of attachment. In conventional printed text, the point of attachment is represented by some siglum such as a star or cross, or a superscript digit.
When encoding such a text, it is conventional to replace this siglum by the content of the annotation, duly marked up with a note element. This may not always be possible for example with marginal notes, which may not be anchored to an exact location. For ease of processing, it may be adequate to position marginal notes before the relevant paragraph or other element. In printed texts, it is sometimes conventional to group notes together at the foot of the page on which their points of attachment appear. This practice is not generally recommended for TEI-encoded texts, since the pagination of a particular printed text is unlikely to be of structural significance. In some cases, however, it may be desirable to transcribe notes not at their point of attachment to the text but at their point of appearance, typically at the end of the volume, or the end of the chapter. In such cases, the target attribute of the note may be used to indicate the point of attachment. It is also possible to encode the point of attachment itself, using the ptr or ref element, pointing from that to the body of the note placed elsewhere.
In cases where the note is applied not to a point but to a span of text, not itself represented as a TEI element, the target attribute may use an appropriate pointer expression, for example using the range() function to specify the span of attachment. For further discussion of pointing to points and spans in the text, see section 3.6 Simple Links and Cross-References.
<l>And from my neck so free</l>
<l>The albatross fell off, and sank</l>
<l>Like lead into the sea.
<note type="gloss" place="margin">The spell begins to break</note>
</l>
<l>The self-same moment I could pray</l>
<l>And from my neck so free</l>
<l>The albatross fell off, and sank</l>
<l>Like lead into the sea.</l>
<note type="gloss" place="margin">The spell begins to break</note>
</lg>
distinct entities or objects of any sort.<note n="1" place="bottom">We
explain below why we use the uncommon term
<mentioned>collection</mentioned> instead of the expected
<mentioned>set</mentioned>. Our usage corresponds to the
<mentioned>aggregate</mentioned> of many mathematical writings and to
the sense of <mentioned>class</mentioned> found in older logical
writings.</note> The elements ...
In addition to transcribing notes already present in the copy text, researchers may wish to add their own notes or comments to it. The note element may be used for either purpose, but it will usually be advisable to distinguish the two categories. One way might be to use the type attribute shown above, categorizing notes as authorial, editorial, etc. Where notes derive from many sources, or where a more precise attribution is required, the resp attribute may be used to point to a definition of the person or other agency responsible for the content of the note.
<!-- ... -->
<note place="margin" resp="#STC" type="gloss">The spell begins to break</note>
<note place="foot" resp="#JLL">The turning point of the poem...</note>
</lg>
<title>The Rime of the Ancient Mariner: an annotated edition</title>
<author xml:id="STC">Samuel Taylor Coleridge</author>
<editor xml:id="JLL">John Livingston Lowes</editor>
</titleStmt>
When annotating the electronic text by means of analytic notes in some structured vocabulary, e.g. to specify the topics or themes of a text, the span and interp elements may be more effective than the free form note element; these elements are available when the module for simple analysis is selected (see section 17.3 Spans and Interpretations).
3.8.2 Index EntriesTEI: Index Entries¶
The indexing of scholarly texts is a skilled activity, involving substantial amounts of human judgment and analysis. It should not therefore be assumed that simple searching and information retrieval software will be able to meet all the needs addressed by a well-crafted manual index, although it may complement them for example by providing free text search. The role of an index is to provide access via keywords and phrases which are not necessarily present in the text itself, but must be added by the skill of the indexer.
3.8.2.1 Pre-existing indexesTEI: Pre-existing indexes¶
<!--...-->
<list type="index">
<item>Women, how cause of mel. <ref>193</ref>; their vanity in
apparell taxed, <ref>527</ref>; their counterfeit tears
<ref>547</ref>; their vices <ref>601</ref>, commended,
<ref>624</ref>.</item>
<item>Wormwood, good against mel. <ref>443</ref>
</item>
<item>World taxed, <ref>181</ref>
</item>
<item>Writers of the cure of mel. 295</item>
<!--...-->
</list>
</div>
<list>
<item>how cause of mel. <ref>193</ref>;</item>
<item>their vanity in apparell taxed, <ref>527</ref>;</item>
<item>their counterfeit tears <ref>547</ref>;</item>
<item>their vices
<list>
<item>
<ref>601</ref>,</item>
<item> commended, <ref>624</ref>.</item>
</list>
</item>
</list>
</item>
<!-- in the text --><pb xml:id="P624"/>
<!-- start of page 624 -->
<!-- in the index -->
<ref target="#P624">624</ref>
3.8.2.2 Auto-generated indexesTEI: Auto-generated indexes¶
It can also be useful, however, to generate a new index from a machine-readable text, whether the text is being written for the first time with the tags here defined, or as an addition to a text transcribed from some other source. Depending on the complexity of the text and its subject matter, such an automatically-generated index may not in itself satisfy all the needs of scholarly users. However it can assist a professional indexer to construct a fully adequate index, which might then be post-edited into the digital text, marked-up along the lines already suggested for preserving pre-existing index material.
- index (index entry) marks a location to be indexed for whatever purpose.
<index>
<term>Lemmatization, Arabic</term>
</index>and are beginning to build parsers.</p>
The effect of this will be to generate an index entry for the term ‘Lemmatization’, referencing the location of the original index element.
topic of Arabic lemmatisation
<index spanTo="#ALAMEND">
<term>Lemmatization, Arabic</term>
</index> concerning which it is important to note .....
<!-- much learned material omitted here -->
and now we can build our parser.<anchor xml:id="ALAMEND"/>
</p>
This would generate the same index entries as the previous example, but the reference would be to the whole span of text between the location of the index element and the location of the element identified by the code ALAMEND, rather than a single point, and thus might (for example) include a sequence of page numbers.
Although the position of the index element in the text provides the target location that will be specified in the generated index entry, no part of the text itself is used to construct that entry. Index terms appearing in the entry come solely from the content of term elements, which consequently may have to repeat words or phrases from the text proper. This need not be done verbatim, thus giving scope for normalization of spelling (as in the example above) or other modifications which may assist generation of an index in a desired form or sequence.
<index>
<term sortKey="0000">@</term>
</index> precedes an
attribute name</p>
<!-- definition of the glyph here -->
</char>
<p>The Artist formerly known as Prince <index>
<term sortKey="Prince">
<g ref="#PrinceGlyph"/>
</term>
</index>...</p>
<index indexName="INDEX-PERSONS">
<term>Ashford, John</term>
</index> was,
coincidentally, born in
<index indexName="INDEX-PLACES">
<term>Ashford
(Kent)</term>
</index>Ashford...</p>
<index>
<term>lemmatization</term>
<index>
<term>arabic</term>
</index>
</index>
...</p>
<term>Women</term>
<index>
<term>their vices</term>
</index>
</index>
<term>Women</term>
<index>
<term>their vices</term>
<index>
<term>commended</term>
</index>
</index>
</index>
When processing such index elements, the duplication required to make the structure explicit will normally be removed, so as to produce entries like those quoted above. However, this is not required by the encoding recommended here.
<div type="appendix">
<head>Bibliography</head>
<listBibl>
<bibl> ... </bibl>
</listBibl>
</div>
<divGen n="Index Nominum" type="INDEX-NAMES"/>
<divGen n="Index Loci" type="INDEX-PLACES"/>
</back>
<divGen n="A1" type="INDEX-NAMES">
<head>An Index of Names</head>
</divGen>
</back>
If a processing instruction is used, then these parameters for the generated index may be supplied in some other way.
One final feature frequently found in manually-created indexes to printed works cannot readily be encoded by the means provided here, namely cross-references internal to the index term listing. For example, if all references to the TEI in a text have been indexed using the index term Text Encoding Initiative, it may also be helpful to include an entry under the term TEI containing some text such as ‘see Text Encoding Initiative’. Such internal cross-references must be added as part of the post-editing phase for an auto-generated index.
3.9 Graphics and other non-textual componentsTEI: Graphics and other non-textual components¶
Graphics, such as illustrations or diagrams, appear in many different kinds of text, and often with different purposes. In some cases, the graphic is an integral part of a text (indeed, some texts — comic books for example — may be almost entirely graphic); in others the graphic may be a kind of optional extra. In some cases, the text may be incomprehensible unless the graphic is included; in others, the presence of the graphic adds very little to the sense of the work. It will therefore be a matter of encoding policy as to whether or how a graphic found in a source text is transferred to a digital version of the same. In documents which are ‘born digital’, graphics and other forms of non-textual element may be particularly salient, but their inclusion in an archival form of the document concerned remains an editorial decision.
- figure groups elements representing or containing graphic information such as an illustration or figure.
- graphic/ indicates the location of an inline graphic, illustration, or figure.
- binaryObject provides encoded binary data representing an inline graphic or other object.
- in some non-XML or binary format such as PNG, JPEG, etc.
- in an XML format such as SVG
- in a TEI XML format such as the notation for graphs and trees described in 19 Graphs, Networks, and Trees
- att.internetMedia provides attributes for specifying the type of a computer
resource using a standard taxonomy.
mimeType (MIME media type) specifies the applicable multimedia internet mail extension (MIME) media type
through my first, second, third, and
fourth volumes. -- In the fifth volume
I have been very good, -- the precise
line I have described in it being this :
<graphic url="zigzag2.png" mimeType="image/png"/>
By which it appears, that except at the
curve, marked A. where I took a trip
to Navarre, -- and the indented curve B.
which is the short airing when I was
there with the Lady Baussiere and her
page, -- I have not taken the least frisk
...</p>
<graphic
url="http://www.iath.virginia.edu/gants/Ornaments/Heads/hp-ral02.gif"/>
</head>
The figure element discussed in 14.3 Specific Elements for Graphic Images provides additional capabilities, for example the ability to combine a number of images into a hierarchically organized structure or a block of images. It also provides the ability to associate an image with additional information such as a heading or a description.
3.10 Reference SystemsTEI: Reference Systems¶
By reference system we mean the system by which names or references are associated with particular passages of a text (e.g. Ps. 23:3 for the third verse of Psalm 23 or Amores 2.10.7 for Ovid's Amores, book 2, poem 10, line 7). Such names make it possible to mark a place within a text and enable other readers to find it again. A reference system may be based on structural units (chapters, paragraphs, sentences; stanza and verse), typographic units (page and line numbers), or divisions created specifically for reference purposes (chapter and verse in Biblical texts). Where one exists, the traditional reference system for a text should be preserved in an electronic transcript of it, if only to make it easier to compare electronic and non-electronic versions of the text.
- where a reference system exists, and is based on the same logical structure as that of the text's markup, the reference for a passage may be recorded as the value of the global xml:id or n attribute on an appropriate tag, or may be constructed by combining attribute values from several levels of tags, as described below in section 3.10.1 Using the xml:id and n Attributes.
- where there is no pre-existing reference system, the global xml:id or n attributes may be used to construct one (e.g. collections and corpora created in electronic form), as described below in section 3.10.2 Creating New Reference Systems.
- where a reference system exists which is not based on the same logical structure as that of the text's markup (for example, one based on the page and line numbers of particular editions of the text rather than on the structural divisions of it), any of a variety of methods for encoding the logical structure representing the reference system may be employed, as described in chapter 20 Non-hierarchical Structures.
- where a reference system exists which does not correspond to any particular logical structure, or where the logical structure concerned is of no interest to the encoder except as a means of supporting the referencing system, then references may be encoded by means of milestone elements, which simply mark points in the text at which values in the reference system change, as described below in section 3.10.3 Milestone Elements.
When a text has no pre-existing associated reference system of any kind, these Guidelines recommend as a minimum that at least the page boundaries of the source text be marked using one of the methods outlined in this section. Retaining page breaks in the markup is also recommended for texts which have a detailed reference system of their own. Line breaks in prose texts may be, but need not be, tagged. 13
3.10.1 Using the xml:id and n AttributesTEI: Using the xml:id and n Attributes¶
When traditional reference schemes represent a hierarchical structuring of the text which mirrors that of the marked-up document, the n attribute defined for all elements may be used to indicate the traditional identifier of the relevant structural units. The n attribute may also be used to record the numbering of sections or list items in the copy text if the copy-text numbering is important for some reason, for example because the numbers are out of sequence.
<div2 n="1" type="book">
<!-- ... -->
</div2>
<div2 n="2" type="book">
<div3 n="1" type="poem">
<!-- ... -->
</div3>
<div3 n="2" type="poem">
<!-- ... -->
</div3>
<!-- ... -->
<div3 n="10" type="poem">
<l n="1"> ... </l>
<l n="2"> ... </l>
<!-- ... -->
<l n="7"> ... </l>
</div3>
<!-- ... -->
</div2>
<!-- ... -->
</div1>
<div2 n="Amores 1" type="book">
<!-- ... -->
</div2>
<div2 n="Amores 2" type="book">
<div3 n="Amores 2.1" type="poem">
<!-- ... -->
</div3>
<!-- ... -->
<div3 n="Amores 2.10" type="poem">
<!-- ... -->
<l n="Amores 2.10.7"> ... </l>
<!-- ... -->
</div3>
<!-- ... -->
</div2>
<!-- ... -->
</div1>
<div2 xml:id="am.1" type="book">
<!-- ... -->
</div2>
<div2 xml:id="am.2" type="book">
<div3 xml:id="am.2.1" type="poem">
<!-- ... -->
</div3>
<!-- ... -->
<div3 xml:id="am.2.10" type="poem">
<!-- ... -->
<l xml:id="am.2.10.7"> ... </l>
<!-- ... -->
</div3>
<!-- ... -->
</div2>
<!-- ... -->
</div1>
To document the usage and to allow automatic processing of these standard references, it is recommended that the TEI header be used to declare whether standard references are recorded in the n or xml:id attributes and which elements may carry standard references or portions of them. For examples of declarations for the reference systems just shown, see section 3.10.4 Declaring Reference Systems.
Using the n attribute one can specify only a single standard referencing system, a limitation not without problems, since some editions may define structural units differently and thus create alternative reference systems. For example, another edition of the Amores considers poem 10 a continuation of poem 9, and therefore would specify the same line as Amores 2.9.31. In order to record both of these reference systems one could employ any of a variety of methods discussed in chapter 20 Non-hierarchical Structures.
3.10.2 Creating New Reference SystemsTEI: Creating New Reference Systems¶
If a text has no canonical reference system of its own, a reference system, if needed, may be derived from the structure of the electronic text, specifically from the markup of the text. As with any reference system intended for long-term use, it is important to see the reference as an established, unchanging point in the text. Should the text be revised or rearranged, the reference-system identifiers associated with any bit of text must stay with that bit of text, even if it means the reference numbers fall out of sequence. (A new reference system may always be created beside the old one if out-of-sequence numbers must be avoided.)
The global attributes n and xml:id may be used to assign reference identifiers to segments of the text. Identifiers specified by either attribute apply to the entire element for which they are given. ID attributes must be unique within a single document, and ID values must begin with a letter. No such restrictions are made on the values of n attributes.
A convenient method of mechanically generating unique values for xml:id or n attributes based on the structure of the document is to construct, for each element, a domain-style address comprising a series of components separated by full stops, with one component for each level of the document hierarchy. Two methods may be used. In the typed path form of identifier, each component in the identifier takes the form of an element identifier, a hyphen, and a number, for example p-2. The element name specifies what type of element is to be sought, and the number specifies which occurrence of that element type is to be selected. (The hyphen and number may be omitted if there is only one element of the given type.) In the untyped path form of identifier, each component consists of a number, indicating which element in the sequence of nodes at each level is to be selected.
Identifiers generated with these methods should use the text element as their starting point, rather than the TEI or body elements. The TEI element may be taken as a starting point only if identifiers need to be generated for the teiHeader, which is not usually the case; using the body element as a root would prevent assignment of identifiers for the front and back matter. The component corresponding to the root element can be omitted from identifiers, if no confusion will result. In collections and corpora, the component corresponding to the root may be replaced by the unique identifier assigned to the text or sample.
<front xml:id="Front" n="AB.1">
<div xml:id="Front.div-1" n="AB.1.1">
<p> ... </p>
</div>
<titlePage xml:id="Front.titlePage" n="AB.1.2">
<titlePart> ... </titlePart>
</titlePage>
<div xml:id="Front.div-2" n="AB.1.3">
<p> ... </p>
</div>
</front>
<body xml:id="Body" n="AB.2">
<p xml:id="Body.p-1" n="AB.2.1"> ... </p>
<p xml:id="Body.p-2" n="AB.2.2"> ... </p>
<div xml:id="Body.div-1" n="AB.2.3">
<head xml:id="Body.div-1.head" n="AB.2.3.1"> ... </head>
<p xml:id="Body.div-1.p-1" n="AB.2.3.2"> ... </p>
<p xml:id="Body.div-1.p-2" n="AB.2.3.3"> ... </p>
</div>
<div xml:id="Body.div-2" n="AB.2.4">
<head xml:id="Body.div-2.head" n="AB.2.4.1"> ... </head>
<p xml:id="Body.div-2.p-1" n="AB.2.4.2"> ... </p>
<p xml:id="Body.div-2.p-2" n="AB.2.4.3"> ... </p>
</div>
</body>
</text>
If the xml:id attribute is used to record the reference identifiers generated, each value should record the entire path. If the n attribute is used, each value may record either the entire path or only the subpath from the parent element. The attribute used, the elements which can bear standard reference identifiers, and the method for constructing standard reference identifiers, should all be declared in the header as described in section 2.3.5 The Reference System Declaration.
3.10.3 Milestone ElementsTEI: Milestone Elements¶
- milestone/ marks a boundary point separating any kind of section of a text, typically but not necessarily indicating a point at which some part of a standard reference system changes, where the change is not represented by a structural element.
- pb/ (page break) marks the boundary between one page of a text and the next in a standard reference system.
- lb/ (line break) marks the start of a new (typographic) line in some edition or version of a text.
- cb/ (column break) marks the boundary between one column of a text and the next in a standard reference system.
These elements simply mark the points in a text at which some category in a reference system changes. They have no content but subdivide the text into regions, rather in the same way as milestones mark points along a road, thus implicitly dividing it into segments. The elements pb, cb, and lb are specialised types of milestone, marking page, column, and line boundaries. The global n attribute is used in each case to provide a value for the particular unit associated with this milestone (for example, the page or line number). Since it is not structural, validation of a reference system based on milestones cannot readily be checked by an XML parser, so it will be the responsibility of the encoder or the application software to ensure that they are given in the correct order.
<body>
<milestone unit="part" n="1"/>
<div1 n="1" type="chapter">
<p>
<!-- ... -->
</p>
</div1>
<div1 n="2" type="chapter">
<p>
<!-- ... -->
</p>
</div1>
<div1 n="3" type="chapter">
<p>
<!-- ... -->
</p>
<milestone unit="part" n="2"/>
<p>
<!-- ... -->
</p>
</div1>
</body>
</text>
<body>
<div1 n="1" type="part">
<milestone unit="chapter" n="1"/>
<p>
<!-- ... -->
</p>
<milestone unit="chapter" n="2"/>
<p>
<!-- ... -->
</p>
<milestone unit="chapter" n="3"/>
<p>
<!-- ... -->
</p>
</div1>
<div1 n="2" type="part">
<p>
<!-- ... -->
</p>
<milestone unit="chapter" n="4"/>
<p>
<!-- ... -->
</p>
</div1>
</body>
</text>
<milestone unit="speaker" n="Man"/>
<l>Oh what is this I cannot see</l>
<l>With icy hands gets a hold on me</l>
<milestone unit="speaker" n="Death"/>
<l>Oh I am Death, none can excel</l>
<l>I open the doors of heaven and hell</l>
</lg>
Milestone tags also make it possible to record the reference systems used in a number of different editions of the same work. The reference system of any one edition can be recreated from a text in which all are marked by simply ignoring all elements that do not specify that edition on their ed attribute.
<milestone ed="E2" unit="work"/>
<milestone ed="E1" unit="book"/>
<milestone ed="E1" unit="poem"/>
<milestone ed="E2" unit="poem"/>
<milestone ed="E2" unit="book"/>
<milestone ed="E1" unit="poem"/>
<milestone ed="E2" unit="poem"/>
In this case no n value is specified, since the numbers rise predictably and the application can keep a count from the start of the document, if desired.
<milestone ed="E1" unit="book" n="1"/>
<milestone ed="E1" unit="poem" n="1"/>
<milestone ed="E1" unit="poem" n="2"/>
<milestone ed="E1" unit="book" n="2"/>
<milestone ed="E1" unit="book" n="1"/>
<milestone ed="E1" unit="poem" n="1.1"/>
<milestone ed="E1" unit="poem" n="1.2"/>
<milestone ed="E1" unit="book" n="2"/>
When using milestone tags, line numbers may be supplied for every line or only periodically (every fifth, every tenth line). The latter may be simpler; the former is more reliable.
The style of numbering used in the values of n is unrestricted: for the example above, I.i, I.ii, and I.iii could have been used equally well if preferred. The special value unnumbered should be reserved for marking sections of text which fall outside the normal numbering system (e.g. chapter heads, poem numbers, titles, or speaker attributions in a verse drama).
By default, there are no constraints on the values supplied for the ed attribute. If it is felt appropriate to enforce such a restriction, the techniques described in 23.2 Personalization and Customization may be used, for example to specify that the attribute must specify one of a predefined set of values.
See below, section 3.10.4 Declaring Reference Systems, for examples of declarations for the reference systems just shown.
Milestone elements may be used to mark any kind of shift in the properties associated with a piece of text, whether or not would normally be considered a reference system. For example, they may be used to mark changes in narrative voice in a prose text, or changes of speaker in a dramatic text, where these are not marked using structural elements such as sp, perhaps in order to avoid a clash of hierarchies.
3.10.4 Declaring Reference SystemsTEI: Declaring Reference Systems¶
Whatever kind of reference system is used in an electronic text, it is recommended that the TEI header contain a description of its construction in the refsDecl element described in section 2.3.5 The Reference System Declaration. As described there, the declaration may consist either of a formal declaration using the cRefPattern element or an informal description in prose. The former is recommended because unlike prose it can be processed by software.
<fileDesc>
<!-- ... -->
</fileDesc>
<encodingDesc>
<refsDecl>
<cRefPattern
matchPattern="([^ ]+) ([0-9]+)\.([0-9]+)\.([0-9]+)"
replacementPattern="#xpath(//div1[@n='$1']/div2[@n='$2']/div3[@n='$3']/l[@n='$4']">
<p>A canonical reference is assembled with
<list>
<item>the name of the <label>work</label>: the
<att>n</att> of a <gi>div1</gi>,</item>
<item>a space,</item>
<item>the number of the <label>book</label>: the
<att>n</att> of a child <gi>div2</gi>,</item>
<item>a full stop</item>
<item>the number of the <label>poem</label>: the
<att>n</att> of a child <gi>div3</gi>,</item>
<item>the line number: the <att>n</att> value of a
child <gi>l</gi>
</item>
</list>
</p>
</cRefPattern>
<cRefPattern
matchPattern="([^ ]+) ([0-9]+)\.([0-9]+)"
replacementPattern="#xpath(//div1[@n='$1']/div2[@n='$2']/div3[@n='$3']">
<p>Same as above, but without the last component (full
stop followed by the <gi>l</gi>'s <att>n</att>.</p>
</cRefPattern>
<cRefPattern
matchPattern="([^ ]+) ([0-9]+)"
replacementPattern="#xpath(//div1[@n='$1']/div2[@n='$2']">
<p>Same as above, but without the poem component (full
stop followed by the <gi>div3</gi>'s <att>n</att>.</p>
</cRefPattern>
</refsDecl>
</encodingDesc>
</teiHeader>
<cRefPattern
matchPattern="([^ ]+ [0-9]+\.[0-9]+\.[0-9]+)"
replacementPattern="#xpath(//l[@n='$1')"/>
</refsDecl>
<cRefPattern
matchPattern="([^ ]+ [0-9]+\.[0-9]+\.[0-9]+)"
replacementPattern="#xpath(//l[@n='$1')"/>
<cRefPattern
matchPattern="([^ ]+ [0-9]+\.[0-9]+)"
replacementPattern="#xpath(//div2[@n='$1')"/>
</refsDecl>
<cRefPattern matchPattern="(.*)" replacementPattern="#$1"/>
</refsDecl>
<p>Standard references to work, book, poem, and line may be
constructed from the milestone tags in the text.</p>
</refsDecl>
<refState ed="E1" unit="work" delim=" "/>
<refState ed="E1" unit="book" delim="."/>
<refState ed="E1" unit="poem" delim=":"/>
<refState ed="E1" unit="line"/>
</refsDecl>
3.11 Bibliographic Citations and ReferencesTEI: Bibliographic Citations and References¶
- bibl (bibliographic citation) contains a loosely-structured bibliographic citation of which the sub-components may or may not be explicitly tagged.
- biblStruct (structured bibliographic citation) contains a structured bibliographic citation, in which only bibliographic sub-elements appear and in a specified order.
- biblFull (fully-structured bibliographic citation) contains a fully-structured bibliographic citation, in which all components of the TEI file description are present.
- listBibl (citation list) contains a list of bibliographic citations of any kind.
In printed texts, the individual constituents of a bibliographic reference are conventionally marked off from each other and from the flow of text by such features as bracketing, italics, special punctuation conventions, underlining, etc. In electronic texts, such distinctions are also important, whether in order to produce acceptably formatted output or to facilitate intelligent retrieval processing, 14 quite apart from the need to distinguish the reference itself as a textual object with particular linguistic properties.
It should be emphasized that for references as for other textual features, the primary or sole consideration is not how the text should be formatted when it is printed. The distinctions permitted by the scheme outlined here may not necessarily be all that particular formatters or bibliographic styles require, although they should prove adequate to the needs of many such commonly used software systems. 15 The features distinguished and described below (in section 3.11.2 Components of Bibliographic References) constitute a set which has been useful for a wide range of bibliographic purposes and in many applications, and which moreover corresponds to a great extent with existing bibliographic and library cataloguing practice. For a fuller account of that practice as applied to electronic texts see section 2.2.7 The Source Description; for a brief mention of related library standards see section 2.7 Note for Library Cataloguers.
3.11.1 Elements of Bibliographic ReferencesTEI: Elements of Bibliographic References¶
The members of the model.biblLike class all share a number of possible component sub-elements. For the bibl and biblStruct elements, exactly the same sub-elements are concerned, and they are described together in section 3.11.2 Components of Bibliographic References; for the biblFull element, the sub-elements concerned are fully described in section 2.2 The File Description.
was <bibl>Tufte's <title>Envisioning
Information</title>
</bibl>, although he may
never have actually read it.</p>
was Tufte's <title>Envisioning Information</title>,
although he may never have actually read it.</p>
in <bibl>Baxter, 1983</bibl>.
<monogr>
<author>Edward R. Tufte</author>
<title>Envisioning Information</title>
<imprint>
<pubPlace>Cheshire, Conn.</pubPlace>
<publisher>Graphics Press</publisher>
<date>1990</date>
</imprint>
</monogr>
</biblStruct>
<titleStmt>
<title>Envisioning Information</title>
<author>Tufte, Edward R[olf]</author>
</titleStmt>
<extent>126 pp.</extent>
<publicationStmt>
<publisher>Graphics Press</publisher>
<pubPlace>Cheshire, Conn. USA</pubPlace>
<date>1990</date>
</publicationStmt>
</biblFull>
<head>Bibliography</head>
<biblStruct xml:id="NELSON80">
<analytic>
<author>Nelson, T. H.</author>
<title>Replacing the printed word:
a complete literary system.</title>
</analytic>
<monogr>
<title>Information Processing '80: Proceedings of the IFIPS
Congress, October 1980</title>
<editor>Simon H. Lavington</editor>
<imprint>
<publisher>North-Holland</publisher>
<pubPlace>Amsterdam</pubPlace>
<date>1980</date>
</imprint>
<biblScope>pp 1013–23 </biblScope>
</monogr>
<note>Apparently a draft of section 4 of
<title>Literary Machines</title>.</note>
</biblStruct>
<bibl xml:id="NELSON88">Ted Nelson: <title>Literary Machines</title>
(privately published, 1987)</bibl>
<bibl xml:id="BAXTER88">
<author>Baxter, Glen</author>
<title>Glen Baxter His Life: the years of struggle</title>
London: Thames and Hudson, 1988.
</bibl>
</listBibl>
<head>Bibliography</head>
<item>
<bibl xml:id="NEL80">
<author>Nelson, T. H.</author>
<title level="a">Replacing the printed word:
a complete literary system.</title>
<title level="m">Information Processing '80:
Proceedings of the IFIPS Congress, October 1980</title>
<editor>Simon H. Lavington</editor>
<publisher>North-Holland</publisher>
<pubPlace>Amsterdam</pubPlace>
<date>1980</date>
<biblScope>pp 1013–23
</biblScope>
<note>Apparently a draft of section 4 of
<title>Literary Machines</title>.</note>
</bibl>
</item>
<item>
<bibl xml:id="NEL88">Ted Nelson: <title>Literary Machines</title>
(privately published, 1987)</bibl>
</item>
<item>
<bibl xml:id="BAX88">
<author>Baxter, Glen</author>
<title>Glen Baxter His Life: the years of struggle</title>
London: Thames and Hudson, 1988.
</bibl>
</item>
</list>
3.11.2 Components of Bibliographic ReferencesTEI: Components of Bibliographic References¶
- elements for grouping components of the analytic, monographic, and series levels in a structured bibliographic reference
- titles of various kinds, and statements of intellectual responsibility (authorship, etc.)
- information relating to the publication, pagination, etc. of an item (most of these constitute the default members of the model.biblPart class)
- annotation, commentary, and further detail
3.11.2.1 Analytic, Monographic, and Series LevelsTEI: Analytic, Monographic, and Series Levels¶
- the analytic level, giving the title, author, etc., of the article;
- the monographic level, giving the title, editor, etc., of the collection;
- the series level, giving the title of the series, possibly the names of its editors, etc., and the number of the volume within that series.
- analytic (analytic level) contains bibliographic elements describing an item (e.g. an article or poem) published within a monograph or journal and not as an independent publication.
- monogr (monographic level) contains bibliographic elements describing an item (e.g. a book or journal) published as an independent item (i.e. as a separate physical object).
- series (series information) contains information about the series in which a book or other bibliographic item has appeared.
For purposes of TEI encoding, journals and anthologies are both treated as monographs; a journal title will thus be tagged as a <title level="j"> element, or simply as a title within a monogr element. Individual articles in the journal or collected texts should be treated at the ‘analytic’ level. When an article has been printed in more than one journal or collection, the bibliographic reference may have more than one monogr element, each possibly followed by one or more series elements. A series element always relates to the most recently preceding monogr element. (Whether reprints of an article are treated in the same bibliographic reference or a separate one varies among different styles. Library lists typically use a different entry for each publication, while academic footnoting practice typically treats all publications of the same article in a single entry.)
<analytic>
<author>Thaller, Manfred</author>
<title level="a">A Draft Proposal for a Standard for the
Coding of Machine Readable Sources</title>
</analytic>
<monogr>
<title level="j">Historical Social Research</title>
<imprint>
<biblScope type="vol">40</biblScope>
<date>October 1986</date>
<biblScope type="pages">3-46</biblScope>
</imprint>
</monogr>
<monogr>
<title level="m">Modelling Historical Data:
Towards a Standard for Encoding and
Exchanging Machine-Readable Texts</title>
<editor>Daniel I. Greenstein</editor>
<imprint>
<pubPlace>St. Katharinen</pubPlace>
<publisher>Max-Planck-Institut für Geschichte
In Kommission bei
Scripta Mercaturae Verlag</publisher>
<date>1991</date>
</imprint>
</monogr>
<series xml:lang="de">
<title level="s">Halbgraue Reihe
zur Historischen Fachinformatik</title>
<respStmt>
<resp>Herausgegeben von</resp>
<name type="person">Manfred Thaller</name>
<name type="org">Max-Planck-Institut für Geschichte</name>
</respStmt>
<title level="s">Serie A: Historische Quellenkunden</title>
<biblScope>Band 11</biblScope>
</series>
</biblStruct>
The practice of analytic vs. monographic citation, as described here, should be distinguished from the practice of including within one citation a reference to another work, which the encoder considers to be related to in some way: see further 3.11.2.5 Related items below.
Punctuation should not appear between the elements within a structured bibliographic entry, unless it is contained within the elements it delimits. As the example shows, it is possible to encode the entry without any inter-element punctuation: this facilitates use of the biblStruct element in systems which can render bibliographic references in any of several styles.
3.11.2.2 Authors, Titles, and EditorsTEI: Authors, Titles, and Editors¶
- title contains a title for any kind of work.
- author in a bibliographic reference, contains the name(s) of the author(s), personal or corporate, of a work; for example in the same form as that provided by a recognized bibliographic name authority.
- editor secondary statement of responsibility for a bibliographic item, for example the name of an individual, institution or organization, (or of several such) acting as editor, compiler, translator, etc.
- respStmt (statement of responsibility) supplies a statement of responsibility for the intellectual content of a text, edition, recording, or series, where the specialized elements for authors, editors, etc. do not suffice or do not apply.
- resp (responsibility) contains a phrase describing the nature of a person's intellectual responsibility.
- name (name, proper noun) contains a proper noun or noun phrase.
- meeting contains the formalized descriptive title for a meeting or conference, for use in a bibliographic description for an item derived from such a meeting, or as a heading or preamble to publications emanating from it.
<analytic>
<author>Lucy Allen Paton</author>
<title>Notes on Manuscripts of the
<title level="m" xml:lang="fr">Prophécies de Merlin</title>
</title>
</analytic>
<monogr>
<title level="j">PMLA</title>
<imprint>
<biblScope type="vol">8</biblScope>
<date>1913</date>
<biblScope type="pages">122</biblScope>
</imprint>
</monogr>
</biblStruct>
In some bibliographic applications, it may prove useful to distinguish main titles from subordinate titles, parallel titles, etc. The type attribute is provided to allow this distinction to be recorded.
<title level="a" type="main">Studies on the physiology of
the hibernating hedgehog, 15</title>
<title level="a" type="subordinate">Effects of seasonal
and temperature changes on the in vitro glycerol release from
brown adipose tissue</title>
<title level="j">Ann. Acad. Sci. Fenn., Ser. A4</title>
<date>1972</date>
<biblScope type="vol">187</biblScope>
<biblScope type="pp">1-4</biblScope>
</bibl>
<title level="m" type="main">The swan lake ballet</title>
= <title level="m" type="parallel" xml:lang="fr">Le lac des cygnes</title>
: <title level="m" type="subordinate" xml:lang="fr">grand ballet en 4 actes</title>
: <title level="m" type="subordinate">op. 20</title>
[Score].
New York: Broude Brothers; [1951] (B.B. 59). vi, 685 p.</bibl>
The elements author and editor have, for printed books and articles, a fairly obvious significance; for other kinds of bibliographic items their proper usage may be less obvious. The author element should be used for the person or agency with primary responsibility for a work's intellectual content, and the element editor for an editor of the work. Thus an organization such as a radio or television station is usually accounted ‘author’ of a broadcast, for example, while the author of a Government report will usually be the agency which produced it.
For anyone else with responsibility for the work, the respStmt element should be used. The nature of the responsibility is indicated by means of a resp element, and the person, organization, etc. responsible by a name, persName, or orgName element. Strings such as ‘unknown’ may be encoded using the rs element. At least one of the four naming elements (name, persName, orgName, or rs) and one resp element should be given within the respStmt element, followed optionally by any number of any of them.
Examples of secondary responsibility of this kind include the roles of illustrator, translator, encoder, and annotator. The respStmt element may also be used for editors, if it is desired to record the specific terms in which their role is described.
Examples of author and editor may be found in sections 3.11.1 Elements of Bibliographic References, and 3.11.2.1 Analytic, Monographic, and Series Levels; wherever author and editor may occur, the respStmt element may also occur. When one of these elements precedes or immediately follows a title, it applies to that title; when it follows an edition element or occurs within an edition statement, it applies to the edition in question.
<author>Lominadze, D. G.</author>
<title level="m">Cyclotron waves in plasma.</title>
<respStmt>
<resp>translated by</resp>
<name>A. N. Dellis;</name>
</respStmt>
<respStmt>
<resp>edited by</resp>
<name>S. M. Hamberger.</name>
</respStmt>
<edition>1st ed.</edition>
<pubPlace>Oxford:</pubPlace>
<publisher>Pergamon Press,</publisher>
<date>1981.</date>
<extent>206 p.</extent>
<title level="s">International series in natural philosophy.</title>
<note place="inline">Translation of:
<title xml:lang="ru" level="m">Ciklotronnye volny v plazme.</title>
</note>
</bibl>
<monogr xml:lang="de">
<title>Des Minnesangs Frühling</title>
<note place="inline">Mit 1 Faksimile</note>
<edition>36., neugestaltete und erweiterte Auflage</edition>
<respStmt>
<resp>Unter Benutzung der Ausgaben von <name>Karl
Lachmann</name> und <name>Moriz Haupt</name>, <name>Friedrich
Vogt</name> und <name>Carl von Kraus</name> bearbeitet von</resp>
<name>Hugo Moser</name>
<name>Helmut Tervooren</name>
</respStmt>
<imprint>
<biblScope type="volume">I Texte</biblScope>
<pubPlace>Stuttgart</pubPlace>
<publisher>S. Hirzel Verlag</publisher>
<date>1977</date>
</imprint>
</monogr>
</biblStruct>
<monogr>
<title>Proceedings of a workshop on corpus resources</title>
<respStmt>
<resp>Programme Organizer</resp>
<name>Geoffrey Leech</name>
</respStmt>
<meeting>DTI Speech and Language Technology Club meeting, 3-4
January 1990, Wadham College, Oxford</meeting>
</monogr>
</biblStruct>
3.11.2.3 Imprint, Pagination, and Other DetailsTEI: Imprint, Pagination, and Other Details¶
- imprint groups information relating to the publication or distribution of a bibliographic item.
- address contains a postal address, for example of a publisher, an organization, or an individual.
- pubPlace (publication place) contains the name of the place where a bibliographic item was published.
- publisher provides the name of the organization responsible for the publication or distribution of a bibliographic item.
- date contains a date in any format.
- idno (identifying number) supplies any number or other identifier used to identify a bibliographic item in a standardized way.
- extent describes the approximate size of a text as stored on some carrier medium, whether digital or non-digital, specified in any convenient units.
- biblScope (scope of citation) defines the scope of a bibliographic reference, for example as a list of page numbers, or a named subdivision of a larger work.
For bibliographic purposes, usually only the place (or places) of publication are required, possibly including the name of the country, rather than a full address; the element pubPlace is provided for this purpose. Where however the full postal address is likely to be of importance in identifying or locating the bibliographic item concerned, it may be supplied and tagged using the address element described in section 3.5.2 Addresses. Alternatively, if desired, the rs or name elements described in section 3.5.1 Referring Strings may be used; this involves no claim that the information given is either a full address or the name of a city.
<monogr>
<author>Nicholas, Charles K.</author>
<author>Welsch, Lawrence A.</author>
<title>On the interchangeability of SGML and ODA</title>
<imprint>
<pubPlace>Gaithersburg, MD</pubPlace>
<publisher>National Institute of Standards and Technology
</publisher>
<date when="1992-01">January 1992</date>
</imprint>
<extent>19 pp.</extent>
</monogr>
<idno type="NIST">NISTIR 4681</idno>
</biblStruct>
<monogr>
<author>Hansen, W.</author>
<title level="u">Creation of hierarchic text
with a computer display</title>
<note place="inline">Ph.D. dissertation</note>
<imprint>
<publisher>Dept. of Computer Science, Stanford Univ.</publisher>
<pubPlace>Stanford, CA</pubPlace>
<date when="1971-06">June 1971</date>
</imprint>
</monogr>
</biblStruct>
<monogr>
<author>Shirley, James</author>
<title type="main">The gentlemen of Venice</title>
<title type="subordinate">a tragi-comedie presented at the private
house in Salisbury Court by Her Majesties servants</title>
<note place="inline">[Microform]</note>
<imprint>
<pubPlace>London</pubPlace>
<publisher>H. Moseley</publisher>
<date>1655</date>
</imprint>
<extent>78 p.</extent>
</monogr>
<monogr>
<imprint>
<pubPlace>New York</pubPlace>
<publisher>Readex Microprint</publisher>
<date>1953</date>
</imprint>
<extent>1 microprint card, 23 x 15 cm.</extent>
</monogr>
<series>
<title>Three centuries of drama: English, 1642–1700</title>
</series>
</biblStruct>
An alternative way of handling the above situation would be to use the relatedItem element described in section 3.11.2.5 Related items below.
A bibliographic description, particularly for an analytic title, will often include some additional information specifying its location, for example as a volume number, page number, range of page numbers, or name or number of a subdivision of the host work. The element biblScope may be used to identify such information if it is present. Where it is desired to distinguish different classes of such information (volume number, page number, chapter number, etc.), the type attribute may be used with any convenient typology.
When the item being cited is a journal article, the imprint element describing the issue in which it appeared may contain biblScope elements for volume and page numbers, together with a date element.
<analytic>
<author>Wrigley, E. A.</author>
<title>Parish registers and the historian</title>
</analytic>
<monogr>
<editor>Steel, D. J.</editor>
<title>National index of parish registers</title>
<imprint>
<pubPlace>London</pubPlace>
<publisher>Society of Genealogists</publisher>
<date when="1968">1968</date>
<biblScope type="vol">vol. 1</biblScope>
<biblScope type="pp">pp. 155–167.</biblScope>
</imprint>
</monogr>
</biblStruct>
<analytic>
<author>Boguraev, Branimir</author>
<author>Neff, Mary</author>
<title>Text Representation, Dictionary Structure,
and Lexical Knowledge</title>
</analytic>
<monogr>
<title level="j">Literary & Linguistic Computing</title>
<imprint>
<biblScope type="vol">7</biblScope>
<biblScope type="issue">2</biblScope>
<date>1992</date>
<biblScope type="pp">110-112</biblScope>
</imprint>
</monogr>
</biblStruct>
<analytic>
<author>Chesnutt, David</author>
<title>Historical Editions in the States</title>
</analytic>
<monogr>
<title level="j">Computers and the Humanities</title>
<imprint>
<biblScope>25.6</biblScope>
<date when="1991-12">(December, 1991):</date>
<biblScope>377–380</biblScope>
</imprint>
</monogr>
</biblStruct>
3.11.2.4 Series InformationTEI: Series Information¶
Series information may (in bibl elements) or must (in biblStruct elements) be enclosed in a series element or (in a biblFull element) a seriesStmt element. The title of the series may be tagged <title level="s">, the volume number <biblScope type="vol">, and responsibility statements for the series (e.g. the name and affiliation of the editor, as in the example in section 3.11.2.1 Analytic, Monographic, and Series Levels) may be tagged editor or respStmt.
3.11.2.5 Related itemsTEI: Related items¶
In bibliographic parlance, a related item is any bibliographic item which, though related to that being defined, is distinct from it. The distinction between analytic and monographic items made above may be thought of as a special case of this kind of ‘related’ item. More usually however, the term is applied to such items as translations, continuations, original sources, parts, etc.
- relatedItem contains or references some other bibliographic item which is related to the present one in some specified manner, for example as a constituent or alternative version of it.
<monogr>
<author>Swinburne, Algernon Charles</author>
<title>Swinburne's <title>Atalanta in Calydon</title>: A Facsimile of the
First Edition</title>
<editor>Georges Lafourcade</editor>
<imprint>
<pubPlace>London</pubPlace>
<publisher>Oxford UP</publisher>
<date>1930</date>
</imprint>
</monogr>
<relatedItem type="original">
<ref target="#bibl04"/>
</relatedItem>
</biblStruct>
<biblStruct xml:id="bibl04">
<monogr>
<author> Swinburne, Algernon Charles</author>
<title>Atalanta in Calydon</title>
<imprint>
<pubPlace>London</pubPlace>
<publisher>Edward Moxon</publisher>
<date>1865</date>
</imprint>
</monogr>
</biblStruct>
<monogr>
<author>Shirley, James</author>
<title type="main">The gentlemen of Venice</title>
<imprint>
<pubPlace>New York</pubPlace>
<publisher>Readex Microprint</publisher>
<date>1953</date>
</imprint>
<extent>1 microprint card, 23 x 15 cm.</extent>
</monogr>
<series>
<title>Three centuries of drama: English, 1642–1700</title>
</series>
<relatedItem type="original">
<biblStruct>
<monogr>
<author>Shirley, James</author>
<title type="main">The gentlemen of Venice</title>
<title type="subordinate">a tragi-comedie presented at the private
house in Salisbury Court by Her Majesties servants</title>
<imprint>
<pubPlace>London</pubPlace>
<publisher>H. Moseley</publisher>
<date>1655</date>
</imprint>
<extent>78 p.</extent>
</monogr>
</biblStruct>
</relatedItem>
</biblStruct>
3.11.2.6 Notes and Other Additional InformationTEI: Notes and Other Additional Information¶
- note contains a note or annotation.
<author>Coombs, James H., Allen H. Renear,
and Steven J. DeRose.</author>
<title level="a">Markup Systems and the Future of Scholarly
Text Processing.</title>
<title level="j">Communications of the ACM</title>
<biblScope>30.11 (November 1987): 933–947.</biblScope>
<note>Classic polemic supporting descriptive over procedural
markup in scholarly work.</note>
</bibl>
3.11.2.7 Order of Components within ReferencesTEI: Order of Components within References¶
The order of elements in bibl elements is not constrained.
- notes on the publication (and meeting elements describing the conference, in the case of a proceedings volume)
- edition elements, each followed by any related editor or respStmt elements
- imprint
- biblScope
Finally, within the series information in a biblStruct, the sequence of elements is not constrained.
If more detailed structuring of a bibliographic description is required, the biblFull element should be used. This is not further described here, as its contents are essentially equivalent to those of the fileDesc element in the teiHeader, which is fully described in section 2.2 The File Description.
3.11.3 Bibliographic Pointers TEI: Bibliographic Pointers ¶
3.11.4 Relationship to Other Bibliographic SchemesTEI: Relationship to Other Bibliographic Schemes¶
The bibliographic tagging defined here can capture the distinctions required by most bibliographic encoding systems; for the benefit of users of some commonly used systems, the following lists of equivalences are offered, showing the relationship of the markup defined here to the fields defined for bibliographic records in the Scribe, BibTeX, and ProCite systems.
- address
- tag as placeName or address
- annote
- tag as note
- author
- tag as author
- booktitle
- tag as <title level="m"> or title within monogr
- chapter
- tag as <biblScope type="chapter">
- date
- used only to record date entry was made in the bibliographic database; not supported
- edition
- tag as edition
- editor
- tag as editor or respStmt
- editors
- tag as multiple editor or respStmt elements
- fullauthor
- use the reg element, possibly inside a choice element, inside either an author or name
- fullorganization
- use the reg element, possibly inside a choice element, inside a <name type="org">
- howpublished
- tag as note, possibly using the form <note place="inline">
- institution
- used only for issuer of technical reports; tag as publisher
- journal
- tag as <title level="j"> or title within monogr
- key
- used to specify an alternate sort key for the bibliographic item, for use instead of author's or editor's name; not supported
- meeting
- tag as meeting or as note
- month
- use date; if the date is not in a trivially parseable form, use the when attribute to provide a normalized equivalent in one of the format from XML Schema Part 2: Datatypes Second Edition
- note
- tag as note
- number
- tag as <biblScope type="issue"> or <biblScope type="number">; for technical report numbers, use <idno type="docno">
- organization
- used only for sponsor of conference; use <name type="org"> within respStmt within meeting element
- pages
- tag as <biblScope type="pp">
- publisher
- tag as publisher
- school
- used only for institutions at which thesis work is done; tag as publisher
- series
- tag as <title level="s"> or title within series
- title
- tag as title in appropriate context or with appropriate level value
- volume
- tag as <biblScope type="vol">
- year
- tag as date; if the date is not in a trivially parseable form, use the when attribute to provide an ISO-format equivalent
3.12 Passages of Verse or DramaTEI: Passages of Verse or Drama¶
- l (verse line) contains a single, possibly incomplete, line of verse.
- lg (line group) contains a group of verse lines functioning as a formal unit, e.g. a stanza, refrain, verse paragraph, etc.
- sp (speech) An individual speech in a performance text, or a passage presented as such in a prose or verse text.
- speaker A specialized form of heading or label, giving the name of one or more speakers in a dramatic text or fragment.
- stage (stage direction) contains any kind of stage direction within a dramatic text or fragment.
Full details of other, more specialized, elements for the encoding of texts which are predominantly verse or drama are described in the appropriate chapter of part three (for verse, see the verse base described in chapter 6 Verse; for performance texts, see the drama base described in chapter 7 Performance Texts). In this section, we describe only the elements listed above, all of which can appear in any text, whichever of the three modes prose, verse, or drama may predominate in it.
3.12.1 Core Tags for VerseTEI: Core Tags for Verse¶
Like other written texts, verse texts or poems may be hierarchically subdivided, for example into books or cantos. These structural subdivisions should be encoded using the general purpose div or div1 (etc.) elements described below in chapters 4 Default Text Structure and 6 Verse. The fundamental unit of a verse text is the verse line rather than the paragraph, however.
<l>Of that Forbidden Tree, whose<lb/> mortal tast</l>
<l>Brought Death into the World,<lb/> and all our woe,</l>
<l>With loss of Eden, till one greater Man</l>
<l>Restore us, and regain the blissful Seat...</l>
The l element should not be used to represent typographic lines in non-verse materials: if the line-breaking points in a prose text are considered important for analysis, they should be marked with the lb element. Alternatively, a neutral segmentation element such as seg or ab may be used; see further discussion of these elements in chapter 16 Linking, Segmentation, and Alignment. The l element is a member of the model.lLike class, which is a subclass of the model.divPart class, along with elements from the model.pLike (paragraph-like) class.
- att.typed provides attributes which can be used to classify or subclassify elements in any way.
type characterizes the element in some sense, using any convenient classification scheme or typology. subtype provides a sub-categorization of the element, if needed
<l>Come fill up the Glass,</l>
<l rend="indent">Round, round let it pass,</l>
<l>'Till our Reason be lost in our Wine:</l>
<l rend="indent">Leave Conscience's Rules</l>
<l rend="indent">To Women and Fools,</l>
<l>This only can make us divine.</l>
</lg>
<lg n="Chorus" type="refrain">
<l>Then a Mohock, a Mohock I'll be,</l>
<l>No Laws shall restrain</l>
<l>Our Libertine Reign,</l>
<l>We'll riot, drink on, and be free.</l>
</lg>
<lg type="octet">
<l>Thus speaks the Muse, and bends her brow severe:—</l>
<l>“Did I, <name>Lætitia</name>, lend my choicest lays,</l>
<l>And crown thy youthful head with freshest bays,</l>
<l>That all the' expectance of thy full-grown year</l>
<l>Should lie inert and fruitless? O revere</l>
<l>Those sacred gifts whose meed is deathless praise,</l>
<l>Whose potent charms the' enraptured soul can raise</l>
<l>Far from the vapours of this earthly sphere!</l>
</lg>
<lg type="sestet">
<l>Seize, seize the lyre! resume the lofty strain!</l>
<l>'T is time, 't is time! hark how the nations round</l>
<l>With jocund notes of liberty resound,—</l>
<l>And thy own <name>Corsica</name> has burst her chain!</l>
<l>O let the song to <name>Britain's</name> shores rebound,</l>
<l rend="indent(-1)">Where Freedom's once-loved voice is heard,
alas! in vain.”</l>
</lg>
</lg>
<l>More tight at this, then thou: Dispatch. O Loue,</l>
<l>That thou couldst see my Warres to day, and knew'st</l>
<l>The Royall Occupation, thou should'st see</l>
<l part="I">A Workeman in't. <stage>Enter an Armed Soldier.</stage>
</l>
<l part="F">Good morrow to thee, welcome. </l>
<!-- ... -->
<l>Unprofitably travelling toward the grave,</l>
<l>Like a false steward who hath much received</l>
<l part="I">And renders nothing back.</l>
</lg>
<lg type="para" n="7">
<l part="F">Was it for this</l>
<l>That one, the fairest of all rivers, loved</l>
<l>To blend his murmurs with my nurse's song,</l>
<!-- ... -->
</lg>
<speaker>First Voice</speaker>
<lg type="stanza" part="I">
<l>But why drives on that ship so fast</l>
<l>Withouten wave or wind?</l>
</lg>
</sp>
<sp>
<speaker>Second Voice</speaker>
<lg type="stanza" part="F">
<l>The air is cut away before,</l>
<l>And closes from behind.</l>
</lg>
</sp>
For alternative methods of aligning groups of lines which do not form simple hierarchic groups, or which are discontinuous, see the more detailed discussion in chapter 16 Linking, Segmentation, and Alignment. For discussion of other elements and attributes specific to the encoding of verse, see chapter 6 Verse.
3.12.2 Core Tags for DramaTEI: Core Tags for Drama¶
Like other written texts, dramatic and other performance texts such as cinema or TV scripts are often hierarchically organized, for example into acts and scenes. These structural subdivisions should be encoded using the general purpose div or div1 (etc.) elements described below in chapters 4 Default Text Structure and 7 Performance Texts. Within these divisions, the body of a performance text typically consists of speeches, often prefixed by a phrase indicating who is speaking, and occasionally interspersed with stage directions of various kinds.
<head>Scene 2.</head>
<stage type="setting">Peachum, Filch.</stage>
<sp>
<speaker>FILCH.</speaker>
<p>Sir, Black Moll hath sent word her Trial comes on in
the Afternoon, and she hopes you will order Matters
so as to bring her off.</p>
</sp>
<sp>
<speaker>PEACHUM.</speaker>
<p>Why, she may plead her Belly at worst; to my
Knowledge she hath taken care of that Security.
But, as the Wench is very active and industrious,
you may satisfy her that I'll soften the Evidence.</p>
</sp>
<sp>
<speaker>FILCH.</speaker>
<p>Tom Gagg, sir, is found guilty.</p>
</sp>
</div2>
<head>ACT I</head>
<div2 n="1" type="Scene">
<head>SCENE I</head>
<stage rend="italic">Enter Barnardo and Francisco,
two Sentinels, at several doors</stage>
<sp>
<speaker>Barn</speaker>
<l part="Y">Who's there?</l>
</sp>
<sp>
<speaker>Fran</speaker>
<l>Nay, answer me. Stand and unfold yourself.</l>
</sp>
<sp>
<speaker>Barn</speaker>
<l part="I">Long live the King!</l>
</sp>
<sp>
<speaker>Fran</speaker>
<l part="M">Barnardo?</l>
</sp>
<sp>
<speaker>Barn</speaker>
<l part="F">He.</l>
</sp>
<sp>
<speaker>Fran</speaker>
<l>You come most carefully upon your hour.</l>
</sp>
<sp>
<speaker>Barn</speaker>
<l>'Tis now struck twelve. Get thee to bed, Francisco.</l>
</sp>
<sp>
<speaker>Fran</speaker>
<l>For this relief much thanks. 'Tis bitter cold,</l>
<l part="I">And I am sick at heart.</l>
</sp>
</div2>
</div1>
<add place="margin">Now call'd <name xml:id="barnardo">Bernardo</name> &
<name xml:id="francisco">Francesco</name>.</add>
</stage>
<sp who="#francisco">
<speaker>1.</speaker>
<l part="Y">Stand: who is that?</l>
</sp>
<sp who="#barnardo">
<speaker>2.</speaker>
<l part="Y">Tis I.</l>
</sp>
<sp who="#francisco">
<speaker>1.</speaker>
<l>O you come most carefully vpon your watch,</l>
</sp>
<sp who="#barnardo">
<speaker>2.</speaker>
<l>And if you meete Marcellus and Horatio,</l>
<l>The partners of my watch, bid them make haste.</l>
</sp>
<sp who="#francisco">
<speaker>1.</speaker>
<l part="Y">I will: See who goes there.</l>
</sp>
<stage>Enter Horatio and Marcellus.</stage>
<div2 n="1" type="scene">
<head rend="italic">Actus primus, Scena prima.</head>
<stage rend="italic" type="setting">A tempestuous
noise of Thunder and Lightning heard: Enter
a Ship-master, and a Boteswaine.</stage>
<sp>
<speaker>Master.</speaker>
<p>Bote-swaine.</p>
</sp>
<sp>
<speaker>Botes.</speaker>
<p>Heere Master: What cheere?</p>
</sp>
<sp>
<speaker>Mast.</speaker>
<p>Good: Speake to th' Mariners: fall
too't, yarely, or we run our selues a ground,
bestirre, bestirre. <stage type="move">Exit.</stage>
</p>
</sp>
<stage type="move">Enter Mariners.</stage>
<sp>
<speaker>Botes.</speaker>
<p>Heigh my hearts, cheerely, cheerely my harts: yare,
yare: Take in the toppe-sale: Tend to th' Masters whistle:
Blow till thou burst thy winde, if roome e-nough.</p>
</sp>
</div2>
</div1>
<speaker>The reverend Doctor Opimiam</speaker>
<p>I do not think I have named a single unpresentable fish.</p>
</sp>
<sp>
<speaker>Mr Gryll</speaker>
<p>Bream, Doctor: there is not much to be said for bream.</p>
</sp>
<sp>
<speaker>The Reverend Doctor Opimiam</speaker>
<p>On the contrary, sir, I think there is much to be said for him.
In the first place ...</p>
<p>Fish, Miss Gryll — I could discourse to you on fish by the
hour: but for the present I will forbear ...</p>
</sp>
<speaker>Lord Curryfin</speaker>
<stage>(after a pause).</stage>
<p>
<q>Mass</q> as the second grave-digger says
in <title>Hamlet</title>, <q>I cannot tell.</q>
</p>
</sp>
<p>A chorus of laughter dissolved the sitting.</p>
3.13 Overview of the Core Module TEI: Overview of the Core Module ¶
- Module core: Elements common to all TEI documents
-
- Elements defined: abbr add addrLine address analytic author bibl biblScope biblStruct binaryObject cb choice cit corr date del desc distinct divGen editor email emph expan foreign gap gloss graphic head headItem headLabel hi imprint index item l label lb lg list listBibl measure measureGrp meeting mentioned milestone monogr name note num orig p pb postBox postCode ptr pubPlace publisher q quote ref reg relatedItem resp respStmt rs said series sic soCalled sp speaker stage street teiCorpus term time title unclear
↑ Contents « 2 The TEI Header » 4 Default Text Structure