General

The following example demonstrates a simple use of TEI markup for the encoding of structural features in prose text:

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Or worse, what would happen when another Academy member had decided to go for a stroll in the park instead? He quickly thought up several possible plans:

hide behind a tree and duck catch the duck as subject material for a speech on the annual meeting be frank, meet his colleague, and 1. pat him on the shoulder 2. tell a joke 3. hand him the duck 4. offer him a sip from his 2.5 l bottle of coke 5. pull his beard

Or maybe he could still announce his absence from the meeting by sending an antedated letter of apology to Professor M. Orkelidius, Royal Academy of Whoopledywhaa, Queenstreet 81, TB90 00E Whoopledywhaa.

Plenty of options, he thought, sat on a bench and opened the book he had taken from the Whoopledywhaaian National Library. It was titled 'While thou art here', by Sir Edmund Peckwood. While reading the first sentence, his placid expression turned to a certain je ne sais quoi: For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa.

Encoding structural features in prose text.

Title Pages

Title pages may be encoded within front or back by using the element titlePage. titlePage must not be confused with fileDesc, which may contain titleStmt and publicationStmt. Whereas titlePage is used for the transcription and encoding of the physical title page in text, fileDesc is part of the teiHeader section containing meta-information, in this case a bibliographic description of the electronic file. A title page commonly contains the title of the work (docTitle), which can consist of several subsections or divisions (titlePart), with an type attribute documenting their role. The name of the author of the document (docAuthor) often occurs inside a byline (byline), which contains the primary statement of responsibility given for a work. Other components of titlePage may be the edition statement (docEdition), the date of a document (docDate), and the imprint statement (docImprint), which may further contain the place of publication (pubPlace), a date (date or docDate), and names (name) of, e.g., the publisher (publisher). Besides this information, a titlePage may also contain an anonymous or attributed quotation (epigraph), a formal statement authorizing the publication of a work (imprimatur), and/or an inline graphic, illustration, or figure (graphic).

Roy Offire The Strange Adventures of Dr. Burt Diddledygook Wanderings in the life of a buoyant academic Transcribed from the diaries. First Edition Kirkcaldy, Bucket Books, 1972 Encoding a title page with titlePage.

Referring Strings

Proper nouns name people, places, and objects and are easily traceable in a text, since they commonly appear with the first letter in upper case. This may be encoded with name carrying a type attribute specifying the kind of object referred to.

'Plenty of options', he thought, sat on a bench and opened the book he had taken from the Whoopledywhaaian National Library. It was titled 'While thou art here', by Sir Edmund Peckwood. While reading the first sentence, his placid expression turned to a certain je ne sais quoi: 'For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa.'

Encoding proper names with the name element.

However, people, places, and objects may also be referred to with common nouns, for which the element rs (referring string) may be used. This element may also carry a type attribute specifying the kind of object referred to.The rs element may be used for any reference to a person, place or object in the form of a proper noun, a noun phrase, or a common noun. The name element may be used synonymously with the rs element in the special cases of referencing strings which consist only of proper nouns. The choice between rs or name in these cases is the encoder’s. Both elements can nest: for example, name may also nest inside rs where a proper name is part of a larger referring string, as in Royal Academy of Whoopledywhaa

'Plenty of options', he thought, sat on a bench and opened the book he had taken from the Whoopledywhaaian National Library. It was titled 'While thou art here', by Sir Edmund Peckwood. While reading the first sentence, his placid expression turned to a certain je ne sais quoi: 'For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa.'

Encoding referring strings with rs.

Dates and Time

Any expression defining a date or time may be encoded with the corresponding elements date and time. The system or calendar to which the date belongs may be documented using a calendar attribute. The when attribute supplies the value of a date or time in a standard form, which is useful for text processing.

The normalised representation of the content of the date element should conform to a valid W3C schema datatype for expressing temporal data: 2009 December 2009 31 Dec 2009 New Year’s Eve 2009 Panjshanbeh 10 Dey 1388 last day of December December thirty-first of the month

The same counts for the normalized representation of the content of time: 11:55 pm five minutes before midnight five minutes before the new year 2010 The last example also includes a date string and can equally well be tagged as five minutes before the new year 2010 .

The date element can also be used to mark a span of time, using the from and to attributes, or a range of time, using the notBefore and notAfter attributes:

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Expressing more dating nuances with from, to, notBefore, and notAfter.

In this example, the from and to attributes in the first date element express a period of time, spanning from 1935 to 1960. In the second date element, the combination of notBefore and notAfter indicates a time range in the second half of September 1960.

See section 13.1.2 Dating Attributes of the TEI Guidelines for a comprehensive explanation of the use and combinations of these dating attributes.

Numbers and Measures

Numbers and measures may be encoded using num and measure respectively.

num may contain numbers, written in any form. The attribute type can be used to indicate the type of numeric value, and value to supply the value of the number in standard form.

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa.

Encoding numbers with num.

Here are more examples of the standardisation of numbers: xxv twenty-five percent 25% 25th

In its fullest form, a measure consists of a number, a phrase expressing units of measure, and a phrase expressing the commodity being measured, though not all of these components need to be present in every case. These three components may be encoded on a measure element with the attributes quantity, unit, and commodity.

Or worse, what would happen when another Academy member had decided to go for a stroll in the park instead? He quickly thought up several possible plans:

hide behind a tree and duck catch the duck as subject material for a speech on the annual meeting be frank, meet his colleague, and 1. pat him on the shoulder 2. tell a joke 3. hand him the duck 4. offer him a sip from his 2.5 l bottle of coke 5. pull his beard Encoding measures with measure.

Addresses

E-mail addresses can be encoded with the email element.

M.Orkelidius@raw.org Encoding an e-mail address with email.

A postal address can be encoded with the address element. It can contain a number of addrLine elements, one for each address line.

Or maybe he could still announce his absence from the meeting by sending an antedated letter of apology to

Professor M. Orkelidius Royal Academy of Whoopledywhaa Queenstreet 81 TB90 00E Whoopledywhaa

Encoding a postal address with address.

Alternatively, an address can be encoded in more detail, with more semantically rich elements such as street, postCode and postBox. Names of people, organisations, companies, etc. may be encoded using name, with a type attribute indicating the type of object which is being named.

Or maybe he could still announce his absence from the meeting by sending an antedated letter of apology to

Professor M. Orkelidius Royal Academy of Whoopledywhaa Queenstreet 81 TB90 00E Whoopledywhaa

Encoding the components of a postall address with specific elements.

Abbreviations and Expansions

It is sometimes useful to encode abbreviations and their expansions in texts. This facilitates special processing, regularisation by the full form of an abbreviation, or the rendering of different possible expansions of an abbreviation. Abbreviations may be marked using abbr. The type attribute may be used to distinguish types of abbreviations by their function:

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Encoding abbreviations with abbr.

Alternatively, and depending on the encoder’s preference, the expansion of an abbreviation may be encoded with expan. This is often done when the editor or encoder of a text has silently expanded the abbreviation for whatever reason. It is equally possible to record both the (original) abbreviation and the (editorial) expansion by wrapping both in a choice element.

For the first time in twenty-five years, Dr Doctor Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa ( RAW Royal Academy of Whoopledywhaa ).

Combining both abbreviations and their expansions in choice.

Notes and Annotations

The most explicit form of textual annotation is the addition of notes to the text using note. This element serves for the encoding of all kinds of annotations, whether they are already present in the text or supplied by the editor; whether they appear as block notes in the main text area, at the foot of the page, at the end of the chapter or volume, in the margin, or in some other place. The type attribute can be used to distinguish between different types of annotations. In a resp attribute, the person or other agency responsible for the content of the note can be identified, pointing to the xml:id value of an element that identifies this person or agency. Where possible, a note can be inserted in the text at the point where its identifier or mark first appears. The location of the note may be documented using a place attribute.

'Plenty of options', he thought, sat on a bench and opened the book he had taken from the Whoopledywhaaian National LibraryThe National Library of Whoopledywhaa was founded in 1886 with the acquisition of the library of the late King Anthony.. It was titled 'While thou art here', by Sir Edmund PeckwoodThe manuscript reads 'Petwood'.. While reading the first sentence, his placid expression turned to a certain je ne sais quoi: 'For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa.'

Encoding an editorial annotation with note.

Here, an editorial annotation is inserted into the text, using the note element. Its type attribute indicates it is an editorial annotation; the person responsible for its content is pointed to with the resp attribute. In this case, it is referring to another element in the same document, with xml:id=EV. In the resp attribute, this ID value is preceded with a hash character (#), in order to indicate it as the identifier part of a formal URI reference.

See section 3.6. Simple Links and Cross-References in the TEI Guidelines for a full discussion of notes which are encoded not at the point of attachment but at the point of appearance, e.g., at the end of a chapter or a volume. See chapter 16. Linking, Segmentation, and Alignment for mechanisms to encode multiple views of larger or heterogeneous spans of text. See section 17.3. Spans and Interpretation for a discussion of advanced interpretive annotations.

Index Entries

Pre-existing indexes may be encoded as plain lists (list) inside div in the front or back sections of a text, for example. On the other hand, in order to generate new indexes from machine readable text, the location to be indexed can be marked with an index element. When the text is being indexed on multiple levels, the name of the index can be given in an indexName attribute. The term to be indexed should appear in a term element inside index.

'Plenty of options', he thought, sat on a bench and opened the book he had taken from the Whoopledywhaaian National Library Library National . It was titled 'While thou art here', by Sir Edmund Peckwood. While reading the first sentence, his placid expression turned to a certain je ne sais quoi: 'For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaaw Academy Royal .'

Encoding index entries with index.

Notice, how index entries can nest in order to create multi-level index entries. With this encoding in place, it will be possible to create an institutions index, with the terms Library, National and Academy, Royal, referencing the location of the original index element in the text.

See section 3.8.3 Index Entries of the TEI Guidelines for a full discussion of the TEI encoding strategies applied to indexes.

Apparent Errors

Apparent errors in the text may be indicated using the sic element, or corrected inside corr.

It was titled 'While thou art here', by Sir Edmund Petwood.

It was titled 'While thou art here', by Sir Edmund Peckwood.

Alternative encodings: an apparent error with sic, or its correction with corr.

Alternatively, the encoder may both record the original source text and provide a correction by using both sic and corr (in either order) wrapped in a choice element.

It was titled 'While thou art here', by Sir Edmund Peckwood Petwood .

Combining both errors and their corrections in choice.

The encoder may encode the degree of certainty associated with the intervention or interpretation using a cert attribute, and indicate the agency responsible for the intervention or interpretation (for instance an editor or transcriber), using resp. The value of resp is a pointer to an element in the document header that is associated with a person responsible for the intervention.

It was titled 'While thou art here', by Sir Edmund Peckwood Petwood .

Identifying the person responsible for a correction with resp, and indicating a degree of certainty with cert.

The attribute value #EV points to a name element in the teiHeader, for example in the respStmt section:

editor Edward Vanhoutte Identifying an editor for the electronic text with respStmt.

See for a fuller treatment of editorial interventions.

Regularisation and Normalisation

Standard or regularised forms for variant forms or non-standard spelling may be provided for a number of reasons. This is called regularisation or normalisation. The original, non-normalized form may be flagged using the orig element.

It was titled 'While thou art here', by Sir Edmund Peckwood.

Explicitly encoding a word as an original form in the source text, with orig.

If the encoder wants to indicate that certain words have been normalised, which means modernisation of spelling in this example, the reg element may be used.

It was titled 'While you are here', by Sir Edmund Peckwood.

Encoding a regularised form with reg.

Alternatively, the encoder may decide to record both the original form orig and the regularised form reg, wrapped inside a choice. In the case of the modernisation of spelling, an electronic text could thus serve as the basis of an old- or new-spelling edition.

It was titled 'While thou you art are here', by Sir Edmund Peckwood.

Combining both original forms and their regularisations in choice.

The resp attribute may be used to specify the person or agency responsible for the regularisation or normalisation.

It was titled 'While thou you art are here', by Sir Edmund Peckwood.

Identifying the person responsible for a normalisation with resp.

Additions, Deletions, and Omissions

Another editorial intervention in the text may be the documentation and creation of additions, deletions, and omissions. When transcribing a source document, gap may be used to indicate a point where material has been omitted, both because the material is illegible, invisible, or inaudible in the source, and because the editor or transcriber has decided to omit material for editorial reasons or as part of sampling practice. The reason for omission may be given in a reason attribute. Sample values include sampling, illegible, inaudible, irrelevant, cancelled. Additional attributes like extent and unit may document the amount of characters, words, lines or any other unit omitted.If the omission is an editorial policy decision, e.g., the systematic exclusion of marginal commentaries from an encoding, the full details of the policy should be documented in editorialDecl inside the encodingDesc of the TEI Header. See .

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Encoding omitted text with gap.

The gap element may appear as an empty element, but my also contain a description of the material omitted using desc.

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). Commentary on the founding charter of the RAW It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Describing text fragments omitted with desc inside gap.

Where words or phrases of moderate lengths have been added or deleted in the source text, this may be recorded using add and del. As with all TEI elements, information on the actual rendition of the additions and deletions can be provided in the global rend attribute. Additionally, the place of the addition may also be recorded using place. See for a detailed discussion of these elements and their attributes.When an editor wants to mark his or her own additions as editorial interventions in the text, corr or supplied should be used, not add. See . For longer additions and deletions, addSpan and delSpan may be used. See .

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a walk stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Encoding authorial additions and deletions in the source text with add and del, respectively.

When additions and deletions can be considered a single intervention in the text, add and del can be grouped inside subst (substition).

For the first time in twenty-five years, Dr Burt Diddledygook decided not to turn up to the annual meeting of the Royal Academy of Whoopledywhaa (RAW). It was a sunny day in late September 1960 bang on noontime and Dr Burt was looking forward to a walk stroll in the park instead. He hoped his fellow members of the RAW weren't even going to notice his absence.

Grouping related additions and deletions that together make up one substitution in the text, inside subst.

Where deletions in the source text cannot be read with confidence, unclear should be used with the reason attribute indicating that the difficulty of transcription is due to deletion. See .