1 teiHeader

1.1 fileDesc

The “fileDesc” element contains the descriptive metadata of the TEI document arranged in the following elements:

  • titleStmt : titles and contributors

  • publicationStmt: information about electronic publishing

  • sourceDesc: information about the source of the document. They will take on a different meaning depending on the use of the TEI document

1.1.1 titleStmt

1.1.1.1 titles, subtitles, overtitles, translated titles

XPath

Title: /TEI/teiHeader/fileDesc/titleStmt/title[@type='main']
Subtitle: /TEI/teiHeader/fileDesc/titleStmt/title[@type='sub']
Overtitle: /TEI/teiHeader/fileDesc/titleStmt/title[@type='sup']
Translated titles: /TEI/teiHeader/fileDesc/titleStmt/title[@type='alt' and @xml:lang]

Usage

  • no line break (<lb />), only one element title per type ;

  • lower case except initial, not ending with a dot;

  • for translated titles the attribute xml:lang is mandatory with a value in ISO 639-1 format.

Example

[...]
<teiHeader>
    <fileDesc>
      <titleStmt>
        <title type="sup">Dolor sit amet</title>
        <title type="main">Lorem ipsum pour Opentext</title>
        <title type="sub">Basé sur le modèle éditorial pour Lodel de OpenEdition</title>
        <title type="alt" xml:lang="en">Other travelling salesmen live a life of luxury</title>
        <title type="alt" xml:lang="es">Las preocupaciones son mucho mayores</title>
[...]

1.1.1.2 Authors, editors, translators

XPath

Author: /TEI/teiHeader/fileDesc/titleStmt/author/
Translator: /TEI/teiHeader/fileDesc/titleStmt/editor[@role='translator']
Scientific editor: /TEI/teiHeader/fileDesc/titleStmt/editor[not(@role)]
Excavations director: /TEI/teiHeader/fileDesc/titleStmt/editor[@role='excavationsdirector']
Collaborator: /TEI/teiHeader/fileDesc/titleStmt/editor[@role='collaborator']

  • Contributors’ names

First name: /TEI/teiHeader/fileDesc/titleStmt/author/persName/forename
Last name: /TEI/teiHeader/fileDesc/titleStmt/author/persName/surname

  • Names of Translators, Scientific Editor, Excavation Director, Collaborator

First name: /TEI/teiHeader/fileDesc/titleStmt/editor/persName/forename
Last name: /TEI/teiHeader/fileDesc/titleStmt/editor/persName/surname

  • Authors’ description

Description
Affiliation: /TEI/teiHeader/fileDesc/titleStmt/author/orgName
IdRef : /TEI/teiHeader/fileDesc/titleStmt/author/idno[@type="IDREF"]
Function: /TEI/teiHeader/fileDesc/titleStmt/author/roleName[@type='function']
Prefix: /TEI/teiHeader/fileDesc/titleStmt/author/roleName[@type='honorific']
Email: /TEI/teiHeader/fileDesc/titleStmt/author/email
Website: /TEI/teiHeader/fileDesc/titleStmt/author/ref[@type='website']

  • Description of the Translator, Scientific Editor, Excavation Director, Collaborator

Description: /TEI/teiHeader/fileDesc/titleStmt/editor/affiliation
Affiliation: /TEI/teiHeader/fileDesc/titleStmt/editor/orgName
IdRef : /TEI/teiHeader/fileDesc/titleStmt/author/idno[@type="IDREF"]
Function: /TEI/teiHeader/fileDesc/titleStmt/editor/roleName[@type='function']
Prefix: /TEI/teiHeader/fileDesc/titleStmt/editor/roleName[@type='honorific']
Email: /TEI/teiHeader/fileDesc/titleStmt/editor/email
Website: /TEI/teiHeader/fileDesc/titleStmt/editor/ref[@type='website']

Usage

  • it is possible to add several authors, translators, etc. for the document;

  • possibility to add descriptions for each contributor, the general description is indicated in the tag <affiliation> ;

  • pay attention to the case and spelling to avoid duplicates in indexes;

  • IdRef: Use the https://www.idref.fr/ repository to retrieve a valid identifier corresponding to the author. Indicate only the identifier (8 digits + 1 digit or X). IdRef can be correctly retrieved using Métopes tools.

Example

[...]
<titleStmt>
[...]
   <author>
       <name>Marin Dacos</name>
       <affiliation>
           Directeur du Cléo (Centre pour l'édition électronique ouverte)
       </affiliation>
       <idno type="IDREF">139753753</idno>
       <roleName type="function">
           Directeur
       </roleName>
       <orgName>
           Cléo
       </orgName>
       <email>
           contact@openedition.org
       </email>
       <ref target="http://www.openedition.org" type="website">http://www.openedition.org</ref>
       <roleName type="honorific">
           M.
       </roleName>
   </author>
   <editor role="translator">
       <persName>
           <forename>Jean-François</forename>
           <surname>Rivière</surname>
       </persName>
       <affiliation>Chargé d'édition au Cléo</affiliation>
   </editor>
   <editor>
       <persName>
           <forename>Nahuel</forename>
           <surname>Angelinetti</surname>
       </persName>
       <affiliation>Développeur au Cléo</affiliation>
   </editor>
[...]

1.1.2 publicationStmt

1.1.2.1 Date of electronic publication

XPath

Date of electronic publication: /TEI/teiHeader/fileDesc/publicationStmt/date

Usage

  • date in format DD/MM/YYYYY;

  • for OpenEdition Journals it is important to provide an electronic publication date: if not, it will be automatically filled in by Lodel and updated if the document is reloaded.

Electronic publication date for journals with embargo period on OpenEdition Journals

  • must match the date of the embargo end, calculated by adding the embargo duration to the print publication date;

  • used by Lodel to manage document availability: display metadata and summary during the embargo period then provide access to full text;

1.1.2.2 Publisher, Distributor

XPath

publisher: /TEI/teiHeader/fileDesc/publicationStmt/publisher
distributor: /TEI/teiHeader/fileDesc/publicationStmt/distributor

Usage

  • Only used in the platform’s output TEI.

Example

<publicationStmt>
    [...]
    <publisher>Université de Poitiers</publisher>
    <distributor>OpenEdition</distributor>
    [...]
</publicationStmt>

1.1.2.3 Identifier

XPath

Document number : /TEI/teiHeader/fileDesc/publicationStmt/idno[@type='documentnumber']
URL : /TEI/teiHeader/fileDesc/publicationStmt/idno[@type='url']
DOI : /TEI/teiHeader/fileDesc/publicationStmt/idno[@type='doi']

Usage

  • Document number: editorial information displayed in the electronic reference of the document, used to simplify the citation of electronic documents;

  • URL and DOI: only used in the platform’s output TEI.

Example

<publicationStmt>
    [...]
    <idno type="documentnumber">24</idno>
    <idno type="url">http://journals.openedition.org/remi/7777</idno>
    <idno type="doi">10.4000/remi.7777</idno>
    [...]
</publicationStmt>

1.1.2.4 License

XPath

License : /TEI/teiHeader/fileDesc/publicationStmt/availability

Usage

  • Used to fill in the license that applies to the document, add an entry to the site’s license index.

Example

<publicationStmt>
    [...]
    <availability>La revue In Situ. Au regard des sciences sociales
                  est mise à disposition selon les termes de la Licence Creative Commons
                  Attribution - Pas d'Utilisation Commerciale - Pas de Modification 4.0 International.
    </availability>
    [...]
</publicationStmt>

1.1.3 sourceDesc

Note

The sourceDesc element contains information about the source document that was used to produce this TEI document. It will have a different meaning depending on the use of the TEI document:

  • when importing a document unto Lodel, sourceDesc will contain metadata related to the printed edition if applicable;

  • in the export “sourceDesc” will contain the metadata of the publication context on OpenEdition (on the journal, issue…).

1.1.3.1 biblFull

Warning

The “biblFull” element is deprecated from version 1.6.2 of the TEI OpenEdition XML schema

1.1.3.2 biblStruct

Warning

The “biblStruct” element is supported:

  • OEJ import: from the 1.6.2 version of the OpenEdition XML TEI schema;

  • OE export: from the 1.6.0 version of the OpenEdition XML TEI schema.

1.1.3.2.1 biblStruct/analytic

XPath

Title: /TEI/teiHeader/sourceDesc/biblStruct/analytic/title[@type='main']
Subtitle: /TEI/teiHeader/sourceDesc/biblStruct/analytic/title[@type='sub']
Overtitle: /TEI/teiHeader/sourceDesc/biblStruct/analytic/title[@type='sup']
Translated titles: /TEI/teiHeader/sourceDesc/biblStruct/analytic/title[@type='alt' and @xml:lang]
Author: /TEI/teiHeader/sourceDesc/biblStruct/analytic/author/
Translator: /TEI/teiHeader/sourceDesc/biblStruct/analytic/editor[@role='translator']
Scientific editor: /TEI/teiHeader/sourceDesc/biblStruct/analytic/editor[not(@role)]
Excavation director: /TEI/teiHeader/sourceDesc/biblStruct/analytic/editor[@role='excavationsdirector']
Collaborator: /TEI/teiHeader/sourceDesc/biblStruct/analytic/editor[@role='collaborator']

Usage

  • Only used in the OpenEdition’s output TEI, the analytic element contains the titles and contributors of the TEI document.

1.1.3.2.2 biblStruct/monogr

XPath

  • Titles

Journal Title (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='j']
Title of the section for articles published out of issue (journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='s']
Translated titles of the section for articles published out of issue (journal):
TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='s' and @type='alt']
Issue title (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='m']
Translated title of the issue issue (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='m' and @type='alt']

  • Identifiers (Journal)

Electronic ISSN:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='eISSN']
Print ISSN:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='pISSN']
Issue URL:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='url' and @subtype='issue']
Issue DOI:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='doi' and @subtype='issue']
Section URL
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='url' and @subtype='serie']
Section DOI:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='doi' and @subtype='serie']

  • Information on the print edition

Pagination of the print edition (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/imprint/biblScope[@unit='page']
Issue (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/imprint/biblScope[@unit='issue']
Date of print publication (Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/imprint/date[@type='published']
Publisher (Journal)
/TEI/teiHeader/sourceDesc/biblStruct/monogr/imprint/publisher

Usage

  • In OpenEdition TEI export, the “monogr” element contains the metadata related to the publication environment of the TEI document (issue, section, review);

  • When importing articles on OpenEdition Journals (import OJ), the following elements are supported:

    • Pagination of the print edition (OJ import);

    • Date of print publication (Journal):

  • Print publication date: date in format DD/MM/YYYYY;

  • Pagination: filled in Roman numbers (V-XXV) or Arabic numbers (5-25), without the mentions p. or pp.;

  • Bibliographical reference: used to specify the bibliographical reference of the document’s printed edition.

1.1.3.2.3 biblStruct Examples

Journal article (import OEJ)

[...]
<sourceDesc>
   <biblStruct>
       <monogr>
           <imprint>
                <biblScope unit="page">39-56</biblScope>
                <date type="published" when="2016-10-24">2016-10-24</date>
            </imprint>
        </monogr>
    </biblStruct>
</sourceDesc>

1.2 encodingDesc

Contains formatting declarations in the tagsDecl element. See 2.2.3   Text layout: hi tags, rend and rendition attributes

1.3 profileDesc

1.3.1 Index: keywords, geography, chronology, themes, etc.

XPath

Index : /TEI/teiHeader/profileDesc/textClass/keywords[@scheme and @xml:lang]/list/item
Person index, use of <persName>: /TEI/teiHeader/profileDesc/textClass/keywords[@scheme]/list/item/persName/forename and /TEI/teiHeader/profileDesc/textClass/keywords[@scheme]/list/item/persName/surname

Usage

  • allowed values for the ‘scheme’ attribute:

  • <keywords scheme="keywords" lang="fr"> : keyword index (mandatory ‘xml:lang’ attribute with a value in ISO 639-1 format);

  • <keywords scheme="geographical">: Geographical index;

  • <keywords scheme="chronological">: Chronological index;

  • <keywords scheme="subject">: Thematic index;

  • <keywords scheme="personcited">: Cited persons index.

  • pay attention to the case and spelling to avoid duplicates in indexes.

Example

<profileDesc>
[...]
    <textClass>
        <keywords scheme="keyword" xml:lang="fr">
            <list>
                <item>aenean</item>
                <item>commodo</item>
                <item>ligula</item>
                <item>eget</item>
                <item>dolor</item>
            </list>
        </keywords>
        <keywords scheme="chronological">
            <list>
                <item>XXIe siecle</item>
            </list>
        </keywords>
        <keywords scheme="geographical">
            <list>
                <item>France</item>
                <item>Ile de France</item>
                <item>Paris</item>
            </list>
        </keywords>
        <keywords scheme="personcited">
          <list>
              <item>
                  <persName>
                      <forename>Olivier</forename>
                      <surname>Dumond</surname>
                  </persName>
              </item>
          </list>
        </keywords>
[...]

1.3.2 Language

XPath

Language: /TEI/teiHeader/profileDesc/langUsage/language

Usage

  • Language: value in ISO 639-1 format;

Example

<profileDesc>
    <langUsage>
        <language>fr</language>
    </langUsage>
[...]