Navigation – Plan du site

Accueil > Documentation > Pour les utilisateurs > Lodel 1.0 > Creating a TEI document in Lodel 1.0

Sommaire – Document précédent –

Creating a TEI document in Lodel 1.0

Jean-François Rivière et Nahuel Angelinetti

Résumés

These instructions look at XML markup for documents due to be imported into Lodel 1.0. The Xpaths suggested here feature in OpenEdition’s editorial model.

Ce document présente les spécifications pour le balisage XML de documents en vue de leur importation dans Lodel 1.0. Les Xpath proposés ici sont définis dans le modèle éditorial de OpenEdition. Voyez en français : Composer un document en TEI pour Lodel 1.0.

Errata

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

Revision 04/28/2015: specifications for linguistic examples added.

These instructions look at XML markup for documents intended for import into Lodel 1.0. The Xpaths suggested here feature in OpenEdition’s editorial model. An example TEI document is provided in the annex: Lorem-ipsum-Lodel1.0.xml. You will also find this documentation in its TEI version here: XML_styling_for_lodel.xml

The TEI Openedition TEI schema is available at this address: http://www.lodel.org/​ns/​. Its technical documentation is available at this address: http://www.lodel.org/​715

teiHeader

Title, subtitle, suptitle, translated titles

Make sure that each title:

  • Is a single paragraph, without line break (<lb />) ;

  • Is in lower case, except the first letter;

  • Does not finish with a fullstop.

Xpath:

  • Title
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:title[@type='main']

  • Subtitle
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:title[@type='sub']

  • Suptitle
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:title[@type='sup']

  • Translated titles
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:title[@type='alt' and @xml:lang]
    Pout les titres traduits, l'attribut "xml:lang" est obligatoire avec un valeur au format ISO 639-1.

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

Authors, translators, academic editor and their description

You can, of course, associate several authors, translators and editors to the document.

Make sure both first names and surnames are displayed in this order and in small case, apart from the first letter. This order is important as Lodel detects the first name as the first word and the surname as the second when the document is imported. In the case of a composite surname, non-breaking spaces (http://en.wikipedia.org/​wiki/​Non-breaking_space) should be used between the different parts of the composite surname to help Lodel correctly distinguish first names and surnames. Non-breaking spaces are not necessary for composite first names.

You must always use the same form for author names. Pay special attention to the case and spelling of first names. E.g. If two documents from the same author are imported into Lodel, and the author is spelled John-Arthur Smith in the first and John Arthur Smith, without the hyphen, in the second, Lodel will consider them as two different authors and will create separate entries in the author index.

Xpath:

  • Author
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:name

  • Translator
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor[@role='translator']/tei:name

  • Editor
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor[not(@role)]/tei:name

For each contributor, you can also provide a description using the <affiliation> tag. You can also use other tags to indicate a contributor’s affiliation, position, email address, title and web site.

Xpath:

  • Author descriptions
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:affiliation/tei:s | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:affiliation/tei:s

  • Affiliation
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:orgName/tei:s | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:orgName/tei:s

  • Position
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:roleName/tei:s | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:roleName/tei:s

  • Title
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:roleName[@type='honorific']/tei:s | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:roleName[@type='honorific']/tei:s

  • Email
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:email/tei:s | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:email/tei:s

  • Web
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:author/tei:ref | /tei:TEI/tei:teiHeader/tei:fileDesc/tei:titleStmt/tei:editor/tei:ref

Example:

[...]
<titleStmt>
[...]
	<author>
		<name>Marin Dacos</name>
		<affiliation>
			Director of the Centre for Open Electronic Publishing (Cléo)
		</affiliation>
		<roleName>
			<s>Director</s>
		</roleName>
		<orgName>
			<s>Cléo</s>
		</orgName>
		<email>
			<s>contact@openedition.org</s>
		</email>
		<ref target="http://www.openedition.org" type="website">http://www.openedition.org</​ref>
		<roleName type="honorific">
			<s>M.</s>
		</roleName>
	</author>
	<editor role="translator">
		<name>Jean-François Rivière</name>
		<affiliation>Cléo publishing manager</affiliation>
	</editor>
	<editor>
		<name>Nahuel Angelinetti</name>
		<affiliation>Cléo developer</affiliation>
	</editor>
</titleStmt>
[...]

Index: Keywords; geography; chronology; themes

As for author names, spelling and the case used in index entries should always be the same in order to avoid any duplicates in the index.

Xpath:

  • Keywords
    /tei:TEI/tei:teiHeader/tei:profileDesc/tei:textClass/tei:keywords[@scheme='keyword' and xml:lang]/tei:list/tei:item
    For keywords, the "xml:lang" attribute is obligatory with a value in ISO 639-1 format.

  • Geographical index
    /tei:TEI/tei:teiHeader/tei:profileDesc/tei:textClass/tei:keywords[@scheme='geographical']/tei:list/tei:item

  • Chronological index
    /tei:TEI/tei:teiHeader/tei:profileDesc/tei:textClass/tei:keywords[@scheme='chronological']/tei:list/tei:item

  • Thematic index
    /tei:TEI/tei:teiHeader/tei:profileDesc/tei:textClass/tei:keywords[@scheme='subject']/tei:list/tei:item

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>21<hi rend="sup">st</hi> century</item>
			</list>
		</keywords>
		<keywords scheme="geographical">
			<list>
				<item>United Kingdom</item>
				<item>Greater Manchester</item>
				<item>Oldham</item>
			</list>
		</keywords>
[...]

Print and electronic publication dates

The publication dates of print and electronic issues of a document should be distinguished.

If the electronic publication date is not indicated in the document, it will be automatically set by Lodel during import at the date of import. If the document is reloaded into Lodel, if the date of electronic publication is not indicated in the document, it will be automatically set when the document is reloaded. In order to retain a stable electronic publication date, in the event the document is reloaded, the publication date should be indicated in the document imported into Lodel.

Xpath :

  • Electronic publication date
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:publicationStmt/tei:date
    with the date in the DD/MM/YYYY format

  • Print publication date
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:sourceDesc/tei:biblFull/tei:publicationStmt/tei:date
    with the date in the DD/MM/YYYY format

Example: 

<fileDesc>
[...]
	<publicationStmt>
		<date>01/07/2010</date> <!--date of electronic publication-->
[...]
	</publicationStmt>
	<sourceDesc>
		<biblFull>
			<publicationStmt>
				<date>01/07/2008</date> <!--date of print publication-->
			</publicationStmt>
[...]
		</biblFull>
	</sourceDesc>
[...]

Electronic publication dates and embargo periods

For Revues.org journals published with an “embargo period”, Lodel uses the electronic publication date to manage display of the article in summary or full-text form. For articles with an electronic publishing date later than the article’s consultation date, only metadata will be displayed (title, author, summary, abstract, etc), while articles with an electronic publication date prior to the article’s consultation date will be displayed in full text. For a two year “embargo period”, the electronic publishing date should be set two years after the print publication date. The article will thus become available in full-text two years after publication of the print version.

Other metadata

Xpath:

  • Language
    /tei:TEI/tei:teiHeader/tei:profileDesc/tei:langUsage/tei:language
    with a value in ISO 639-1 format

  • Pagination
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:sourceDesc/tei:biblFull/tei:publicationStmt/tei:idno[@type='pp']
    The print pagination of a document can be set in various ways: in Roman numbers or and small capitals (V-XXV), or Arabic numbes (5-25). All values are valid. Pagination is indicated without using entering p. or pp., as these are generally added automatically.

  • Document number
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:publicationStmt/tei:idno[@type='documentnumber']
    This is editorial information that can be displayed in the layout and in the document’s electronic reference. The document number can be used, for example, to facilitate the citation of electronic documents.

  • Licence
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:publicationStmt/tei:availability

  • Bibliographical notice for the document
    /tei:TEI/tei:teiHeader/tei:fileDesc/tei:sourceDesc/tei:biblFull/tei:notesStmt/tei:note[@type='bibl']
    Here you can note the bibliographical reference of the document’s print edition

Example:

<fileDesc>
[...]
	<publicationStmt>
		<date>01/07/2010</date>
		<availability>
			Creative Commons Attribution-NoDerivs 3.0 Unported License
		</availability>
		<idno type="documentnumber">25</idno>
	</publicationStmt>
	<sourceDesc>
		<biblFull>
			<publicationStmt>
				<date>01/07/2008</date>
				<idno type="pp">10-27</idno>
			</publicationStmt>
			<notesStmt>
				<note type="bibl">Bibliographical reference of the article’s print edition.</note>
			</notesStmt>
		</biblFull>
	</sourceDesc>
</fileDesc>
[...]
<profileDesc>
	<langUsage>
		<language>fr</language>
	</langUsage>
[...]

Text

Front

Summaries

Xpath:

  • Summaries
    /tei:TEI/tei:text/tei:front/tei:div[@type='abstract' and @xml:lang]
    As for translated titles, the "xml:lang" attribute is obligatory with a value in ISO 639-1 format.

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

Reading notes and reviews

Reading notes and reviews should be styled separately, in separate files. They should not be entitled “Reading notes”.

If the entry does not have its own distinct title, the “Title” style is applied to author and title of the reviewed work. It is also possible to style bibliographical elements (publisher, place and year of publishing…) as a “subtitle”; this means the bibliographical notice also features in the summary.

The title, author name, bibliographical notice and date of publication of reviewed works can also be styled as descriptive elements of the document.

This information allows for better referencing and offers the possibility to create specific indexes (an index of authors of reviewed works for example). This information may be displayed in the layout.

The document should also be given a title, even if the title is the same as content featuring in the “reviewed work” styles.

Xpath:

  • Title of the reviewed work
    /tei:TEI/tei:text/tei:front/tei:div[@type='review']/tei:p[@rend='review-title']

  • Author of the reviewed work
    /tei:TEI/tei:text/tei:front/tei:div[@type='review']/tei:p[@rend='review-author']

  • Bibliographical notice of the reviewed work
    /tei:TEI/tei:text/tei:front/tei:div[@type='review']/tei:p[@rend='review-bibliography']

  • Publication date of the reviewed work
    /tei:TEI/tei:text/tei:front/tei:div[@type='review']/tei:p[@rend='review-date']

Example:

[...]
<text>
	<front>
[...]
		<div type="review">
			<p rend="review-title">Metamorphosis</p>
			<p rend="review-author">Franz Kafka</p>
			<p rend="review-bibliography"Franz Kafka, <hi rend="italic">The Metamorphosis</hi> [2007], translated by David Wyllie, 60 pages, Echo Library. ISBN 1406819255.</p>
			<p rend="review-date">2009</p>
		</div>
[...]

Author notes, editors notes, errata, acknowledgements

Xpath:

  • Author notes
    /tei:TEI/tei:text/tei:front/tei:note[@resp='author']/tei:p

  • Editor notes
    /tei:TEI/tei:text/tei:front/tei:note[@resp='editor']/tei:p

  • Erratum
    /tei:TEI/tei:text/tei:front/tei:div[@type='correction']/tei:p

  • Dedications
    /tei:TEI/tei:text/tei:front/tei:div[@type='dedication']/tei:p

  • Acknowledgements
    /tei:TEI/tei:text/tei:front/tei:div[@type='ack']/tei:p

Example:

[...]
<text>
	<front>
[...]
		<div type="ack">
			<p>I wish to thank the Blind Text Generator website, which provided all the dummy text for this document.</p>
		</div>
		<div type="correction">
			<p>The errata signal all text modifications made after publication.</p>
		</div>
		<note resp="editor">
			<p>
				The dummy text of this document was generated using<ref target="http://www.blindtextgenerator.com/">http://www.blindtextgenerator.com
			</p>
		</note>
		<note resp="author">
			<p>
				The French, English and Spanish summaries are extracts from <hi rend="italic">The Metamorphosis</hi> by Franz Kafka.
			</p>
		</note>
	</front>
[...]

Body

Structure of the text and section titles

The document text should be structured by sections (tags <div>).

Section titles should be indicated as the first element of the section in a <head> tag with an attribute of the subtype="level1" form

Example:

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

Footnotes and endnotes

Footnotes and endnotes should be inserted in the text using <note> tags with a place attribute to indicate the type of note and an n attribute to indicate the note number. The note content should imperatively be placed in one or several paragraphs.

Xpath:

  • Footnotes
    //tei:note[@place='foot' and @n]/tei:p

  • Endnotes
    //tei:note[@place='end'and @n]/tei:p

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

Result:

Curabitur ullamcorper ultricies nisi4. Nam eget dui.i

Text layout: <hi> tags, rend and rendition attributes

To apply text layouts, you can use the <hi> tag with a rend attribute with the following value: italic, bold, sup, sub, uppercase, smallcaps, underline.

You can also use the <hi> tag with a rendition attribute referring to a defined css format style in the header (/tei:TEI/tei:teiHeader/tei:encodingDesc/tei:tagsDecl)

Example:

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

Result:

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

Quotations and paragraph styles (questions, answers, paragraphs without indents, boxes, epigraph)

The following internal styles feature in the editorial model

Xpath :

  • Quotation
    //tei:q[@rend='quotation']

  • Quotation 2
    //tei:q[@rend='quotation2']

  • Quotation 3
    //tei:q[@rend='quotation3']

  • Question
    //tei:p[@rend='question']

  • Answer
    //tei:p[@rend='answer']

  • Paragraphs without indent
    //tei:p[@rend='noindent']

  • Box
    //tei:p[@rend='box']

  • Epigraph
    //tei:p[@rend='epigraph']

Example:

[...]
<q rend="quotation">
	Quotation: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. 
</q>
<q rend="quotation2">
	Quotation 2: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. 
</q>
<q rend="quotation3">
	Quotation 3: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.
</q>
<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">
	Answer: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.  
</p>
<p rend="noindent">
	Paragraph with no indent: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. 
</p>
<p rend="box">
	Box: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel. 
</p>
<p rend="epigraph">
  <hi rend="italic"> One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin.</hi>
  <lb />
  Franz Kafka,
  <hi rend="italic">The Metamorphosis</hi>
</p>
[...]

Result:

Quotation: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Quotation 2: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Quotation 3: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Question: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Answer: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Paragraph with no indent: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

Box: Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus condimentum accumsan quam, non hendrerit lacus posuere vel.

One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin.
Franz Kafka, The Metamorphosis

Lists

Ordered or non-ordered lists are possible and can be interlinked.

Xpath:

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

  • Elements of ordered list
    //tei:list[@type='ordered']/tei:item

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

Result:

  • Fusce fermentum.
    • Nullam cursus lacinia erat.
    • Praesent blandit laoreet nibh.
  • Fusce convallis metus id felis luctus adipiscing.
    1. Pellentesque egestas,
    2. neque sit amet convallis pulvinar,
    3. justo nulla eleifend augue,
    4. ac auctor orci leo non est.

Tables

Tables should be formatted using <table>, <row> and <cell> tags. The attributes rows and cols enable fusion of cells.

Xpath:

  • //tei:table

  • //tei:row

  • //tei:cell[@rows and @cols]

Example:

[...]
<table>
	<row>
		<cell rows="2">
			<s>Batches</s>
		</cell>
		<cell rows="2">
			<s>Data 1</s>
		</cell>
		<cell rows="2">
			<s>Data 2</s>
		</cell>
		<cell cols="2">
			<s>Total</s>
		</cell>
	</row>
	<row>
		<cell>
			<s>
				Total 1<hi rendition="#T12">st</hi> part
			</s>
		</cell>
		<cell>
			<s>
				Total 2<hi rendition="#T12">nd</hi> part
			</s>
		</cell>
	</row>
	<!-- <pb/> -->
	<row>
		<cell rows="2">
			<s>
				 1<hi rendition="#T12">st</hi> batch
			</s>
		</cell>
		<cell>
			<s>12 %</s>
		</cell>
		<cell>
			<s>27 %</s>
		</cell>
		<cell>
			<s>91 %</s>
		</cell>
		<cell>
			<s>98 %</s>
		</cell>
	</row>
	<row>
		<cell>
			<s>26 %</s>
		</cell>
		<cell>
			<s>45 %</s>
		</cell>
		<cell>
			<s>97 %</s>
		</cell>
		<cell>
			<s>92 %</s>
		</cell>
	</row>
	<row>
		<cell rows="2">
			<s>
				2<hi rendition="#T12">nd</hi> batch
			</s>
		</cell>
		<cell>
			<s>24 %</s>
		</cell>
		<cell>
			<s>85 %</s>
		</cell>
		<cell>
			<s>91 %</s>
		</cell>
		<cell>
			<s>94 %</s>
		</cell>
	</row>
	<row>
		<cell>
			<s>54 %</s>
		</cell>
		<cell>
			<s>54 %</s>
		</cell>
		<cell>
			<s>92 %</s>
		</cell>
		<cell>
			<s>92 %</s>
		</cell>
	</row>
</table>
[...]

Result :

Batches

Data 1

Data 2

Total

Total 1st part

Total 2nd part

1st batch

12 %

27 %

91 %

98 %

26 %

45 %

97 %

92 %

2nd batch

24 %

85 %

91 %

94 %

54 %

54 %

92 %

92 %

Hypertext links

Xpath :

  • //tei:ref[@target]

Example:

[...]
<ref target="http://www.openedition.org/​">
	OpenEdition: the electronic resource platform for the humanities and social sciences
</ref>
[...]

Résultat :

OpenEdition: the electronic resource platform for the humanities and social sciences

Images

To insert images in a document, you should create a zip archive containing the TEI file of the article at the root of the archive and the illustrations (in png, jpg or gif format) which can be placed in a directory arborescence in the zip archive.

To insert an illustration in the document, use the <graphic> tag and indicate the path for the image in theurl attribute.

Titles, captions and credits for the image should be styled in the paragraphs with a rend="figure-title",rend="figure-legend" or rend="figure-license" attribute.

If you are using the thumbnail filter developed by OpenEdition, you must respect the following paragraph order:

  • Title of image

  • Image

  • Image caption

  • Image credits

None of the descriptive elements (title, caption, credits) are obligatory.

Example:

[...]
<p rend="figure-title">Opentext functioning</p>
<p>
	<figure>
		<graphic url="relative/path/to/image/img-1.jpg" />
	</figure>
</p>
<p rend="figure-legend">Diagram produced in September 2009</p>
<p rend="figure-license">Surletoit - licence Creative Commons by-nc-sa</p>
[...]

Code

The <code> tag can contain programming language instructions. This code should be included in a CDATA.

Xpath :

  • //tei:p/tei:code

Example:

 <p rend="noindent"> <code lang="xml">
								<![CDATA[ [...] <ref
								target="http://www.openedition.org/​"> OpenEdition: the electronic
								resource platform for the humanities and social sciences
								</ref> [...] ]]> </code> </p>

Result:

[...]
<ref target="http://www.openedition.org/​">
OpenEdition: the electronic resource platform for the humanities and social sciences
</ref>
[...]

Linguistic examples

Specifications have been defined for linguistic examples with the following caracteristics:

  • definition of a type for the example
  • definition of a number for the example
  • multiple lines for an example
  • vertical align of segments in the lines of the example
  • bibliographic reference for the example
  • gloss or definition for the example
  • nested examples (definition of sub-examples)

Xpath:

  • Example with type ('type' attribute) et number ('n' attribute). The value of the type attribute is not restricted but the recommandation is to use type='example'.
    //tei:quote[@type][@n]

  • Lines are defined in <quote> elements
    //tei:quote[@type][@n]/tei:quote

  • Segments og each lines are defined in <seg> elements
    //tei:quote[@type][@n]/tei:quote/tei:seg

  • Bibliographic reference for the example is defined in a <bibl> element
    //tei:quote[@type][@n]/tei:bibl

  • Gloss or definition for the example is defined in a <gloss> element
    //tei:quote[@type][@n]/tei:gloss

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

Result:

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

Result:

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

Back

Bibliography

Bibliographies are created using the <listBibl> and <bibl> tags. The bibliography cannot contain sections <div>, but <listBibl> and <head> tags can be used to insert section titles (see the XPath). The <listBibl> tags can be nested according to the structuring of title levels in the bibliography.

Xpath:

  • Bibliography section
    /tei:TEI/tei:text/tei:back/tei:div[@type='bibliography']/tei:listBibl

  • Bibliographical reference
    /tei:TEI/tei:text/tei:back/tei:div[@type='bibliography']//tei:listBibl/tei:bibl

  • Section titles
    /tei:TEI/tei:text/tei:back/tei:div[@type='bibliography']//tei:listBibl/tei:head[@subtype='leveln']
    where 'leveln' has values between 'level1' and 'level6'.

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

Annexes

Annexes should be placed in an “appendix” type section. The section can contain all elements applicable in the <body>: quotations, illustrations, etc.

Xpath :

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

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>
Haut de page

Documents annexes

Haut de page

Notes

4 Nulla consequat massa quis enim.

Haut de page

Note de fin

i Etiam rhoncus.

Haut de page

Droits d'auteur

© tous droits réservés

Haut de page
OpenEdition