P5: Directrices para la codificación y el intercambio de textos electrónicos

TEI: The TEI Header and its Components¶2.1.1 The TEI Header and its Components

The teiHeader element should be clearly distinguished from the front matter of the text itself (for which see section 4.5 Front Matter). A composite text, such as a corpus or collection, may contain several headers, as further discussed below. In the general case, however, a TEI-conformant text will contain a single teiHeader element, followed by a single text or facsimile element, or both.

The header element has the following description:

• teiHeader (Encabezado TEI) proporciona información descriptiva y declarativa de una página de título electrónico prefijada como un texto conforme a TEI.

  type	especifica el tipo de documento al cual el encabezado se refiere, por ejemplo si este es un corpus o un texto individual.

As discussed above, the teiHeader element has four principal components:

• fileDesc (Descripción del archivo.) contiene una descripción bibliográfica completa del archivo electrónico.
• encodingDesc (Descripción de la codificación) documenta la relación entre un texto electrónico y la fuente o fuentes de las que este deriva.
• profileDesc (descripción del perfil del texto.) proporciona una descripción detallada de los aspectos no bibliográficos de un texto, especialmente las lenguas y jergas usadas, la situación en que se aparecen, los participantes que intervienen, etc.
• revisionDesc (descripción de la revisión) resume el historial de la revisión de un archivo.

TEI: Types of Content in the TEI Header¶2.1.2 Types of Content in the TEI Header

The elements occurring within the TEI header may contain several types of content; the following list indicates how these types of content are described in the following sections:

free prose

Most elements contain simple running prose at some level. Many elements may contain either prose (possibly organized into paragraphs) or more specific elements, which themselves contain prose. In this chapter's descriptions of element content, the phrase prose description should be understood to imply a series of paragraphs, each marked as a p element. The word phrase, by contrast, should be understood to imply character data, interspersed as need be with phrase-level elements, but not organized into paragraphs. For more information on paragraphs, highlighted phrases, lists, etc., see section 3.1 Paragraphs.

grouping elements

Elements whose names end with the suffix Stmt (e.g. editionStmt, titleStmt) usually enclose a group of specialized elements recording some structured information. In the case of the bibliographic elements, the suffix Stmt is used in names of elements corresponding to the ‘areas’ of the International Standard Bibliographic Description.⁴ In most cases grouping elements may contain prose descriptions as an alternative to the set of specialized elements, thus allowing the encoder to choose whether or not the information concerned should be presented in a structured form or in prose.

declarations

Elements whose names end with the suffix Decl (e.g. tagsDecl, refsDecl) enclose information about specific encoding practices applied in the electronic text; often these practices are described in coded form. Typically, such information takes the form of a series of declarations, identifying a code with some more complex structure or description. A declaration which applies to more than one text or division of a text need not be repeated in the header of each such text or subdivision. Instead, the decls attribute of each text (or subdivision of the text) to which the declaration applies may be used to supply a cross-reference to it, as further described in section 15.3 Associating Contextual Information with a Text.

descriptions

Elements whose names end with the suffix Desc (e.g. settingDesc, projectDesc) contain a prose description, possibly, but not necessarily, organized under some specific headings by suggested sub-elements.

TEI: The Title Statement¶2.2.1 The Title Statement

The titleStmt element is the first component of the fileDesc element, and is mandatory:

• titleStmt (declaración del título) agrupa la información referente al título de una obra y a los responsables de su contenido intelectual.

It contains the title given to the electronic work, together with one or more optional statements of responsibility which identify the encoder, editor, author, compiler, or other parties responsible for it:

• title contiene el título completo de una obra de cualquier tipo.
• author en una referencia bibliográfica, contiene el nombre del autor/es, personal o empresa de una obra; la declaración esencial de responsabilidad para cualquier ítem bibliográfico.
• editor declaración secundaria de responsabilidad para un ítem bibliográfico, por ejemplo un nombre particular, o institucional (o cualquier otro) que ha actuado como editor, compilador, traductor, etc.
• sponsor especifica el nombre de la organización o institución responsable.
• funder (responsable de la financiación) proporciona el nombre del individuo, la institución o la organización responsable de la financiación de un proyecto o de un texto.
• principal (investigador principal) proporciona el nombre del investigador principal de la creación de un texto electrónico.
• respStmt (declaración de responsabilidad) proporciona la declaración de la responsabilidad para el contenido intelectual de un texto, edición, grabación o serie, donde no basten o no se apliquen los elementos especializados para autores, editores, etc.
• resp (responsabilidad) contiene un sintagma que describe la naturaleza de la responsabilidad intelectual de una persona.
• name (nombre, nombre propio) contiene un nombre propio o un sintagma nominal

The title element contains the chief name of the electronic work, including any alternative title or subtitles it may have. It may be repeated, if the work has more than one title (perhaps in different languages) and takes whatever form is considered appropriate by its creator. Where the electronic work is derived from an existing source text, it is strongly recommended that the title for the former should be derived from the latter, but clearly distinguishable from it, for example by the addition of a phrase such as ‘: an electronic transcription’ or ‘a digital edition’. This will distinguish the electronic work from the source text in citations and in catalogues which contain descriptions of both types of material.

The electronic work will also have an external name (its ‘filename’ or ‘data set name’) or reference number on the computer system where it resides at any time. This name is likely to change frequently, as new copies of the file are made on the computer system. Its form is entirely dependent on the particular computer system in use and thus cannot always easily be transferred from one system to another. Moreover, a given work may be composed of many files. For these reasons, these Guidelines strongly recommend that such names should not be used as the title for any electronic work.

Helpful guidance on the formulation of useful descriptive titles in difficult cases may be found in chapter 25 of Anglo-American Cataloguing Rules (2002–2005)) or another national cataloguing code.

The elements author, editor, sponsor, funder, and principal, are specializations of the more general respStmt element. These elements are used to provide the statements of responsibility which identify the person(s) responsible for the intellectual or artistic content of an item and any corporate bodies from which it emanates.

Any number of such statements may occur within the title statement. At a minimum, identify the author of the text and (where appropriate) the creator of the file. If the bibliographic description is for a corpus, identify the creator of the corpus. Optionally include also names of others involved in the transcription or elaboration of the text, sponsors, and funding agencies. The name of the person responsible for physical data input need not normally be recorded, unless that person is also intellectually responsible for some aspect of the creation of the file.

Where the person whose responsibility is to be documented is not an author, sponsor, funding body, or principal researcher, the respStmt element should be used. This has two subcomponents: a name element identifying a responsible individual or organization, and a resp element indicating the nature of the responsibility. No specific recommendations are made at this time as to appropriate content for the resp: it should make clear the nature of the responsibility concerned, as in the examples below.

Names given may be personal names or corporate names. Give all names in the form in which the persons or bodies wish to be publicly cited. This would usually be the fullest form of the name, including first names.⁵

TEI: The Edition Statement¶2.2.2 The Edition Statement

The editionStmt element is the second component of the fileDesc element. It is optional but recommended.

• editionStmt (declaración de la edición) agrupa la información relativa a la edición de un texto.

It contains either phrases or more specialized elements identifying the edition and those responsible for it:

• edition (edición) describe las particularidades de la edición de un texto.
• respStmt (declaración de responsabilidad) proporciona la declaración de la responsabilidad para el contenido intelectual de un texto, edición, grabación o serie, donde no basten o no se apliquen los elementos especializados para autores, editores, etc.
• name (nombre, nombre propio) contiene un nombre propio o un sintagma nominal
• resp (responsabilidad) contiene un sintagma que describe la naturaleza de la responsabilidad intelectual de una persona.

For printed texts, the word edition applies to the set of all the identical copies of an item produced from one master copy and issued by a particular publishing agency or a group of such agencies. A change in the identity of the distributing body or bodies does not normally constitute a change of edition, while a change in the master copy does.

For electronic texts, the notion of a ‘master copy’ is not entirely appropriate, since they are far more easily copied and modified than printed ones; nonetheless the term edition may be used for a particular state of a machine-readable text at which substantive changes are made and fixed. Synonymous terms used in these Guidelines are version, level, and release. The words revision and update, by contrast, are used for minor changes to a file which do not amount to a new edition.

No simple rule can specify how ‘substantive’ changes have to be before they are regarded as producing a new edition, rather than a simple update. The general principle proposed here is that the production of a new edition entails a significant change in the intellectual content of the file, rather than its encoding or appearance. The addition of analytic coding to a text would thus constitute a new edition, while automatic conversion from one coded representation to another would not. Changes relating to the character code or physical storage details, corrections of misspellings, simple changes in the arrangement of the contents and changes in the output format do not normally constitute a new edition, whereas the addition of new information (e.g. a linguistic analysis expressed in part-of-speech tagging, sound or graphics, referential links to external data sets) almost always does.

Clearly, there will always be borderline cases and the matter is somewhat arbitrary. The simplest rule is: if you think that your file is a new edition, then call it such. An edition statement is optional for the first release of a computer file; it is mandatory for each later release, though this requirement cannot be enforced by the parser.

Note that all changes in a file considered significant, whether or not they are regarded as constituting a new edition or simply a new revision, should be independently noted in the revision description section of the file header (see section 2.5 The Revision Description).

The edition element should contain phrases describing the edition or version, including the word edition, version, or equivalent, together with a number or date, or terms indicating difference from other editions such as new edition, revised edition etc. Any dates that occur within the edition statement should be marked with the date element. The n attribute of the edition element may be used as elsewhere to supply any formal identification (such as a version number) for the edition.

One or more respStmt elements may also be used to supply statements of responsibility for the edition in question. These may refer to individuals or corporate bodies and can indicate functions such as that of a reviser, or can name the person or body responsible for the provision of supplementary matter, of appendices, etc., in a new edition. For further detail on the respStmt element, see section 3.11 Bibliographic Citations and References.

TEI: Type and Extent of File¶2.2.3 Type and Extent of File

The extent element is the third component of the fileDesc element. It is optional.

• extent describe el tamaño aproximado de un texto almacenado en algún medio, digital o no, especificándolo en alguna unidad funcional.

For printed books, information about the carrier, such as the kind of medium used and its size, are of great importance in cataloguing procedures. The print-oriented rules for bibliographic description of an item's medium and extent need some re-interpretation when applied to electronic media. An electronic file exists as a distinct entity quite independently of its carrier and remains the same intellectual object whether it is stored on a magnetic tape, a CD-ROM, a set of floppy disks, or as a file on a mainframe computer. Since, moreover, these Guidelines are specifically aimed at facilitating transparent document storage and interchange, any purely machine-dependent information should be irrelevant as far as the file header is concerned.

This is particularly true of information about file-type although library-oriented rules for cataloguing often distinguish two types of computer file: ‘data’ and ‘programs’. This distinction is quite difficult to draw in some cases, for example, hypermedia or texts with built in search and retrieval software.

Although it is equally system-dependent, some measure of the size of the computer file may be of use for cataloguing and other practical purposes. Because the measurement and expression of file size is fraught with difficulties, only very general recommendations are possible; the element extent is provided for this purpose. It contains a phrase indicating the size or approximate size of the computer file in one of the following ways:

• in bytes of a specified length (e.g. ‘4000 16-bit bytes’)
• as falling within a range of categories, for example:
  • less than 1 Mb
  • between 1 Mb and 5 Mb
  • between 6 Mb and 10 Mb
  • over 10 Mb
• in terms of any convenient logical units (for example, words or sentences, citations, paragraphs)
• in terms of any convenient physical units (for example, blocks, disks, tapes)

The use of standard abbreviations for units of quantity is recommended where applicable, here as elsewhere (see http://physics.nist.gov/cuu/Units/binary.html).

TEI: Publication, Distribution, Licensing, etc.¶2.2.4 Publication, Distribution, Licensing, etc.

The publicationStmt element is the fourth component of the fileDesc element and is mandatory.

• publicationStmt (declaración de la publicación) agrupa la información concerniente a la publicación o distribución de un texto electrónico u otro texto.

It may contain either a simple prose description organized as one or more paragraphs, or one or more elements from the model.publicationStmtPart class. This class groups a number of elements which are discussed in order below.

• publisher proporciona el nombre de la organización responsable de la publicación o la distribución de un elemento bibliográfico.
• distributor proporciona el nombre de la persona o agente responsable de la distribución de un texto.
• authority (responsable de la presentación) proporciona el nombre de la persona o agente responsable que ha hecho disponible un archivo electrónico, que no es ni el editor ni el distribudor.

The publisher is the person or institution by whose authority a given edition of the file is made public. The distributor is the person or institution from whom copies of the text may be obtained. Where a text is not considered formally published, but is nevertheless made available for circulation by some individual or organization, this person or institution is termed the release authority.

At least one of the above three elements must be present, unless the entire publication statement is given as prose. Each may be followed by one or more of the following elements, in the following order:⁶

• pubPlace (lugar de la publicación) contiene el nombre del lugar de publicación de un elemento bibliográfico.
• address contiene una dirección postal, por ejemplo de un editor, una institución, etc.
• idno (número identificativo) proporciona un número, estándard o no, usado para la identificación de un elemento bibliográfico.

  type	clasifica el número, por ejemplo como un ISBN o cualquier otro número estándard.

• availability proporciona información sobre la disponibilidad de un texto, por ejemplo cualquier restricción en cuanto a su uso o distribución, su copyright, etc.

  status

  proporciona un código identificativo de la disponibilidad actual del texto.

• date contiene una fecha en cualquier formato.

Note that the dates, places, etc., given in the publication statement relate to the publisher, distributor, or release authority most recently mentioned. If the text was created at some date other than its date of publication, its date of creation should be given within the profileDesc element, not in the publication statement. Give any other useful dates (e.g., dates of collection of data) in a note.

Additional detailed elements may be used for the encoding of names, dates, and addresses, as further described in section 3.5 Names, Numbers, Dates, Abbreviations, and Addresses when the module described in chapter 13 Names, Dates, People, and Places is included in a schema.

Where the work is covered by a formal licence (such as a Creative Commons licence), the licence element may be included in availability, with its target attribute pointing to an instance of the licence document. The content of the licence element may include the full text of the licence, or a brief statement of its applicability.

TEI: The Series Statement¶2.2.5 The Series Statement

The seriesStmt element is the fifth component of the fileDesc element and is optional.

• seriesStmt (declaración de serie) agrupa información sobre la serie, si la hay, a la que pertenece una publicación.

In bibliographic parlance, a series may be defined in one of the following ways:

• A group of separate items related to one another by the fact that each item bears, in addition to its own title proper, a collective title applying to the group as a whole. The individual items may or may not be numbered.
• Each of two or more volumes of essays, lectures, articles, or other items, similar in character and issued in sequence.
• A separately numbered sequence of volumes within a series or serial.

The seriesStmt element may contain a prose description or one or more of the following more specific elements:

• title contiene el título completo de una obra de cualquier tipo.
• idno (número identificativo) proporciona un número, estándard o no, usado para la identificación de un elemento bibliográfico.
• respStmt (declaración de responsabilidad) proporciona la declaración de la responsabilidad para el contenido intelectual de un texto, edición, grabación o serie, donde no basten o no se apliquen los elementos especializados para autores, editores, etc.
• resp (responsabilidad) contiene un sintagma que describe la naturaleza de la responsabilidad intelectual de una persona.
• name (nombre, nombre propio) contiene un nombre propio o un sintagma nominal

The idno may be used to supply any identifying number associated with the item, including both standard numbers such as an ISSN and particular issue numbers. (Arabic numerals separated by punctuation are recommended for this purpose: 6.19.33, for example, rather than VI/xix:33). Its type attribute is used to categorize the number further, taking the value ISSN for an ISSN for example.

TEI: The Notes Statement¶2.2.6 The Notes Statement

The notesStmt element is the sixth component of the fileDesc element and is optional. If used, it contains one or more note elements, each containing a single piece of descriptive information of the kind treated as ‘general notes’ in traditional bibliographic descriptions.

• notesStmt (declaración de notas) agrupa algunas notas que proporcionan información sobre un texto adicional referido en otras partes de la descripción bibliográfica.
• note contiene una nota o aclaración

Some information found in the notes area in conventional bibliography has been assigned specific elements in these Guidelines; in particular the following items should be tagged as indicated, rather than as general notes:

• the nature, scope, artistic form, or purpose of the file; also the genre or other intellectual category to which it may belong: e.g. ‘Text types: newspaper editorials and reportage, science fiction, westerns, and detective stories’. These should be formally described within the profileDesc element (section 2.4 The Profile Description).
• summary description providing a factual, non-evaluative account of the subject content of the file: e.g. ‘Transcribes interviews on general topics with native speakers of English in 17 cities during the spring and summer of 1963.’ These should also be formally described within the profileDesc element (section 2.4 The Profile Description).
• bibliographic details relating to the source or sources of an electronic text: e.g. ‘Transcribed from the Norton facsimile of the 1623 Folio’. These should be formally described in the sourceDesc element (section 2.2.7 The Source Description).
• further information relating to publication, distribution, or release of the text, including sources from which the text may be obtained, any restrictions on its use or formal terms on its availability. These should be placed in the appropriate division of the publicationStmt element (section 2.2.4 Publication, Distribution, Licensing, etc.).
• publicly documented numbers associated with the file: e.g. ‘ICPSR study number 1803’ or ‘Oxford Text Archive text number 1243’. These should be placed in an idno element within the appropriate division of the publicationStmt element. International Standard Serial Numbers (ISSN), International Standard Book Numbers (ISBN), and other internationally agreed upon standard numbers that uniquely identify an item, should be treated in the same way, rather than as specialized bibliographic notes.

Nevertheless, the notesStmt element may be used to record potentially significant details about the file and its features, e.g.:

• dates, when they are relevant to the content or condition of the computer file: e.g. ‘manual dated 1983’, ‘Interview wave I: Apr. 1989; wave II: Jan. 1990’
• names of persons or bodies connected with the technical production, administration, or consulting functions of the effort which produced the file, if these are not named in statements of responsibility in the title or edition statements of the file description: e.g. ‘Historical commentary provided by Mark Cohen’
• availability of the file in an additional medium or information not already recorded about the availability of documentation: e.g. ‘User manual is loose-leaf in eleven paginated sections’
• language of work and abstract, if not encoded in the langUsage element, e.g. ‘Text in English with summaries in French and German’
• The unique name assigned to a serial by the International Serials Data System (ISDS), if not encoded in an idno
• lists of related publications, either describing the source itself, or concerned with the creation or use of the electronic work, e.g. ‘Texts used in Burrows (1987)’

TEI: The Source Description¶2.2.7 The Source Description

The sourceDesc element is the seventh and final component of the fileDesc element. It is a mandatory element and is used to record details of the source or sources from which a computer file is derived. This might be a printed text or manuscript, another computer file, an audio or video recording of some kind, or a combination of these. An electronic file may also have no source, if what is being catalogued is an original text created in electronic form.

• sourceDesc (descripción de la fuente) proporciona una descripción del texto (o textos) fuente del que un texto electrónico deriva o ha sido generado.

Alternatively, it may contain elements drawn from the following three classes:

• model.biblLike agrupa elementos que contienen una descripción bibliográfica.

  bibl	(cita bibliográfica.) contiene una cita bibliográfica estructurada libremente, los componentes de la cual pueden nohaber sido etiquetados explícitamente.
  biblFull	(citación bibliográfica estructurada completa) contiene una cita bibliográfica completamente estructurada, en la cual están presentes todos los componentes de la descripción del archivo TEI.
  biblStruct	(cita bibliográfica estructurada.) contiene una cita bibliográfica estructurada, en la cual sólo aparecen los subelementos bibliográficos y en un orden especificado.
  listBibl	(lista de cita) contiene una lista de citas bibliográficas de cualquier tipo.
  msDesc	(descripción del manuscrito) contiene la definición de un único manuscrito.

• model.sourceDescPart agrupa los elementos que pueden usarse al interno de sourceDesc (descripción de la fuente) y que aparecen en diversas ocasiones.

  recordingStmt	(declaración de grabación) describe la serie de grabaciones utilizadas como la base de transcripción de un texto hablado.
  scriptStmt	(declaración del guión) contiene una citación que indica las peculariedades del guión usado en un texto hablado.

• model.listLike agrupa todos los elementos del tipo de lista.

  list	(list) contiene cualquier secuencia de ítems o elementos organizados en una lista.
  listApp	(list of apparatus entries) contains a list of apparatus entries.
  listEvent	(list of events) contains a list of descriptions, each of which provides information about an identifiable event.
  listNym	(lista de nombres canónicos) contiene una lista de nyms, es decir, nombres estándard para cualquier cosa.
  listOrg	(lista de organizaciones) contiene una lista de descripciones, que proporciona a la información sobre una organización identificable.
  listPerson	(lista de personas) contiene una lista de descripciones, y cada una de las cuales proporciona información relativa a una persona específica o a un grupo de personas, p.ej, los participantes de una interacción verbal o las personas referidas en una fuente histórica.
  listPlace	(lista de lugares) contiene una lista de lugares, seguida opcionalmente por una lista de interelaciones (a excepción de la inclusión) definidas entre ellos.
  listWit	(lista de testimonios) contains a list of all the witnesses referred to in wit elements or wit attributes within the critical apparatus.contiene la lista con todos los testimonios a los cuales se hace referencia en los elementos y atributos relativos a los testimonios en el aparato crítico
  table	contiene texto dispuedto en forma de tabla, con filas y columnas.

When the header describes a text derived from some pre-existing TEI-conformant or other digital document, it may be simpler to use the following element, which is designed specifically for documents derived from texts which were ‘born digital’:

• biblFull (citación bibliográfica estructurada completa) contiene una cita bibliográfica completamente estructurada, en la cual están presentes todos los componentes de la descripción del archivo TEI.

For further discussion see section 2.2.8 Computer Files Derived from Other Computer Files .

When the module for manuscript description is included in a schema, this class also makes available the following element:

• msDesc (descripción del manuscrito) contiene la definición de un único manuscrito.

This element enables the encoder to record very detailed information about one or more manuscript or analogous sources, as further discussed in 10 Manuscript Description.

The model.sourceDescPart class also makes available additional elements when additional modules are included. For example, when the spoken module is included, the sourceDesc element may also include the following special-purpose elements, intended for cases where an electronic text is derived from a spoken text rather than a written one:

• scriptStmt (declaración del guión) contiene una citación que indica las peculariedades del guión usado en un texto hablado.
• recordingStmt (declaración de grabación) describe la serie de grabaciones utilizadas como la base de transcripción de un texto hablado.

Full descriptions of these elements and their contents are given in section 8.2 Documenting the Source of Transcribed Speech.

A single electronic text may be derived from multiple source documents, in whole or in part. The sourceDesc may therefore contain a listBibl element grouping together bibl, biblStruct, or msDesc elements for each of the sources concerned. It is also possible to repeat the sourceDesc element in such a case. The decls attribute described in section 15.3 Associating Contextual Information with a Text may be used to associate parts of the encoded text with the bibliographic element from which it derives in either case.

The source description may also include lists of names, persons, places, etc. when these are considered to form part of the source for an encoded document. When such information is recorded using the specialized elements discussed in the namesdates module (13 Names, Dates, People, and Places), the class model.listLike makes available the following elements to hold such information:

• listNym (lista de nombres canónicos) contiene una lista de nyms, es decir, nombres estándard para cualquier cosa.
• listOrg (lista de organizaciones) contiene una lista de descripciones, que proporciona a la información sobre una organización identificable.
• listPerson (lista de personas) contiene una lista de descripciones, y cada una de las cuales proporciona información relativa a una persona específica o a un grupo de personas, p.ej, los participantes de una interacción verbal o las personas referidas en una fuente histórica.
• listPlace (lista de lugares) contiene una lista de lugares, seguida opcionalmente por una lista de interelaciones (a excepción de la inclusión) definidas entre ellos.

TEI: Computer Files Derived from Other Computer Files ¶2.2.8 Computer Files Derived from Other Computer Files

If a computer file (call it B) is derived not from a printed source but from another computer file (call it A) which includes a TEI file header, then the source text of computer file B is another computer file, A. The four sections of A's file header will need to be incorporated into the new header for B in slightly differing ways, as listed below:

fileDesc

A's file description should be copied into the sourceDesc section of B's file description, enclosed within a biblFull element

profileDesc

A's profileDesc should be copied into B's, in principle unchanged; it may however be expanded by project-specific information relating to B.

encodingDesc

A's encoding practice may or (more likely) may not be the same as B's. Since the object of the encoding description is to define the relationship between the current file and its source, in principle only changes in encoding practice between A and B need be documented in B. The relationship between A and its source(s) is then only recoverable from the original header of A. In practice it may be more convenient to create a new complete encodingDesc for B based on A's.

revisionDesc

B is a new computer file, and should therefore have a new revision description. If, however, it is felt useful to include some information from A's revisionDesc, for example dates of major updates or versions, such information must be clearly marked as relating to A rather than to B.

This concludes the discussion of the fileDesc element and its contents.

TEI: The Project Description¶2.3.1 The Project Description

The projectDesc element may be used to describe, in prose, the purpose for which a digital resource was created, together with any other relevant information concerning the process by which it was assembled or collected. This is of particular importance for corpora or miscellaneous collections, but may be of use for any text, for example to explain why one kind of encoding practice has been followed rather than another.

• projectDesc (descripción del proyecto) describe con detalle el objetivo o propósito para el que un archivo electrónico ha sido codificado, junto a cualquier otra información relevante sobre el proceso de codificación.

TEI: The Sampling Declaration¶2.3.2 The Sampling Declaration

A sampling declaration which applies to more than one text or division of a text need not be repeated in the header of each such text. Instead, the decls attribute of each text (or subdivision of the text) to which the sampling declaration applies may be used to supply a cross-reference to it, as further described in section 15.3 Associating Contextual Information with a Text.

TEI: The Editorial Practices Declaration¶2.3.3 The Editorial Practices Declaration

The editorialDecl element is used to provide details of the editorial practices applied during the encoding of a text.

• editorialDecl (declaración de la edición) proporciona detalles de principios editoriales y prácticas aplicadas en la codificación de un texto.

It may contain a prose description only, or one or more of a set of specialized elements, members of the TEI model.editorialDeclPart class. Where an encoder wishes to record an editorial policy not specified above, this may be done by adding a new element to this class, using the mechanisms discussed in chapter 23.3 Personalization and Customization.

Some of these policy elements carry attributes to support automated processing of certain well-defined editorial decisions; all of them contain a prose description of the editorial principles adopted with respect to the particular feature concerned. Examples of the kinds of questions which these descriptions are intended to answer are given in the list below.

correction

• correction (principios de corrección) describe cómo y en qué casos se han hecho correcciones en el texto.

  status	indica el grado de corrección aplicado al texto
  method	indica el método seguido para indicar las correcciones al interno del texto.

Was the text corrected during or after data capture? If so, were corrections made silently or are they marked using the tags described in section 3.4 Simple Editorial Changes? What principles have been adopted with respect to omissions, truncations, dubious corrections, alternate readings, false starts, repetitions, etc.?

normalization

• normalization indica el grado de normalización o de regularización aplicado a la fuente original en el proceso de conversión a formato electrónico.

  source	indica la autoridad de cualquier normalización llevada a cabo.
  method	indica el método adoptado para indicar normalizaciones al interno del texto.

Was the text normalized, for example by regularizing any non-standard spellings, dialect forms, etc.? If so, were normalizations performed silently or are they marked using the tags described in section 3.4 Simple Editorial Changes? What authority was used for the regularization? Also, what principles were used when normalizing numbers to provide the standard values for the value attribute described in section 3.5.3 Numbers and Measures and what format used for them?

quotation

• quotation indica las prácticas editoriales adoptadas respecto al entrecomillado en el original.

  marks	(comillas) indica si se ha mantenido o no el entrecomillado en el texto.
  form	indica cómo se ha marcado el entrecomillado al interno del texto.

How were quotation marks processed? Are apostrophes and quotation marks distinguished? How? Are quotation marks retained as content in the text or replaced by markup? Are there any special conventions regarding for example the use of single or double quotation marks when nested? Is the file consistent in its practice or has this not been checked? See section 3.3.3 Quotation for discussion of ways in which quotation marks may be encoded.

hyphenation

• hyphenation indica el modo en que han sido tratados el uso del guión presente en el texto fuente en la versión codificada de este.

  eol	(fin de línea) indica si el uso del guión al final de la línea se ha conservado en un texto.

Does the encoding distinguish ‘soft’ and ‘hard’ hyphens? What principle has been adopted with respect to end-of-line hyphenation where source lineation has not been retained? Have soft hyphens been silently removed, and if so what is the effect on lineation and pagination? See section 3.2.2 Hyphenation for discussion of ways in which hyphenation may be encoded.

segmentation

• segmentation describe los principios aplicados en la fragmentación del texto, p.ej. en las oraciones, sintagmas, morfemas, etc.

How is the text segmented? If s or seg segmentation units have been used to divide up the text for analysis, how are they marked and how was the segmentation arrived at?

stdVals

• stdVals (valores estándard) indica el formato usado cuando aparecen fechas estandarizadas o valores numéricos.

In most cases, attributes bearing standardized values (such as the when or when-iso attribute on dates) should conform to a defined W3C or ISO datatype. In cases where this is not appropriate, this element may be used to describe the standardization methods underlying the values supplied.

interpretation

• interpretation describe la finalidad de cualquier información analítica o descriptiva añadida al texto en la transcripción.

Has any analytic or ‘interpretive’ information been provided—that is, information which is felt to be non-obvious, or potentially contentious? If so, how was it generated? How was it encoded? If feature-structure analysis has been used, are fsdDecl elements (section 18.11 Feature System Declaration) present?

An editorial practices declaration which applies to more than one text or division of a text need not be repeated in the header of each such text. Instead, the decls attribute of each text (or subdivision of the text) to which it applies may be used to supply a cross-reference to it, as further described in section 15.3 Associating Contextual Information with a Text.

TEI: The Tagging Declaration¶2.3.4 The Tagging Declaration

The tagsDecl element is used to record the following information about the tagging used within a particular text:

• the namespace to which elements appearing within the transcribed text belong.
• how often particular elements appear within the text, so that a recipient can validate the integrity of a text during interchange.
• any comment relating to the usage of particular elements not specified elsewhere in the header.
• a default rendition applicable to all instances of an element.

This information is conveyed by the following elements:

• rendition proporciona información sobre la interpretación ideada para uno o más elementos.
• att.styleDef groups elements which specify the name of a formal definition language used to provide formatting or rendition information.

  scheme	identifica el lenguaje usado para describir la interpretación.
  schemeVersion	supplies a version number for the style language provided in scheme.

• namespace proporciona el nombre formal del namespace al cual pertenecen los elementos documentados por sus hijos.
• tagUsage proporciona información sobre el uso de un elemento específico al interno del texto.

The tagsDecl element consists of an optional sequence of rendition elements, each of which must bear a unique identifier, followed by an optional sequence of one or more namespace elements, each of which contains a series of tagUsage elements, one for each distinct element from that namespace occurring within the outermost text element of a TEI document. Note that these tagUsage elements must be nested within a namespace element, and cannot appear directly within the tagsDecl element.

• » 2.3.4.2 Tag usage
• Principal

TEI: Rendition¶2.3.4.1 Rendition

The rendition element allows the encoder to specify how one or more elements are rendered in the original source in any of the following ways:

• using an informal prose description
• using a standard stylesheet language such as CSS or XSL-FO
• using a project-defined formal language

One or more such specifications may be associated with elements of a document in two ways:

• the render attribute of the appropriate tagUsage element may be used to indicate a default rendition for all occurrences of the named element
• the global rendition attribute may be used on any element to indicate its rendition, overriding or complementing any supplied default value

The global rend and style attributes may also be used to describe the rendering of an element. See further 1.3.1.1.3 Rendition Indicators

For example, the following schematic shows how an encoder might specify that all p elements are by default to be rendered using one set of specifications identified as style1, while hi elements are to use a different set, identified as style2:

<tagsDecl>
 <rendition xml:id="style1">
   ... description of one default rendition here ...
 </rendition>
 <rendition xml:id="style2">
   ... description of another default rendition here ...
 </rendition>
 <namespace name="http://www.tei-c.org/ns/1.0">
  <tagUsage gi="p" render="#style1"> ... </tagUsage>
  <tagUsage gi="hi" render="#style2"> ... </tagUsage>
 </namespace>
</tagsDecl>
<!-- elsewhere in the document -->
<p>This paragraph,mostly rendered in style1, contains a few words
<hi>rendered in style2</hi>
</p>
<p rendition="#style2">This paragraph is all rendered in style2</p>
<p>This is back to style1</p>

As noted above, the content of a rendition element may describe the appearance of the source material using prose, a project-defined formal language, or any standard languages such as the Cascading Stylesheet Language (Bos et al. (eds.) (2011)) or the XML vocabulary for specifying formatting semantics which forms a part of the W3C's Extensible Stylesheet Language (Berglund (ed.) (2006)). A styleDefDecl element (2.3.5 The default style definition language declaration) may be supplied within the encodingDesc to specify which of these applies by default; it may be overridden for one or more specific rendition elements using the scheme attribute.

In the following extended example we consider how to capture the appearance of a typical early 20th century titlepage, such as that in the following figure:

bibliography

Elements for the encoding of the information on a titlepage are presented in 4.6 Title Pages; here we consider how we might go about encoding some of the visual information as well, using the rendition element and its corresponding attributes.

First we define a rendition element for each aspect of the source page rendition that we wish to retain. Details of CSS are given in Bos et al. (eds.) (2011); we use it here simply to provide a vocabulary with which to describe such aspects as font size and style, letter and line spacing, colour, etc. Note that the purpose of this encoding is to describe the original, rather than specify how it should be reproduced, although the two are obviously closely linked.

<styleDefDecl scheme="css" schemeVersion="2.1"/>
<!-- ... -->
<tagsDecl>
 <rendition xml:id="center">text-align: center;</rendition>
 <rendition xml:id="small">font-size: small;</rendition>
 <rendition xml:id="large">font-size: large;</rendition>
 <rendition xml:id="x-large">font-size: x-large;</rendition>
 <rendition xml:id="xx-large">font-size: xx-large</rendition>
 <rendition xml:id="expanded">letter-spacing: +3pt;</rendition>
 <rendition xml:id="x-space">line-height: 150%;</rendition>
 <rendition xml:id="xx-space">line-height: 200%;</rendition>
 <rendition xml:id="red">color: red;</rendition>
</tagsDecl>

The global rendition attribute can now be used to specify on any element which of the above rendition features apply to it. For example, a title page might be encoded as follows:

<titlePage>
 <docTitle rendition="#center #x-space">
  <titlePart>
   <lb/>
   <hi rendition="#x-large">THE POEMS</hi>
   <lb/>
   <hi rendition="#small">OF</hi>
   <lb/>
   <hi rendition="#red #xx-large">ALGERNON CHARLES SWINBURNE</hi>
   <lb/>
   <hi rendition="#large #xx-space">IN SIX VOLUMES</hi>
  </titlePart>
  <titlePart rendition="#xx-space">
   <lb/> VOLUME I.
  <lb/>
   <hi rendition="#red #x-large">POEMS AND BALLADS</hi>
   <lb/>
   <hi rendition="#x-space">FIRST SERIES</hi>
  </titlePart>
 </docTitle>
 <docImprint rendition="#center">
  <lb/>
  <pubPlace rendition="#xx-space">LONDON</pubPlace>
  <lb/>
  <publisher rendition="#red #expanded">CHATTO &amp; WINDUS</publisher>
  <lb/>
  <docDate when="1904" rendition="#small">1904</docDate>
 </docImprint>
</titlePage>

bibliography 

When CSS is used as the style definition language, the scope attribute may be used to specify CSS pseudo-elements. These pseudo-elements are used to specify styling applicable to only a portion of the given text. For example, the first-letter pseudo-element defines styling to be applied to the first letter in the targeted element, while the before and after pseudo-elements can be used often in conjunction with the "content" property to add additional characters which need to be added before or after the element content to make it more closely resemble the appearance of the source.

For example, assuming that a text has been encoded using the q element to enclose passages in quotation marks, but the quotation marks themselves have been routinely omitted from the encoding, a set of renditions such as the following:

<rendition xml:id="quoteBefore" scheme="css" scope="before">content:
'“';</rendition>
<rendition xml:id="quoteAfter" scheme="css" scope="after">content:
'”';</rendition>

might be used to predefine pseudo-elements quoteBefore and quoteAfter. Where a q element is actually rendered in the source with initial and final quotation marks, it may then be encoded as follows:

<q rendition="#quoteBefore #quoteAfter">Four score and seven years
ago...</q>

TEI: The Reference System Declaration¶2.3.6 The Reference System Declaration

The refsDecl element is used to document the way in which any standard referencing scheme built into the encoding works.

• refsDecl (declaración de referencias) indica cómo se han formado las referencias canónicas para este texto.

It may contain either a series of prose paragraphs or the following specialized elements:

• cRefPattern (define cómo convertir una referncia canónica en un URI) indica una expresión y un patrón de remplazamiento para transformar una referencia canónica en un URI.
• refState/ (estado de la referencia) especifica un componente de una referencia canónica definida por el método milestone
• att.patternReplacement provides attributes for regular-expression matching and replacement.

  matchPattern	specifies a regular expression against which the values of other attributes can be matched.
  replacementPattern	especifica un ‘replacement pattern (patrón de remplazamiento)’, el cual, una vez se ha ejecutado el subpatrón de sustitución, proporciona un URI.

Note that not all possible referencing schemes are equally easily supported by current software systems. A choice must be made between the convenience of the encoder and the likely efficiency of the particular software applications envisaged, in this context as in many others. For a more detailed discussion of referencing systems supported by these Guidelines, see section 3.10 Reference Systems below.

A referencing scheme may be described in one of three ways using this element:

• as a prose description
• as a series of pairs of regular expressions and XPaths
• as a concatenation of sequentially organized milestones

Each method is described in more detail below. Only one method can be used within a single refsDecl element.

More than one refsDecl element can be included in the header if more than one canonical reference scheme is to be used in the same document, but the current proposals do not check for mutual inconsistency.

TEI: The Classification Declaration¶2.3.7 The Classification Declaration

TEI: The Geographic Coordinates Declaration¶2.3.8 The Geographic Coordinates Declaration

The following element is provided to indicate (within the header of a document, or in an external location) that a particular coordinate notation, or a particular datum, has been employed in a text. The default notation is a string containing two real numbers separated by whitespace, of which the first indicates latitude and the second longitude according to the 1984 World Geodetic System (WGS84).

• geoDecl (declaración de las coordenadas geográficas) documenta la anotación y los datos usados para los coordenadas geográficas expresadas como contenido del elemento geo en qualquier parte del documento.

  datum

  proporciona un nombre de código de uso general para los datos empleados.

TEI: The Schema Specification¶2.3.9 The Schema Specification

The schemaSpec element contains a schema specification. When this element appears inside encodingDesc, it allows embedding of a schema inside a TEI header; alternatively, this element may be used in the body of an ODD document. The use of ODD files, and their relationship to schemas, is described in detail in 22 Documentation Elements.

TEI: The Application Information Element¶2.3.10 The Application Information Element

It is sometimes convenient to store information relating to the processing of an encoded resource within its header. Typical uses for such information might be:

• to allow an application to discover that it has previously opened or edited a file, and what version of itself was used to do that;
• to show (through a date) which application last edited the file to allow for diagnosis of any problems that might have been caused by that application;
• to allow users to discover information about an application used to edit the file
• to allow the application to declare an interest in elements of the file which it has edited, so that other applications or human editors may be more wary of making changes to those sections of the file.

The class model.applicationLike provides an element, application, which may be used to record such information within the appInfo element.

• appInfo (información de la aplicación) recoge información sobre la aplicación que ha editado el fichero de TEI.
• application proporciona información sobre la aplicación que ha actuado sobre el documento.

  ident	proporciona un identificador para la aplicación, independientemente de su número de versión o el nombre de la visualización.
  version	Suministra un número de versión para la aplicación, independientemente de su identificador o el nombre de la visualización.

Each application element identifies the current state of one software application with regard to the current file. This element is a member of the att.datable class, which provides a variety of attributes for associating this state with a date and time, or a temporal range. The ident and version attributes should be used to uniquely identify the application and its major version number (for example, ImageMarkupTool 1.5). It is not intended that an application should add a new application each time it touches the file.

TEI: Creation¶2.4.1 Creation

TEI: Language Usage¶2.4.2 Language Usage

The langUsage element is used within the profileDesc element to describe the languages, sublanguages, registers, dialects, etc. represented within a text. It contains one or more language elements, each of which provides information about a single language, notably the quantity of that language present in the text. Note that this element should not be used to supply information about any non-standard characters or glyphs used by this language; such information should be recorded in the charDecl element in the encoding description (see further 5 Non-standard Characters and Glyphs).

• langUsage (lengua empleada) describe las lenguas, jergas, registros, dialectos, etc. presentes en el texto.
• language caracteriza una lengua o jerga empleada en un texto.

  usage	especifica el porcentaje (de volumen) aproximado de texto que usa esa lengua.
  ident	(identificador) proporciona un código de lengua construido según se define en RFC 3066 (o en su sucesor) que se utiliza para identificar la lengua documentada por este elemento, y a la cual se hace referencia mediante el atributo globlal xml:lang.

A language element may be supplied for each different language used in a document. If used, its ident attribute should specify an appropriate language identifier, as further discussed in section vi.1. Language identification. This is particularly important if extended language identifiers have been used as the value of xml:lang attributes elsewhere in the document.

TEI: The Text Classification¶2.4.3 The Text Classification

The textClass element is used to classify a text in some way.

• textClass (clasificación de texto) agrupa información que describe la naturaleza o la temática de un texto en términos de un esquema de clasificación estándard.

Text classification may be carried out according to one or more of the following methods:

• by reference to a recognized international classification such as the Dewey Decimal Classification, the Universal Decimal Classification, the Colon Classification, the Library of Congress Classification, or any other system widely used in library and documentation work
• by providing a set of keywords, as provided for example by British Library or Library of Congress Cataloguing in Publication data
• by referencing any other taxonomy of text categories recognized in the field concerned, or peculiar to the material in hand; this may include one based on recurring sets of values for the situational parameters defined in section 15.2.1 The Text Description, or the demographic elements described in section 15.2.2 The Participant Description

The last of these may be particularly important for dealing with existing corpora or collections, both as a means of avoiding the expense or inconvenience of reclassification and as a means of documenting the organizing principles of such materials.

The following elements are provided for this purpose:

• keywords contiene una lista de palabras clave o sintagmas que identifican la temática o la naturaleza del texto.

  scheme

  identifican el vocabulario con el que se define el conjunto de palabras clave referidas.

• classCode (código de clasificación) indica el código de clasificación empleado para este texto en algún sistema de clasificación estándard.

  scheme

  identifica el sistema de clasificación o taxonomía en uso.

• catRef/ (referencia de categoría) indica una o más categorías definidas al interno de una taxonomía o tipología textual.

The keywords element simply categorizes an individual text by supplying a list of keywords which may describe its topic or subject matter, its form, date, etc. In some schemes, the order of items in the list is significant, for example, from major topic to minor; in others, the list has an organized substructure of its own. No recommendations are made here as to which method is to be preferred. Wherever possible, such keywords should be taken from a recognized source, such as the British Library/Library of Congress Cataloguing in Publication data in the case of printed books, or a published thesaurus appropriate to the field.

If no authority file exists, perhaps because the keywords used were assigned directly by an author, the scheme attribute should be omitted.

Alternatively, if the keyword vocabulary itself is locally defined, the scheme attribute will point to the local definition, which will typically be held in a taxonomy element within the classDecl part of the encoding description (see section 2.3.7 The Classification Declaration).

The catRef element categorizes an individual text by pointing to one or more category elements using the target attribute, which it inherits from the att.pointing class. The category element (which is fully described in section 2.3.7 The Classification Declaration) holds information about a particular classification or category within a given taxonomy. Each such category must have a unique identifier, which may be supplied as the value of the target attribute for catRef elements which are regarded as falling within the category indicated.

In general, it is a matter of style whether to use a single catRef with multiple identifiers in the value of target or multiple catRef elements, each with a single identifier in the value of target. However, note that maintenance of a TEI document with a large number of values within a single target can be cumbersome.

The distinction between the catRef and classCode elements is that the values used as identifying codes are exhaustively enumerated for the former, typically within the TEI header. In the latter case, however, the values use any externally-defined scheme, and therefore may be taken from a more open-ended descriptive classification system.

TEI: Calendar Description¶2.4.4 Calendar Description

The calendarDesc element is used within the profileDesc element to document objects referenced by means of either the calendar attribute on date or the dateScheme attribute on any member of the att.datable class.

• calendarDesc (descripción de las calendarios) contiene una descripción de todos los diferentes calendarios usados en un manuscrito.

This element may contain one or more calendar elements:

• calendar (calendario) describes a calendar or dating system used in a dating formula in the text.