P5: TEIガイドライン

3.3.1 What Is Highlighting?TEI: What Is Highlighting?¶

By highlighting we mean the use of any combination of typographic features (font, size, hue, etc.) in a printed or written text in order to distinguish some passage of a text from its surroundings. ⁹ The purpose of highlighting is generally to draw the reader's attention to some feature or characteristic of the passage highlighted; this section describes the elements recommended by these Guidelines for the encoding of such textual features.

The textual functions indicated by highlighting may not be rendered consistently in different parts of a text or in different texts. (For example, a foreign word may appear in italics if the surrounding text is in roman, but in roman if the surrounding text is in italics.) For this reason, these Guidelines distinguish between the encoding of rendering itself and the encoding of the underlying feature expressed by it.

The possible values carried by the rend attribute are not formally defined in this version of the Guidelines. Since the rend attribute may be used to document any peculiarity of the way a given segment of text was rendered in the original source text, it may need to express a very large range of typographic features, by no means restricted to typeface, type size, etc.

In many, if not most, cases the underlying function of a highlighted phrase will be obvious and non-controversial, since the distinctions indicated by a change of highlighting correspond with distinctions discussed elsewhere in these Guidelines. The elements available to record such distinctions are, for the most part, members of the model.emphLike class. This and the model.hiLike class mentioned above constitute the model.highlighted class, which is a phrase level class. Members of this class may appear anywhere within paragraph level elements.

The distinction between the two classes is simple, and typified by the two elements hi and emph: the former marks simply that a passage is typographically distinct in some way, while the latter asserts that a passage is linguistically emphasized for some purpose. These two properties, though often combined, are not identical. It should however be recognized, however, that cases do exist in which it is not economically feasible to mark the underlying function (e.g. in the preparation of large text corpora), as well as cases in which it is not intellectually appropriate (as in the transcription of some older materials, or in the preparation of material for the study of typographic practice). In such cases, the hi element or some other element from the model.hiLike class should be used.

Elements which are sometimes realized by typographic distinction but which are not discussed in this section include title (discussed in section 3.11 Bibliographic Citations and References) and name (discussed in section 3.5.1 Referring Strings).

3.3.2 Emphasis, Foreign Words, and Unusual LanguageTEI: Emphasis, Foreign Words, and Unusual Language¶

3.3.3 QuotationTEI: Quotation¶

One form of presentational variation found particularly frequently in written and printed texts is the use of quotation marks. As with the typographic variations discussed in the preceding section, it is generally helpful to separate the encoding of the underlying textual feature (for example, a quotation or a piece of direct speech) from the encoding of its rendering (for example, the use of a particular style of quotation marks).

The most common and important use of quotation marks is, of course, to mark quotation, by which we mean simply any part of the text attributed by the author or narrator to some agency other than the narrative voice. The q element may be used if no further distinction beyond this is judged necessary. If however it is felt necessary to distinguish passages which are in some sense external to the work from passages of direct speech or thought, a more precise element may be chosen from the list above. Typical examples include passages cited from other works, for which the element quote may be used, and words or phrases spoken or thought by people or characters within the current work, for which the element said may be used. The soCalled element is used for cases where the author or narrator distances him or herself from the words in question without however attributing them to any other voice in particular. The mentioned element is appropriate for a case where a word or phrase is being discussed in the body of a text rather than forming part of the text directly.

As noted above, if the distinction among these various reasons why a passage is offset from surrounding text cannot be made reliably, or is not of interest, then all quoted matter may simply be marked using the q element.

Quotation may be indicated in a printed source by changes in type face, by special punctuation marks (single or double or angled quotes, dashes, etc.) and by layout (indented paragraphs, etc.). If these characteristics are of interest, one or other of the global rend or rendition attributes discussed in section 1.3.1.1 Global Attributes may be used to record them.

Quotation marks themselves may, like other punctuation marks, be felt for some purposes to be worth retaining within a text, quite independently of their description by the rend attribute. This should generally be done using the appropriate Unicode character, or, if this is not possible, a numeric character reference (see Character References).

3.3.4 Terms, Glosses, Equivalents, and DescriptionsTEI: Terms, Glosses, Equivalents, and Descriptions¶

This section describes a set of textual elements which are used to provide a gloss, alternate identification, or description of something.

A term may appear with or without a gloss, as may a mentioned element. Where the gloss is present, it may be linked to the term it is glossing by means of its target attribute. To establish such a link, the encoder should give an xml:id value to the term or mentioned element and provide that id as the value of the target attribute on the gloss element. The following examples demonstrate this facility:

For technical terminology in particular, and generally in terminological studies, it may be useful to associate an instance of a term within a text with a canonical definition for it, which is stored either elsewhere in the same text (for example in a glossary of terms) or externally, for example in a database, authority file, or published standard. The attributes key and ref discussed in section 3.5.1 Referring Strings below are available on the term element for this purpose.

By default, the altIdent of a component is identical to the value of its ident attribute.

3.3.5 Some Further ExamplesTEI: Some Further Examples¶

Clearly, the word vehement is not italicized for the same reason as the phrase not so young as she has been; the former is emphasized, while the latter is proverbial. It also provides an ironic gloss for the words too wise, in the same way as too pert glosses too witty. The glossed phrases are not, however, technical terms or cited words, but quoted phrases, as if the writer were putting words into her own and her mother's mouths. Finally, the words mother and daughter are apparently italicized simply to oppose them in the sentence; certainly they do not fit into any of the categories so far proposed as reasons for italicizing. Note also that the word Anglicé is not italicized although it is not generally considered an English word.

3.4.1 Apparent ErrorsTEI: Apparent Errors¶

Where, as here, the correction takes the form of adding text not otherwise present in the text being encoded, the encoder should use the corr element. Where the correction is present in the text being encoded, and consists of some combination of visible additions and deletions, the elements add or del should be used: see further section 3.4.3 Additions, Deletions, and Omissions below. Where the correction takes the form of addition of material not present in the original because of physical damage or illegibility, the supplied element may be used. Where the ‘correction’ is simply a matter of expanding an abbreviation the ex element may be used. These and other elements to support the detailed encoding of authorial or scribal interventions of this kind are all provided by the module described in chapter 11 Representation of Primary Sources.

3.4.2 Regularization and NormalizationTEI: Regularization and Normalization¶

When the source text makes extensive use of variant forms or non-standard spellings, it may be desirable for a number of reasons to regularize it: that is, to provide ‘standard’ or ‘regularized’ forms equivalent to the non-standard forms. ¹¹

Typical applications for these elements include the production of editions intended for student or lay readers, linguistic research in which spelling or usage variation is not the main question at issue, production of spelling dictionaries, etc.

As elsewhere, the resp attribute may be used to specify the agency responsible for the regularization.

3.4.3 Additions, Deletions, and OmissionsTEI: Additions, Deletions, and Omissions¶

The add and del elements may be used to record where words or phrases have been added or deleted in the copy text. They are not appropriate where longer passages have been added or deleted, which span several elements; for these, the elements addSpan and delSpan described in chapter 11.3.4 Additions and Deletions must be used.

The add element should not be used to mark editorial changes, such as supplying a word omitted by mistake from the source text or a passage present in another version. In these cases, either the corr or supplied tags should be used, as discussed above in section 3.4.1 Apparent Errors, and in section 11.3.3 Correction and Conjecture, respectively.

The unclear element is used to mark passages in the original which cannot be read with confidence, or about which the transcriber is uncertain for other reasons, as for example when transcribing a partially inaudible or illegible source. Its reason and resp attributes are used, as with the gap element, to indicate the cause of uncertainty and the person responsible for the conjectured reading.

Where the material affected is entirely illegible or inaudible, the gap element discussed above should be used in preference.

The del element should not be used where the deletion is such that material cannot be read with confidence, or read at all, or where the material has been omitted by the transcriber or editor for some other reason. Where the material deleted cannot be read with confidence, the unclear tag should be used with the reason attribute indicating that the difficulty of transcription is due to deletion. Where material has been omitted by the transcriber or editor, this may be indicated by use of the gap element. A deletion in which some parts may be read but not others may thus be represented by one or more gap elements intermingled with text, all contained by a del element.

3.5.1 Referring StringsTEI: Referring Strings¶

Simply tagging something as a name is generally not enough to enable automatic processing of personal names into the canonical forms usually required for reference purposes. The name as it appears in the text may be inconsistently spelled, partial, or vague. Moreover, name prefixes such as van or de la may or may not be included as part of the reference form of a name, depending on the language and country of origin of the bearer.

Two issues arise in this context: firstly, there may be a need to encode a regularised form of a name, distinct from the actual form in the source to hand; secondly, there may be a need to identify the particular person, place, etc. referred to by the name, irrespective of whether the name itself is normalized or not. The element reg, introduced in 3.4.2 Regularization and Normalization is provided for the former purpose; the attributes key or ref for the latter.

3.5.2 AddressesTEI: Addresses¶

Where code letters are commonly used in addresses (for example, to identify regions or countries) a useful practice is to supply the full name of the region or country as the content of the element, but to supply the abbreviatory code as the value of the global n attribute, so that (for example) an application preparing formatted labels can readily find the required information. Other components of addresses may be represented using the general-purpose name element or (when the additional module for names and dates is included) the more specialized elements provided for that purpose.

For further discussion of ways of regularizing the names of places, see section 3.5 Names, Numbers, Dates, Abbreviations, and Addresses. A full postal address may also include the name of the addressee, tagged as above using the general purpose name element.

3.5.3 Numbers and MeasuresTEI: Numbers and Measures¶

Like names or abbreviations, numbers can occur virtually anywhere in a text. Numbers are special in that they can be written with either letters or digits (twenty-one, xxi, and 21) and their presentation is language-dependent (e.g. English 5th becomes Greek 5.; English 123,456.78 equals French 123.456,78).

For many kinds of application, e.g. natural-language processing or machine translation, numbers are not regarded as ‘lexical’ in the same way as other parts of a text. For these and other applications, the num element provides a convenient method of distinguishing numbers from the surrounding text. For other kinds of application, numbers are only useful if normalized: here the num element is useful precisely because it provides a standardized way of representing a numerical value.

In its fullest form, a measure consists of a number, a phrase expressing units of measure and a phrase expressing the commodity being measured, though not all of these components need be present in every case. It may be helpful to distinguish measures from surrounding text for two reasons. Firstly, a measure may be expressed using a particular notation or system of abbreviations which the encoder does not wish to regard as lexical. Secondly, a quantitative application may wish to distinguish and normalize the internal components of a measure, in order to perform calculations on them.

3.5.4 Dates and TimesTEI: Dates and Times¶

Dates can occur virtually anywhere in a text, but in some contexts (e.g. bibliographic citations) their encoding is recommended or required rather than optional. Times can also appear anywhere but are generally optional.

Partial dates or times (e.g. 1990, September 1990, twelvish) can be expressed in the when attribute by simply omitting a part of the value supplied. Imprecise dates or times (for example early August, some time after ten and before twelve) may be expressed as date or time ranges.

These mechanisms are useful primarily for fully specified dates or times known with certainty. If component parts of dates or times are to be marked up, or if a more complex analysis of the meaning of a temporal expression is required, the techniques described in chapter 13 Names, Dates, People, and Places should be used in preference to the simple method outlined here.

Where the certainty (i.e. reliability) of the date or time is in question, the encoder should record this fact using the mechanisms discussed in chapter 21 Certainty, Precision, and Responsibility. The same chapter also discusses various methods of recording the precision of numerical or temporal assertions.

The calendar attribute may be used to specify a date in any calendar system; if the when attribute is also supplied, it should specify the equivalent date in the Gregorian calendar.

3.5.5 Abbreviations and Their ExpansionsTEI: Abbreviations and Their Expansions¶

Abbreviation is a particularly important feature of manuscript and other source materials, the transcription of which needs more detailed treatment than is possible using these simple elements. A more detailed set of recommendations is discussed in 11.3 Altered, Corrected, and Erroneous Texts, which includes additional elements made available for the purpose by the transcr module.

3.8.1 Notes and Simple AnnotationTEI: Notes and Simple Annotation¶

A note is any additional comment found in a text, marked in some way as being out of the main textual stream. All notes should be marked using the same tag, note, whether they appear as block notes in the main text area, at the foot of the page, at the end of the chapter or volume, in the margin, or in some other place.

Notes may be in a different hand or typeface, may be authorial or editorial, and may have been added later. Attributes may be used to specify these and other characteristics of notes, as detailed below.

Where possible, the body of a note should be inserted in the text at the point at which its identifier or mark first appears; we term this the note's point of attachment. This may not always be possible for example with marginal notes, which may not be anchored to an exact location. For ease of processing, it may be adequate to position marginal notes before the relevant paragraph or other element. In printed texts, it is sometimes conventional to group notes together at the foot of the page on which their points of attachment appear. This practice is not generally recommended for TEI-encoded texts, since the pagination of a particular printed text is unlikely to be of structural significance. In some cases, however, it may be desirable to transcribe notes not at their point of attachment to the text but at their point of appearance, typically at the end of the volume, or the end of the chapter. In such cases, the target attribute of the note should be used to indicate the point of attachment.

In cases where the note is attached not to a point but to a span of text, the target attribute should use an appropriate pointer expression, for example using the range() function to specify the span of attachment. For further discussion of pointing to points and spans in the text, see section 3.6 Simple Links and Cross-References.

In addition to transcribing notes already present in the copy text, researchers may wish to add their own notes or comments to it. The note element may be used for either purpose, but it will usually be advisable to distinguish the two categories. One way might be to use the type attribute shown above, categorizing notes as authorial, editorial, etc. Where notes derive from many sources, or where a more precise attribution is required, the resp attribute may be used to point to a definition of the person or other agency responsible for the content of the note.

When annotating the electronic text by means of analytic notes in some structured vocabulary, e.g. to specify the topics or themes of a text, the span and interp elements may be more effective than the free form note element; these elements are available when the module for simple analysis is selected (see section 17.3 Spans and Interpretations).

3.8.2 Index EntriesTEI: Index Entries¶

The indexing of scholarly texts is a skilled activity, involving substantial amounts of human judgment and analysis. It should not therefore be assumed that simple searching and information retrieval software will be able to meet all the needs addressed by a well-crafted manual index, although it may complement them for example by providing free text search. The role of an index is to provide access via keywords and phrases which are not necessarily present in the text itself, but must be added by the skill of the indexer.

3.10.1 Using the xml:id and n AttributesTEI: Using the xml:id and n Attributes¶

When traditional reference schemes represent a hierarchical structuring of the text which mirrors that of the marked-up document, the n attribute defined for all elements may be used to indicate the traditional identifier of the relevant structural units. The n attribute may also be used to record the numbering of sections or list items in the copy text if the copy-text numbering is important for some reason, for example because the numbers are out of sequence.

To document the usage and to allow automatic processing of these standard references, it is recommended that the TEI header be used to declare whether standard references are recorded in the n or xml:id attributes and which elements may carry standard references or portions of them. For examples of declarations for the reference systems just shown, see section 3.10.4 Declaring Reference Systems.

Using the n attribute one can specify only a single standard referencing system, a limitation not without problems, since some editions may define structural units differently and thus create alternative reference systems. For example, another edition of the Amores considers poem 10 a continuation of poem 9, and therefore would specify the same line as Amores 2.9.31. In order to record both of these reference systems one could employ any of a variety of methods discussed in chapter 20 Non-hierarchical Structures.

3.10.2 Creating New Reference SystemsTEI: Creating New Reference Systems¶

If a text has no canonical reference system of its own, a reference system, if needed, may be derived from the structure of the electronic text, specifically from the markup of the text. As with any reference system intended for long-term use, it is important to see the reference as an established, unchanging point in the text. Should the text be revised or rearranged, the reference-system identifiers associated with any bit of text must stay with that bit of text, even if it means the reference numbers fall out of sequence. (A new reference system may always be created beside the old one if out-of-sequence numbers must be avoided.)

The global attributes n and xml:id may be used to assign reference identifiers to segments of the text. Identifiers specified by either attribute apply to the entire element for which they are given. ID attributes must be unique within a single document, and ID values must begin with a letter. No such restrictions are made on the values of n attributes.

A convenient method of mechanically generating unique values for xml:id or n attributes based on the structure of the document is to construct, for each element, a domain-style address comprising a series of components separated by full stops, with one component for each level of the document hierarchy. Two methods may be used. In the typed path form of identifier, each component in the identifier takes the form of an element identifier, a hyphen, and a number, for example p-2. The element name specifies what type of element is to be sought, and the number specifies which occurrence of that element type is to be selected. (The hyphen and number may be omitted if there is only one element of the given type.) In the untyped path form of identifier, each component consists of a number, indicating which element in the sequence of nodes at each level is to be selected.

Identifiers generated with these methods should use the text element as their starting point, rather than the TEI or body elements. The TEI element may be taken as a starting point only if identifiers need to be generated for the teiHeader, which is not usually the case; using the body element as a root would prevent assignment of identifiers for the front and back matter. The component corresponding to the root element can be omitted from identifiers, if no confusion will result. In collections and corpora, the component corresponding to the root may be replaced by the unique identifier assigned to the text or sample.

If the xml:id attribute is used to record the reference identifiers generated, each value should record the entire path. If the n attribute is used, each value may record either the entire path or only the subpath from the parent element. The attribute used, the elements which can bear standard reference identifiers, and the method for constructing standard reference identifiers, should all be declared in the header as described in section 2.3.5 The Reference System Declaration.

3.10.3 Milestone ElementsTEI: Milestone Elements¶

These elements simply mark the points in a text at which some category in a reference system changes. They have no content but subdivide the text into regions, rather in the same way as milestones mark points along a road, thus implicitly dividing it into segments. The elements pb, cb, and lb are specialised types of milestone, marking page, column, and line boundaries. The global n attribute is used in each case to provide a value for the particular unit associated with this milestone (for example, the page or line number). Since it is not structural, validation of a reference system based on milestones cannot readily be checked by an XML parser, so it will be the responsibility of the encoder or the application software to ensure that they are given in the correct order.

Milestone tags also make it possible to record the reference systems used in a number of different editions of the same work. The reference system of any one edition can be recreated from a text in which all are marked by simply ignoring all elements that do not specify that edition on their ed attribute.

In this case no n value is specified, since the numbers rise predictably and the application can keep a count from the start of the document, if desired.

When using milestone tags, line numbers may be supplied for every line or only periodically (every fifth, every tenth line). The latter may be simpler; the former is more reliable.

The style of numbering used in the values of n is unrestricted: for the example above, I.i, I.ii, and I.iii could have been used equally well if preferred. The special value unnumbered should be reserved for marking sections of text which fall outside the normal numbering system (e.g. chapter heads, poem numbers, titles, or speaker attributions in a verse drama).

By default, there are no constraints on the values supplied for the ed attribute. If it is felt appropriate to enforce such a restriction, the techniques described in 23.2 Personalization and Customization may be used, for example to specify that the attribute must specify one of a predefined set of values.

See below, section 3.10.4 Declaring Reference Systems, for examples of declarations for the reference systems just shown.

Milestone elements may be used to mark any kind of shift in the properties associated with a piece of text, whether or not would normally be considered a reference system. For example, they may be used to mark changes in narrative voice in a prose text, or changes of speaker in a dramatic text, where these are not marked using structural elements such as sp, perhaps in order to avoid a clash of hierarchies.

3.10.4 Declaring Reference SystemsTEI: Declaring Reference Systems¶

Whatever kind of reference system is used in an electronic text, it is recommended that the TEI header contain a description of its construction in the refsDecl element described in section 2.3.5 The Reference System Declaration. As described there, the declaration may consist either of a formal declaration using the cRefPattern element or an informal description in prose. The former is recommended because unlike prose it can be processed by software.

3.11.1 Elements of Bibliographic ReferencesTEI: Elements of Bibliographic References¶

The members of the model.biblLike class all share a number of possible component sub-elements. For the bibl and biblStruct elements, exactly the same sub-elements are concerned, and they are described together in section 3.11.2 Components of Bibliographic References; for the biblFull element, the sub-elements concerned are fully described in section 2.2 The File Description.

3.11.2 Components of Bibliographic ReferencesTEI: Components of Bibliographic References¶

3.11.3 Bibliographic Pointers TEI: Bibliographic Pointers ¶

3.11.4 Relationship to Other Bibliographic SchemesTEI: Relationship to Other Bibliographic Schemes¶

The bibliographic tagging defined here can capture the distinctions required by most bibliographic encoding systems; for the benefit of users of some commonly used systems, the following lists of equivalences are offered, showing the relationship of the markup defined here to the fields defined for bibliographic records in the Scribe, BibTeX, and ProCite systems.

3.12.1 Core Tags for VerseTEI: Core Tags for Verse¶

Like other written texts, verse texts or poems may be hierarchically subdivided, for example into books or cantos. These structural subdivisions should be encoded using the general purpose div or div1 (etc.) elements described below in chapters 4 Default Text Structure and 6 Verse. The fundamental unit of a verse text is the verse line rather than the paragraph, however.

The l element should not be used to represent typographic lines in non-verse materials: if the line-breaking points in a prose text are considered important for analysis, they should be marked with the lb element. Alternatively, a neutral segmentation element such as seg or ab may be used; see further discussion of these elements in chapter 16 Linking, Segmentation, and Alignment. The l element is a member of the model.lLike class, which is a subclass of the model.divPart class, along with elements from the model.pLike (paragraph-like) class.

For alternative methods of aligning groups of lines which do not form simple hierarchic groups, or which are discontinuous, see the more detailed discussion in chapter 16 Linking, Segmentation, and Alignment. For discussion of other elements and attributes specific to the encoding of verse, see chapter 6 Verse.

3.12.2 Core Tags for DramaTEI: Core Tags for Drama¶

Like other written texts, dramatic and other performance texts such as cinema or TV scripts are often hierarchically organized, for example into acts and scenes. These structural subdivisions should be encoded using the general purpose div or div1 (etc.) elements described below in chapters 4 Default Text Structure and 7 Performance Texts. Within these divisions, the body of a performance text typically consists of speeches, often prefixed by a phrase indicating who is speaking, and occasionally interspersed with stage directions of various kinds.