TEI Lite was the name adopted for what the TEI editors originally conceived of as a simple demonstration of how the TEI (Text Encoding Initiative) encoding scheme might be adopted to meet 90% of the needs of 90% of the TEI user community. In retrospect, it was predictable that many people should imagine TEI Lite to be all there is to TEI, or find TEI Lite to be far too heavy for their needs.
The original TEI Lite (1996) was based largely on observations of existing and previous practice in the encoding of texts, particularly as manifest in the collections of the Oxford Text Archive and other collections of the period. It is therefore unsurprising that it seems to have become, if not a de facto standard, at least a common point of departure for electronic text centres and encoding projects world wide. Maybe the fact that we actually produced this shortish, readable, manual for it also helped.
Early adopters of TEI Lite included a number of ‘Electronic Text Centers’ and digital library initiatives. It was also adopted as the basis for some early TEI-conformant authoring systems, and as the basis for introductory tutorials, many of them in languages other than English (see further the list of legacy versions at http://www.tei-c.org/Vault/P4/Lite/).
In 2002, following the publication of TEI P4, the XML version of the TEI Guidelines, which uses the generation of TEI Lite as an example of the TEI modification mechanism, the opportunity was taken to produce a lightly revised XML-conformant version. In 2006, a more substantially revised version based on TEI P5 was produced; this reflected the many changes between TEI P4 and TEI P5, but was not otherwise significantly different. In 2012, the TEI Technical Council, decided that a final revision should be undertaken to ensure that the documentation remained consistent with the latest (2.1) release of TEI P5. This version uses a recently added mechanism in the TEI customization architecture, which permits a customization to define only the TEI elements to be included in a schema, rather than the elements to be excluded from it. As such it is probably more resilient to change than earlier versions.
This document provides an introduction to the recommendations of the Text Encoding Initiative (TEI), by describing a specific subset of the full TEI encoding scheme. The scheme documented here can be used to encode a wide variety of commonly encountered textual features, in such a way as to maximize the usability of electronic transcriptions and to facilitate their interchange among scholars using different computer systems. It is fully compatible with the full TEI scheme, as defined by TEI document P5, Guidelines for Electronic Text Encoding and Interchange, as of February 2006, and available from the TEI Consortium website at http://www.tei-c.org/.
The Text Encoding Initiative (TEI) Guidelines are addressed to anyone who wants to interchange information stored in an electronic form. They emphasize the interchange of textual information, but other forms of information such as images and sound are also addressed. The Guidelines are equally applicable in the creation of new resources and in the interchange of existing ones.
The Guidelines provide a means of making explicit certain features of a text in such a way as to aid the processing of that text by computer software running on different machines. This process of making explicit we call markup or encoding. Any textual representation on a computer uses some form of markup; the TEI came into being partly because of the enormous variety of mutually incomprehensible encoding schemes currently besetting scholarship, and partly because of the expanding range of scholarly uses now being identified for texts in electronic form.
The TEI Guidelines describe an encoding scheme which can be expressed using a number of different formal languages. The first editions of the Guidelines used the Standard Generalized Markup Language (SGML); since 2002, this has been replaced by the use of the Extensible Markup Language (XML). These markup languages have in common the definition of text in terms of elements and attributes, and rules governing their appearance within a text. The TEI's use of XML is ambitious in its complexity and generality, but it is fundamentally no different from that of any other XML markup scheme, and so any general-purpose XML-aware software is able to process TEI-conformant texts.
Since 2001, the TEI has been a community initiative supported by an international membership consortium. It was originally an international research project sponsored by the Association for Computers and the Humanities, the Association for Computational Linguistics, and the Association for Literary and Linguistic Computing, with substantial funding over its first five years from the U.S. National Endowment for the Humanities, Directorate General XIII of the Commission of the European Communities, the Andrew W. Mellon Foundation, the Social Science and Humanities Research Council of Canada and others. The Guidelines were first published in May 1994, after six years of development involving many hundreds of scholars from different academic disciplines worldwide. During the years that followed, the Guidelines became increasingly influential in the development of the digital library, in the language industries, and even in the development of the World Wide Web itself. The TEI Consortium was set up in January 2001, and a year later produced an edition of the Guidelines entirely revised for XML compatibility. In 2004, it set about a major revision of the Guidelines to take full advantage of new schema languages, the first release of which appeared in 2005. This revision of the TEI Lite document conforms to version 2.1 of this most recent edition of the Guidelines, TEI P5, released in June 2012.
At the outset of its work, the overall goals of the TEI were defined by the closing statement of a planning conference held at Vassar College, N.Y., in November, 1987; these ‘Poughkeepsie Principles’ were further elaborated in a series of design documents. The Guidelines, say these design documents, should:
The world of scholarship is large and diverse. For the Guidelines to have wide acceptability, it was important to ensure that:
The present document describes a manageable selection from the extensive set of elements and recommendations resulting from those design goals, which is called TEI Lite.
In selecting from the several hundred elements defined by the full TEI scheme, we have tried to identify a useful ‘starter set’, comprising the elements which almost every user should know about. Experience working with TEI Lite will be invaluable in understanding the full TEI scheme and in knowing how to integrate specialized parts of it into the general TEI framework.
Our goals in defining this subset may be summarized as follows:
The reader may judge our success in meeting these goals for him or herself.
Although we have tried to make this document self-contained, as suits a tutorial text, the reader should be aware that it does not cover every detail of the TEI encoding scheme. All of the elements described here are fully documented in the TEI Guidelines themselves, which should be consulted for authoritative reference information on these, and on the many others which are not described here. Some basic knowledge of XML is assumed.
We begin with a short example, intended to show what happens when a passage of prose is typed into a computer by someone with little sense of the purpose of mark-up, or the potential of electronic texts. In an ideal world, such output might be generated by a very accurate optical scanner. It attempts to be faithful to the appearance of the printed text, by retaining the original line breaks, by introducing blanks to represent the layout of the original headings and page breaks, and so forth. Where characters not available on the keyboard are needed (such as the accented letter a in faàl or the long dash), it attempts to mimic their appearance.
CHAPTER 38
READER, I married him. A quiet wedding we had: he and I, the par-
son and clerk, were alone present. When we got back from church, I
went into the kitchen of the manor-house, where Mary was cooking
the dinner, and John cleaning the knives, and I said --
'Mary, I have been married to Mr Rochester this morning.' The
housekeeper and her husband were of that decent, phlegmatic
order of people, to whom one may at any time safely communicate a
remarkable piece of news without incurring the danger of having
one's ears pierced by some shrill ejaculation and subsequently stunned
by a torrent of wordy wonderment. Mary did look up, and she did
stare at me; the ladle with which she was basting a pair of chickens
roasting at the fire, did for some three minutes hang suspended in air,
and for the same space of time John's knives also had rest from the
polishing process; but Mary, bending again over the roast, said only --
'Have you, miss? Well, for sure!'
A short time after she pursued, 'I seed you go out with the master,
but I didn't know you were gone to church to be wed'; and she
basted away. John, when I turned to him, was grinning from ear to
ear.
'I telled Mary how it would be,' he said: 'I knew what Mr Ed-
ward' (John was an old servant, and had known his master when he
was the cadet of the house, therefore he often gave him his Christian
name) -- 'I knew what Mr Edward would do; and I was certain he
would not wait long either: and he's done right, for aught I know. I
wish you joy, miss!' and he politely pulled his forelock.
'Thank you, John. Mr Rochester told me to give you and Mary
this.'
I put into his hand a five-pound note. Without waiting to hear
more, I left the kitchen. In passing the door of that sanctum some time
after, I caught the words --
'She'll happen do better for him nor ony o' t' grand ladies.' And
again, 'If she ben't one o' th' handsomest, she's noan faa\l, and varry
good-natured; and i' his een she's fair beautiful, onybody may see
that.'
I wrote to Moor House and to Cambridge immediately, to say what
I had done: fully explaining also why I had thus acted. Diana and
474
JANE EYRE 475
Mary approved the step unreservedly. Diana announced that she
would just give me time to get over the honeymoon, and then she
would come and see me.
'She had better not wait till then, Jane,' said Mr Rochester, when I
read her letter to him; 'if she does, she will be too late, for our honey-
moon will shine our life long: its beams will only fade over your
grave or mine.'
How St John received the news I don't know: he never answered
the letter in which I communicated it: yet six months after he wrote
to me, without, however, mentioning Mr Rochester's name or allud-
ing to my marriage. His letter was then calm, and though very serious,
kind. He has maintained a regular, though not very frequent correspond-
ence ever since: he hopes I am happy, and trusts I am not of those who
live without God in the world, and only mind earthly things.
⚓This transcription suffers from a number of shortcomings:
This particular encoding represents a set of choices or priorities. As a trivial example, note that in the second example, end-of-line hyphenation has been silently removed. Conceivably Brontë (or her printer) intended the word ‘honeymoon’ to appear as ‘honey-moon’ on its second appearance, though this seems unlikely: our decision to focus on Brontë's text, rather than on the printing of it in this particular edition, makes it impossible to be certain. This is an instance of the fundamental selectivity of any encoding. An encoding makes explicit only those textual features of importance to the encoder. It is not difficult to think of ways in which the encoding of even this short passage might readily be extended. For example:
TEI-recommended ways of carrying out most of these are described in the remainder of this document. The TEI scheme as a whole also provides for an enormous range of other possibilities, of which we cite only a few:
For recommendations on these and many other possibilities, the full Guidelines should be consulted.
All TEI-conformant texts contain (a) a TEI header (marked up as a teiHeader element) and (b) the transcription of the text proper (marked up as a text element). These two elements are combined together to form a single TEI element, which must be declared within the TEI namespace1.
The TEI header provides information analogous to that provided by the title page of a printed text. It has up to four parts: a bibliographic description of the machine-readable text, a description of the way it has been encoded, a non-bibliographic description of the text (a text profile), and a revision history. The header is described in more detail in section 19 The Electronic Title Page.
A TEI text may be unitary (a single work) or composite (a collection of single works, such as an anthology). In either case, the text may have an optional front or back. In between is the body of the text, which, in the case of a composite text, may consist of groups, each containing more groups or texts.
In the remainder of this document, we discuss chiefly simple text structures. The discussion in each case consists of a short list of relevant TEI elements with a brief definition of each, followed by definitions for any attributes specific to that element, and a reference to any classes of which the element is a member. These references are linked to full specifications for each object, as given in the TEI Guidelines. In most cases, short examples are also given.
For example, here are the elements discussed so far:
As indicated above, a simple TEI document at the textual level consists of the following elements:
Elements specific to front and back matter are described below in section 18 Front and Back Matter. In this section we discuss the elements making up the body of a text.
The body of a prose text may be just a series of paragraphs, or these paragraphs may be grouped together into chapters, sections, subsections, etc. Each paragraph is tagged using the p tag. The div element is used to represent any such grouping of paragraphs.
The type attribute on the div element may be used to supply a conventional name for this category of text division, or otherwise distinguish them. Typical values might be ‘book’, ‘chapter’, ‘section’, ‘part’, ‘poem’, ‘song’, etc. For a given project, it will usually be advisable to define and adhere to a specific list of such values.
A div element may itself contain further, nested, divs, thus mimicking the traditional structure of a book, which can be decomposed hierarchically into units such as parts, containing chapters, containing sections, and so on. TEI texts in general conform to this simple hierarchic model.
The xml:id attribute may be used to supply a unique identifier for the division, which may be used for cross references or other links to it, such as a commentary, as further discussed in section 8 Cross References and Links. It is often useful to provide an xml:id attribute for every major structural unit in a text, and to derive its values in some systematic way, for example by appending a section number to a short code for the title of the work in question, as in the examples below. It is particularly useful to supply such identifiers if the resource concerned is to be made available over the web, since they make it much easier for other web-based applications to link directly to the corresponding parts of your text.
The n attribute may be used to supply (additionally or alternatively) a short mnemonic name or number for a division, or any other element. If a conventional form of reference or abbreviation for the parts of a work already exists (such as the book/chapter/verse pattern of Biblical citations), the n attribute is the place to record it; unlike the identifier supplied by xml:id, it does not need to be unique.
The xml:lang attribute may be used to specify the language of the division. Languages are identified by an internationally defined code, as further discussed in section 6.3 Foreign Words or Expressions below.
The rend attribute may be used to supply information about the rendition (appearance) of a division, or any other element, as further discussed in section 6 Marking Highlighted Phrases below. As with the type attribute, a project will often find it useful to predefine the possible values for this attribute, but TEI Lite does not constrain it in anyway.
These four attributes, xml:id, n, xml:lang, and rend are so widely useful that they are allowed on any element in any TEI schema: they are global attributes. Other global attributes defined in the TEI Lite scheme are discussed in section 8.3 Special kinds of Linking.
Every div may have a title or heading at its start, and (less commonly) a trailer such as ‘End of Chapter 1’ at its end. The following elements may be used to transcribe them:
Some other elements which may be necessary at the beginning or ending of text divisions are discussed below in section 18.1.2 Prefatory Matter.
<div type="chapter" n="1">), it may be omitted; where it contains otherwise unrecoverable text it should always be included. For example, the start of Hardy's Under the Greenwood Tree might be encoded as follows: As in the Bronte example above, the paragraphs making up a textual division are tagged with the p tag. In poetic or dramatic texts different tags are needed, to represent verse lines and stanzas in the first case, or individual speeches and stage directions in the second. :
Note that the l element marks verse lines, not typographic lines: the original lineation of the first few lines above has not therefore been made explicit by this encoding, and may be lost. The lb element described in section 5 Page and Line Numbers might additionally be used to mark typographic lines if so desired.
#OPI etc.) are links, pointing to a list of the characters in the novel, each of which has an identifier: Page and line breaks etc. may be marked with the following elements.
These elements mark a single point in the text, not a span of text. The global n attribute should be used to supply the number of the page or line beginning at the tag.
When working from a paginated original, it is often useful to record its pagination, if only to simplify later proof-reading. It is also useful for synchronizing an encoded text with a set of page images. Recording the line breaks may be useful for similar reasons.
A special attribute break may be used to indicate whether or not this empty element is considered as a word-breaking, irrespective of any adjacent whitespace. For example, in the following encoded sample:
The pb and lb elements are special cases of the general class of milestone elements which mark reference points within a text. The generic milestone element can mark any kind of reference point: for example, a column break, the start of a new kind of section not otherwise tagged, or in general any significant change in the text not marked by an XML element. The names used for types of unit and for editions referred to by the ed and unit attributes may be chosen freely, but should be documented in the header refsDecl element (see 19.2.3 Reference and Classification Declarations). The milestone element may be used to replace the others, or the others may be used as a set; they should not be mixed arbitrarily.
Highlighted words or phrases are those made visibly different from the rest of the text, typically by a change of type font, handwriting style, ink colour etc., which is intended to draw the reader's attention to some associated change.
The global rend attribute can be attached to any element, and used wherever necessary to specify details of the highlighting used for it in the source. For example, a heading rendered in bold might be tagged <head rend="bold">, and one in italic <head rend="italic">.
The values to be used for the rend attribute are not specified by the TEI Guidelines, since they will depend entirely on the needs of the particular project. Some typical values might include italic, bold etc. for font variations; center, right etc. for alignment; large, small etc. for size; smallcaps, allcaps etc. for type variants and so on. Several such words may be used in combination as necessary, but no formal syntax is proposed. The full TEI Guidelines provide more rigorous mechanisms, using other W3C standards such as CSS, as an alternative to the use of rend.
It is not always possible or desirable to interpret the reasons for such changes of rendering in a text. In such cases, the element hi may be used to mark a sequence of highlighted text without making any claim as to its status.
Alternatively, where the cause for the highlighting can be identified with confidence, a number of other, more specific, elements are available.
Some features (notably quotations and glosses) may be found in a text either marked by highlighting, or with quotation marks. In either case, the elements q and gloss (as discussed in the following section) should be used. If the highlighting is to be recorded, use the global rend attribute.
Like changes of typeface, quotation marks are conventionally used to denote several different features within a text, of which the most frequent is quotation. When possible, we recommend that the underlying feature be tagged, rather than the simple fact that quotation marks appear in the text, using the following elements:
To record how a quotation was printed (for example, in-line or set off as a display or block quotation), the rend attribute should be used. This may also be used to indicate the kind of quotation marks used.
The creator of the electronic text must decide whether quotation marks are replaced by the tags or whether the tags are added and the quotation marks kept. If the quotation marks are removed from the text, the rend attribute may be used to record the way in which they were rendered in the copy text.
The full TEI Guidelines provide additional elements to distinguish direct speech, quotation, and other typical uses of quotation mark although it is not always possible and may not be considered desirable to interpret the function of quotation marks in a text. For simplicity, only q (which may be used for any such case) has been included in TEI Lite.
As these examples show, the foreign element should not be used to tag foreign words if some other more specific element such as title, mentioned, or term applies. The global xml:lang attribute may be attached to any element to show that it uses some other language than that of the surrounding text.
The codes used to identify languages, supplied on the xml:lang attribute, must be constructed in a particular way, and must conform to common Internet standards2, as further explained in the relevant section of the TEI Guidelines. Some simple example codes for a few languages are given here:
| zh | Chinese | grc | Ancient Greek |
| en | English | el | Greek |
| enm | Middle English | ja | Japanese |
| fr | French | la | Latin |
| de | German | sa | Sanskrit |
All notes, whether printed as footnotes, endnotes, marginalia, or elsewhere, should be marked using the same element:
Where possible, the body of a note should be inserted in the text at the point at which its identifier or mark first appears. This may not be possible for example with marginalia, which may not be anchored to an exact location. For simplicity, it may be adequate to position marginal notes before the relevant paragraph or other element. Notes may also be placed in a separate division of the text (as end-notes are, in printed books) and linked to the relevant portion of the text using their target attribute.
The n attribute may be used to supply the number or identifier of a note if this is required. The resp attribute should be used consistently to distinguish between authorial and editorial notes, if the work has both kinds.
Explicit cross references or links from one point in a text to another in the same or another document may be encoded using the elements described in this section. Implicit links (such as the association between two parallel texts, or that between a text and its interpretation) may be encoded using the linking attributes discussed in section 8.3 Special kinds of Linking.
A cross reference from one point within a single document to another can be encoded using either of the following elements:
The difference between these two elements is that ptr is an empty element, simply marking a point from which a link is to be made, whereas ref may contain some text as well, typically identifying the target of the cross reference. The ptr element would be used for a cross reference which is to be indicated by some non-verbal means such as a symbol or icon, or in an electronic text by a button. It is also useful in document production systems, where the formatter can generate the correct verbal form of the cross reference.
Sometimes the target of a cross reference does not correspond with any particular feature of a text, and so may not be tagged as an element of some kind. If the desired target is simply a point in the current document, the easiest way to mark it is by introducing an anchor element at the appropriate spot. If the target is some sequence of words not otherwise tagged, the seg element may be introduced to mark them. These two elements are described as follows:
ABCD and EFGH in this example) are to be found somewhere else in the current document. Assuming that no element already exists to carry these identifiers, the anchor and seg elements may be used: The type attribute should be used (as above) to distinguish amongst different purposes for which these general purpose elements might be used in a text. Some other uses are discussed in section 8.3 Special kinds of Linking below.
So far, we have shown how the elements ptr and ref may be used for cross-references or links whose targets occur within the same document as their source. However, the same elements may also be used to refer to elements in any other XML document or resource, such as a document on the web, or a database component. This is possible because the value of the target attribute may be any valid universal resource indicator (URI)Note: A full definition of this term, defined by the W3C (the consortium which manages the development and maintenance of the World Wide Web), is beyond the scope of this tutorial: however, the most frequently encountered version of a URI is the familiar ‘URL’ used to indicate a web page, such as http://www.tei-c.org/index.xml.
A URI may reference a web page or just a part of one, for example http://www.tei-c.org/index.xml#SEC2. The sharp sign indicates that what follows it is the identifier of an element to be located within the XML document identified by what precedes it: this example will therefore locate an element which has an xml:id attribute value of SEC2 within the document retrieved from http://www.tei-c.org/index.xml. In the examples we have discussed so far, the part to the left of the sharp sign has been omitted: this is understood to mean that the referenced element is to be located within the current document.
Parts of an XML document can be specified by means of other more sophisticated mechanisms using a special language called Xpath, also defined by the W3C. This is particularly useful where the elements to be linked to do not bear identifiers and must therefore be located by some other means.
The following special purpose linking attributes are defined for every element in the TEI Lite scheme:
The process of encoding an electronic text has much in common with the process of editing a manuscript or other text for printed publication. In either case a conscientious editor may wish to record both the original state of the source and any editorial correction or other change made in it. The elements discussed in this and the next section provide some facilities for meeting these needs.
The following elements may be used to mark correction, that is editorial changes introduced where the editor believes the original to be erroneous:
The following elements may be used to mark normalization, that is editorial changes introduced for the sake of consistency or modernization of a text:
As an example, consider this extract from the quarto printing of Shakespeare's Henry V.
... for his nose was as sharp as a pen and a table of green feelds⚓
In addition to correcting or normalizing words and phrases, editors and transcribers may also supply missing material, omit material, or transcribe material deleted or crossed out in the source. In addition, some material may be particularly hard to transcribe because it is hard to make out on the page. The following elements may be used to record such phenomena:
#LB on the resp attribute is used to point to a fuller definition (typically in a respStmt element) for the agency responsible for correcting the duplication of for.#DHL points to another location where more information about the hand concerned is to be found3.The full TEI scheme provides more precise ways of capturing different aspects of a transcription, distinguishing for example between text added or supplied by the encoder and text indicated as supplied or deleted in the source. TEI Lite does not provide different tags for these purposes.
Like names, dates, and numbers, abbreviations may be transcribed as they stand or expanded; they may be left unmarked, or encoded using the following elements:
The type attribute may be used to distinguish types of abbreviation by their function.
The TEI scheme defines elements for a large number of ‘data-like’ features which may appear almost anywhere within almost any kind of text. These features may be of particular interest in a range of disciplines; they all relate to objects external to the text itself, such as the names of persons and places, numbers and dates. They also pose particular problems for many natural language processing (NLP) applications because of the variety of ways in which they may be presented within a text. The elements described here, by making such features explicit, reduce the complexity of processing texts containing them.
A referring string is a phrase which refers to some person, place, object, etc. Two elements are provided to mark such strings:
The name element by contrast is provided for the special case of referencing strings which consist only of proper nouns; it may be used synonymously with the rs element, or nested within it if a referring string contains a mixture of common and proper nouns.
Simply tagging something as a name is rarely 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.
Tags for the more detailed encoding of times and dates include the following:
| period | supplies pointers to one or more definitions of named periods of time (typically categorys, dates or <event>s) within which the datable item is understood to have occurred. |
| when [att.datable.w3c] | supplies the value of the date or time in a standard form, e.g. yyyy-mm-dd. |
Numbers 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). In natural-language processing or machine-translation applications, it is often helpful to distinguish them from other, more ‘lexical’ parts of the text. In other applications, the ability to record a number's value in standard notation is important. The num element provides this possibility:
The element list is used to mark any kind of list. A list is a sequence of text items, which may be numbered, bulleted, or arranged as a glossary list. Each item may be preceded by an item label (in a glossary list, this label is the term being defined):
<list type="gloss">. Here, each item comprises a term and a gloss, marked with label and item respectively. These correspond to the elements term and gloss, which can occur anywhere in prose text. Where the internal structure of a list item is more complex, it may be preferable to regard the list as a table, for which special-purpose tagging is defined below (13 Tables).
Lists of bibliographic items should be tagged using the listBibl element, described in the next section.
It is often useful to distinguish bibliographic citations where they occur within texts being transcribed for research, if only so that they will be properly formatted when the text is printed out. The element bibl is provided for this purpose. Where the components of a bibliographic reference are to be distinguished, the following elements may be used as appropriate. It is generally useful to mark at least those parts (such as the titles of articles, books, and journals) which will need special formatting. The other elements are provided for cases where particular interest attaches to such details.
For lists of bibliographic citations, the listBibl element should be used; it may contain a series of bibl elements.
Tables represent a challenge for any text processing system, but simple tables, at least, appear in so many texts that even in the simplified TEI tag set presented here, markup for tables is necessary. The following elements are provided for this purpose:
Not all the components of a document are necessarily textual. The most straightforward text will often contain diagrams or illustrations, to say nothing of documents in which image and text are inextricably intertwined, or electronic resources in which the two are complementary.
The encoder may simply record the presence of a graphic within the text, possibly with a brief description of its content, and may also provide a link to a digitized version of the graphic, using the following elements:
Any textual information accompanying the graphic, such as a heading and/or caption, may be included within the figure element itself, in a head and one or more p elements, as also may any text appearing within the graphic itself. It is strongly recommended that a prose description of the image be supplied, as the content of a figDesc element, for the use of applications which are not able to render the graphic, and to render the document accessible to vision-impaired readers. (Such text is not normally considered part of the document proper.)
It is often said that all markup is a form of interpretation or analysis. While it is certainly difficult, and may be impossible, to distinguish firmly between ‘objective’ and ‘subjective’ information in any universal way, it remains true that judgments concerning the latter are typically regarded as more likely to provide controversy than those concerning the former. Many scholars therefore prefer to record such interpretations only if it is possible to alert the reader that they are considered more open to dispute, than the rest of the markup. This section describes some of the elements provided by the TEI scheme to meet this need.
Interpretation typically ranges across the whole of a text, with no particular respect to other structural units. A useful preliminary to intensive interpretation is therefore to segment the text into discrete and identifiable units, each of which can then bear a label for use as a sort of ‘canonical reference’. To facilitate such uses, these units may not cross each other, nor nest within each other. They may conveniently be represented using the following element:
Tokenization, that is, the identification of lexical or non-lexical tokens within a text, is a very common requirement for all kinds of textual analysis, and not an entirely trivial one. The decision as to whether, for example, ‘can't’ in English or ‘du’ in French should be treated as one word or two is not simple. Consequently it is often useful to make explicit the preferred tokenization in a marked up text. The following elements are available for this purpose:
The w element is a specialisation of the seg element which has already been introduced for use in identifying otherwise unmarked targets of cross references and hypertext links (see section 8 Cross References and Links); it identifies some phrase-level portion of text to which the encoder may assign a user-specified type, as well as a unique identifier; it may thus be used to tag textual features for which there is no other provision in the published TEI Guidelines.
A seg element of one type (unlike the s element which it superficially resembles) can be nested within a seg element of the same or another type. This enables quite complex structures to be represented; some examples were given in section 8.3 Special kinds of Linking above. However, because it must respect the requirement that elements be properly nested and may not cut across each other, it cannot cope with the common requirement to associate an interpretation with arbitrary segments of a text which may completely ignore the document hierarchy. It also requires that the interpretation itself be represented by a single coded value in the type attribute.
Neither restriction applies to the interp element, which provides powerful features for the encoding of quite complex interpretive information in a relatively straightforward manner.
These elements allow the encoder to specify both the class of an interpretation, and the particular instance of that class which the interpretation involves. Thus, whereas with seg one can say simply that something is an apostrophe, with interp one can say that it is an instance (apostrophe) of a larger class (rhetorical figures).
Moreover, interp is a ‘stand off’ element: it does not surround the segments of text which it describes, but instead is linked to the passage in question either by means of the ana attribute discussed in section 8.3 Special kinds of Linking above, or by means of its own inst attribute. This means that any kind of analysis can be represented, independently of the document hierarchy, as well as facilitating the grouping of analyses of a particular type together. A special purpose interpGrp element is provided for the latter purpose.
For example, suppose that you wish to mark such diverse aspects of a text as themes or subject matter, rhetorical figures, and the locations of individual scenes of the narrative. Different portions of our sample passage from Jane Eyre for example, might be associated with the rhetorical figures of apostrophe, hyperbole, and metaphor; with subject-matter references to churches, servants, cooking, postal service, and honeymoons; and with scenes located in the church, in the kitchen, and in an unspecified location (drawing room?).
Although the focus of this document is on the use of the TEI scheme for the encoding of existing ‘pre-electronic’ documents, the same scheme may also be used for the encoding of new documents. In the preparation of new documents (such as this one), XML has much to recommend it: the document's structure can be clearly represented, and the same electronic text can be re-used for many purposes — to provide both online hypertext or browsable versions and well-formatted typeset versions from a common source for example.
To facilitate this, the TEI Lite schema includes some elements for marking features of technical documents in general, and of XML-related documents in particular.
The following elements may be used to mark particular features of technical documents:
A formatting application, given a text like that above, can be instructed to format examples appropriately (e.g. to preserve line breaks, or to use a distinctive font). Similarly, the use of tags such as ident greatly facilitates the construction of a useful index.
A particular problem arises when XML encoding is the subject of discussion within a technical document, itself encoded in XML. In such a document, it is clearly essential to distinguish clearly the markup occurring within examples from that marking up the document itself, and end-tags are highly likely to occur. One simple solution is to use the predefined entity reference < to represent each < character which marks the start of an XML tag within the examples. A more general solution is to mark off the whole body of each example as containing data which is not to be scanned for XML mark-up by the parser. This is achieved by enclosing it within a special XML construct called a CDATA marked section, as in the following example:
<p>A list should be encoded as
follows: <eg><![ CDATA [ <list> <item>First item in the
list</item> <item>Second item</item> </list> ]]> </eg> The
<gi>list</gi> element consists of a series of <gi>item</gi>
elements.⚓The list element used within the example above will not be regarded as forming part of the document proper, because it is embedded within a marked section (beginning with the special markup declaration <![CDATA[ , and ending with ]]>).
Note also the use of the gi element to tag references to element names (or generic identifiers) within the body of the text.
Most modern document production systems have the ability to generate automatically whole sections such as a table of contents or an index. The TEI Lite scheme provides an element to mark the location at which such a generated section should be placed.
This example also demonstrates the use of the type attribute to distinguish the different kinds of division to be generated: in the first case a table of contents (a toc) and in the second an index.
When an existing index or table of contents is to be encoded (rather than one being generated) for some reason, the list element discussed in section 11 Lists should be used.
While production of a table of contents from a properly tagged document is generally unproblematic for an automatic processor, the production of a good quality index will often require more careful tagging. It may not be enough simply to produce a list of all parts tagged in some particular way, although extracting (for example) all occurrences of elements such as term or name will often be a good departure point for an index.
The TEI schema provides a special purpose index tag which may be used to mark both the parts of the document which should be indexed, and how the indexing should be done.
The address element is used to mark a postal address of any kind. It contains one or more addrLine elements, one for each line of the address.
With the advent of XML and its adoption of Unicode as the required character set for all documents, most problems previously associated with the representation of the divers languages and writing systems of the world are greatly reduced. For those working with standard forms of the European languages in particular, almost no special action is needed: any XML editor should enable you to input accented letters or other ‘non-ASCII’ characters directly, and they should be stored in the resulting file in a way which is transferable directly between different systems.
There are two important exceptions: the characters & and < may not be entered directly in an XML document, since they have a special significance as initiating markup. They must always be represented as entity references, like this: & or <. Other characters may also be represented by means of entity reference where necessary, for example to retain compatibility with a pre-Unicode processing system.
For many purposes, particularly in older texts, the preliminary material such as title pages, prefatory epistles, etc., may provide very useful additional linguistic or social information. P5 provides a set of recommendations for distinguishing the textual elements most commonly encountered in front matter, which are summarized here.
The start of a title page should be marked with the element titlePage. All text contained on the page should be transcribed and tagged with the appropriate element from the following list:
Typeface distinctions should be marked with the rend attribute when necessary, as described above. Very detailed description of the letter spacing and sizing used in ornamental titles is not as yet provided for by the Guidelines. Changes of language should be marked by appropriate use of the xml:lang attribute or the foreign element, as necessary. Names of people, places, or organizations, may be tagged using the name element wherever they appear if no other more specific element is available.
Major blocks of text within the front matter should be marked using div elements; the following suggested values for the type attribute may be used to distinguish various common types of prefatory matter:
Where other kinds of prefatory matter are encountered, the encoder is at liberty to invent other values for the type attribute.
Like any text division, those in front matter may contain low level structural or non-structural elements as described elsewhere. They will generally begin with a heading or title of some kind which should be tagged using the head element. Epistles will contain the following additional elements:
Epistles which appear elsewhere in a text will, of course, contain these same elements.
Because of variations in publishing practice, back matter can contain virtually any of the elements listed above for front matter, and the same elements should be used where this is so. Additionally, back matter may contain the following types of matter within the back element. Like the structural divisions of the body, these should be marked as div elements, and distinguished by the following suggested values of the type attribute:
Every TEI text has a header which provides information analogous to that provided by the title page of printed text. The header is introduced by the element teiHeader and has four major parts:
A corpus or collection of texts with many shared characteristics may have one header for the corpus and individual headers for each component of the corpus. In this case the type attribute indicates the type of header. <teiHeader type="corpus"> introduces the header for corpus-level information.
Some of the header elements contain running prose which consists of one or more ps. Others are grouped:
The fileDesc element is mandatory. It contains a full bibliographic description of the file with the following elements:
The following elements can be used in the titleStmt:
[title of source]: a machine readable transcription [title of source]: electronic edition A machine readable version of: [title of source]⚓The respStmt element contains the following subcomponents:
The editionStmt groups information relating to one edition of the digital resource (where edition is used as elsewhere in bibliography), and may include the following elements:
Determining exactly what constitutes a new edition of an electronic text is left to the encoder.
The extent statement describes the approximate size of the digital resource.
The publicationStmt is mandatory. It may contain a simple prose description or groups of the elements described below:
At least one of these three elements must be present, unless the entire publication statement is in prose. The following elements may occur within them:
The seriesStmt element groups information about the series, if any, to which a publication belongs. It may contain title, idno, or respStmt elements.
The notesStmt, if used, contains one or more note elements which contain a note or annotation. Some information found in the notes area in conventional bibliography has been assigned specific elements in the TEI scheme.
The sourceDesc is a mandatory element which records details of the source or sources from which the computer file is derived. It may contain simple prose or a bibliographic citation, using one or more of the following elements:
The encodingDesc element specifies the methods and editorial principles which governed the transcription of the text. Its use is highly recommended. It may be prose description or may contain elements from the following list:
The editorialDecl contains a prose description of the practices used when encoding the text. Typically this description should cover such topics as the following, each of which may conveniently be given as a separate paragraph.
The refsDecl element is used to document the way in which any standard referencing scheme built into the encoding works. In its simplest form, it consists of prose description.
The classDecl element groups together definitions or sources for any descriptive classification schemes used by other parts of the header. At least one such scheme must be provided, encoded using the following elements:
Linkage between a particular text and a category within such a taxonomy is made by means of the catRef element within the textClass element, as described in the next section below.
The profileDesc element enables information characterizing various descriptive aspects of a text to be recorded within a single framework. It has three optional components:
The creation element is useful for documenting where a work was created, even though it may not have been published or recorded there.
The textClass element classifies a text. This may be done with reference to a classification system locally defined by means of the classDecl element, or by reference to some externally defined established scheme such as the Universal Decimal Classification. Texts may also be classified using lists of keywords, which may themselves be drawn from locally or externally defined control lists. The following elements are used to supply such classifications:
Press reportage - Sunday and also as Religion might be documented as follows: Multiple classifications may be supplied using any of the mechanisms described in this section.
The revisionDesc element provides a change log in which each change made to a text may be recorded. The log may be recorded as a sequence of change elements each of which contains a brief description of the change. The attributes when and who may be used to identify when the change was carried out and the agency responsible for it.
In a production environment it will usually be found preferable to use some kind of automated system to track and record changes. Many such version control systems, as they are known, can also be configured to update the TEI Header of a file automatically.
The TEI Lite schema is a pure subset of TEI P5. In the following list of elements and classes used, some information, notably the examples, derives from the canonical definition for the element in TEI P5 and may therefore refer to elements or attributes not provided by TEI Lite. Note however that only the elements listed here are available within the TEI Lite schema. These specifications also refer to many attributes which although available in TEI Lite are not discussed in this tutorial for lack of space.
| <abbr> (abbreviation) contains an abbreviation of any sort. [3.6.5. Abbreviations and Their Expansions] | |||||||||||
| Module | core | ||||||||||
| Attributes |
| ||||||||||
| Member of | |||||||||||
| Contained by | core: abbr add addrLine author bibl biblScope choice corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer | ||||||||||
| May contain | |||||||||||
| Note | If abbreviations are expanded silently, this practice should be documented in the editorialDecl, either with a <normalization> element or a p. | ||||||||||
| Example | <choice> <expan>North Atlantic Treaty Organization</expan> <abbr cert="low">NorATO</abbr> <abbr cert="high">NATO</abbr> <abbr cert="high" xml:lang="fr">OTAN</abbr> </choice> | ||||||||||
| Example | <choice> <abbr>SPQR</abbr> <expan>senatus populusque romanorum</expan> </choice> | ||||||||||
| Content model | <content> | ||||||||||
| Schema Declaration | element abbr { att.global.attributes, att.typed.attribute.subtype, att.cmc.attributes, attribute type { teidata.enumerated }?, macro.phraseSeq } | ||||||||||
| <add> (addition) contains letters, words, or phrases inserted in the source text by an author, scribe, or a previous annotator or corrector. [3.5.3. Additions, Deletions, and Omissions] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope corr date del editor emph expan foreign gloss head hi item l label lg mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled speaker stage term time title unclear figures: cell header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | In a diplomatic edition attempting to represent an original source, the add element should not be used for additions to the current TEI electronic edition made by editors or encoders. In these cases, either the corr or <supplied> element are recommended. In a TEI edition of a historical text with previous editorial emendations in which such additions or reconstructions are considered part of the source text, the use of add may be appropriate, dependent on the editorial philosophy of the project. |
| Example | The story I am going to relate is true as to its main facts, and as to the consequences <add place="above">of these facts</add> from which this tale takes its title. |
| Content model | <content> |
| Schema Declaration | element add { att.global.attributes, att.transcriptional.attributes, att.placement.attributes, att.typed.attributes, att.dimensions.attributes, att.cmc.attributes, macro.paraContent } |
| <address> (address) contains a postal address, for example of a publisher, an organization, or an individual. [3.6.2. Addresses 2.2.4. Publication, Distribution, Licensing, etc. 3.12.2.4. Imprint, Size of a Document, and Reprint Information] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal publicationStmt sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | This element should be used for postal addresses only. Within it, the generic element addrLine may be used as an alternative to any of the more specialized elements available from the model.addrPart class, such as <street>, <postCode> etc. |
| Example | Using just the elements defined by the core module, an address could be represented as follows: <address> <street>via Marsala 24</street> <postCode>40126</postCode> <name>Bologna</name> <name>Italy</name> </address> |
| Example | When a schema includes the names and dates module more specific elements such as country or settlement would be preferable over generic name: <address> <street>via Marsala 24</street> <postCode>40126</postCode> <settlement>Bologna</settlement> <country>Italy</country> </address> |
| Example | <address> <addrLine>Computing Center, MC 135</addrLine> <addrLine>P.O. Box 6998</addrLine> <addrLine>Chicago, IL 60680</addrLine> <addrLine>USA</addrLine> </address> |
| Example | <address> <country key="FR"/> <settlement type="city">Lyon</settlement> <postCode>69002</postCode> <district type="arrondissement">IIème</district> <district type="quartier">Perrache</district> <street> <num>30</num>, Cours de Verdun</street> </address> |
| Content model | <content> |
| Schema Declaration | element address { att.global.attributes, att.cmc.attributes, ( model.global*, ( ( model.addrPart, model.global* )+ ) ) } |
| <addrLine> (address line) contains one line of a postal address. [3.6.2. Addresses 2.2.4. Publication, Distribution, Licensing, etc. 3.12.2.4. Imprint, Size of a Document, and Reprint Information] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: address |
| May contain | |
| Note | Addresses may be encoded either as a sequence of lines, or using any sequence of component elements from the model.addrPart class. Other non-postal forms of address, such as telephone numbers or email, should not be included within an address element directly but may be wrapped within an addrLine if they form part of the printed address in some source text. |
| Example | <address> <addrLine>Computing Center, MC 135</addrLine> <addrLine>P.O. Box 6998</addrLine> <addrLine>Chicago, IL</addrLine> <addrLine>60680 USA</addrLine> </address> |
| Example | <addrLine> <ref target="tel:+1-201-555-0123">(201) 555 0123</ref> </addrLine> |
| Content model | <content> |
| Schema Declaration |
element addrLine { att.global.attributes, macro.phraseSeq } |
| <anchor> (anchor point) attaches an identifier to a point within a text, whether or not it corresponds with a textual element. [8.4.2. Synchronization and Overlap 17.5. Correspondence and Alignment] | |
| Module | linking |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine address author bibl biblScope cit corr date del editor emph expan foreign gloss head hi item l label lg list listBibl mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled sp speaker stage term time title unclear header: authority change classCode distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg |
| May contain | Empty element |
| Note | On this element, the global xml:id attribute must be supplied to specify an identifier for the point at which this element occurs within a document. The value used may be chosen freely provided that it is unique within the document and is a syntactically valid name. There is no requirement for values containing numbers to be in sequence. |
| Example | <s>The anchor is he<anchor xml:id="A234"/>re somewhere.</s> <s>Help me find it.<ptr target="#A234"/> </s> |
| Content model | <content> |
| Schema Declaration | element anchor { att.global.attributes, att.typed.attributes, att.cmc.attributes, empty } |
| <argument> (argument) contains a formal list or prose description of the topics addressed by a subdivision of a text. [4.2. Elements Common to All Divisions 4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <argument> <p>Monte Video — Maldonado — Excursion to R Polanco — Lazo and Bolas — Partridges — Absence of Trees — Deer — Capybara, or River Hog — Tucutuco — Molothrus, cuckoo-like habits — Tyrant Flycatcher — Mocking-bird — Carrion Hawks — Tubes formed by Lightning — House struck</p> </argument> |
| Content model | <content> |
| Schema Declaration | element argument { att.global.attributes, att.cmc.attributes, ( ( model.global | model.headLike )*, ( ( model.common, model.global* )+ ) ) } |
| <att> (attribute) contains the name of an attribute appearing within running text. [23. Documentation Elements] | |||||||||
| Module | tagdocs | ||||||||
| Attributes |
| ||||||||
| Member of | |||||||||
| Contained by | analysis: s core: abbr add addrLine author biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer | ||||||||
| May contain | XSD Name | ||||||||
| Note | As an alternative to using the scheme attribute a namespace prefix may be used. Where both scheme and a prefix are used, the prefix takes precedence. | ||||||||
| Example | <p>The TEI defines several <soCalled>global</soCalled> attributes; their names include <att>xml:id</att>, <att>rend</att>, <att>xml:lang</att>, <att>n</att>, <att>xml:space</att>, and <att>xml:base</att>; <att scheme="XX">type</att> is not amongst them.</p> | ||||||||
| Content model | <content> | ||||||||
| Schema Declaration | element att { att.global.attributes, attribute scheme { teidata.enumerated }?, teidata.name } | ||||||||
| <author> (author) in a bibliographic reference, contains the name(s) of an author, personal or corporate, of a work; for example in the same form as that provided by a recognized bibliographic name authority. [3.12.2.2. Titles, Authors, and Editors 2.2.1. The Title Statement] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: editionStmt titleStmt |
| May contain | |
| Note | Particularly where cataloguing is likely to be based on the content of the header, it is advisable to use a generally recognized name authority file to supply the content for this element. The attributes key or ref may also be used to reference canonical information about the author(s) intended from any appropriate authority, such as a library catalogue or online resource. In the case of a broadcast, use this element for the name of the company or network responsible for making the broadcast. Where an author is unknown or unspecified, this element may contain text such as Unknown or Anonymous. When the appropriate TEI modules are in use, it may also contain detailed tagging of the names used for people, organizations or places, in particular where multiple names are given. |
| Example | <author>British Broadcasting Corporation</author> <author>La Fayette, Marie Madeleine Pioche de la Vergne, comtesse de (1634–1693)</author> <author>Anonymous</author> <author>Bill and Melinda Gates Foundation</author> <author> <persName>Beaumont, Francis</persName> and <persName>John Fletcher</persName> </author> <author> <orgName key="BBC">British Broadcasting Corporation</orgName>: Radio 3 Network </author> |
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> |
| Content model | <content> |
| Schema Declaration | element author { att.global.attributes, att.naming.attributes, att.datable.attributes, macro.phraseSeq } |
| <authority> (release authority) supplies the name of a person or other agency responsible for making a work available, other than a publisher or distributor. [2.2.4. Publication, Distribution, Licensing, etc.] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | header: publicationStmt |
| May contain | |
| Example | <authority>John Smith</authority> |
| Content model | <content> |
| Schema Declaration | element authority { att.global.attributes, att.canonical.attributes, macro.phraseSeq.limited } |
| <availability> (availability) supplies information about the availability of a text, for example any restrictions on its use or distribution, its copyright status, any licence applying to it, etc. [2.2.4. Publication, Distribution, Licensing, etc.] | |||||||||
| Module | header | ||||||||
| Attributes |
| ||||||||
| Member of | |||||||||
| Contained by | core: bibl header: publicationStmt | ||||||||
| May contain | |||||||||
| Note | A consistent format should be adopted | ||||||||
| Example | <availability status="restricted"> <p>Available for academic research purposes only.</p> </availability> <availability status="free"> <p>In the public domain</p> </availability> <availability status="restricted"> <p>Available under licence from the publishers.</p> </availability> | ||||||||
| Example | <availability> <licence target="http://opensource.org/licenses/MIT"> <p>The MIT License applies to this document.</p> <p>Copyright (C) 2011 by The University of Victoria</p> <p>Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:</p> <p>The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.</p> <p>THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.</p> </licence> </availability> | ||||||||
| Content model | <content> | ||||||||
| Schema Declaration | element availability { att.global.attributes, att.declarable.attributes, attribute status { "free" | "unknown" | "restricted" }?, ( model.availabilityPart | model.pLike )+ } | ||||||||
| <back> (back matter) contains any appendixes, etc. following the main part of a text. [4.7. Back Matter 4. Default Text Structure] | |
| Module | textstructure |
| Attributes |
|
| Contained by | textstructure: text |
| May contain | |
| Note | Because cultural conventions differ as to which elements are grouped as back matter and which as front matter, the content models for the back and front elements are identical. |
| Example | <back> <div type="appendix"> <head>The Golden Dream or, the Ingenuous Confession</head> <p>TO shew the Depravity of human Nature, and how apt the Mind is to be misled by Trinkets and false Appearances, Mrs. Two-Shoes does acknowledge, that after she became rich, she had like to have been, too fond of Money <!-- .... --> </p> </div> <!-- ... --> <div type="epistle"> <head>A letter from the Printer, which he desires may be inserted</head> <salute>Sir.</salute> <p>I have done with your Copy, so you may return it to the Vatican, if you please; <!-- ... --> </p> </div> <div type="advert"> <head>The Books usually read by the Scholars of Mrs Two-Shoes are these and are sold at Mr Newbery's at the Bible and Sun in St Paul's Church-yard.</head> <list> <item n="1">The Christmas Box, Price 1d.</item> <item n="2">The History of Giles Gingerbread, 1d.</item> <!-- ... --> <item n="42">A Curious Collection of Travels, selected from the Writers of all Nations, 10 Vol, Pr. bound 1l.</item> </list> </div> <div type="advert"> <head>By the KING's Royal Patent, Are sold by J. NEWBERY, at the Bible and Sun in St. Paul's Church-Yard.</head> <list> <item n="1">Dr. James's Powders for Fevers, the Small-Pox, Measles, Colds, &c. 2s. 6d</item> <item n="2">Dr. Hooper's Female Pills, 1s.</item> <!-- ... --> </list> </div> </back> |
| Content model | <content> |
| Schema Declaration | element back { att.global.attributes, att.declaring.attributes, ( ( model.frontPart | model.pLike.front | model.pLike | model.listLike | model.global )*, ( ( model.div1Like, ( model.frontPart | model.div1Like | model.global )* ) | ( model.divLike, ( model.frontPart | model.divLike | model.global )* ) )?, ( ( model.divBottomPart, ( model.divBottomPart | model.global )* )? ) ) } |
| <bibl> (bibliographic citation) contains a loosely-structured bibliographic citation of which the sub-components may or may not be explicitly tagged. [3.12.1. Methods of Encoding Bibliographic References and Lists of References 2.2.7. The Source Description 16.3.2. Declarable Elements] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | Contains phrase-level elements, together with any combination of elements from the model.biblPart class |
| Example | <bibl>Blain, Clements and Grundy: Feminist Companion to Literature in English (Yale, 1990)</bibl> |
| Example | <bibl> <title level="a">The Interesting story of the Children in the Wood</title>. In <author>Victor E Neuberg</author>, <title>The Penny Histories</title>. <publisher>OUP</publisher> <date>1968</date>. </bibl> |
| Example | <bibl type="article" subtype="book_chapter" xml:id="carlin_2003"> <author> <name> <surname>Carlin</surname> (<forename>Claire</forename>)</name> </author>, <title level="a">The Staging of Impotence : France’s last congrès</title> dans <bibl type="monogr"> <title level="m">Theatrum mundi : studies in honor of Ronald W. Tobin</title>, éd. <editor> <name> <forename>Claire</forename> <surname>Carlin</surname> </name> </editor> et <editor> <name> <forename>Kathleen</forename> <surname>Wine</surname> </name> </editor>, <pubPlace>Charlottesville, Va.</pubPlace>, <publisher>Rookwood Press</publisher>, <date when="2003">2003</date>. </bibl> </bibl> |
| Content model | <content> |
| Schema Declaration | element bibl { att.global.attributes, att.declarable.attributes, att.typed.attributes, att.sortable.attributes, att.docStatus.attributes, att.cmc.attributes, ( text | model.gLike | model.highlighted | model.pPart.data | model.pPart.edit | model.segLike | model.ptrLike | model.biblPart | model.global )* } |
| <biblScope> (scope of bibliographic reference) defines the scope of a bibliographic reference, for example as a list of page numbers, or a named subdivision of a larger work. [3.12.2.5. Scopes and Ranges in Bibliographic Citations] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: seriesStmt |
| May contain | |
| Note | When a single page is being cited, use the from and to attributes with an identical value. When no clear endpoint is provided, the from attribute may be used without to; for example a citation such as ‘p. 3ff’ might be encoded It is now considered good practice to supply this element as a sibling (rather than a child) of <imprint>, since it supplies information which does not constitute part of the imprint. |
| Example | <biblScope>pp 12–34</biblScope> <biblScope unit="page" from="12" to="34"/> <biblScope unit="volume">II</biblScope> <biblScope unit="page">12</biblScope> |
| Content model | <content> |
| Schema Declaration | element biblScope { att.global.attributes, att.citing.attributes, macro.phraseSeq } |
| <body> (text body) contains the whole body of a single unitary text, excluding any front or back matter. [4. Default Text Structure] | |
| Module | textstructure |
| Attributes |
|
| Contained by | textstructure: text |
| May contain | |
| Example | <body> <l>Nu scylun hergan hefaenricaes uard</l> <l>metudæs maecti end his modgidanc</l> <l>uerc uuldurfadur sue he uundra gihuaes</l> <l>eci dryctin or astelidæ</l> <l>he aerist scop aelda barnum</l> <l>heben til hrofe haleg scepen.</l> <l>tha middungeard moncynnæs uard</l> <l>eci dryctin æfter tiadæ</l> <l>firum foldu frea allmectig</l> <trailer>primo cantauit Cædmon istud carmen.</trailer> </body> |
| Content model | <content> |
| Schema Declaration | element body { att.global.attributes, att.declaring.attributes, ( model.global*, ( ( model.divTop, ( model.global | model.divTop )* )? ), ( ( model.divGenLike, ( model.global | model.divGenLike )* )? ), ( ( ( model.divLike, ( model.global | model.divGenLike )* )+ ) | ( ( model.div1Like, ( model.global | model.divGenLike )* )+ ) | ( ( ( ( schemaSpec | model.common ), model.global* )+ ), ( ( ( model.divLike, ( model.global | model.divGenLike )* )+ ) | ( ( model.div1Like, ( model.global | model.divGenLike )* )+ ) )? ) ), ( ( model.divBottom, model.global* )* ) ) } |
| <byline> (byline) contains the primary statement of responsibility given for a work on its title page or at the head or end of the work. [4.2.2. Openers and Closers 4.5. Front Matter] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | The byline on a title page may include either the name or a description for the document's author. Where the name is included, it may optionally be tagged using the docAuthor element. |
| Example | <byline>Written by a CITIZEN who continued all the while in London. Never made publick before.</byline> |
| Example | <byline>Written from her own MEMORANDUMS</byline> |
| Example | <byline>By George Jones, Political Editor, in Washington</byline> |
| Example | <byline>BY <docAuthor>THOMAS PHILIPOTT,</docAuthor> Master of Arts, (Somtimes) Of Clare-Hall in Cambridge.</byline> |
| Content model | <content> |
| Schema Declaration | element byline { att.global.attributes, att.cmc.attributes, ( text | model.gLike | model.phrase | docAuthor | model.global )* } |
| <catDesc> (category description) describes some category within a taxonomy or text typology, either in the form of a brief prose description or in terms of the situational parameters used by the TEI formal <textDesc>. [2.3.7. The Classification Declaration] | |
| Module | header |
| Attributes |
|
| Contained by | header: category |
| May contain | |
| Example | <catDesc>Prose reportage</catDesc> |
| Example | <catDesc> <textDesc n="novel"> <channel mode="w">print; part issues</channel> <constitution type="single"/> <derivation type="original"/> <domain type="art"/> <factuality type="fiction"/> <interaction type="none"/> <preparedness type="prepared"/> <purpose type="entertain" degree="high"/> <purpose type="inform" degree="medium"/> </textDesc> </catDesc> |
| Content model | <content> |
| Schema Declaration | element catDesc { att.global.attributes, att.canonical.attributes, ( text | model.limitedPhrase | model.catDescPart )* } |
| <category> (category) contains an individual descriptive category, possibly nested within a superordinate category, within a user-defined taxonomy. [2.3.7. The Classification Declaration] | |
| Module | header |
| Attributes |
|
| Contained by | |
| May contain | |
| Example | <category xml:id="b1"> <catDesc>Prose reportage</catDesc> </category> |
| Example | <category xml:id="b2"> <catDesc>Prose </catDesc> <category xml:id="b11"> <catDesc>journalism</catDesc> </category> <category xml:id="b12"> <catDesc>fiction</catDesc> </category> </category> |
| Example | <category xml:id="LIT"> <catDesc xml:lang="pl">literatura piękna</catDesc> <catDesc xml:lang="en">fiction</catDesc> <category xml:id="LPROSE"> <catDesc xml:lang="pl">proza</catDesc> <catDesc xml:lang="en">prose</catDesc> </category> <category xml:id="LPOETRY"> <catDesc xml:lang="pl">poezja</catDesc> <catDesc xml:lang="en">poetry</catDesc> </category> <category xml:id="LDRAMA"> <catDesc xml:lang="pl">dramat</catDesc> <catDesc xml:lang="en">drama</catDesc> </category> </category> |
| Content model | <content> |
| Schema Declaration | element category { att.global.attributes, att.datcat.attributes, ( ( catDesc+ | ( model.descLike | equiv | gloss )* ), category* ) } |
| <catRef> (category reference) specifies one or more defined categories within some taxonomy or text typology. [2.4.3. The Text Classification] | |||||||
| Module | header | ||||||
| Attributes |
| ||||||
| Contained by | header: textClass | ||||||
| May contain | Empty element | ||||||
| Note | The scheme attribute needs to be supplied only if more than one taxonomy has been declared. | ||||||
| Example | <catRef scheme="#myTopics" target="#news #prov #sales2"/> <!-- elsewhere --> <taxonomy xml:id="myTopics"> <category xml:id="news"> <catDesc>Newspapers</catDesc> </category> <category xml:id="prov"> <catDesc>Provincial</catDesc> </category> <category xml:id="sales2"> <catDesc>Low to average annual sales</catDesc> </category> </taxonomy> | ||||||
| Content model | <content> | ||||||
| Schema Declaration | element catRef { att.global.attributes, att.pointing.attributes, attribute scheme { teidata.pointer }?, empty } | ||||||
| <cell> (cell) contains one cell of a table. [15.1.1. TEI Tables] | |
| Module | figures |
| Attributes |
|
| Contained by | figures: row |
| May contain | |
| Example | <row> <cell role="label">General conduct</cell> <cell role="data">Not satisfactory, on account of his great unpunctuality and inattention to duties</cell> </row> |
| Content model | <content> |
| Schema Declaration | element cell { att.global.attributes, att.tableDecoration.attributes, macro.specialPara } |
| <change> (change) documents a change or set of changes made during the production of a source document, or during the revision of an electronic file. [2.6. The Revision Description 2.4.1. Creation 12.7. Identifying Changes and Revisions] | |||||||
| Module | header | ||||||
| Attributes |
| ||||||
| Contained by | header: revisionDesc | ||||||
| May contain | |||||||
| Note | The who attribute may be used to point to any other element, but will typically specify a respStmt or <person> element elsewhere in the header, identifying the person responsible for the change and their role in making it. It is recommended that changes be recorded with the most recent first. The status attribute may be used to indicate the status of a document following the change documented. | ||||||
| Example | <titleStmt> <title> ... </title> <editor xml:id="LDB">Lou Burnard</editor> <respStmt xml:id="BZ"> <resp>copy editing</resp> <name>Brett Zamir</name> </respStmt> </titleStmt> <!-- ... --> <revisionDesc status="published"> <change who="#BZ" when="2008-02-02" status="public">Finished chapter 23</change> <change who="#BZ" when="2008-01-02" status="draft">Finished chapter 2</change> <change n="P2.2" when="1991-12-21" who="#LDB">Added examples to section 3</change> <change when="1991-11-11" who="#MSM">Deleted chapter 10</change> </revisionDesc> | ||||||
| Example | <profileDesc> <creation> <listChange> <change xml:id="DRAFT1">First draft in pencil</change> <change xml:id="DRAFT2" notBefore="1880-12-09">First revision, mostly using green ink</change> <change xml:id="DRAFT3" notBefore="1881-02-13">Final corrections as supplied to printer.</change> </listChange> </creation> </profileDesc> | ||||||
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> | ||||||
| Content model | <content> | ||||||
| Schema Declaration | element change { att.ascribed.attributes, att.datable.attributes, att.docStatus.attributes, att.global.attributes, att.typed.attributes, attribute target { list { teidata.pointer+ } }?, macro.specialPara } | ||||||
| <choice> (choice) groups a number of alternative encodings for the same point in a text. [3.5. Simple Editorial Changes] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope choice corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | Because the children of a choice element all represent alternative ways of encoding the same sequence, it is natural to think of them as mutually exclusive. However, there may be cases where a full representation of a text requires the alternative encodings to be considered as parallel. Note also that choice elements may self-nest. Where the purpose of an encoding is to record multiple witnesses of a single work, rather than to identify multiple possible encoding decisions at a given point, the <app> element and associated elements discussed in section 13.1. The Apparatus Entry, Readings, and Witnesses should be preferred. |
| Example | An American encoding of Gulliver's Travels which retains the British spelling but also provides a version regularized to American spelling might be encoded as follows. <p>Lastly, That, upon his solemn oath to observe all the above articles, the said man-mountain shall have a daily allowance of meat and drink sufficient for the support of <choice> <sic>1724</sic> <corr>1728</corr> </choice> of our subjects, with free access to our royal person, and other marks of our <choice> <orig>favour</orig> <reg>favor</reg> </choice>.</p> |
| Content model | <content> |
| Schema Declaration | element choice { att.global.attributes, att.cmc.attributes, ( model.choicePart | choice ), ( model.choicePart | choice ), ( model.choicePart | choice )* } |
| <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. [3.3.3. Quotation 4.3.1. Grouped Texts 10.3.5.1. Examples] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author biblScope cit corr del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled sp speaker stage term title unclear header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: argument body div docAuthor docDate docEdition epigraph imprimatur postscript salute signed titlePart trailer |
| May contain | |
| Example | <cit> <q>and the breath of the whale is frequently attended with such an insupportable smell, as to bring on disorder of the brain.</q> <bibl>Ulloa's South America</bibl> </cit> |
| Content model | <content> |
| Schema Declaration | element cit { att.global.attributes, att.typed.attributes, att.cmc.attributes, ( model.biblLike | model.egLike | model.entryPart | model.global | model.graphicLike | model.ptrLike | model.attributable | pc | q )+ } |
| <classCode> (classification code) contains the classification code used for this text in some standard classification system. [2.4.3. The Text Classification] | |||||||
| Module | header | ||||||
| Attributes |
| ||||||
| Contained by | header: textClass | ||||||
| May contain | |||||||
| Example | <classCode scheme="http://www.udc.org">410</classCode> | ||||||
| Content model | <content> | ||||||
| Schema Declaration | element classCode { att.global.attributes, attribute scheme { teidata.pointer }, macro.phraseSeq.limited } | ||||||
| <classDecl> (classification declarations) contains one or more taxonomies defining any classificatory codes used elsewhere in the text. [2.3.7. The Classification Declaration 2.3. The Encoding Description] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | header: encodingDesc |
| May contain | header: taxonomy |
| Example | <classDecl> <taxonomy xml:id="LCSH"> <bibl>Library of Congress Subject Headings</bibl> </taxonomy> </classDecl> <!-- ... --> <textClass> <keywords scheme="#LCSH"> <term>Political science</term> <term>United States -- Politics and government — Revolution, 1775-1783</term> </keywords> </textClass> |
| Content model | <content> |
| Schema Declaration |
element classDecl { att.global.attributes, taxonomy+ } |
| <closer> (closer) groups together salutations, datelines, and similar phrases appearing as a final group at the end of a division, especially of a letter. [4.2.2. Openers and Closers 4.2. Elements Common to All Divisions] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <div type="letter"> <p> perhaps you will favour me with a sight of it when convenient.</p> <closer> <salute>I remain, &c. &c.</salute> <signed>H. Colburn</signed> </closer> </div> |
| Example | <div type="chapter"> <p> <!-- ... --> and his heart was going like mad and yes I said yes I will Yes.</p> <closer> <dateline> <name type="place">Trieste-Zürich-Paris,</name> <date>1914–1921</date> </dateline> </closer> </div> |
| Content model | <content> |
| Schema Declaration | element closer { att.global.attributes, att.written.attributes, att.cmc.attributes, ( text | model.gLike | signed | dateline | salute | model.phrase | model.global )* } |
| <code> contains literal code from some formal language such as a programming language. [23.1.1. Phrase Level Terms] | |||||||
| Module | tagdocs | ||||||
| Attributes |
| ||||||
| Member of | |||||||
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer | ||||||
| May contain | Character data only | ||||||
| Example | <code lang="JAVA"> Size fCheckbox1Size = new Size(); fCheckbox1Size.Height = 500; fCheckbox1Size.Width = 500; xCheckbox1.setSize(fCheckbox1Size); </code> | ||||||
| Content model | <content> | ||||||
| Schema Declaration |
element code { att.global.attributes, attribute lang { teidata.word }?, text } | ||||||
| <corr> (correction) contains the correct form of a passage apparently erroneous in the copy text. [3.5.1. Apparent Errors] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope choice corr date del editor emph expan foreign gloss head hi item l label lg mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled speaker stage term time title unclear figures: cell header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Example | If all that is desired is to call attention to the fact that the copy text has been corrected, corr may be used alone: I don't know, Juan. It's so far in the past now — how <corr>can we</corr> prove or disprove anyone's theories? |
| Example | It is also possible, using the choice and sic elements, to provide an uncorrected reading: I don't know, Juan. It's so far in the past now — how <choice> <sic>we can</sic> <corr>can we</corr> </choice> prove or disprove anyone's theories? |
| Content model | <content> |
| Schema Declaration | element corr { att.global.attributes, att.editLike.attributes, att.typed.attributes, att.cmc.attributes, macro.paraContent } |
| <creation> (creation) contains information about the creation of a text. [2.4.1. Creation 2.4. The Profile Description] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | header: profileDesc |
| May contain | |
| Note | The creation element may be used to record details of a text's creation, e.g. the date and place it was composed, if these are of interest. It may also contain a more structured account of the various stages or revisions associated with the evolution of a text; this should be encoded using the <listChange> element. It should not be confused with the publicationStmt element, which records date and place of publication. |
| Example | <creation> <date>Before 1987</date> </creation> |
| Example | <creation> <date when="1988-07-10">10 July 1988</date> </creation> |
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> |
| Content model | <content> |
| Schema Declaration | element creation { att.global.attributes, att.datable.attributes, ( text | model.limitedPhrase | listChange )* } |
| <date> (date) contains a date in any format. [3.6.4. Dates and Times 2.2.4. Publication, Distribution, Licensing, etc. 2.6. The Revision Description 3.12.2.4. Imprint, Size of a Document, and Reprint Information 16.2.3. The Setting Description 14.4. Dates] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal publicationStmt sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Example | <date when="1980-02">early February 1980</date> |
| Example | Given on the <date when="1977-06-12">Twelfth Day of June 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> |
| Example | <date when="1990-09">September 1990</date> |
| Content model | <content> |
| Schema Declaration | element date { att.global.attributes, att.canonical.attributes, att.datable.attributes, att.editLike.attributes, att.dimensions.attributes, att.typed.attributes, att.cmc.attributes, ( text | model.gLike | model.phrase | model.global )* } |
| <dateline> (dateline) contains a brief description of the place, date, time, etc. of production of a letter, newspaper story, or other work, prefixed or suffixed to it as a kind of heading or trailer. [4.2.2. Openers and Closers] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <dateline>Walden, this 29. of August 1592</dateline> |
| Example | <div type="chapter"> <p> <!-- ... --> and his heart was going like mad and yes I said yes I will Yes.</p> <closer> <dateline> <name type="place">Trieste-Zürich-Paris,</name> <date>1914–1921</date> </dateline> </closer> </div> |
| Content model | <content> |
| Schema Declaration | element dateline { att.global.attributes, att.cmc.attributes, ( text | model.gLike | model.phrase | model.global | docDate )* } |
| <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, or a previous annotator or corrector. [3.5.3. Additions, Deletions, and Omissions] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope corr date del editor emph expan foreign gloss head hi item l label lg mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled speaker stage term time title unclear figures: cell header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | This element should be used for deletion of shorter sequences of text, typically single words or phrases. The <delSpan> element should be used for longer sequences of text, for those containing structural subdivisions, and for those containing overlapping additions and deletions. The text deleted must be at least partially legible in order for the encoder to be able to transcribe it (unless it is restored in a <supplied> tag). Illegible or lost text within a deletion may be marked using the gap tag to signal that text is present but has not been transcribed, or is no longer visible. Attributes on the gap element may be used to indicate how much text is omitted, the reason for omitting it, etc. If text is not fully legible, the unclear element (available when using the additional tagset for transcription of primary sources) should be used to signal the areas of text which cannot be read with confidence in a similar way. Degrees of uncertainty over what can still be read, or whether a deletion was intended may be indicated by use of the <certainty> element (see 22. Certainty, Precision, and Responsibility). There is a clear distinction in the TEI between del and <surplus> on the one hand and gap or unclear on the other. del indicates a deletion present in the source being transcribed, which states the author's or a later scribe's intent to cancel or remove text. <surplus> indicates material present in the source being transcribed which should have been so deleted, but which is not in fact. gap or unclear, by contrast, signal an editor's or encoder's decision to omit something or their inability to read the source text. See sections 12.3.1.7. Text Omitted from or Supplied in the Transcription and 12.3.3.2. Use of the gap, del, damage, unclear, and supplied Elements in Combination for the relationship between these and other related elements used in detailed transcription. |
| Example | <l> <del rend="overtyped">Mein</del> Frisch <del rend="overstrike" type="primary">schwebt</del> weht der Wind </l> |
| Example | <del rend="overstrike"> <gap reason="illegible" quantity="5" unit="character"/> </del> |
| Content model | <content> |
| Schema Declaration | element del { att.global.attributes, att.transcriptional.attributes, att.typed.attributes, att.dimensions.attributes, att.cmc.attributes, macro.paraContent } |
| <desc> (description) contains a short description of the purpose, function, or use of its parent element, or when the parent is a documentation element, describes or defines the object being documented. [23.4.1. Description of Components] | |||||||||||
| Module | core | ||||||||||
| Attributes |
| ||||||||||
| Member of | |||||||||||
| Contained by | |||||||||||
| May contain | |||||||||||
| Note | When used in a specification element such as <elementSpec>, TEI convention requires that this be expressed as a finite clause, begining with an active verb. | ||||||||||
| Example | Example of a desc element inside a documentation element. <dataSpec module="tei" ident="teidata.point"> <desc versionDate="2010-10-17" xml:lang="en">defines the data type used to express a point in cartesian space.</desc> <content> <dataRef name="token" restriction="(-?[0-9]+(\.[0-9]+)?,-?[0-9]+(\.[0-9]+)?)"/> </content> <!-- ... --> </dataSpec> | ||||||||||
| Example | Example of a desc element in a non-documentation element. <place xml:id="KERG2"> <placeName>Kerguelen Islands</placeName> <!-- ... --> <terrain> <desc>antarctic tundra</desc> </terrain> <!-- ... --> </place> | ||||||||||
| Schematron | A desc with a type of deprecationInfo should only occur when its parent element is being deprecated. Furthermore, it should always occur in an element that is being deprecated when desc is a valid child of that element. <sch:rule context="tei:desc[ @type eq 'deprecationInfo']"> <sch:assert test="../@validUntil">Information about a deprecation should only be present in a specification element that is being deprecated: that is, only an element that has a @validUntil attribute should have a child <desc type="deprecationInfo">.</sch:assert> </sch:rule> | ||||||||||
| Content model | <content> | ||||||||||
| Schema Declaration | element desc { att.global.attributes, att.translatable.attributes, att.typed.attribute.subtype, att.cmc.attributes, attribute type { teidata.enumerated }?, macro.limitedContent } | ||||||||||
| <distributor> (distributor) supplies the name of a person or other agency responsible for the distribution of a text. [2.2.4. Publication, Distribution, Licensing, etc.] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: publicationStmt |
| May contain | |
| Example | <distributor>Oxford Text Archive</distributor> <distributor>Redwood and Burn Ltd</distributor> |
| Content model | <content> |
| Schema Declaration | element distributor { att.global.attributes, att.canonical.attributes, macro.phraseSeq } |
| <div> (text division) contains a subdivision of the front, body, or back of a text. [4.1. Divisions of the Body] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <body> <div type="part"> <head>Fallacies of Authority</head> <p>The subject of which is Authority in various shapes, and the object, to repress all exercise of the reasoning faculty.</p> <div n="1" type="chapter"> <head>The Nature of Authority</head> <p>With reference to any proposed measures having for their object the greatest happiness of the greatest number [...]</p> <div n="1.1" type="section"> <head>Analysis of Authority</head> <p>What on any given occasion is the legitimate weight or influence to be attached to authority [...] </p> </div> <div n="1.2" type="section"> <head>Appeal to Authority, in What Cases Fallacious.</head> <p>Reference to authority is open to the charge of fallacy when [...] </p> </div> </div> </div> </body> |
| Schematron | <sch:rule context="tei:div"> <sch:report test="(ancestor::tei:l or ancestor::tei:lg) and not(ancestor::tei:floatingText)"> Abstract model violation: Lines may not contain higher-level structural elements such as div, unless div is a descendant of floatingText. </sch:report> </sch:rule> |
| Schematron | <sch:rule context="tei:div"> <sch:report test="(ancestor::tei:p or ancestor::tei:ab) and not(ancestor::tei:floatingText)"> Abstract model violation: p and ab may not contain higher-level structural elements such as div, unless div is a descendant of floatingText. </sch:report> </sch:rule> |
| Content model | <content> |
| Schema Declaration | element div { att.global.attributes, att.divLike.attributes, att.typed.attributes, att.declaring.attributes, att.written.attributes, ( ( model.divTop | model.global )*, ( ( ( ( ( ( model.divLike | model.divGenLike ), model.global* )+ ) | ( ( ( ( schemaSpec | model.common ), model.global* )+ ), ( ( ( model.divLike | model.divGenLike ), model.global* )* ) ) ), ( ( model.divBottom, model.global* )* ) )? ) ) } |
| <divGen> (automatically generated text division) indicates the location at which a textual division generated automatically by a text-processing application is to appear. [3.9.2. Index Entries] | |||||||||||
| Module | core | ||||||||||
| Attributes |
| ||||||||||
| Member of | |||||||||||
| Contained by | |||||||||||
| May contain | core: head | ||||||||||
| Note | This element is intended primarily for use in document production or manipulation, rather than in the transcription of pre-existing materials; it makes it easier to specify the location of indices, tables of contents, etc., to be generated by text preparation or word processing software. | ||||||||||
| Example | One use for this element is to allow document preparation software to generate an index and insert it in the appropriate place in the output. The example below assumes that the indexName attribute on index elements in the text has been used to specify index entries for the two generated indexes, named NAMES and THINGS: <back> <div1 type="backmat"> <head>Bibliography</head> <!-- ... --> </div1> <div1 type="backmat"> <head>Indices</head> <divGen n="Index Nominum" type="NAMES"/> <divGen n="Index Rerum" type="THINGS"/> </div1> </back> | ||||||||||
| Example | Another use for divGen is to specify the location of an automatically produced table of contents: <front> <!--<titlePage>...</titlePage>--> <divGen type="toc"/> <div> <head>Preface</head> <p> ... </p> </div> </front> | ||||||||||
| Content model | <content> | ||||||||||
| Schema Declaration | element divGen { att.global.attributes, att.typed.attribute.subtype, attribute type { teidata.enumerated }?, model.headLike* } | ||||||||||
| <docAuthor> (document author) contains the name of the author of the document, as given on the title page (often but not always contained in a byline). [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | The document author's name often occurs within a byline, but the docAuthor element may be used whether the byline element is used or not. It should be used only for the author(s) of the entire document, not for author(s) of any subset or part of it. (Attributions of authorship of a subset or part of the document, for example of a chapter in a textbook or an article in a newspaper, may be encoded with byline without docAuthor.) |
| Example | <titlePage> <docTitle> <titlePart>Travels into Several Remote Nations of the World, in Four Parts.</titlePart> </docTitle> <byline> By <docAuthor>Lemuel Gulliver</docAuthor>, First a Surgeon, and then a Captain of several Ships</byline> </titlePage> |
| Content model | <content> |
| Schema Declaration | element docAuthor { att.global.attributes, att.canonical.attributes, att.cmc.attributes, macro.phraseSeq } |
| <docDate> (document date) contains the date of a document, as given on a title page or in a dateline. [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | Cf. the general date element in the core tag set. This specialized element is provided for convenience in marking and processing the date of the documents, since it is likely to require specialized handling for many applications. It should be used only for the date of the entire document, not for any subset or part of it. |
| Example | <docImprint>Oxford, Clarendon Press, <docDate>1987</docDate> </docImprint> |
| Content model | <content> |
| Schema Declaration | element docDate { att.global.attributes, att.cmc.attributes, att.datable.attributes, macro.phraseSeq } |
| <docEdition> (document edition) contains an edition statement as presented on a title page of a document. [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | Cf. the edition element of bibliographic citation. As usual, the shorter name has been given to the more frequent element. |
| Example | <docEdition>The Third edition Corrected</docEdition> |
| Content model | <content> |
| Schema Declaration |
element docEdition { att.global.attributes, macro.paraContent } |
| <docImprint> (document imprint) contains the imprint statement (place and date of publication, publisher name), as given (usually) at the foot of a title page. [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | Cf. the <imprint> element of bibliographic citations. As with title, author, and editions, the shorter name is reserved for the element likely to be used more often. |
| Example | <docImprint>Oxford, Clarendon Press, 1987</docImprint> Imprints may be somewhat more complex: <docImprint> <pubPlace>London</pubPlace> Printed for <name>E. Nutt</name>, at <pubPlace>Royal Exchange</pubPlace>; <name>J. Roberts</name> in <pubPlace>wick-Lane</pubPlace>; <name>A. Dodd</name> without <pubPlace>Temple-Bar</pubPlace>; and <name>J. Graves</name> in <pubPlace>St. James's-street.</pubPlace> <date>1722.</date> </docImprint> |
| Content model | <content> |
| Schema Declaration | element docImprint { att.global.attributes, ( text | model.gLike | model.phrase | pubPlace | docDate | publisher | model.global )* } |
| <docTitle> (document title) contains the title of a document, including all its constituents, as given on a title page. [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <docTitle> <titlePart type="main">The DUNCIAD, VARIOURVM.</titlePart> <titlePart type="sub">WITH THE PROLEGOMENA of SCRIBLERUS.</titlePart> </docTitle> |
| Content model | <content> |
| Schema Declaration | element docTitle { att.global.attributes, att.canonical.attributes, ( model.global*, ( ( titlePart, model.global* )+ ) ) } |
| <edition> (edition) describes the particularities of one edition of a text. [2.2.2. The Edition Statement] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: editionStmt |
| May contain | |
| Example | <edition>First edition <date>Oct 1990</date> </edition> <edition n="S2">Students' edition</edition> |
| Content model | <content> |
| Schema Declaration |
element edition { att.global.attributes, macro.phraseSeq } |
| <editionStmt> (edition statement) groups information relating to one edition of a text. [2.2.2. The Edition Statement 2.2. The File Description] | |
| Module | header |
| Attributes |
|
| Contained by | header: fileDesc |
| May contain | |
| Example | <editionStmt> <edition n="S2">Students' edition</edition> <respStmt> <resp>Adapted by </resp> <name>Elizabeth Kirk</name> </respStmt> </editionStmt> |
| Example | <editionStmt> <p>First edition, <date>Michaelmas Term, 1991.</date> </p> </editionStmt> |
| Content model | <content> |
| Schema Declaration | element editionStmt { att.global.attributes, ( model.pLike+ | ( edition, model.respLike* ) ) } |
| <editor> contains a 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. [3.12.2.2. Titles, Authors, and Editors] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: editionStmt seriesStmt titleStmt |
| May contain | |
| Note | A consistent format should be adopted. Particularly where cataloguing is likely to be based on the content of the header, it is advisable to use generally recognized authority lists for the exact form of personal names. |
| Example | <editor role="Technical_Editor">Ron Van den Branden</editor> <editor role="Editor-in-Chief">John Walsh</editor> <editor role="Managing_Editor">Anne Baillot</editor> |
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> |
| Content model | <content> |
| Schema Declaration | element editor { att.global.attributes, att.naming.attributes, att.datable.attributes, macro.phraseSeq } |
| <editorialDecl> (editorial practice declaration) provides details of editorial principles and practices applied during the encoding of a text. [2.3.3. The Editorial Practices Declaration 2.3. The Encoding Description 16.3.2. Declarable Elements] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | header: encodingDesc |
| May contain | core: p |
| Example | <editorialDecl> <p>All words converted to Modern American spelling using Websters 9th Collegiate dictionary</p> <p>All opening quotation marks converted to “ all closing quotation marks converted to &cdq;.</p> </editorialDecl> |
| Content model | <content> |
| Schema Declaration | element editorialDecl { att.global.attributes, att.declarable.attributes, model.pLike+ } |
| <eg> (example) contains any kind of illustrative example. [23.5. Element Specifications 23.5.3. Attribute List Specification] | |
| Module | tagdocs |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | If the example contains material in XML markup, either it must be enclosed within a CDATA marked section, or character entity references must be used to represent the markup delimiters. If the example contains well-formed XML, it should be marked using the more specific <egXML> element. |
| Example | <p>The <gi>term</gi> element is declared using the following syntax: <eg><![CDATA[<!ELEMENT term (%phrase.content;)>]]</eg> </p> |
| Content model | <content> |
| Schema Declaration |
element eg { att.global.attributes, macro.phraseSeq } |
| <emph> (emphasized) marks words or phrases which are stressed or emphasized for linguistic or rhetorical effect. [3.3.2.2. Emphatic Words and Phrases 3.3.2. Emphasis, Foreign Words, and Unusual Language] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Example | You took the car and did <emph>what</emph>?!! |
| Example | <q>What it all comes to is this,</q> he said. <q> <emph>What does Christopher Robin do in the morning nowadays?</emph> </q> |
| Content model | <content> |
| Schema Declaration |
element emph { att.global.attributes, att.cmc.attributes, macro.paraContent } |
| <encodingDesc> (encoding description) documents the relationship between an electronic text and the source or sources from which it was derived. [2.3. The Encoding Description 2.1.1. The TEI Header and Its Components] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | header: teiHeader |
| May contain | core: p |
| Example | <encodingDesc> <p>Basic encoding, capturing lexical information only. All hyphenation, punctuation, and variant spellings normalized. No formatting or layout information preserved.</p> </encodingDesc> |
| Content model | <content> |
| Schema Declaration | element encodingDesc { att.global.attributes, ( model.encodingDescPart | model.pLike )+ } |
| <epigraph> (epigraph) contains a quotation, anonymous or attributed, appearing at the start or end of a section or on a title page. [4.2.3. Arguments, Epigraphs, and Postscripts 4.2. Elements Common to All Divisions 4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <epigraph xml:lang="la"> <cit> <bibl>Lucret.</bibl> <quote> <l part="F">petere inde coronam,</l> <l>Vnde prius nulli velarint tempora Musae.</l> </quote> </cit> </epigraph> |
| Content model | <content> |
| Schema Declaration | element epigraph { att.global.attributes, att.cmc.attributes, ( model.common | model.global )* } |
| <expan> (expansion) contains the expansion of an abbreviation. [3.6.5. Abbreviations and Their Expansions] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope choice corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | The content of this element should be the expanded abbreviation, usually (but not always) a complete word or phrase. The <ex> element provided by the transcr module may be used to mark up sequences of letters supplied within such an expansion. If abbreviations are expanded silently, this practice should be documented in the editorialDecl, either with a <normalization> element or a p. |
| Example | The address is Southmoor <choice> <expan>Road</expan> <abbr>Rd</abbr> </choice> |
| Example | <choice xml:lang="la"> <abbr>Imp</abbr> <expan>Imp<ex>erator</ex> </expan> </choice> |
| Content model | <content> |
| Schema Declaration | element expan { att.global.attributes, att.editLike.attributes, att.cmc.attributes, macro.phraseSeq } |
| <extent> (extent) describes the approximate size of a text stored on some carrier medium or of some other object, digital or non-digital, specified in any convenient units. [2.2.3. Type and Extent of File 2.2. The File Description 3.12.2.4. Imprint, Size of a Document, and Reprint Information 11.7.1. Object Description] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Example | <extent>3200 sentences</extent> <extent>between 10 and 20 Mb</extent> <extent>ten 3.5 inch high density diskettes</extent> |
| Example | The <measure> element may be used to supply normalized or machine tractable versions of the size or sizes concerned. <extent> <measure unit="MiB" quantity="4.2">About four megabytes</measure> <measure unit="pages" quantity="245">245 pages of source material</measure> </extent> |
| Content model | <content> |
| Schema Declaration |
element extent { att.global.attributes, macro.phraseSeq } |
| <figDesc> (description of figure) contains a brief prose description of the appearance or content of a graphic figure, for use when documenting an image without displaying it. [15.4. Specific Elements for Graphic Images] | |
| Module | figures |
| Attributes |
|
| Contained by | figures: figure |
| May contain | |
| Note | This element is intended for use as an alternative to the content of its parent figure element ; for example, to display when the image is required but the equipment in use cannot display graphic images. It may also be used for indexing or documentary purposes. |
| Example | <figure> <graphic url="emblem1.png"/> <head>Emblemi d'Amore</head> <figDesc>A pair of naked winged cupids, each holding a flaming torch, in a rural setting.</figDesc> </figure> |
| Content model | <content> |
| Schema Declaration |
element figDesc { att.global.attributes, macro.limitedContent } |
| <figure> (figure) groups elements representing or containing graphic information such as an illustration, formula, or figure. [15.4. Specific Elements for Graphic Images] | |
| Module | figures |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine address author bibl biblScope cit corr date del editor emph expan foreign gloss head hi item l label lg list mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled sp speaker stage term time title unclear header: authority change classCode distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg |
| May contain | |
| Example | <figure> <head>The View from the Bridge</head> <figDesc>A Whistleresque view showing four or five sailing boats in the foreground, and a series of buoys strung out between them.</figDesc> <graphic url="http://www.example.org/fig1.png" scale="0.5"/> </figure> |
| Content model | <content> |
| Schema Declaration | element figure { att.global.attributes, att.placement.attributes, att.typed.attributes, att.written.attributes, att.cmc.attributes, ( model.headLike | model.common | figDesc | model.graphicLike | model.global | model.divBottom )* } |
| <fileDesc> (file description) contains a full bibliographic description of an electronic file. [2.2. The File Description 2.1.1. The TEI Header and Its Components] | |
| Module | header |
| Attributes |
|
| Contained by | header: teiHeader |
| May contain | |
| Note | The major source of information for those seeking to create a catalogue entry or bibliographic citation for an electronic file. As such, it provides a title and statements of responsibility together with details of the publication or distribution of the file, of any series to which it belongs, and detailed bibliographic notes for matters not addressed elsewhere in the header. It also contains a full bibliographic description for the source or sources from which the electronic text was derived. |
| Example | <fileDesc> <titleStmt> <title>The shortest possible TEI document</title> </titleStmt> <publicationStmt> <p>Distributed as part of TEI P5</p> </publicationStmt> <sourceDesc> <p>No print source exists: this is an original digital text</p> </sourceDesc> </fileDesc> |
| Content model | <content> |
| Schema Declaration | element fileDesc { att.global.attributes, ( ( titleStmt, editionStmt?, extent?, publicationStmt, seriesStmt*, notesStmt? ), sourceDesc+ ) } |
| <foreign> (foreign) identifies a word or phrase as belonging to some language other than that of the surrounding text. [3.3.2.1. Foreign Words or Expressions] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | The global xml:lang attribute should be supplied for this element to identify the language of the word or phrase marked. As elsewhere, its value should be a language tag as defined in 6.1. Language Identification. This element is intended for use only where no other element is available to mark the phrase or words concerned. The global xml:lang attribute should be used in preference to this element where it is intended to mark the language of the whole of some text element. The <distinct> element may be used to identify phrases belonging to sublanguages or registers not generally regarded as true languages. |
| Example | This is heathen Greek to you still? Your <foreign xml:lang="la">lapis philosophicus</foreign>? |
| Content model | <content> |
| Schema Declaration |
element foreign { att.global.attributes, att.cmc.attributes, macro.phraseSeq } |
| <formula> (formula) contains a mathematical or other formula. [15.2. Formulæ and Mathematical Expressions] | |
| Module | figures |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author biblScope cit corr date del editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled speaker stage term time title unclear header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Example | <formula notation="tex">$E=mc^2$</formula> |
| Example | <formula notation="none">E=mc<hi rend="sup">2</hi> </formula> |
| Example | <formula notation="mathml"> <m:math> <m:mi>E</m:mi> <m:mo>=</m:mo> <m:mi>m</m:mi> <m:msup> <m:mrow> <m:mi>c</m:mi> </m:mrow> <m:mrow> <m:mn>2</m:mn> </m:mrow> </m:msup> </m:math> </formula> |
| Content model | <content> |
| Schema Declaration | element formula { att.global.attributes, att.notated.attributes, att.cmc.attributes, ( text | model.graphicLike | model.hiLike )* } |
| <front> (front matter) contains any prefatory matter (headers, abstracts, title page, prefaces, dedications, etc.) found at the start of a document, before the main body. [4.6. Title Pages 4. Default Text Structure] | |
| Module | textstructure |
| Attributes |
|
| Contained by | textstructure: text |
| May contain | |
| Note | Because cultural conventions differ as to which elements are grouped as front matter and which as back matter, the content models for the front and back elements are identical. |
| Example | <front> <epigraph> <quote>Nam Sibyllam quidem Cumis ego ipse oculis meis vidi in ampulla pendere, et cum illi pueri dicerent: <q xml:lang="grc">Σίβυλλα τί θέλεις</q>; respondebat illa: <q xml:lang="grc">ὰποθανεῖν θέλω.</q> </quote> </epigraph> <div type="dedication"> <p>For Ezra Pound <q xml:lang="it">il miglior fabbro.</q> </p> </div> </front> |
| Example | <front> <div type="dedication"> <p>To our three selves</p> </div> <div type="preface"> <head>Author's Note</head> <p>All the characters in this book are purely imaginary, and if the author has used names that may suggest a reference to living persons she has done so inadvertently. ...</p> </div> </front> |
| Example | <front> <div type="abstract"> <div> <head> BACKGROUND:</head> <p>Food insecurity can put children at greater risk of obesity because of altered food choices and nonuniform consumption patterns.</p> </div> <div> <head> OBJECTIVE:</head> <p>We examined the association between obesity and both child-level food insecurity and personal food insecurity in US children.</p> </div> <div> <head> DESIGN:</head> <p>Data from 9,701 participants in the National Health and Nutrition Examination Survey, 2001-2010, aged 2 to 11 years were analyzed. Child-level food insecurity was assessed with the US Department of Agriculture's Food Security Survey Module based on eight child-specific questions. Personal food insecurity was assessed with five additional questions. Obesity was defined, using physical measurements, as body mass index (calculated as kg/m2) greater than or equal to the age- and sex-specific 95th percentile of the Centers for Disease Control and Prevention growth charts. Logistic regressions adjusted for sex, race/ethnic group, poverty level, and survey year were conducted to describe associations between obesity and food insecurity.</p> </div> <div> <head> RESULTS:</head> <p>Obesity was significantly associated with personal food insecurity for children aged 6 to 11 years (odds ratio=1.81; 95% CI 1.33 to 2.48), but not in children aged 2 to 5 years (odds ratio=0.88; 95% CI 0.51 to 1.51). Child-level food insecurity was not associated with obesity among 2- to 5-year-olds or 6- to 11-year-olds.</p> </div> <div> <head> CONCLUSIONS:</head> <p>Personal food insecurity is associated with an increased risk of obesity only in children aged 6 to 11 years. Personal food-insecurity measures may give different results than aggregate food-insecurity measures in children.</p> </div> </div> </front> |
| Content model | <content> |
| Schema Declaration | element front { att.global.attributes, att.declaring.attributes, ( ( model.frontPart | model.pLike | model.pLike.front | model.global )*, ( ( ( ( model.div1Like, ( model.div1Like | model.frontPart | model.global )* ) | ( model.divLike, ( model.divLike | model.frontPart | model.global )* ) ), ( ( model.divBottom, ( model.divBottom | model.global )* )? ) )? ) ) } |
| <funder> (funding body) specifies the name of an individual, institution, or organization responsible for the funding of a project or text. [2.2.1. The Title Statement] | |
| Module | header |
| Attributes |
|
| Member of | |
| Contained by | core: bibl header: editionStmt titleStmt |
| May contain | |
| Note | Funders provide financial support for a project; they are distinct from sponsors (see element sponsor), who provide intellectual support and authority. |
| Example | <funder>The National Endowment for the Humanities, an independent federal agency</funder> <funder>Directorate General XIII of the Commission of the European Communities</funder> <funder>The Andrew W. Mellon Foundation</funder> <funder>The Social Sciences and Humanities Research Council of Canada</funder> |
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> |
| Content model | <content> |
| Schema Declaration | element funder { att.global.attributes, att.canonical.attributes, att.datable.attributes, macro.phraseSeq.limited } |
| <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. [3.5.3. Additions, Deletions, and Omissions] | |||||||||||||||||
| Module | core | ||||||||||||||||
| Attributes |
| ||||||||||||||||
| Member of | |||||||||||||||||
| Contained by | core: abbr add addrLine address author bibl biblScope cit corr date del editor emph expan foreign gloss head hi item l label lg list mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled sp speaker stage term time title unclear header: authority change classCode distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg | ||||||||||||||||
| May contain | core: desc | ||||||||||||||||
| Note | The gap, unclear, and del core tag elements may be closely allied in use with the <damage> and <supplied> elements, available when using the additional tagset for transcription of primary sources. See section 12.3.3.2. Use of the gap, del, damage, unclear, and supplied Elements in Combination for discussion of which element is appropriate for which circumstance. The gap tag simply signals the editors decision to omit or inability to transcribe a span of text. Other information, such as the interpretation that text was deliberately erased or covered, should be indicated using the relevant tags, such as del in the case of deliberate deletion. | ||||||||||||||||
| Example | <gap quantity="4" unit="chars" reason="illegible"/> | ||||||||||||||||
| Example | <gap quantity="1" unit="essay" reason="sampling"/> | ||||||||||||||||
| Example | <del> <gap atLeast="4" atMost="8" unit="chars" reason="illegible"/> </del> | ||||||||||||||||
| Example | <gap extent="several lines" reason="lost"/> | ||||||||||||||||
| Content model | <content> | ||||||||||||||||
| Schema Declaration | element gap { att.global.attributes, att.timed.attributes, att.editLike.attributes, att.dimensions.attributes, att.cmc.attributes, attribute reason { list { ( "cancelled" | "deleted" | "editorial" | "illegible" | "inaudible" | "irrelevant" | "sampling" | teidata.enumerated )+ } }?, attribute agent { teidata.enumerated }?, ( model.descLike | model.certLike )* } | ||||||||||||||||
| <gi> (element name) contains the name (generic identifier) of an element. [23. Documentation Elements 23.5. Element Specifications] | |||||||||
| Module | tagdocs | ||||||||
| Attributes |
| ||||||||
| Member of | |||||||||
| Contained by | analysis: s core: abbr add addrLine author biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer | ||||||||
| May contain | XSD Name | ||||||||
| Example | <p>The <gi>xhtml:li</gi> element is roughly analogous to the <gi>item</gi> element, as is the <gi scheme="DBK">listItem</gi> element.</p> This example shows the use of both a namespace prefix and the scheme attribute as alternative ways of indicating that the gi in question is not a TEI element name: in practice only one method should be adopted. | ||||||||
| Content model | <content> | ||||||||
| Schema Declaration | element gi { att.global.attributes, attribute scheme { teidata.enumerated }?, teidata.name } | ||||||||
| <gloss> (gloss) identifies a phrase or word used to provide a gloss or definition for some other word or phrase. [3.4.1. Terms and Glosses 23.4.1. Description of Components] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc category change classCode creation distributor edition extent funder language licence principal sponsor taxonomy linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Note | The target and cRef attributes are mutually exclusive. |
| Example | We may define <term xml:id="tdpv" rend="sc">discoursal point of view</term> as <gloss target="#tdpv">the relationship, expressed through discourse structure, between the implied author or some other addresser, and the fiction.</gloss> |
| Content model | <content> |
| Schema Declaration | element gloss { att.global.attributes, att.declaring.attributes, att.translatable.attributes, att.typed.attributes, att.pointing.attributes, att.cReferencing.attributes, att.cmc.attributes, macro.phraseSeq } |
| <graphic> (graphic) indicates the location of a graphic or illustration, either forming part of a text, or providing an image of it. [3.10. Graphics and Other Non-textual Components 12.1. Digital Facsimiles] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author biblScope cit corr date del editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg rs sic soCalled speaker stage term time title unclear header: change distributor edition extent licence linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePage titlePart trailer |
| May contain | core: desc |
| Note | The mimeType attribute should be used to supply the MIME media type of the image specified by the url attribute. Within the body of a text, a graphic element indicates the presence of a graphic component in the source itself. Within the context of a <facsimile> or <sourceDoc> element, however, a graphic element provides an additional digital representation of some part of the source being encoded. |
| Example | <figure> <graphic url="fig1.png"/> <head>Figure One: The View from the Bridge</head> <figDesc>A Whistleresque view showing four or five sailing boats in the foreground, and a series of buoys strung out between them.</figDesc> </figure> |
| Example | <facsimile> <surfaceGrp n="leaf1"> <surface> <graphic url="page1.png"/> </surface> <surface> <graphic url="page2-highRes.png"/> <graphic url="page2-lowRes.png"/> </surface> </surfaceGrp> </facsimile> |
| Example | <facsimile> <surfaceGrp n="leaf1" xml:id="spi001"> <surface xml:id="spi001r"> <graphic type="normal" subtype="thumbnail" url="spi/thumb/001r.jpg"/> <graphic type="normal" subtype="low-res" url="spi/normal/lowRes/001r.jpg"/> <graphic type="normal" subtype="high-res" url="spi/normal/highRes/001r.jpg"/> <graphic type="high-contrast" subtype="low-res" url="spi/contrast/lowRes/001r.jpg"/> <graphic type="high-contrast" subtype="high-res" url="spi/contrast/highRes/001r.jpg"/> </surface> <surface xml:id="spi001v"> <graphic type="normal" subtype="thumbnail" url="spi/thumb/001v.jpg"/> <graphic type="normal" subtype="low-res" url="spi/normal/lowRes/001v.jpg"/> <graphic type="normal" subtype="high-res" url="spi/normal/highRes/001v.jpg"/> <graphic type="high-contrast" subtype="low-res" url="spi/contrast/lowRes/001v.jpg"/> <graphic type="high-contrast" subtype="high-res" url="spi/contrast/highRes/001v.jpg"/> <zone xml:id="spi001v_detail01"> <graphic type="normal" subtype="thumbnail" url="spi/thumb/001v-detail01.jpg"/> <graphic type="normal" subtype="low-res" url="spi/normal/lowRes/001v-detail01.jpg"/> <graphic type="normal" subtype="high-res" url="spi/normal/highRes/001v-detail01.jpg"/> <graphic type="high-contrast" subtype="low-res" url="spi/contrast/lowRes/001v-detail01.jpg"/> <graphic type="high-contrast" subtype="high-res" url="spi/contrast/highRes/001v-detail01.jpg"/> </zone> </surface> </surfaceGrp> </facsimile> |
| Content model | <content> |
| Schema Declaration | element graphic { att.global.attributes, att.media.attributes, att.resourced.attributes, att.declaring.attributes, att.typed.attributes, att.cmc.attributes, model.descLike* } |
| <group> (group) contains the body of a composite text, grouping together a sequence of distinct texts (or groups of such texts) which are regarded as a unit for some purpose, for example the collected works of an author, a sequence of prose essays, etc. [4. Default Text Structure 4.3.1. Grouped Texts 16.1. Varieties of Composite Text] | |
| Module | textstructure |
| Attributes |
|
| Contained by | |
| May contain | |
| Example | <text> <!-- Section on Alexander Pope starts --> <front> <!-- biographical notice by editor --> </front> <group> <text> <!-- first poem --> </text> <text> <!-- second poem --> </text> </group> </text> <!-- end of Pope section--> |
| Content model | <content> |
| Schema Declaration | element group { att.global.attributes, att.declaring.attributes, att.typed.attributes, ( ( model.divTop | model.global )*, ( ( text | group ), ( text | group | model.global )* ), model.divBottom* ) } |
| <head> (heading) contains any type of heading, for example the title of a section, or the heading of a list, glossary, manuscript description, etc. [4.2.1. Headings and Trailers] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | |
| May contain | |
| Note | The head element is used for headings at all levels; software which treats (e.g.) chapter headings, section headings, and list titles differently must determine the proper processing of a head element based on its structural position. A head occurring as the first element of a list is the title of that list; one occurring as the first element of a <div1> is the title of that chapter or section. |
| Example | The most common use for the head element is to mark the headings of sections. In older writings, the headings or incipits may be rather longer than usual in modern works. If a section has an explicit ending as well as a heading, it should be marked as a trailer, as in this example: <div1 n="I" type="book"> <head>In the name of Christ here begins the first book of the ecclesiastical history of Georgius Florentinus, known as Gregory, Bishop of Tours.</head> <div2 type="section"> <head>In the name of Christ here begins Book I of the history.</head> <p>Proposing as I do ...</p> <p>From the Passion of our Lord until the death of Saint Martin four hundred and twelve years passed.</p> <trailer>Here ends the first Book, which covers five thousand, five hundred and ninety-six years from the beginning of the world down to the death of Saint Martin.</trailer> </div2> </div1> |
| Example | When headings are not inline with the running text (see e.g. the heading "Secunda conclusio") they might however be encoded as if. The actual placement in the source document can be captured with the place attribute. <div type="subsection"> <head place="margin">Secunda conclusio</head> <p> <lb n="1251"/> <hi rend="large">Potencia: habitus: et actus: recipiunt speciem ab obiectis<supplied>.</supplied> </hi> <lb n="1252"/>Probatur sic. Omne importans necessariam habitudinem ad proprium [...] </p> </div> |
| Example | The head element is also used to mark headings of other units, such as lists: With a few exceptions, connectives are equally useful in all kinds of discourse: description, narration, exposition, argument. <list rend="bulleted"> <head>Connectives</head> <item>above</item> <item>accordingly</item> <item>across from</item> <item>adjacent to</item> <item>again</item> <item> <!-- ... --> </item> </list> |
| Content model | <content> |
| Schema Declaration | element head { att.global.attributes, att.typed.attributes, att.placement.attributes, att.written.attributes, att.cmc.attributes, ( text | lg | model.gLike | model.phrase | model.inter | model.lLike | model.global )* } |
| <hi> (highlighted) marks a word or phrase as graphically distinct from the surrounding text, for reasons concerning which no claim is made. [3.3.2.2. Emphatic Words and Phrases 3.3.2. Emphasis, Foreign Words, and Unusual Language] | |
| Module | core |
| Attributes |
|
| Member of | |
| Contained by | core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | |
| Example | <hi rend="gothic">And this Indenture further witnesseth</hi> that the said <hi rend="italic">Walter Shandy</hi>, merchant, in consideration of the said intended marriage ... |
| Content model | <content> |
| Schema Declaration | element hi { att.global.attributes, att.written.attributes, att.cmc.attributes, macro.paraContent } |
| <ident> (identifier) contains an identifier or name for an object of some kind in a formal language. ident is used for tokens such as variable names, class names, type names, function names etc. in formal programming languages. [23.1.1. Phrase Level Terms] | |
| Module | tagdocs |
| Attributes |
|
| Member of | |
| Contained by | analysis: s core: abbr add addrLine author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder language licence principal sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer |
| May contain | Character data only |
| Note | In running prose, this element may be used for any kind of identifier in any formal language. It should not be used for element and attribute names in XML, for which the special elements gi and att are provided. |
| Example | <ident type="ns">http://www.tei-c.org/ns/Examples</ident> |
| Content model | <content> |
| Schema Declaration |
element ident { att.global.attributes, att.typed.attributes, text } |
| <idno> (identifier) supplies any form of identifier used to identify some object, such as a bibliographic item, a person, a title, an organization, etc. in a standardized way. [14.3.1. Basic Principles 2.2.4. Publication, Distribution, Licensing, etc. 2.2.5. The Series Statement 3.12.2.4. Imprint, Size of a Document, and Reprint Information] | |||||||||
| Module | header | ||||||||
| Attributes |
| ||||||||
| Member of | |||||||||
| Contained by | analysis: s core: abbr add addrLine address author bibl biblScope corr date del desc editor emph expan foreign gloss head hi item l label mentioned name note num orig p pubPlace publisher q ref reg resp rs sic soCalled speaker stage term time title unclear header: authority catDesc change classCode creation distributor edition extent funder idno language licence principal publicationStmt seriesStmt sponsor linking: seg tagdocs: eg textstructure: byline closer dateline docAuthor docDate docEdition docImprint imprimatur opener salute signed titlePart trailer | ||||||||
| May contain | header: idno character data | ||||||||
| Note | idno should be used for labels which identify an object or concept in a formal cataloguing system such as a database or an RDF store, or in a distributed system such as the World Wide Web. Some suggested values for type on idno are ISBN, ISSN, DOI, and URI. | ||||||||
| Example | <idno type="ISBN">978-1-906964-22-1</idno> <idno type="ISSN">0143-3385</idno> <idno type="DOI">10.1000/123</idno> <idno type="URI">http://www.worldcat.org/oclc/185922478</idno> <idno type="URI">http://authority.nzetc.org/463/</idno> <idno type="LT">Thomason Tract E.537(17)</idno> <idno type="Wing">C695</idno> <idno type="oldCat"> <g ref="#sym"/>345 </idno> In the last case, the identifier includes a non-Unicode character which is defined elsewhere by means of a <glyph> or <char> element referenced here as | ||||||||
| Schematron | <sch:rule context="tei:*[@calendar]"> <sch:assert test="string-length( normalize-space(.) ) gt 0"> @calendar indicates one or more systems or calendars to which the date represented by the content of this element belongs, but this <sch:name/> element has no textual content.</sch:assert> </sch:rule> | ||||||||
| Content model | <content> | ||||||||
| Schema Declaration | element idno { att.global.attributes, att.sortable.attributes, att.datable.attributes, att.typed.attribute.subtype, att.cmc.attributes, attribute type { teidata.enumerated }?, ( text | model.gLike | idno )* } | ||||||||
| <imprimatur> (imprimatur) contains a formal statement authorizing the publication of a work, sometimes required to appear on a title page or its verso. [4.6. Title Pages] | |
| Module | textstructure |
| Attributes |
|
| Member of | |
| Contained by | textstructure: titlePage |
| May contain | |
| Example | <imprimatur>Licensed and entred acording to Order.</imprimatur> |
| Content model | <content> |
| Schema Declaration |
element imprimatur { att.global.attributes, macro.paraContent } |
| <index> (index entry) marks a location to be indexed for whatever purpose. [3.9.2. Index Entries] | |||||||||
| Module | core | ||||||||
| Attributes |
| ||||||||
| Member of | |||||||||
| Contained by | |||||||||