OpenEdition TEI Guidelines

Release 1.6.2

_images/openedition.png

Note

This documentation follows the versions of the OpenEdition TEI Schema, a new version of the documentation is available in French and English for each release.

Click ReadTheDocs at the bottom of the menu on the left to choose language and version.

The TEI elements handled by OpenEdition and their use are described in the section: Guidelines

The support of the elements according to the context (OpenEdition Journals or Books Import, OpenEdition TEI Export) and the version of the TEI schema is specified in the part: Usage of TEI elements

Compatibility between versions of the TEI schema, editorial models and OTX (for uses out of the OpenEdition platform) is described in the section: Lodel and TEI schema

The page Changelog and roadmap lists the changes of the versions of the TEI schema.

Guidelines

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
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
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.

Example

[...]
<titleStmt>
[...]
   <author>
       <name>Marin Dacos</name>
       <affiliation>
           Directeur du Cléo (Centre pour l'édition électronique ouverte)
       </affiliation>
       <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;
  • do not use for OpenEdition Books (the date is defined at book level);
  • 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, book…).
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 and OEB 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']
Title of the book or issue (Book and Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/title[@level='m']
Translated title of the book or issue (Book and 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']
  • Identifiers (Book)
Electronic ISBN:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='eISBN']
Print ISBN:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='pISBN']
Book URL:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='url' and @subtype='book']
Book DOI:
/TEI/teiHeader/sourceDesc/biblStruct/monogr/idno[@type='doi' and @subtype='book']
  • Information on the print edition
Pagination of the print edition (Book and 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 (Book and Journal):
/TEI/teiHeader/sourceDesc/biblStruct/monogr/imprint/date[@type='published']
Publisher (Book and 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 (book, issue, section, review);

  • When importing articles on OpenEdition Journals or book chapters on OpenEdition Books (import OB), the following elements are supported:

    • Pagination of the print edition (OJ import and OB import);
    • Date of print publication (import OJ). On OpenEdition Books the print publication date is defined at the book level.

  • Print publication date: date in format DD/MM/YYYYY; do not use this date for OpenEdition Books;

  • 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/series

XPath

Title of the serie:
/TEI/teiHeader/sourceDesc/biblStruct/series/title[@level='s']
Translated title of the serie:
/TEI/teiHeader/sourceDesc/biblStruct/series/title[@level='s' and @type='alt']
Electronic ISSN of the serie:
/TEI/teiHeader/sourceDesc/biblStruct/series/idno[@type='eISSN']
Print ISSN of the serie:
/TEI/teiHeader/sourceDesc/biblStruct/series/idno[@type='pISSN']
URL of the serie:
/TEI/teiHeader/sourceDesc/biblStruct/series/idno[@type='url']

Usage

  • In OpenEdition TEI export, for book chapters only, the series element contains the metadata related to the publishing environment of the TEI document (series).
1.1.3.2.4   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>

Journal article (OpenEdition export)

[...]
<sourceDesc>
   <biblStruct type="article">
        <analytic>
            <title level="a" type="main">La formation des étudiants marocains dans les pays de l’Est de l’Europe (1960-2015)</title>
            <title level="a" type="alt" xml:lang="en">Moroccan Students’ Training in Eastern Europe Countries (1960-2015)</title>
            <title level="a" type="alt" xml:lang="es">La formación de los estudiantes marroquíes en los países de Europa del Este (1960-2015)</title>
            <author>
                <persName>
                    <forename>Kamal</forename>
                    <surname>Mellakh</surname>
                </persName>
                <affiliation>
                    Enseignant-chercheur, Département de sociologie, Faculté des lettres et sciences humaines de Mohammedia, Université Hassan II, Casablanca B.P 546, Mohammedia, Maroc ; kmellakh@yahoo.fr
                </affiliation>
            </author>
        </analytic>
        <monogr>
            <title level="j">Revue européenne des migrations internationales</title>
            <idno type="eISSN">1777-5418</idno>
            <idno type="pISSN">0765-0752</idno>
            <title level="m">Former des élites : mobilités des étudiants d'Afrique au nord du Sahara dans les pays de l'ex-bloc socialiste</title>
            <title level="m" type="alt" xml:lang="en">Training Elites: Mobilities of Students of Africa North of Sahara to the Former Socialist Block</title>
            <title level="m" type="alt" xml:lang="es">Formar a las élites: movilidades de los estudiantes de África del norte del Sáhara hacia el ex-bloque socialista</title>
            <idno type="doi" subtype="issue">10.4000/remi.7751</idno>
            <idno type="url" subtype="issue">http://journals.openedition.org/remi/7751</idno>
            <imprint>
                <publisher>Université de Poitiers</publisher>
                <biblScope unit="page">39-56</biblScope>
                <biblScope unit="issue">vol. 32 - n°2</biblScope>
                <date type="published" when="2016-10-24">2016-10-24</date>
            </imprint>
        </monogr>
    </biblStruct>
</sourceDesc>

Book chapter (OpenEdition export)

[...]
<biblStruct type="chapter">
    <analytic>
        <title level="a" type="main">Albert Cossery écrit‑il arabe ?</title>
        <author>
            <persName>
                <forename>Frédéric</forename>
                <surname>Lagrange</surname>
            </persName>
        </author>
    </analytic>
    <monogr>
        <title level="m">Savants, amants, poètes et fous</title>
        <idno type="pISBN">9782351597521</idno>
        <idno type="eISBN">9782351595503</idno>
        <idno type="doi" subtype="book">10.4000/books.ifpo.13332</idno>
        <idno type="url" subtype="book">http://books.openedition.org/ifpo/13332</idno>
        <imprint>
            <publisher>Presses de l’Ifpo</publisher>
            <publisher>Centre français d'archéologie et de sciences sociales (Cefas)</publisher>
            <biblScope unit="page">133-157</biblScope>
            <date type="published" when="2019">2019</date>
        </imprint>
    </monogr>
    <series>
        <title level="s">Contemporain publications</title>
        <idno type="pISSN">2225-7578</idno>
        <idno type="url">http://books.openedition.org/ifpo/62</idno>
    </series>
</biblStruct>

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>
[...]

2   text

2.1   front

front contains any any preliminary matter (abstracts, dedications, etc.) found at the start of a document, before the main body.

2.1.1   Abstracts

XPath

Abstract : /TEI/text/front/div[@type='abstract' and @xml:lang]

Usage

  • the xml:lang attribute is required with a value in ISO 639-1 format;
  • single paragraph, line break allowed (<lb> tag);
  • no references to notes.

Example

[...]
<text>
    <front>
[...]
        <div type="abstract" xml:lang="fr">
            <p>Il était sur le dos, un dos aussi dur qu’une carapace, et, en relevant un peu la tête, il vit, bombé, brun, cloisonné par des arceaux plus rigides, son abdomen sur le haut duquel la couverture, prête à glisser tout à fait, ne tenait plus qu’à peine. Ses nombreuses pattes, lamentablement grêles par comparaison avec la corpulence qu’il avait par ailleurs, grouillaient désespérément sous ses yeux. « Qu’est-ce qui m’est arrivé ? » pensa-t-il.</p>
            <p>Ce n’était pas un rêve. [...]</p>
        </div>
        <div type="abstract" xml:lang="en">
            <p>"Oh, God", he thought, "what a strenuous career it is that I've chosen! Travelling day in and day out. Doing business like this takes much more effort than doing your own business at home, and on top of that there's the curse of travelling, worries about making train connections, bad and irregular food, contact with different people all the time so that you can never get to know anyone or become friendly with them. It can all go to Hell! "He felt a slight itch up on his belly; pushed himself slowly up on his back towards the headboard so that he could lift his head better; found where the itch was, and saw that it was covered with lots of little white spots which he didn't know what to make of; and when he tried to feel the place with one of his legs he drew it quickly back because as soon as he touched it he was overcome by a cold shudder. He slid back into his former position. "Getting up early all the time", he thought, "it makes you stupid. You've got to get enough sleep. Other travelling salesmen live a life of luxury. For instance, whenever I go back to the guest house during the morning to copy out the contract, these gentlemen are always still sitting there eating their breakfasts. I ought to just try that with my boss; I'd get kicked out on the spot. But who knows, maybe that would be the best thing for me. If I didn't have my parents to think about I'd have given in my notice a long time ago, I'd have gone up to the boss and told him just what I think, tell him everything I would, let him know just what I feel. He'd fall right off his desk! And it's a funny sort of business to be sitting up there at your desk, talking down at your subordinates from up there, especially when you have to go right up close because the boss is hard of hearing. Well, there's still some hope; once I've got the money together to pay off my parents' debt to him - another five or six years I suppose - that's definitely what I'll do. That's when I'll make the big change.</p>
        </div>
        <div type="abstract" xml:lang="es">
            <p>Las preocupaciones son mucho mayores cuando se trabaja fuera, por no hablar de las molestias propias de los viajes: estar pendiente de los enlaces de los trenes; la comida mala, irregular; relaciones que cambian constantemente, que nunca llegan a ser verdaderamente cordiales, y en las que no tienen cabida los sentimientos. amsa era viajante de comercio-, y de la pared colgaba una estampa recientemente recortada de una revista ilustrada y puesta en un marco dorado.</p>
        </div>
[...]
2.1.2   Reading notes and reviews

XPath

Title of the reviewed work: /TEI/text/front/div[@type='review']/p[@rend='review-title']
Author of the reviewed work: /TEI/text/front/div[@type='review']/p[@rend='review-author']
Bibliographical notice of the reviewed work: /TEI/text/front/div[@type='review']/p[@rend='review-bibliography']
Publication date of the reviewed work: /TEI/text/front/div[@type='review']/p[@rend='review-date']

Usage for OpenEdition Journals

  • each document must contain a single review or reading note;
  • they should not be entitled “Reading notes”;
  • the document should also be given a title, recommended format: Author of the reviewed work, Title of the reviewed work;
  • possibility to add bibliographical elements (publisher, place and year of publishing…) as a “subtitle”;
  • the metadata of reviews offers the possibility to create specific indexes on the journal website.

Example

[...]
<text>
    <front>
[...]
        <div type="review">
            <p rend="review-title">La métamorphose</p>
            <p rend="review-author">Franz Kafka</p>
            <p rend="review-bibliography">Franz Kafka, <hi rend="italic">La métaporphose</hi> [1938] , trad. de l'allemand par Alexandre Vialatte, 224 pages, 140 x 205 mm. Collection Du monde entier, Gallimard-nouv. ISBN 2070235157.</p>
            <p rend="review-date">1938</p>
        </div>
[...]
2.1.3   Author notes, editors notes, errata, acknowledgements

Warning

For the import of documents on OpenEdition, the Xpath indicated for the author’s and editor’s notes are compatible with versions 1.6.2 and higher of the TEI OpenEdition schema.

XPath

Author notes: /TEI/text/front/note[@type='author']/p
Editor notes: /TEI/text/front/note[@type='publisher']/p
Erratum : /TEI/text/front/div[@type='correction']/p
Dedications: /TEI/text/front/div[@type='dedication']/p
Acknowledgements: /TEI/text/front/div[@type='ack']/p

Usage

  • several paragraphs allowed;
  • line break allowed (<lb> tag).

Example

[...]
<text>
    <front>
[...]
        <div type="ack">
            <p>Je remercie le site Blind Text Generator qui a fourni tout le faux-texte de ce document.</p>
        </div>
        <div type="correction">
            <p>L'erratum permet de signaler les modifications apportées au texte après sa publication.</p>
        </div>
        <note type="publisher">
            <p>
                Le texte de ce document a été généré sur le site <ref target="http://www.blindtextgenerator.com/">http://www.blindtextgenerator.com</ref>.
            </p>
        </note>
        <note type="author">
            <p>
                Les résumés français, anglais et espagnol sont des extraits de <hi rend="italic">La Métamorphose</hi> de Franz Kafka.
            </p>
        </note>
    </front>
[...]
</text>

2.2   body

body contains the whole body of a single unitary text, excluding any front or back matter.

2.2.1   Structure of the text and section titles

Xpath

Sections : //div
Section titles: //head[@subtype='leveln']

Usage

  • the document’s text should be structured by sections (<div> tags).
  • section titles should be indicated as the first element of the section in a <head> tag with an attribute of the <subtype="leveln"> where ‘leveln’ can take all values between ‘level1’ and ‘level6’.

Example

[...]
        <div>
            <head subtype="level1">1. ...</head>
            <div>
                <head subtype="level2">1.1. ...</head>
                <p>...</p>
                <div>
                    <head subtype="level3">1.1.1. ...</head>
                    <p>...</p>
                </div>
                <div>
                    <head subtype="level3">1.1.2. ...</head>
                    <p>...</p>
                </div>
            </div>
            <div>
                <head  subtype="level2">1.2. ...</head>
                <p>...</p>
            </div>
        </div>
        <div>
            <head subtype="level1">2. ...</head>
            <p>...</p>
        </div>
[...]
2.2.2   Footnotes and endnotes

Xpath

Footnotes: //note[@place='foot' and @n]/p
Endnotes: //note[@place='end'and @n]/p

Usage

  • inserted in the text using <note> tags;
  • the attribute ‘place’ indicates the type of note;
  • the attribute ‘n’ indicates the note number;
  • the note content should imperatively be placed in one or several paragraphs.

Example

[...]
Curabitur ullamcorper ultricies nisi<note place="foot" n="4">
    <p>Nulla consequat massa quis enim.</p>
    </note>. Nam eget dui.
    <note place="end" n="i"><p>Etiam rhoncus.</p>
</note>
[...]

HTML result

<p class="paragraphesansretrait">
  Curabitur ullamcorper ultricies nisi
  <a class="footnotecall" id="bodyftn1" href="#ftn1">4</a>
  . Nam eget dui.
  <a class="endnotecall" id="bodyftn2" href="#ftn2">i</a>
</p>
2.2.3   Text layout: hi tags, rend and rendition attributes

XPath

Text layout : //hi[@rend ou @rendition]
Format style : /TEI/teiHeader/encodingDesc/tagsDecl

Usage

  • allowed values for the attribute ‘rend’ of the <hi> tag: italic, bold, sup, sub, uppercase, small-caps, underline;
  • the attribute ‘rendition’ of the <hi> tag should refer to a css format style defined in <tagsDecl> in the header.

Example

<teiHeader>
[...]
      <encodingDesc>
[...]
          <tagsDecl>
              <rendition xml:id="T5" scheme="css">font-style:italic;font-weight:bold</rendition>
              <rendition xml:id="T6" scheme="css">font-style:italic;text-decoration:underline</rendition>
              <rendition xml:id="T7" scheme="css">font-style:italic;text-decoration:underline;font-weight:bold</rendition>
              <rendition xml:id="T10" scheme="css">text-decoration:underline;font-weight:bold</rendition>
          </tagsDecl>
      </encodingDesc>
[...]
</teiHeader>
<body>
    <text>
        <div>
            <p>
                <hi rend="italic">Aenean <hi rend="sup">commodo</hi></hi> ligula eget dolor. Aenean massa.
                <hi rendition="#T5">Cum sociis</hi>
                natoque
                <hi rendition="#T6">penatibus et magnis</hi>
                dis
                <hi rendition="#T7">parturient montes</hi>, nascetur
                <hi rendition="#T10">ridiculus mus</hi>.
            </p>
        </div>
[...]

HTML rendering

Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.

2.2.4   Quotation

Xpath

Quotation: //q[@rend='quotation']
Quotation bis: //q[@rend='quotation2']
Quotation ter: //q[@rend='quotation3']

Usage

  • utiliser de préférence <q rend='quotation'> ;
  • les 2 autres styles peuvent servir à différencier plusieurs niveaux de citation au niveau de l’affichage html.

Example

[...]
<q rend="quotation">
    Citation : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</q>
<q rend="quotation2">
    Citation bis : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</q>
<q rend="quotation3">
    Citation ter : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</q>
[...]

HTML result

<blockquote>
 <p class="citation">Citation : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. </p>
</blockquote>
<blockquote class="citationbis">
 <p class="citationbis">Citation bis : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. </p>
</blockquote>
<blockquote class="citationter">
 <p class="citationter">Citation ter : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.</p>
</blockquote>
2.2.5   Paragraph styles

Xpath

Question : //p[@rend='question']
Answer: //p[@rend='answer']
Paragraph without indentation: //p[@rend='noindent']
Box: //p[@rend='box']
Epigraph: //p[@rend='epigraph']
Break: //p[@rend='break']

Usage

  • les styles questions / réponses permettent de différencier ces éléments dans le rendu html des entretiens ;
  • no indent paragraph are used to follow the idea, it does not include paragraph number.

Example

[...]
<p rend="question">
    Question : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</p>
<p rend="answer">
    Réponse : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</p>
<p rend="noindent">
    Paragraphe sans retrait : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</p>
<p rend="box">
    Encadré : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</p>
<p rend="epigraph">
  <hi rend="italic">En se réveillant un matin après des rêves agités, Gregor Samsa se retrouva, dans son lit, métamorphosé en un monstrueux insecte.</hi>
   <lb />
   Franz Kafka,
    <hi rend="italic">La métamorphose</hi>
  </p>
<p rend="break">* * *</p>
[...]

HTML result

<p class="question">Question : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.</p>
<p class="reponse">Réponse : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.  </p>
<p class="paragraphesansretrait">Paragraphe sans retrait : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. </p>
<p class="encadre">Encadré : Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. </p>
<p class="epigraphe">              <em>En se réveillant un matin après des rêves agités, Gregor Samsa se retrouva, dans son lit, métamorphosé en un monstrueux insecte.</em>               <br />               Franz Kafka,              <em>La métamorphose</em>            </p>
<p class="separateur">* * *</p>
2.2.6   Lists

Xpath

Elements of non-ordered list: //list[@type='unordered']/item
Elements of ordered list: //list[@type='ordered']/item

Usage

  • possibility to nest elements of non-ordered and ordered list;
  • possibilité de définir un type de numérotation avec l’attribut ‘rendition’ sur l’élément <list> ;
  • the attribute ‘rendition’ of <list> tag refers to a style defined in <tagsDecl> tag.

Allowed values of the attribute ‘rendition’ for non-ordered lists:

  • list-style-type:disc
  • list-style-type:square
  • list-style-type:circle

For ordered lists:

  • list-style-type:decimal
  • list-style-type:lower-roman
  • list-style-type:upper-roman
  • list-style-type:lower-alpha
  • list-style-type:upper-alpha

Example

[...]
<list xml:id="list2094761347" type="unordered">
    <item>
        Fusce fermentum.
        <list type="unordered">
            <item>
                Nullam cursus lacinia erat.
            </item>
            <item>
                Praesent blandit laoreet nibh.
            </item>
        </list>
    </item>
    <item>
        Fusce convallis metus id felis luctus adipiscing.
        <list type="ordered">
            <item>
                Pellentesque egestas,
            </item>
            <item>
                neque sit amet convallis pulvinar,
            </item>
            <item>
                justo nulla eleifend augue,
            </item>
            <item>
                ac auctor orci leo non est.
            </item>
        </list>
    </item>
</list>
[...]

HTML result

<ul class="texte">
 <li>Fusce fermentum.
  <ul class="texte">
   <li>Nullam cursus lacinia erat.</li>
   <li>Praesent blandit laoreet nibh. </li>
  </ul>
 </li>
 <li>Fusce convallis metus id felis luctus adipiscing.
   <ol class="texte">
    <li>Pellentesque egestas, </li>
    <li>neque sit amet convallis pulvinar,</li>
    <li>justo nulla eleifend augue, </li>
    <li>ac auctor orci leo non est. </li>
  </ol>
 </li>
</ul>

Example

<teiHeader>
[...]
        <encodingDesc>
[...]
            <tagsDecl>
                <rendition xml:id="list1" scheme="css">list-style-type:upper-roman</rendition>
        <rendition xml:id="list2" scheme="css">list-style-type:lower-roman</rendition>
        <rendition xml:id="list3" scheme="css">list-style-type:lower-alpha</rendition>
        <rendition xml:id="list4" scheme="css">list-style-type:upper-alpha</rendition>
            </tagsDecl>
        </encodingDesc>
[...]
</teiHeader>
<body>
    <text>
        <div>
             <list rendition="#list1" type="ordered">
                 <item>item 1</item>
                 <item>item 2</item>
                 <item>item 3</item>
             </list>
             <list rendition="#list2" type="ordered">
                 <item>item 1</item>
                 <item>item 2</item>
                 <item>item 3</item>
             </list>
             <list rendition="#list3" type="ordered">
                 <item>item 1</item>
                 <item>item 2</item>
                 <item>item 3</item>
             </list>
             <list rendition="#list4" type="ordered">
                 <item>item 1</item>
                 <item>item 2</item>
                 <item>item 3</item>
             </list>
        </div>
[...]

HTML result

<ol style="list-style-type:upper-roman;" class="texte">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ol>
<ol style="list-style-type:lower-roman;" class="texte">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ol>
<ol style="list-style-type:lower-alpha;" class="texte">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ol>
<ol style="list-style-type:upper-alpha;" class="texte">
    <li>item 1</li>
    <li>item 2</li>
    <li>item 3</li>
</ol>
2.2.7   Tables

Xpath

  • Table: //table
  • Row: //row
  • Cell: //cell[@rows and @cols]

Usage

  • the attributes ‘rows’ and ‘cols’ of <cell> tag enable fusion of cells.

Example

[...]
<table>
    <row>
        <cell rows="2">Lots</cell>
        <cell rows="2">Données 1</cell>
        <cell rows="2">Données 2</cell>
        <cell cols="2">Total</cell>
    </row>
    <row>
        <cell>Total 1<hi rendition="#T12">ère</hi> partie</cell>
        <cell>Total 2<hi rendition="#T12">e</hi> partie</cell>
    </row>
    <row>
        <cell rows="2">1<hi rendition="#T12">er</hi> lot</cell>
        <cell>12 %</cell>
        <cell>27 %</cell>
        <cell>91 %</cell>
        <cell>98 %</cell>
    </row>
    <row>
        <cell>26 %</cell>
        <cell>45 %</cell>
        <cell>97 %</cell>
        <cell>s>92 %</cell>
    </row>
    <row>
        <cell rows="2">2<hi rendition="#T12">nd</hi> lot</cell>
        <cell>24 %</cell>
        <cell>85 %</cell>
        <cell>91 %</cell>
        <cell>94 %</cell>
    </row>
    <row>
        <cell>54 %</cell>
        <cell>54 %</cell>
        <cell>92 %</cell>
        <cell>92 %</cell>
    </row>
</table>
[...]

HTML rendering

Lots

Données 1

Données 2

Total

Total 1ère partie

Total 2e partie

1er lot

12 %

27 %

91 %

98 %

26 %

45 %

97 %

92 %

2nd lot

24 %

85 %

91 %

94 %

54 %

54 %

92 %

92 %

2.2.8   Hypertext links

Xpath

Links: //ref[@target]

Usage

  • indicate url in the attribute ‘target’, with protocol (http, https).

Example

[...]
<ref target="http://www.openedition.org/​">
    OpenEdition : portail de ressources électroniques en sciences humaines et sociales
</ref>
[...]

HTML rendering

OpenEdition : portail de ressources électroniques en sciences humaines et sociales

2.2.9   Images

Xpath

Image title: //p[@rend='figure-title']
Image: //p/figure/graphic[@url]
Image caption: //p[@rend='figure-legend']
Image credits: //p[@rend='figure-license']

Usage

  • respect the order of the elements: image title, image, image caption, image credits;
  • create a zip archive containing the TEI file of the article at the root of the archive and the illustrations which can be placed in a directory arborescence;
  • indicate the path for the image in the ‘url’ attribute of <graphic> tag;
  • images must be in png, jpg, svg or gif format.

Example

[...]
<p rend="figure-title">Fonctionnement d'Opentext</p>
<p>
    <figure>
        <graphic url="relative/path/to/image/img-1.jpg" />
    </figure>
</p>
<p rend="figure-legend">Schéma réalisé en septembre 2009</p>
<p rend="figure-license">Surletoit - licence Creative Commons by-nc-sa</p>
[...]
2.2.10   Formula

Xpath

Formula: //p/formula

Usage

  • the <formula> tag can contain math formula. This formula should be included in a CDATA;
  • in some websites, the browser can interpret the LaTeX with MathJax to display the formulas.

Example

<p>
<formula notation="latex"><![CDATA[\[\frac{{\partial v}}{{\partial t}} = \frac{K}{{CD}}\left( {\frac{{{\partial ^2}v}}{{\partial {x^2}}} + \frac{{{\partial ^2}v}}{{\partial {y^2}}} + \frac{{{\partial ^2}v}}{{\partial {z^2}}}} \right)\]]]></formula>
</p>
<p>Un formule mathématique inline <formula notation="latex"><![CDATA[\(\frac{{{\partial ^2}v}}{{\partial {z^2}}} = 0\)]]></formula>.</p>
[...]

HTML result

<p class="latex">
\[\frac{{\partial v}}{{\partial t}} = \frac{K}{{CD}}\left( {\frac{{{\partial ^2}v}}{{\partial {x^2}}} + \frac{{{\partial ^2}v}}{{\partial {y^2}}} + \frac{{{\partial ^2}v}}{{\partial {z^2}}}} \right)\]</formula>
</p>
<p class="texte">Un formule mathématique inline <span class="latex">\(\frac{{{\partial ^2}v}}{{\partial {z^2}}} = 0\)</span>.</p>
[...]
]]>
2.2.11   Code

Xpath

Code : //p/code[@lang]

Usage

  • indicate programming langage in the attribute ‘lang’;
  • the code should be included in a CDATA.

Example

<p rend="noindent">
    <code lang="xml">
<![CDATA[
[...]
<ref target="http://www.openedition.org/​">
    OpenEdition : portail de ressources électroniques en sciences humaines et sociales
</ref>
[...]
]]>
    </code>
</p>

HTML result

<p class="paragraphesansretrait"></p>
<pre><code class="brush: xml;">[...]
&lt;ref target="http://www.openedition.org/​"&gt;
OpenEdition : portail de ressources électroniques en sciences humaines et sociales
&lt;/ref&gt;
[...]</code></pre>
2.2.12   Linguistic examples

Xpath

Examples: //quote[@type][@n]
Lines: //quote[@type][@n]/quote
Segments: //quote[@type][@n]/quote/seg
Bibliographic reference: //quote[@type][@n]/bibl
Gloss : //quote[@type][@n]/gloss

Usage

  • possibility to define a type for the example with the attribute ‘type’, the recommandation is to use type=”example”;
  • possibility to number the example with the attribute ‘n’;
  • possibility to define multiple lines for an example with elements <quote>;
  • possibility to align vertically segments in the lines with elements <seg>;
  • possibility to define bibliographic reference with elements <bibl>;
  • possibility to associate gloss or definition for the example with elements <gloss>;
  • nested examples (definition of sub-examples)

Simple example

[...]
<quote n="01" type="example">
  <quote>
    <seg>vous dites vous êtes allé donner un cours (H4 / I++)</seg>
    <seg>en fait (H3 / I=)</seg>
  </quote>
  <quote>
    <seg>you say you went to give a class</seg>
    <seg>in fact</seg>
  </quote>
   <bibl>My bibliographic reference</bibl>
   <gloss>My definition (cf &lt;gloss&gt; dans la documentation de référence de la TEI)</gloss>
</quote>
[...]

HTML rendering*

01quand vous dites vous êtes allé donner un cours (H4 / I++)en fait (H3 / I=)
when you say you went to give a classin fact
My bibliographic reference
My definition (cf <gloss> dans la documentation de référence de la TEI)

Nested Examples

[...]
<quote n="1" type="example">
  <quote n="a" type="example">
    <quote>
      <seg>quand vous dites vous êtes allé donner un cours (H4 / I++)</seg>
      <seg>en fait (H3 / I=)</seg>
    </quote>
    <quote>
      <seg>when you say you went to give a class</seg>
      <seg>in fact</seg>
    </quote>
    <bibl>bibliographic reference for example 1a</bibl>
    <gloss>definition for example 1a</gloss>
  </quote>
  <quote n="b" type="example">
    <quote>
      <seg>c’est e vous avez voulu (H3 / I=)</seg>
      <seg>savoir comment on pouvait se</seg>
    </quote>
    <quote>
      <seg>it’s er you wanted</seg>
      <seg>to know how one could</seg>
    </quote>
    <bibl>bibliographic reference for example 1b</bibl>
    <gloss>definition for example 1b</gloss>
  </quote>
</quote>
[...]

HTML rendering

1
a quand vous dites vous êtes allé donner un cours (H4 / I++) en fait (H3 / I=)
when you say you went to give a class in fact
bibliographic reference for example 1a
definition for example 1a
b c’est e vous avez voulu (H3 / I=) savoir comment on pouvait se
it’s er you wanted to know how one could
bibliographic reference for example 1b
definition for example 1b

2.3   back

back contains any appendixes, etc. following the main part of a text.

2.3.1   Bibliography

Xpath

Bibliography section: /TEI/text/back/div[@type='bibliography']/listBibl
Bibliographical reference:/TEI/text/back/div[@type='bibliography']//listBibl/bibl
Section titles: /TEI/text/back/div[@type='bibliography']//listBibl/head[@subtype='leveln']

Usage

  • Bibliography section is defined with the tag <div type='bibliography'> and starts with a ``<listBibl>``tag;
  • <listBibl> cannot contain sections <div>;
  • <head> tags can be used to insert section titles, ‘leveln’ attributes can take all values between ‘level1’ and ‘level6’;
  • the <listBibl> tags can be nested according to the structure of title levels in the bibliography;
  • bibliographical references are indicated with the <bibl> tag.

Example

[...]
<back>
  <div type="bibliography">
  <listBibl>
    <bibl>
    Bennett, Francis et Michael Holdsworth.
    <hi rend="italic" xml:lang="en">Embracing the Digital Age. An Opportunity for Booksellers and the Book Trade</hi>
    . Londres : The Booksellers Association of the United Kingdom &amp; Ireland, 2007.
    </bibl>
    <listBibl>
      <head subtype="level1">Partie 1</head>
      <bibl>
      Carrérot, Olivier, éd.
      <hi rend="italic">Qu’est-ce qu’un livre aujourd’hui ? Pages, marges, écrans</hi>
      . Les Cahiers de la Librairie. Paris : La Découverte, 2009.
      </bibl>
    </listBibl>
  </listBibl>
  </div>
[...]
</back>
[...]
2.3.2   Annexes

Xpath

Annexes: /TEI/text/back/div[@type='appendix']

Usage

  • annexes section is defined with the element <div type="appendix">;
  • all elements applicable in the <body> can be used in this section.

Example

<back>
[...]
    <div type="appendix">
        <div type="div1">
            <head subtype="level1">Vivamus laoreet</head>
            <p>
                Nullam tincidunt adipiscing enim.
            </p>
            <div type="div2">
                <head subtype="level2">Lorem ipsum</head>
                <p>
                    Aenean commodo ligula eget dolor.
                </p>
                <p rend="figure-title">Fonctionnement d'Opentext</p>
                <p>
                    <figure>
                        <graphic url="relative/path/to/image/img-1.jpg" />
                    </figure>
                </p>
                <p rend="figure-legend">Schéma réalisé en septembre 2009</p>
                <p rend="figure-license">Surletoit - licence Creative Commons by-nc-sa</p>
                <p>
                    Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi.
                </p>
                <q rend="quotation">
                    Vestibulum purus quam, scelerisque ut, mollis sed, nonummy id, metus.
                </q>
                <p>
                    <hi xml:lang="en">Nunc nonummy metus. </hi>
                    Vestibulum volutpat pretium libero.
                </p>
            </div>
        </div>
    </div>
[...]
</back>

Compatibility

Lodel and TEI schema

Lodel websites must use one of the editorial models compatible with the TEI schema to import documents. The editorial model contains XPath used by the TEI parser of Lodel to fill the database. It is imperative to monitor the compatibility of the versions between the editorial model and the schema.

To import text document (doc, docx, odt) you must use the OTX version compatible with the TEI schema.

Version compatibility

OpenEdition TEI OJ Editorial model OB Editorial model OTX
1.6.2 1.0.2 1.0.2 v1.2.0
1.6.1 1.0.0 1.0.0 v1.1.2
[*]this section is for Lodel users outside OpenEdition platforms.

Usage of TEI elements

The following tables presents the possibilities of using the elements of the OpenEdition schema for:

  • the import of documents on OpenEdition Journals (Import OJ);
  • the import of documents on OpenEdition Books (Import OB);
  • documents exported in TEI OpenEdition format (OE Export).

The documents exported in TEI OpenEdition format are use for the following purposes:

  • Re-publication on another platform;
  • Text and Data Mining;
  • Long-term archiving.

Caption:

  • ✓ : element is allowed
  • - : element is not allowed
  • X.X.X+: element is allowed from the X.X.X version of OpenEdition TEI schema
  • X.X.X-: element is allowed up to the X.X.X version of OpenEdition TEI schema

fileDesc

titleStmt
/TEI/teiHeader/fileDesc/titleStmt/
Element Import OJ Import OB Export OE
1.1.1.1   titles, subtitles, overtitles, translated titles
title[@type=’main’] ✓ ✓ ✓
title[@type=’sub’] ✓ ✓ ✓
title[@type=’sup’] ✓ ✓ ✓
title[@type=’alt’ and @xml:lang] [1] ✓ ✓ ✓
1.1.1.2   Authors, editors, translators
author ✓ ✓ ✓
editor[@role=’translator’] ✓ ✓ ✓
editor[not(@role)] ✓ ✓ ✓
editor[@role=’excavationsdirector’] EM archeo [2] - ✓
editor[@role=’collaborator’] EM archeo [2] some EM [3] ✓
author and editor
/TEI/teiHeader/fileDesc/titleStmt/author/
/TEI/teiHeader/fileDesc/titleStmt/editor/
Element Import OJ Import OB Export OE
persName/forename ✓ ✓ ✓
persName/surname ✓ ✓ ✓
affiliation ✓ ✓ ✓
orgName ✓ ✓ ✓
roleName[@type=’function’] ✓ ✓ ✓
roleName[@type=’honorific’] ✓ ✓ ✓
email ✓ ✓ ✓
ref[@type=’website’] ✓ ✓ ✓
publicationStmt
/TEI/teiHeader/fileDesc/publicationStmt/
Element Import OJ Import OB Export OE
1.1.2.1   Date of electronic publication
date ✓ - ✓
1.1.2.2   Publisher, Distributor
publisher - - ✓
distributor - - 1.6.1+
1.1.2.3   Identifier
idno[@type=’documentnumber’] ✓ - ✓
idno[@type=’url’] - - ✓
idno[@type=’doi’] - - 1.6.1+
1.1.2.4   License
availability ✓ - ✓
sourceDesc/biblStruct
analytic
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/analytic/
Element Import OJ Import OB Export OE
1.1.3.2.1   biblStruct/analytic
title[@type=’main’] - - 1.6.1+
title[@type=’sup’] - - 1.6.1+
title[@type=’sub’] - - 1.6.1+
title[@type=’alt’] - - 1.6.1+
author - - 1.6.1+
editor[@role=’translator’] - - 1.6.1+
editor[not(@role)] - - 1.6.1+
editor[@role=’excavationsdirector’] - - 1.6.1+
editor[@role=’collaborator’] - - 1.6.1+
monogr
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/monogr/
Element Import OJ Import OB Export OE
1.1.3.2.2   biblStruct/monogr
title[@level] - - 1.6.1+
title[@leveland @type] - - 1.6.1+
idno[@type] - - 1.6.1+
idno[@type and @subtype] - - 1.6.1+
imprint/biblScope[@unit=’issue’] - - 1.6.1+
imprint/publisher - - 1.6.1+
imprint/biblScope[@unit=’page’] 1.6.2+ 1.6.2+ 1.6.1+
imprint/date[@type=’published’] 1.6.2+ - 1.6.1+
series
/TEI/teiHeader/fileDesc/sourceDesc/biblStruct/series/
Element Import OJ Import OB Export OE
1.1.3.2.3   biblStruct/series
title[@level] - - 1.6.1+
title[@leveland @type] - - 1.6.1+
idno[@type] - - 1.6.1+

encodingDesc

tagsDecl
/TEI/teiHeader/encodingDesc/tagsDecl/
Element Import OJ Import OB Export OE
2.2.3   Text layout: hi tags, rend and rendition attributes
rendition[@xml:id and @scheme=”css”] ✓ ✓ ✓

profileDesc

/TEI/teiHeader/profileDesc/

langUsage/language

Element Import OJ Import OB Export OE
1.3.2   Language
langUsage/language ✓ ✓ ✓
textClass/keywords
/TEI/teiHeader/profileDesc/textClass/keywords/
Element Import OJ Import OB Export OE
1.3.1   Index: keywords, geography, chronology, themes, etc.
[@scheme=’keyword’ and xml:lang] [1] ✓ ✓ ✓
[@scheme=’geographical’] ✓ ✓ ✓
[@scheme=’chronological’] ✓ ✓ ✓
[@scheme=’subject’] ✓ ✓ ✓
[@scheme=’personcited’] some EM [3] some EM [3] -

text

front
/TEI/text/front/
Element Import OJ Import OB Export OE
2.1.1   Abstracts
div[@type=’abstract’ and @xml:lang] [1] ✓ ✓ ✓
2.1.2   Reading notes and reviews
div[@type=’review’]/p[@rend=’review-title’] ✓ - ✓
div[@type=’review’]/p[@rend=’review-author’] ✓ - ✓
div[@type=’review’]/p[@rend=’review-bibliography’] ✓ - ✓
div[@type=’review’]/p[@rend=’review-date’] ✓ - ✓
2.1.3   Author notes, editors notes, errata, acknowledgements
div[@type=’correction’]/p ✓ ✓ ✓
div[@type=’dedication’]/p ✓ ✓ ✓
div[@type=’ack’]/tei:p ✓ ✓ ✓
note[@type=’author’]/p 1.6.2+ 1.6.2+ 1.6.1+
note[@type=’publisher’]/p 1.6.2+ 1.6.2+ 1.6.1+
body
/TEI/text/body/
Element Import OJ Import OB Export OE
2.2.1   Structure of the text and section titles
div ✓ ✓ ✓
head[@subtype=’leveln’] ✓ ✓ ✓
2.2.2   Footnotes and endnotes
note[@place=’foot’ and @n]/p ✓ ✓ ✓
note[@place=’end’ and @n]/p ✓ ✓ ✓
2.2.3   Text layout: hi tags, rend and rendition attributes
hi[@rend] [4] ✓ ✓ ✓
2.2.4   Quotation
q[@rend=’quotation’] ✓ ✓ ✓
q[@rend=’quotation2’] ✓ ✓ ✓
q[@rend=’quotation3’] ✓ ✓ ✓
2.2.5   Paragraph styles
p[@rend=’answer’] ✓ ✓ ✓
p[@rend=’noindent’] ✓ ✓ ✓
p[@rend=’box’] ✓ ✓ ✓
p[@rend=’epigraph’] ✓ ✓ ✓
p[@rend=’break’] ✓ ✓ ✓
2.2.6   Lists
list[@type=’unordered’]/item ✓ ✓ ✓
list[@type=’ordered’]/item ✓ ✓ ✓
2.2.7   Tables
table ✓ ✓ ✓
row ✓ ✓ ✓
cell[@rows and @cols] ✓ ✓ ✓
2.2.8   Hypertext links
ref[@target] ✓ ✓ ✓
2.2.9   Images
p/figure/graphic[@url] ✓ ✓ ✓
p[@rend=’figure-title’] ✓ ✓ ✓
p[@rend=’figure-legend’] ✓ ✓ ✓
p[@rend=’figure-license’] ✓ ✓ ✓
2.2.10   Formula
formula[@notation=’latex’] [5] ✓ ✓ ✓
2.2.11   Code
code[@lang] ✓ ✓ ✓
2.2.12   Linguistic examples
quote[@type and @n]/quote ✓ ✓ ✓
quote[@type and @n]/seg ✓ ✓ ✓
quote[@type and @n]/bibl ✓ ✓ ✓
quote[@type and @n]/gloss ✓ ✓ -
back
/TEI/text/back/
Element Import OJ Import OB Export OE
2.3.1   Bibliography
div[@type=’bibliography’]/listBibl ✓ ✓ ✓
div[@type=’bibliography’]/listBibl/bibl ✓ ✓ ✓
div[@type=’bibliography’]/listBibl/head[@subtype=’leveln’] ✓ ✓ ✓
2.3.2   Annexes
div[@type=’appendix’] ✓ ✓ ✓
[1](1, 2, 3) the attribute xml:lang must be given in ISO 639-1 format.
[2](1, 2) Some archaeological journals have an “archeo” editorial model that provides additional elements to the generic editorial model.
[3](1, 2, 3) Some journals or publishers use an editorial model that contains additional elements in addition to the generic editorial model.
[4]allowed values for the attribute ‘rend’ of the element <hi>: italic, bold, sup, sub, uppercase, small-caps, underline.
[5]Some sites use MathJax to display LaTeX formulas in the browser.

Validation with XML Schema

All versions of OpenEdition TEI XML Schema are available

You can validate your TEI file in your XML editor using the following attributes in the root element (/TEI) of the TEI file :

<?xml version="1.0" encoding="UTF-8"?>
<TEI
     xmlns="http://www.tei-c.org/ns/1.0"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://www.tei-c.org/ns/1.0 http://lodel.org/ns/tei/tei.openedition.1.6.2/document.xsd">

You can also validate your XML files on Linux with xmllint:

xmllint --schema http://lodel.org/ns/tei/tei.openedition.1.6.2/document.xsd XML-FILE.tei.xml --noout

Sample TEI files

Planning

Versions applicable on OpenEdition platforms:

For importing documents on OpenEdition Books and Journals

  • from 2020/02/11: OpenEdition TEI 1.6.2
  • until 2020/02/10: OpenEdition TEI 1.5.2

For OpenEdition TEI export

  • from 2020/02/11: OpenEdition TEI 1.6.2
  • until 2020/02/10: OpenEdition TEI 1.6.1

Changelog and roadmap

Version 1.6.2

[2019-12-17]

  • removed element
    • sourceDesc/biblFull
  • xsd
    • add xsd/tei.openedition.1.6.2

Version 1.6.1

[2019-07-22]

  • new attribute support
    • head@rend
    • head@rendition
  • tag nesting
    • allow <q>, <table> in <note>
    • allow <ref> in
    • allow <list>, <p>, <q> in <cell>
    • allow <list> in <div>
  • xsd
    • add xsd/tei.openedition.1.6.1
  • other
    • update <body> behaviour and avoid the xsd/tei.openedition.1.6.0/document.xsd validity error: ‘cos-nonambig’ (using ROMA 5.0.0 with TEI 3.5.0). See commit 6ade00f

Version 1.6.0

[2019-05-28]

  • odd
    • schemaSpec/source use now https
    • remove release number from odd now useless with roma 5.0.0
    • rename odd/tei.openedition.odd -> odd/tei.openedition.odd.xml
    • rm 1st char <U+FEFF> in odd
    • add schemaLocation to tei.openedition.odd.xml
  • new elements support:
    • distributor: allow distributor in teiHeader
    • biblStruct (usefull in teiHeader/fileDesc/sourceDesc for TEI export after publication)
      • analytic
      • monogr
      • imprint
      • series
    • schemaRef: ref to odd source in xsd schema
  • new attribute support:
    • biblScope@unit
    • date@type: used in publicationStmt (published date)
  • tag nesting
    • allow <figure> in <hi>
    • allow <figure> in <cell>
    • allow <q> in <item>
    • allow <listBibl> in <body>
  • xsd
    • add xsd/tei.openedition.1.6.0

Updates before Version 1.5.2

  • 11/10/2017 : correction on math formula examples
  • 06/01/2017: 2 contributors : collaborator and excavationsdirector, person cited, math formula
  • 03/01/2017: specifications for //tei:p[@rend='break']
  • 14/12/2016: fix <hi rend="small-caps">
  • 12/12/2016: list style type
  • 10/23/2015: specifications for <persName> added.
  • 04/28/2015: specifications for linguistic examples added.
  • 04/27/2015: correction for epigraphs: unlike what was written in this documentation before this day, epigraphs must be included in the <body> element, not in the <front> element.

OpenEdition

OpenEdition is a comprehensive digital publishing infrastructure at the service of scientific information in the Humanities and social Sciences. The OpenEdition portal includes four publishing and information platforms in the humanities and social sciences: OpenEdition Journals , OpenEdition Books, Hypotheses (research blogs) and Calenda (announcements of international academic events). The portal is thus a space dedicated to the promotion of research, publishing tens of thousands of scientific documents that promote open access, while respecting the economic equilibrium of publications.

https://www.openedition.org

License

Creative Commons Attribution 4.0 International License

OpenEdition TEI Guidelines is licensed under a Creative Commons Attribution 4.0 International License.