The Project Gutenberg EBook of The Guide to PGTEI by Marcello Perathoner

This eBook is for the use of anyone anywhere at no cost and with almost no restrictions whatsoever. You may copy it, give it away or re-use it under the terms of the Project Gutenberg License included with this eBook or online at http://www.gutenberg.org/license

Title: The Guide to PGTEI

Author: Marcello Perathoner

Release Date: September 3, 2005 [Ebook #20000]

Language: English

***START OF THE PROJECT GUTENBERG EBOOK THE GUIDE TO PGTEI***

The Guide to PGTEI

Version 0.4

by Marcello Perathoner

Edition 4, (September 3, 2005)

Contents

- Disclaimer

- Introduction to Markup

- Elements

- Attributes

- Entities

- Working Strategy

- Validating your text

- Further Reading

- More Links

- Standard Header for PG submission

- PGTEI Extensions to TEI-Lite

- Stylesheets

- Character Maps

- Hyphenation Exceptions

- <pgIf>

- Known Problems and Caveats

- Headers and Unicode in PDF

- PGTEI Implementation Details and Reference

- 3. The Structure of a TEI Text

- 4. Encoding the Body

- 4.1. Text Division Elements

- 4.2. Headings and Closings

- 4.3. Prose, Verse and Drama

- 5. Page and Line Numbers

- 6. Marking Highlighted Phrases

- 6.1. Changes of Typeface, etc.

- 6.2. Quotations and Related Features

- 6.3. Foreign Words or Expressions

- 7. Notes

- 8. Cross References and Links

- 8.1. Simple Cross References

- 8.2. Extended Pointers

- 8.3. Linking Attributes

- 9. Editorial Interventions

- 10. Omissions, Deletions, and Additions

- 11. Names, Dates, Numbers and Abbreviations

- 11.1. Names and Referring Strings

- 11.2. Dates and Times

- 11.3. Numbers

- 11.4. Abbreviations and their Expansion

- 11.5. Addresses

- 12. Lists

- 13. Bibliographic Citations

- 14. Tables

- 15. Figures and Graphics

- 16. Interpretation and Analysis

- 16.1. Orthographic Sentences

- 16.2. General-Purpose Interpretation Elements

- 17. Technical Documentation

- 17.1. Additional Elements for Technical Documents

- 17.2. Generated Divisions

- 17.3. Index Generation

- 18. Character Sets, Diacritics, etc.

- XML entities

- XML special characters

- Characters you may miss

- 19. Front and Back Matter

- 19.1. Front Matter

- 19.1.1. Title Page

- 19.1.2. Prefatory Matter

- 19.2. Back Matter

- 19.2.1. Structural Divisions of Back Matter

- 20. The Electronic Title Page

- 20.1. The File Description

- 20.1.1. The Title Statement

- 20.1.2. The Edition Statement

- 20.1.3. The Extent Statement

- 20.1.4. The Publication Statement

- 20.1.5. Series and Notes Statements

- 20.1.6. The Source Description

- 20.2. The Encoding Description

- 20.2.1. Project and Sampling Descriptions

- 20.2.2. Editorial Declarations

- 20.2.3. Tagging, Reference, and Classification Declarations

- 20.3. The Profile Description

- 20.4. The Revision Description

- How to Install the Gnutenberg Press

- Footnotes

- Credits

- A Word from Project Gutenberg

- The Full Project Gutenberg License

List of Figures

- A Displayed Formula

- SVG Image of red star

- The Gnutenberg Press

List of Tables

- Ways to use XML entities

- XML special characters

- Useful characters not in ISO-8859-1

Disclaimer

This document does not represent any official PG standard. It describes PGTEI, the dialect of TEI used by the Gnutenberg Press, which is part of the online text conversion system which is installed on www.gutenberg.org.

The Gnutenberg Press will convert any TEI conformant text, but texts marked up according to this guide will look better and contain all the necessary headers and footers for posting on PG.

Introduction to Markup

To mark up a text means to identify its components according to a set of rules.

Basically you say: this (point in the text) is the start of a paragraph; this is the end of a paragraph; this is the start of a chapter; this the end, etc.

In TEI-speak a text component is referred to as element. Paragraphs, chapters, highlighted words, quotes, footnotes, etc. are such elements.

Elements

To mark a text region as element you have to insert an opening tag at the start and a closing tag at the end of the text region. In TEI a paragraph is represented by an element of type p. You type an opening tag by enclosing the element type with brackets: <p>. A closing tag has a slash after the first bracket: </p>.

Here's an example of how you would mark up a paragraph:

<p>'Oh, bless you, it doesn't matter in the least.
If the man is caught, it will be _on account_ of
their exertions; if he escapes, it will be _in
spite_ of their exertions. It's heads I win and
tails you lose.'</p>

Don't worry about the line breaks, the text will get reformatted anyway. The formatter knows where a paragraph ends by the </p> tag and does not care about empty lines and such.

Let's do some more markup. In TEI the <emph> element stands for emphasized text:

<p>'Oh, bless you, it doesn't matter in the least.
If the man is caught, it will be <emph>on account</emph> of
their exertions; if he escapes, it will be <emph>in
spite</emph> of their exertions. It's heads I win and
tails you lose.'</p>

In TEI the <q> element stands for quoted text:

<p><q>Oh, bless you, it doesn't matter in the least.
If the man is caught, it will be <emph>on account</emph> of
their exertions; if he escapes, it will be <emph>in
spite</emph> of their exertions. It's heads I win and
tails you lose.</q></p>

Every opening tag needs a corresponding closing tag. Opening and closing tags must always nest like parentheses in a mathematical equation.

This is right:

<q><emph> ... </emph></q>

and this is wrong:

<q><emph> ... </q></emph>

Attributes

Most elements can take attributes. Attributes are used to add specifications to elements in exactly the same way in which adjectives add specifications to nouns.

<p> ... Above all, why should the second man write up the
German word <foreign lang="de">Rache</foreign> before
decamping? ... </p>

In TEI the <foreign> element is used to mark a passage in a foreign language. The lang attribute specifies which language it is.

The attribute name must be followed by an = and the attribute value must be put in quotes. An element can have zero or more attributes but every attribute must have a different name.

<p> ... Above all, why should the second man write up the German
word <foreign lang="de" rend="font-style: italic">Rache</foreign> before
decamping? ... </p>

Entities

In TEI you can specify characters you don't have on your keyboard with entities. Let's see how to insert the em-dash character, that is the long dash you see in printed books. (In PG etexts that character is mostly represented by two dashes -- because ASCII lacks that character.)

<q> ... Among other things I bought these brown boots
&mdash; gave six dollars for them &mdash; and had one
stolen before ever I had them on my feet.</q>

In TEI the entity &mdash; represents an em-dash. Substituting &mdash; for -- makes the text look more professional.

Entities start with an ampersand (&) and end with a semicolon (;). You can find a list of supported TEI entities in Chapter 18.

Working Strategy

You can and should mark up a text incrementally. That is: make more than one pass over the whole text and in each pass mark up a subset of elements.

You may start marking only the most prominent text features like chapters and paragraphs. Later you make a second pass marking all italicized text. If you still want to do more, make another pass replacing all quotation marks with the <q> element.

TODO: a PG working group needs to codify different ‘levels’ of PGTEI markup.

Most probably you will start with a TEI text automatically generated by a some program from the plain vanilla etext. Your task will then be to proof the tags inserted by the program.

Start with generic tags

If you cannot state with confidence the reason why a text passage is highlighted, use the generic <hi> tag. A person more knowledgeable than you can easily make another pass over the text searching for all generic tags and replacing them with more appropriate specific tags, eg. the <emph> or <title> tags.

If you encounter a passage in a foreign language unknown to you just use the bare <foreign>. Another person who knows the language may add the lang attribute.

Insert comments

You can insert comments any place you want. These will stay in the TEI text but not show up in the formatted output. By using the word: FIXME you can mark positions that require further inspection.

A comment starts with <!-- and ends with -->.

<p><q>Oh, bless you, it doesn't matter in the least.
If the man is caught, it will be <emph>on account</emph>
of their exertions; if he escapes, it will be <emph>in
spite</emph> of their exertions. It's heads I win and
tails you lose. Whatever they do, they will have
followers.

<!-- FIXME: provide a footnote with a translation -->

<quote lang="fr">Un sot trouve toujours un plus sot qui
l'admire.</quote></q></p>

Later it will be easy to search for all FIXME in the text and fix them.

Validating your text

One of the advantages of XML is that a program can check the markup for you. To do this you need a validator and the DTD (Document Type Definition).

You can get XML validators from here:

•

xmllint

And here is the PGTEI DTD.

For all of you who don't want to install a validator on your own PC there is an online validation service for PGTEI. It can also convert your text to different output formats.

Further Reading

As primary source of information refer to TEI Lite: An Introduction to Text Encoding for Interchange by Lou Burnard and C. M. Sperberg-McQueen, June 1995, revised May 2002.

A still smaller subset of TEI is described in: Bare Bones TEI A Very Very Small Subset of the TEI Encoding Scheme by C. M. Sperberg-McQueen, Document No. TEI U6, 30 Aug 1994, revised June 1995.

The complete TEI markup language (caveat emptor) is described in: TEI P4: Guidelines for Electronic Text Encoding and Interchange by C. M. Sperberg-McQueen, and L. Burnard editors, 2002.

The homepage of the Text Encoding Initiative Consortium has many other interesting stuff and links.

More Links

Language Codes: Code for the Representation of the Names of Languages. From ISO 639, revised 1989

Standard Header for PG submission

These are examples for the official header and footer in a PGTEI text. The <publicationStmt> section is mandatory.

<?xml version="1.0" encoding="iso-8859-1" ?>

<!DOCTYPE TEI.2 SYSTEM "http://www.gutenberg.org/tei/marcello/0.4/dtd/pgtei.dtd">

<TEI.2 lang="en">
<teiHeader>
<fileDesc>
<titleStmt>
<title>Alice's Adventures in Wonderland</title>
<respStmt><resp>Illustrated by</resp> <name>John Tenniel</name></respStmt>
<author><name reg="Carroll, Lewis">Lewis Carroll</name></author>
<editor role="illustrator"><name reg="Tenniel, John">John Tenniel</name></editor>
</titleStmt>
<editionStmt>
<edition n="30">
Edition 30
</edition>
</editionStmt>
<publicationStmt>
<publisher>Project Gutenberg</publisher>
<date value="1991-01">January, 1991</date>
<idno type="etext-no">11</idno>
<availability>
<p>This eBook is for the use of anyone anywhere at no cost and
with almost no restrictions whatsoever. You may copy it, give it
away or re-use it under the terms of the Project Gutenberg
License online at www.gutenberg.org/license</p>
</availability>
</publicationStmt>
<seriesStmt>
<title level="s">#1 in our series by Lewis Carroll</title>
<idno type="vol">1</idno>
</seriesStmt>
<sourceDesc>
<bibl>
Unknown
</bibl>
</sourceDesc>
</fileDesc>
<encodingDesc>
<classDecl>
<taxonomy id="lc">
<bibl>
<title>Library of Congress Classification</title>
</bibl>
</taxonomy>
</classDecl>
</encodingDesc>
<profileDesc>
<langUsage>
<language id="en"></language>
<language id="fr"></language>
</langUsage>
<textClass>
<classCode scheme="lc">PR</classCode>
<keywords>
<list>
<item>Alice</item>
</list>
</keywords>
</textClass>
</profileDesc>
<revisionDesc>
<change>
<date value="1991-01">January 1991</date>
<respStmt><name>Anonymous</name></respStmt>
<item>Project Gutenberg edition 10</item>
</change>
<change>
<date value="1994-03">March 1994</date>
<respStmt><name>Anonymous</name></respStmt>
<item>Project Gutenberg edition 30</item>
</change>
<change>
<date value="2003-03">March 2003</date>
<respStmt><name>Marcello Perathoner</name></respStmt>
<item>TEI Markup</item>
</change>
</revisionDesc>
</teiHeader>

<text lang="en">
<front>
<div>
<divGen type="pgheader" />
</div>

<div>
<divGen type="encodingDesc" />
</div>

<div rend="page-break-before: right">
<divGen type="titlepage" />
</div>

<div rend="page-break-before: right">
<index index="pdf" />
<head>Contents</head>
<divGen type="toc" />
</div>
</front>

<body rend="page-break-before: right">

Note that the xml encoding declaration must match the encoding your file is saved with. If you save your file in utf-8 enconding the declaration must be as follows:

<?xml version="1.0" encoding="utf-8" ?>

And this is an example for the footer:

</body>

<back rend="page-break-before: right">
<div id="footnotes">
<index index="toc" />
<index index="pdf" />
<head>Footnotes</head>
<divGen type="footnotes"/>
</div>

<div rend="page-break-before: right">
<divGen type="pgfooter" />
</div>

</back>
</text>
</TEI.2>

PGTEI Extensions to TEI-Lite

This section describes features of PGTEI you won't find in TEI-Lite. Most of these features have been added to enable TEI-Lite to be a print mastering format.

Stylesheets

Experimental. Feature may change without notice.

You can include a stylesheet into your TEI document. This stylesheet can change the default rendering of TEI elements and provide shortcuts or classes you can use in your rend attributes.

These are the default classes provided by the default stylesheet built into the converter software:

display

Formats the text as block and displays it. A display has margins on all sides and thus stands out from the usual flow of text.

q.display

quote.display

Formats the quote as display and turns off quote signs.

This is how you include your stylesheet into your TEI text:

</teiHeader>

<pgExtensions>
...
<pgStyleSheet>
emph             { font-weight: bold }
table            { rules: all }
.indent          { margin-left: 2 }
.bold            { font-weight: bold }
.italic          { font-style: italic }
.red-ink         { color: red }
emph.bold        { font-style: italic; color: red }
</pgStyleSheet>
...
</pgExtensions>

<text>

You can have a class selector, which starts with a dot followed by the name of the class, or an element selector, which is the name of the TEI element. You may select arbitrary names for your classes, but names starting with “x-” are reserved. You may also combine an element selector with a class selector.

The syntax here resembles CSS, but the implementation is not so powerful as full CSS selectors. You may have only one selector on the left side of your declaration, although you may have multiple declarations on the right side.

After having defined classes you can use them like this:

<hi rend="italic; red-ink">

instead of:

<hi rend="font-style: italic; color: red">

The results will be exactly the same.

Of course you can also mix classes and declarations like this:

<hi rend="italic; color: blue">

Character Maps

Experimental. Feature may change without notice.

In TXT mode the converter outputs a file with the minimal encoding able to represent all characters in the source document. Thus, if all your characters fall inside the range covered by iso-8859-1, the converter will output a TXT file encoded in iso-8859-1. If some characters are not contained in iso-8859-1, it will output a file encoded in utf-8.

If you want to force the encoder to output a lesser encoding than the one it would choose based on the source character range, you have to map all source characters outside the smaller range onto some character inside the smaller range.

The code in this example will change every occurence of the unicode characters 0x21c and 0x21d to the iso-8859-1 character “3”. If your source file contains no other characters outside the range of iso-8859-1, the converter will then output a file encoded in iso-8859-1.

The note inside the pgCharMap will be added to a <divGen type="encodingDesc"> section if (and only if) this char map was applied in the conversion process.

</teiHeader>

<pgExtensions>
...
<pgCharMap formats="pdf txt">
<note><p>Transcribers note: the character
Yogh has been replaced with the character
"3".</p></note>
<char id="U0x21c">
<charName>Yogh</charName>
<desc>LATIN CAPITAL LETTER YOGH</desc>
<mapping>3</mapping>
</char>
<char id="U0x21d">
<charName>yogh</charName>
<desc>LATIN SMALL LETTER YOGH</desc>
<mapping>3</mapping>
</char>
</pgCharMap>
...
</pgExtensions>

<text>

The following code will include an external charmap contained in the specified resource. The resource must be available to the converter. The resource must be a valid xml file containing one <pgExtensions> root node with one or more <pgCharMap> children.

</teiHeader>

<pgExtensions>
...
<pgCharMap href="http://www.gutenberg.org/tei/marcello/0.4/charmaps/utf2iso.charmap" />
...
</pgExtensions>

<text>

Hyphenation Exceptions

Experimental. Feature may change without notice.

In the PDF format words will be automatically hyphenated. If the algorithm doesn't always hyphenate right, or it doesn't hyphenate a word it should, you can give it some hints.

</teiHeader>

<pgExtensions>
...
<pgHyphenationExceptions>
<item>strych-nine</item>
<item>sov-er-eign</item>
<item>neverhyphenatethisword</item>
</pgHyphenationExceptions>
...
</pgExtensions>

<text>

<pgIf>

Used to insert conditional text.

Attribute has takes the following values:

footnotes

Test if the text requires a footnote section.

Only paginated output formats like PDF can place the footnotes at the foot of the page. Other formats like HTML don't know pages at all, so we have to place the footnotes at the end of the whole text. (PDF too can have endnotes — notes that appear at the end of the book instead of at the foot of the page.)

This example creates a <back> only if there are footnotes. In a text with footnotes it will create a <back> in the HTML output format but not in the PDF output format.

<pgIf has="footnotes">
<then>
<back rend="page-break-before: right">
<divGen type="footnotes" />
</back>
</then>
</pgIf>

Attribute output takes the following values:

html

Test if the output format is HTML.

pdf

Test if the output format is TeX. TeX is presently used for PDF generation.

txt

Test if the output format is NROFF. NROFF is presently used for TXT generation.

If you use this feature your text will need revision to accomodate any change in the TEI processing system. For instance, it is not guaranteed that PDF output will always be generated by TeX nor that TXT will always go through NROFF.

<div rend="display; text-align: right">

<pgIf output="pdf">
<then>
<p>
<formula notation="tex">
\reflectbox{Jabberwocky}\medbreak
\reflectbox{'Twas brillig, and the slithy toves}\break
\reflectbox{\quad Did gyre and gimble in the wabe;}\break
\reflectbox{All mimsy were the borogoves,}\break
\reflectbox{\quad And the mome raths outgrabe.}\par
</formula>
</p>
</then>
<else>
<lg>
<l rend="text-align: right"> ykcowrebbaJ </l>
</lg>
<lg>
<l rend="text-align: right"> sevot yhtils eht dna ,gillirb sawT' </l>
<l rend="text-align: right"> ebaw eht ni elbmig dna eryg diD&emsp; </l>
<l rend="text-align: right"> ,sevogorob eht erew ysmim llA </l>
<l rend="text-align: right"> .ebargtuo shtar emom eht dnA&emsp; </l>
</lg>
</else>
</pgIf>

</div>

Will be rendered as (if you are viewing the PDF file you will see true mirrored text[1]):

ykcowrebbaJ

sevot yhtils eht dna ,gillirb sawT'

ebaw eht ni elbmig dna eryg diD

,sevogorob eht erew ysmim llA

.ebargtuo shtar emom eht dnA

Known Problems and Caveats

Headers and Unicode in PDF

If you have non-iso-8859-1 characters in your <head> tags, the pdf conversion may choke. The pdf bookmark section only accepts characters in the ‘PDF document encoding vector’, which is roughly equivalent to iso-8859-1. If you are using unicode characters, you'll have to use the <index index="pdf"> tag to provide an alternate heading.

The most common offending characters, like em-dash and typografical quotes are substituted by the converter. Backslash and curly braces are not supported by TeX.

In this example the pdf converter would choke on the unicode characters in the heading. Thus you have to provide an alternate heading for the pdf bookmark section.

<div>
<index index="pdf" level1="The Eighth Ishráq" />
<head>The Eighth Is&#x331;h&#x331;ráq</head>

PGTEI Implementation Details and Reference

This section explains the implementation details and limitations of the Gnutenberg Press system and shows more examples. Numbered headers refer to the corresponding section in the TEI Lite Introduction.

3. The Structure of a TEI Text

See the TEI-Lite introduction.

Composite texts are not supported.

<teiCorpus>

Unsupported

<group>

Unsupported.

4. Encoding the Body

See the TEI-Lite introduction.

4.1. Text Division Elements

The rend attribute

On a block element the attribute rend may take one or more of the following values:

List of keywords for the rend attribute

text-align: left

This block is left-adjusted.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

text-align: center

This block is centered.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

text-align: right

This block is right-adjusted.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

text-align: justify

This block is left- and right-justified.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

display: inline

This entity is displayed inline.

display: block

This entity is displayed as a block.

display

This entity is rendered as a block and has wider margins.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

white-space: pre

White space is not collapsed and line breaks in the source are preserved. Use for computer code or ascii-art.

if ($a > $b) {
$b = $a;
}

margin-left: n

This block gets indented by n em-spaces. n may be negative.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

margin-right: n

This block gets right-indented by n em-spaces. n may be negative.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

margin-top: n

This block gets a top margin of em-spaces.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

margin-bottom: n

This block gets a bottom margin of n em-spaces.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem.

page-break-before: always

This element starts a new page.

<div rend="page-break-before: always" id="chapter2">
<head>Chapter 2</head>
<p> ... </p>
</div>

page-break-before: right

This element starts a new right-hand page.

<div rend="page-break-before: right" id="part2">
<head>Part 2</head>
<p> ... </p>
</div>

float: left

(HTML mode only.) The division is floated to the left margin.

float: right

(HTML mode only.) The division is floated to the right margin.

page-float: 'h|t|p|b'

(PDF mode only). Floats the division to the top or bottom of the page or to a special page. Valid value is a string composed of one or more of the option letters:

h

The floated division may stay here if there is enough room left on this page.

t

The division may float to the top of the current page, if there is enough room for both, it and the previous text. If this is not the case, it is added at the top of the next page. The subsequent text continues on the current page.

b

The division may float to the bottom of the current page. The subsequent text continues until the room left on the current page is just enough for the float. If there is already insufficient room, the float will be put at the bottom of the next page.

p

The division may float to a special page containig only floats.

The picture in the next example will appear at this point in the text if there is enough room left on the page, else it will float to the top of the next page.

<figure url="alice-01.png"
rend="page-float: 'ht'; text-align: center">
<figDesc>White Rabbit checking watch.</figDesc>
</figure>

<p>

Attribute rend takes the following values in addition to those listed under “All Block Elements”:

text-indent: n

This paragraph will have its first line indented by n em-spaces. n may be zero. Works only in formats that indent paragraphs, like pdf.

Embedded letters

If you try to mark up an embedded letter (piece of correspondence) you'll be surprised to find that the simple approach doesn't validate. Use this approach instead:

<div>
<head>Chapter 1. The Spread of Evolution</head>
<p>His book on animals and plants ...
<text>
<body>
<head>C. Darwin to T.H.Huxley</head>
<p> ... </p>
</body>
</text>
... </p>
</div>

Chapter 1. The Spread of Evolution

His book on animals and plants ...

C. Darwin to T. H. Huxley

...

...

4.2. Headings and Closings

<head>

Use <head> for the main header and <head type="sub"> for any subtitle. It is up to you to decide which title is main and which are sub.

<div>
<head>Part I</head>
<head type="sub">Being a Reprint from the Reminiscences of
John H. Watson, M.D. late of the Army Medical Department</head>

<div>
<head>Mr. Sherlock Holmes</head>

<p>In the year 1878 I took my degree of Doctor ... </p>

<p>The campaign brought honours and promotion to many, ... </p>

...

</div>

<div>
<head>The Science of Deduction</head>

<p> We met next day as he had arranged, and inspected the rooms
at No. 221b, Baker Street, of which he had spoken at our meeting.
... </p>

...

</div>

...

</div>

4.3. Prose, Verse and Drama

<l>

Attribute part; only the values, I, M and F are supported.

Example:

<lg type="limerick">
<l>There was a young lady of Riga,</l>
<l>Who smiled as she rode on a tiger;</l>
<l rend="margin-left: 2">They came back from the ride</l>
<l rend="margin-left: 2">With the lady inside,</l>
<l>And the smile on the face of the tiger.</l>
</lg>

Will be rendered as:

There was a young lady of Riga,

Who smiled as she rode on a tiger;

They came back from the ride

With the lady inside,

And the smile on the face of the tiger.

<sp>

<sp><speaker>Margarete</speaker>

<l part="I">Versprich mir, Heinrich!</l>
</sp>

<sp><speaker>Faust</speaker>

<l part="F">Was ich kann!</l>
</sp>

<sp><speaker>Margarete</speaker>

<l>Nun sag, wie hast du's mit der Religion?</l>
<l>Du bist ein herzlich guter Mann,</l>
<l>Allein ich glaub, du hältst nicht viel davon.</l>
</sp>

Will be rendered as:

Margarete

Versprich mir, Heinrich!

Faust

Was ich kann!

Margarete

Nun sag, wie hast du's mit der Religion?

Du bist ein herzlich guter Mann,

Allein ich glaub, du hältst nicht viel davon.

5. Page and Line Numbers

See the TEI-Lite introduction.

<lb/>

This tag has a different semantic than in TEI: without an ed attribute it produces a line break in the output at this point. (It should just record a line break in a certain edition.) There ain't a tag in TEI for a forced line break that is not a poetry line, so I collared this one.

<milestone unit="tb"/>

You can generate thought-breaks if you set the unit attribute to tb. The default is to generate a small vertical gap.

These are the supported values for the rend attribute:

stars: n

generates a thought-break consisting of n stars: asterisks.

rule: n%

generates a horizontal rule that is n % the width of the text.

<milestone unit="tb" rend="rule: 50%" />

<milestone unit="tb" rend="stars: 12" />

* * * * * * * * * * * *

6. Marking Highlighted Phrases

See the TEI-Lite introduction.

6.1. Changes of Typeface, etc.

This are the supported values for the rend attribute when applied to inline elements such as <hi>:

font-style: italic

for text in italics

font-style: normal

for text in roman

font-weight: bold

for bold text

font-weight: normal

for normal text

font-weight: x

where x is a value between 100 and 900: 100 200 300 400 500 600 700 800 900. Note that display depends also on the fonts actually available on the user's machine.

text-decoration: underline

for underlined gjpqy text. pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

text-decoration: line-through

for striked out text pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

text-decoration: none

for normal text

font-variant: small-caps

for text in SMALL CAPITALS

text-transform: uppercase

for text in UPPERCASE OR ITALIC UPPERCASE

vertical-align: super

for superscript text

vertical-align: sub

for subscript text

letter-spacing: length

for expanded text. Length is a value like 0.15em. pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius pneumonoultramicroscopicsilicovolcanoconiosis supercalifragilisticexpialidocius The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog.

color: keyword

where keyword is one of the HTML colors:
black
silver
gray
white
maroon
red
purple
fuchsia
green
lime
olive
yellow
navy
blue
teal
aqua

color: #xxxxxx

where #xxxxxx are 3 hexadecimal color values:
#000
#f00
#0f0
#00f
#000000
#ff0000
#00ff00
#0000ff

font-size: keyword

where keyword is one of: xx-small x-small small medium large x-large xx-large

font-size: n%

where n is a percentage value: 50% 75% 100% 150% 200%

font-family: x

where x is a font family name:
Times
Helvetica
Courier
Note that HTML display depends also on the fonts actually available on the user's machine.

<p>I have left everything <foreign lang="la" rend="font-style: italic">in
statu quo</foreign> until I hear from you.</p>

<hi>

The default rendering for <hi> without any rend attribute is font-style: italic.

6.2. Quotations and Related Features

<q>

Attribute rend takes the following values:

pre: none

This quote has no opening mark.

post: none

This quote has no closing mark.

pre: '&lsquo;'

This quote has the specified opening mark.

post: '&rsquo;'

This quote has the specified closing mark.

display

This quote is rendered as a block quote and has no quote mark.

<p> <q rend="post: none">The first thing that put us out was that
advertisement. Spaulding, he came down into the office just this
day eight weeks, with this very paper in his hand, and he
says:</q> </p>

<p> <q><q>I wish to the Lord, Mr.&nbsp;Wilson, that I was a
red-headed man.</q></q> </p>

Will be rendered as:

“The first thing that put us out was that advertisement. Spaulding, he came down into the office just this day eight weeks, with this very paper in his hand, and he says:

“ ‘I wish to the Lord, Mr. Wilson, that I was a red-headed man.’ ”

6.3. Foreign Words or Expressions

omissis

7. Notes[2]

See the TEI-Lite introduction.

<note>

The place attribute supports only the values of foot, end and margin.

The n attribute is not supported.

<note place="foot">

Inserts a footnote marker at the exact point in the text. There should be no space between the commented text and the opening <note>, any space should be moved after the closing </note>.

<p> When I was a boy, there was but one permanent
ambition among my comrades in our village<note place="foot"><p>

Hannibal, Missouri.

</p></note> on the west bank of the Mississippi River.
That was, to be a steamboatman. ... </p>

Will be rendered as:

When I was a boy, there was but one permanent ambition among my comrades in our village[3] on the west bank of the Mississippi River. That was, to be a steamboatman. ...

The handling of footnotes depends on the output format: if the format has facilities for pagination (PDF) the footnote appears at the bottom of the current page. No special markup is required to make this happen.

If the format has no such facilities (HTML and TXT) the footnotes must be collected by inserting a <divGen type="footnotes"> at the book back. In HTML the footnote marker will be linked to the footnote text.

<note place="end">

These notes must be collected with a <divGen type="endnotes" target="id">. This element collects all endnotes inside the element with the target id.

These[4] are just[5] a few dummy[6] notes[7]. See chapter end for result.

Mixing footnotes and endnotes in the same text will severely mix up the foo counters. So doing that is discouraged.

<note place="margin">

This is a margin note. Margin notes work best with short words.

This places a note into the margin of the page. For the TXT format the margin note works the same as the footnote.

Collected Endnotes from Chapter 7

These are the endnotes from Chapter 7.

4.

Dummy Note

5.

Another Dummy Note

6.

More Dummy Notes

7.

Final Dummy Note

8. Cross References and Links

See the TEI-Lite introduction.

Note: links work only in the HTML and PDF formats.

8.1. Simple Cross References

<ptr>, <ref>

Use these for internal links.

Attribute target supports only one destination.

<p>See: <ref target="chapter42">Chapter 42</ref>.</p>
...
<anchor id="chapter42" />
<div>
<head type="sub">Chapter 42</head>
<head>The Answer</head>
<p> Wouldn't you like to know? ... </p>
...
</div>

8.2. Extended Pointers

<xptr>, <xref>

Use these for external links.

Attribute doc is not supported.

New attribute url. Enter the link destination here.

<p>The <xref url="http://www.tei-c.org">homepage of TEI</xref>.</p>

8.3. Linking Attributes

9. Editorial Interventions

See the TEI-Lite introduction.

10. Omissions, Deletions, and Additions

See the TEI-Lite introduction.

11. Names, Dates, Numbers and Abbreviations

See the TEI-Lite introduction.

11.1. Names and Referring Strings

<name type="ship"> and <rs type="ship"> are output in italics.

11.2. Dates and Times

11.3. Numbers

11.4. Abbreviations and their Expansion

11.5. Addresses

12. Lists

See the TEI-Lite introduction.

<list>

type

The type attribute takes following values:

Accepted values for the type attribute.

simple

A list without list markers.

bulleted

A list with bullets as list markers.

ordered

An ordered list with decimal numbers as list markers.

gloss

A gloss list, with user supplied terms as list markers.

rend

Note: the run-on value is not supported.

The rend attribute accepts following properties: (Note: disc, circle and greek letters are unicode characters. They are currently supported only in HTML and unicode TXT.)

Accepted values for the list-style-type property.

none

A list without list markers.

hyphen

A list with hyphens as list markers.

disc

A list with round bullets as list markers.

circle

A list with circles as list markers.

square

A list with square bullets as list markers.

decimal

A list with decimal numbers as list markers.

upper-roman

A list with uppercase roman numerals as list markers.

lower-roman

A list with lowercase roman numerals as list markers.

upper-latin
or   upper-alpha

A list with uppercase latin alphabet letters as list markers.

lower-latin
or   lower-alpha

A list with lowercase latin alphabet letters as list markers.

lower-greek

A list with lowercase greek alphabet letters as list markers.

List examples:

<list type="simple">

First

Second

Third

<list type="bulleted">

•

First

•

Second

•

Third

<list type="ordered">

1.

First

2.

Second

3.

Third

<list type="ordered">

1.

First Paragraph

2.

Second Paragraph

3.

Third Paragraph

<list type="gloss">

First Term

First Gloss

Second Term

Second Gloss

Third Term

Third Gloss

<list type="ordered" rend="list-style-type: upper-roman">

I.

First

II.

Second

III.

Third

<list type="ordered" rend="list-style-type: lower-alpha">

a.

First

b.

Second

c.

Third

<list type="ordered" rend="list-style-type: lower-greek">

α.

First

β.

Second

γ.

Third

On those remote pages it is written that animals are divided into

a

those that belong to the Emperor,

b

embalmed ones,

c

those that are trained,

d

suckling pigs,

e

mermaids,

f

fabulous ones,

g

stray dogs,

h

those that are included in this classification,

i

those that tremble as if they were mad,

j

innumerable ones,

k

those drawn with a very fine camel's-hair brush,

l

others,

m

those that have just broken a flower vase,

n

those that resemble flies from a distance.

1.

a butcher

2.

a baker

3.

a candlestick maker, with

•

rings on his fingers

•

bells on his toes

Unit Three — Vocabulary

acerbus, -a, -um

bitter, harsh

ager, agrī, M.

field

audiō, -īre, -īvī, -ītus

hear, listen (to)

bellum, -ī, N.

war

bonus, -a, -um

good

Report of the conduct and progress of Ernest Pontifex. Upper Vth form — half term ending Midsummer 1851

Classics

Idle listless and unimproving

Mathematics

ditto

Divinity

ditto

Conduct in house

Orderly

General conduct

Not satisfactory, on account of his great unpunctuality and inattention to duties

The simple, straightforward statement of an idea is preferable to the use of a worn-out expression.

TRITE

SIMPLE, STRAIGHTFORWARD

bury the hatchet

stop fighting, make peace

at loose ends

disorganized

on speaking terms

friendly

fair and square

completely honest

at death's door

near death

EVIL

I am cast upon a horrible desolate island, void of all hope of recovery.

I am singled out and separated as it were from all the world to be miserable.

I am divided from mankind — a solitaire; one banished from human society.

GOOD

But I am alive; and not drowned, as all my ship's company were.

But I am singled out, too, from all the ship's crew, to be spared from death...

But I am not starved, and perishing on a barren place, affording no sustenances....

13. Bibliographic Citations

See the TEI-Lite introduction.

14. Tables

See the TEI-Lite introduction.

<table>

Attribute rend takes following values:

rules: all

Use this to give the table rules around every cell.

latexcolumns

PDF output only. Use to give TeX hints about the table columns. The table is implemented using the LaTeX longtable environment.

tblcolumns

TXT output only. Use to give nroff hints about the table columns. The table is implemented using the tbl preprocessor.

<table rend="latexcolumns: '|l|r|p{5cm}|';
tblcolumns: 'l r lw(30m)'">

<row>

Attribute role not supported.

15. Figures and Graphics

See the TEI-Lite introduction.

<figure>

Only PNG and JPEG formats are supported at present.

Attribute entity not supported. Use url instead.

New attribute url: the url of the image file.

Attribute rend width is the width of the figure. In PDF 100% represents the current linewidth.

<figure url="alice-01.png"
rend="page-float: 'htb'; text-align: center; width: 50%">
<figDesc>White Rabbit checking watch.</figDesc>
</figure>

16. Interpretation and Analysis

See the TEI-Lite introduction.

16.1. Orthographic Sentences

16.2. General-Purpose Interpretation Elements

17. Technical Documentation

See the TEI-Lite introduction.

17.1. Additional Elements for Technical Documents

<eg>

Use for examples. This is a block element, with line breaks preserved. In HTML it is also rendered as a shaded box.

<eg>
Example
Example
Example
</eg>

Will be rendered:

Example
Example
Example

<formula>

Attribute notation can take following values:

tex

In PDF output mode this will pipe the contents of the <formula> element directly through to the TeX processor.

In HTML output mode the contents of the <formula> element will be passed to an instance of TeX and converted to an image. The resulting image file is inserted into the HTML file.

In all other output modes it will be ignored.

mathml

In HTML output mode the contents of the <formula> element will be inserted literally into the HTML file.

In all other output modes it will be ignored.

svg

In HTML and PDF output modes the SVG contents of the <formula> element will be converted to an image and inserted into the file.

In all other output modes it will be ignored.

Example:

<p>This is an inlined formula:
<formula notation="tex">$\int_0^\infty f: x\,dx$</formula>.
And this is some more text after the inlined formula.</p>

Will be rendered as:

This is an inlined formula: . And this is some more text after the inlined formula.

Example:

<p rend="text-align: center">
<formula notation="tex"><![CDATA[
\begin{align*}
\left[ \frac{n}{p} \right] +
\left[ \frac{n}{p^2} \right] &+
\left[ \frac{n}{p^3} \right] + \ldots \\
&= \sum_{i=0}^h \frac{a_i(p^{h-i} - 1)}{p - 1} \\
&= \frac{a_0p^h + a_1p^{h-1} + \ldots + a_h -
(a_0 + a_1 + \ldots + a_h)}{p-1} \\
&= \frac{n - (a_0 + a_1 + \ldots + a_h)}{p - 1}.
\end{align*}]]>
</formula>
</p>

Note the use of a CDATA section to avoid having to replace all &s with &amp;. A CDATA section starts with <![CDATA[ and ends with ]]>.

Will be rendered as:

An embedded SVG image.

<p rend="text-align: center">
<formula notation="svg"><![CDATA[
<?xml version="1.0" standalone="no"?>
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN"
"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg width="12cm" height="4cm" viewBox="0 0 1200 400"
xmlns="http://www.w3.org/2000/svg" version="1.1">

<polygon fill="red" stroke="yellow"
stroke-width="10"
points="350,75  379,161 469,161 397,215
423,301 350,250 277,301 303,215
231,161 321,161" />
</svg>
]]>
</formula>
</p>

Will be rendered as:

17.2. Generated Divisions

<divGen>

Although this is called <divGen> actually it generates only the contents of a <div>. You must always surround this tag with a <div> and provide a suitable <head> and optional <index> tags as well.

Attribute type supports following values:

titlepage

Generates a standard title page from the <teiHeader> element.

toc

Generates a table of contents from <index index="toc"> elements.

pgheader

Generates a standard PG header appropriate for the output format.

pgfooter

Generates a standard PG footer appropriate for the output format.

footnotes

Generates a footnotes section. This section is automatically populated with the contents of the <note type="foot"> tags found in the text.

endnotes

Generates an endnotes section. This section is automatically populated with the contents of the <note type="end"> tags found in the text.

encodingDesc

Generates a section containing the notes attached to the used character mappings. Use this to document to the reader which mappings have been applied in generating this output format.

any valid name

Generates a list from all <index index="name"> elements. Use this for List of Figures etc.

Attribute target may be set to the id of a section of the text. Setting target on a <divGen type="endnotes"> element makes the <divGen> collect only endnotes from that section of the text.

<div>
<index index="toc" />
<head>Footnotes</head>
<divGen type="footnotes" />
</div>

To produce a list of figures, use:

<div rend="page-break-before: right">
<head>List of Figures</head>
<divGen type="fig" />
</div>

...

<figure url="images/process.png">
<index index="fig"/>
<head>The Gnutenberg Press</head>
</figure>

17.3. Index Generation

<index>

Attributes level2 through level4 not supported.

Attribute index supports following values:

toc

The table of contents.

pdf

The bookmarks section of a PDF file. Note that no unicode characters (like &mdash;) should be used for a PDF bookmark. iso-8859-1 characters are safe.

any valid name

Use this to generate lists of figures or tables.

Element <index> attribute level1 will default to the contents of the next <head> element.

18. Character Sets, Diacritics, etc.

See the TEI-Lite introduction.

XML entities

You should use a unicode-capable editor to edit your files and save them in utf-8 encoding. If you cannot do that, you'll have to choose a different encoding and enter all characters your encoding cannot handle with XML entities. To do that, you'll have to find out the unicode code point of the character first.

Ways to use XML entities

Example

yields

Decimal

&#162;

¢

Hexadecimal

&#xa2;

¢

Named

&cent;

¢

XML special characters

You must replace these characters if they occur in your original text. This is because TEI recognizes them as special characters, eg. < and > are the start and the end of a markup tag, & is the start of an entity.

XML special characters

replace

with

&

&amp;

<

&lt;

>

&gt;

Characters you may miss

If you use the ISO-8859-1 encoding to save your TEI file, you will not be able to enter these characters directly. You can still get them if you write:

Useful characters not in ISO-8859-1

to get

type

comment

Œ

&OElig;

The OE ligature used in French texts.

œ

&oelig;

The oe ligature used in French texts.

><

&zwj;

Zero-width joiner. Use: shelf&zwj;
ful to get rid of the ff ligature. Sometimes TeX may need a little hint. See shelfful vs. shelfful. Use also to make sure a word does not get broken here.

> <

&nbsp;

A non-breaking space. Use: Mr.&nbsp;
Sherlock Holmes

> <

&ensp;

A space the size of an n.

> <

&emsp;

A space the size of an m. A typografical quad.

> <

&thinsp;

A thin space. May be appropriate between quotes. Note: the program inserts a thin space between quotes automatically if you mark up quotes using the <q>
tag.

–

&ndash;

This is the right dash to use between numbers. Eg: 1914&ndash;
18 The great war of 1914–18.

—

&mdash;

Use instead of --.

——

&qdash;

Use instead of ----. A quote dash or two-em-dash is used to indicate missing letters: Mr. P—— woke up.

‘

&lsquo;

’

&rsquo;

‚

&sbquo;

“

&ldquo;

”

&rdquo;

„

&bdquo;

†

&dagger;

‡

&Dagger;

•

&bull;

bullet

…

&hellip;

Horizontal ellipsis. Use instead of three dots. Note how the ellipsis dots are spaced farther apart than if you enter three dots: ...

‰

&permil;

′

&prime;

Use for coordinates.

″

&Prime;

Use for coordinates.

‹

&lsaquo;

French guillemet

›

&rsaquo;

French guillemet

€

&euro;

™

&trade;

If you are using a UNICODE-capable editor, you can just enter the characters directly.

TeX Backend “Obnoxious” Character Test: $&#%^~_"|<>``—''

This is a TeX backend character test (please close your eyes).

TeX control characters: backslash \ open curly brace { close curly brace } dollar sign $ ampersand & number sign # percent sign % caret ^ tilde ~ underscore _ double quote " vertical bar | less than < greater than > .

TeX characters that need math mode: one sup ¹ two sup ² three sup ³ multiply × divide ÷ plusminus ± logical not ¬ mu µ .

Characters TeX thinks are special (but are not): one hyphen - two hyphens -- three hyphens --- four hyphens ---- caret and o ^o tilde and o ~o underscore and o _o lsquo and lsquo `` rsquo and rsquo '' question mark and lsquo ?` exclamation mark and lsquo !` .

Greek: α β γ δ.

Cyrillic: Пролетарии всех стран, соединяйтесь!

Chinese: 知己知彼, 百戰百勝

Combining diacritical marks: a̱b̰c̽ḍ

Nroff leading dot: dot .

If these all came out right your TeX backend is working. (You may open your eyes again.)

19. Front and Back Matter

See the TEI-Lite introduction.

19.1. Front Matter

19.1.1. Title Page

<epigraph>

“I pity the man who can travel from Dan to Beersheba, and say ‘'Tis all barren;’ and so is all the world to him who will not cultivate the fruits it offers.”
—— Sterne: Sentimental Journey.

An epigraph contains a quotation, anonymous or attributed, appearing at the start of a section or chapter, or on a title page. An epigraph is rendered in smaller type and right adjusted.

<argument>

Monte Video — Maldonado — Excursion to R Polanco — Lazo and Bolas — Partridges — Absence of Trees — Deer — Capybara, or River Hog — Tucutuco — Molothrus, cuckoo-like habits — Tyrant Flycatcher — Mocking-bird — Carrion Hawks — Tubes formed by Lightning — House struck

A formal list or prose description of the topics addressed by a subdivision of a text.

19.1.2. Prefatory Matter

19.2. Back Matter

19.2.1. Structural Divisions of Back Matter

20. The Electronic Title Page

See the TEI-Lite introduction.

Experimental

Partially supported through the <divGen type="colophon"> element.

It is easier to just copy the provided header template and modify the appropriate entries than to build a conformant <teiHeader> from scratch.

20.1. The File Description

20.1.1. The Title Statement

20.1.2. The Edition Statement

20.1.3. The Extent Statement

20.1.4. The Publication Statement

20.1.5. Series and Notes Statements

20.1.6. The Source Description

20.2. The Encoding Description

20.2.1. Project and Sampling Descriptions

20.2.2. Editorial Declarations

20.2.3. Tagging, Reference, and Classification Declarations

20.3. The Profile Description

20.4. The Revision Description

How to Install the Gnutenberg Press

The Gnutenberg Press is the software to convert from TEI to HTML, TeX and TXT. It is a collection of XSLT stylesheets driven by a Perl script.

The Gnutenberg Press

The XSLT stylesheets do the bulk of the work. The Perl script calls XSLT at the right moments and fixes up things that are just too difficult to get right with XSLT, like the correct placement of newlines, which is crucial to TeX and nroff.

The Gnutenberg Press is released under the GNU General Public License: GPL.

You may download the Gnutenberg Press.

To use the Gnutenberg Press you need these tools:

The Gnome XML and XSLT libraries

Get libxml2 and libxslt from the XML C parser and toolkit of Gnome.

Perl

The Pathologically Eclectic Rubbish Lister by Larry Wall in a version >= 5.8.0. Get Perl from the Comprehensive Perl Archive Network. Install the XML::LibXML and XML::LibXSLT modules from CPAN.

TeX

The typesetting system invented by Donald Knuth. Get TeX from the TeX Users Group Home Page.

nroff

Get GNU groff.

If you are running a fairly recent Linux distribution you should already have got most of them. If you are on Windows you'll have to sweat some to get them all, but, if you run Windows, you like to suffer, right?

Footnotes

1.

Technical information: You may wonder why we don't use the convert formula to image feature here to generate the reflected text in HTML. Actually \reflectbox is a command of the pdflatex driver. To convert formulas into images we use the dvips driver because of its higher output quality.

2.

This note ref should not display in the toc.

3.

Hannibal, Missouri.

***END OF THE PROJECT GUTENBERG EBOOK THE GUIDE TO PGTEI***

Credits

October 2002

Started writing it

Marcello Perathoner

A Word from Project Gutenberg

This file should be named 20000-h.html or 20000-h.zip.

This and all associated files of various formats will be found in:

http://www.gutenberg.org/dirs/2/0/0/0/20000/

Updated editions will replace the previous one — the old editions will be renamed.

Creating the works from public domain print editions means that no one owns a United States copyright in these works, so the Foundation (and you!) can copy and distribute it in the United States without permission and without paying copyright royalties. Special rules, set forth in the General Terms of Use part of this license, apply to copying and distributing Project Gutenberg™ electronic works to protect the Project Gutenberg™ concept and trademark. Project Gutenberg is a registered trademark, and may not be used if you charge for the eBooks, unless you receive specific permission. If you do not charge anything for copies of this eBook, complying with the rules is very easy. You may use this eBook for nearly any purpose such as creation of derivative works, reports, performances and research. They may be modified and printed and given away — you may do practically anything with public domain eBooks. Redistribution is subject to the trademark license, especially commercial redistribution.

The Full Project Gutenberg License

Please read this before you distribute or use this work.

To protect the Project Gutenberg™ mission of promoting the free distribution of electronic works, by using or distributing this work (or any other work associated in any way with the phrase “Project Gutenberg”), you agree to comply with all the terms of the Full Project Gutenberg™ License (available with this file or online at http://www.gutenberg.org/license).

Section 1.

General Terms of Use & Redistributing Project Gutenberg™ electronic works

1.A.

By reading or using any part of this Project Gutenberg™ electronic work, you indicate that you have read, understand, agree to and accept all the terms of this license and intellectual property (trademark/copyright) agreement. If you do not agree to abide by all the terms of this agreement, you must cease using and return or destroy all copies of Project Gutenberg™ electronic works in your possession. If you paid a fee for obtaining a copy of or access to a Project Gutenberg™ electronic work and you do not agree to be bound by the terms of this agreement, you may obtain a refund from the person or entity to whom you paid the fee as set forth in paragraph 1.E.8.

1.B.

“Project Gutenberg” is a registered trademark. It may only be used on or associated in any way with an electronic work by people who agree to be bound by the terms of this agreement. There are a few things that you can do with most Project Gutenberg™ electronic works even without complying with the full terms of this agreement. See paragraph 1.C below. There are a lot of things you can do with Project Gutenberg™ electronic works if you follow the terms of this agreement and help preserve free future access to Project Gutenberg™ electronic works. See paragraph 1.E below.

1.C.

The Project Gutenberg Literary Archive Foundation (“the Foundation” or PGLAF), owns a compilation copyright in the collection of Project Gutenberg™ electronic works. Nearly all the individual works in the collection are in the public domain in the United States. If an individual work is in the public domain in the United States and you are located in the United States, we do not claim a right to prevent you from copying, distributing, performing, displaying or creating derivative works based on the work as long as all references to Project Gutenberg are removed. Of course, we hope that you will support the Project Gutenberg™ mission of promoting free access to electronic works by freely sharing Project Gutenberg™ works in compliance with the terms of this agreement for keeping the Project Gutenberg™ name associated with the work. You can easily comply with the terms of this agreement by keeping this work in the same format with its attached full Project Gutenberg™ License when you share it without charge with others.

1.D.

The copyright laws of the place where you are located also govern what you can do with this work. Copyright laws in most countries are in a constant state of change. If you are outside the United States, check the laws of your country in addition to the terms of this agreement before downloading, copying, displaying, performing, distributing or creating derivative works based on this work or any other Project Gutenberg™ work. The Foundation makes no representations concerning the copyright status of any work in any country outside the United States.

1.E.

Unless you have removed all references to Project Gutenberg:

1.E.1.

The following sentence, with active links to, or other immediate access to, the full Project Gutenberg™ License must appear prominently whenever any copy of a Project Gutenberg™ work (any work on which the phrase “Project Gutenberg” appears, or with which the phrase “Project Gutenberg” is associated) is accessed, displayed, performed, viewed, copied or distributed:

This eBook is for the use of anyone anywhere at no cost and with almost no restrictions whatsoever. You may copy it, give it away or re-use it under the terms of the Project Gutenberg License included with this eBook or online at http://www.gutenberg.org

1.E.2.

If an individual Project Gutenberg™ electronic work is derived from the public domain (does not contain a notice indicating that it is posted with permission of the copyright holder), the work can be copied and distributed to anyone in the United States without paying any fees or charges. If you are redistributing or providing access to a work with the phrase “Project Gutenberg” associated with or appearing on the work, you must comply either with the requirements of paragraphs 1.E.1 through 1.E.7 or obtain permission for the use of the work and the Project Gutenberg™ trademark as set forth in paragraphs 1.E.8 or 1.E.9.

1.E.3.

If an individual Project Gutenberg™ electronic work is posted with the permission of the copyright holder, your use and distribution must comply with both paragraphs 1.E.1 through 1.E.7 and any additional terms imposed by the copyright holder. Additional terms will be linked to the Project Gutenberg™ License for all works posted with the permission of the copyright holder found at the beginning of this work.

1.E.4.

Do not unlink or detach or remove the full Project Gutenberg™ License terms from this work, or any files containing a part of this work or any other work associated with Project Gutenberg™.

1.E.5.

Do not copy, display, perform, distribute or redistribute this electronic work, or any part of this electronic work, without prominently displaying the sentence set forth in paragraph 1.E.1 with active links or immediate access to the full terms of the Project Gutenberg™ License.

1.E.6.

You may convert to and distribute this work in any binary, compressed, marked up, nonproprietary or proprietary form, including any word processing or hypertext form. However, if you provide access to or distribute copies of a Project Gutenberg™ work in a format other than “Plain Vanilla ASCII” or other format used in the official version posted on the official Project Gutenberg™ web site (http://www.gutenberg.org), you must, at no additional cost, fee or expense to the user, provide a copy, a means of exporting a copy, or a means of obtaining a copy upon request, of the work in its original “Plain Vanilla ASCII” or other form. Any alternate format must include the full Project Gutenberg™ License as specified in paragraph 1.E.1.

1.E.7.

Do not charge a fee for access to, viewing, displaying, performing, copying or distributing any Project Gutenberg™ works unless you comply with paragraph 1.E.8 or 1.E.9.

1.E.8.

You may charge a reasonable fee for copies of or providing access to or distributing Project Gutenberg™ electronic works provided that

•

You pay a royalty fee of 20% of the gross profits you derive from the use of Project Gutenberg™ works calculated using the method you already use to calculate your applicable taxes. The fee is owed to the owner of the Project Gutenberg™ trademark, but he has agreed to donate royalties under this paragraph to the Project Gutenberg Literary Archive Foundation. Royalty payments must be paid within 60 days following each date on which you prepare (or are legally required to prepare) your periodic tax returns. Royalty payments should be clearly marked as such and sent to the Project Gutenberg Literary Archive Foundation at the address specified in Section 4, “Information about donations to the Project Gutenberg Literary Archive Foundation.”

•

You provide a full refund of any money paid by a user who notifies you in writing (or by e-mail) within 30 days of receipt that s/he does not agree to the terms of the full Project Gutenberg™ License. You must require such a user to return or destroy all copies of the works possessed in a physical medium and discontinue all use of and all access to other copies of Project Gutenberg™ works.

•

You provide, in accordance with paragraph 1.F.3, a full refund of any money paid for a work or a replacement copy, if a defect in the electronic work is discovered and reported to you within 90 days of receipt of the work.

•

You comply with all other terms of this agreement for free distribution of Project Gutenberg™ works.

1.E.9.

If you wish to charge a fee or distribute a Project Gutenberg™ electronic work or group of works on different terms than are set forth in this agreement, you must obtain permission in writing from both the Project Gutenberg Literary Archive Foundation and Michael Hart, the owner of the Project Gutenberg™ trademark. Contact the Foundation as set forth in Section 3 below.

1.F.

1.F.1.

Project Gutenberg volunteers and employees expend considerable effort to identify, do copyright research on, transcribe and proofread public domain works in creating the Project Gutenberg™ collection. Despite these efforts, Project Gutenberg™ electronic works, and the medium on which they may be stored, may contain “Defects,” such as, but not limited to, incomplete, inaccurate or corrupt data, transcription errors, a copyright or other intellectual property infringement, a defective or damaged disk or other medium, a computer virus, or computer codes that damage or cannot be read by your equipment.

1.F.2.

LIMITED WARRANTY, DISCLAIMER OF DAMAGES — Except for the “Right of Replacement or Refund” described in paragraph 1.F.3, the Project Gutenberg Literary Archive Foundation, the owner of the Project Gutenberg™ trademark, and any other party distributing a Project Gutenberg™ electronic work under this agreement, disclaim all liability to you for damages, costs and expenses, including legal fees. YOU AGREE THAT YOU HAVE NO REMEDIES FOR NEGLIGENCE, STRICT LIABILITY, BREACH OF WARRANTY OR BREACH OF CONTRACT EXCEPT THOSE PROVIDED IN PARAGRAPH F3. YOU AGREE THAT THE FOUNDATION, THE TRADEMARK OWNER, AND ANY DISTRIBUTOR UNDER THIS AGREEMENT WILL NOT BE LIABLE TO YOU FOR ACTUAL, DIRECT, INDIRECT, CONSEQUENTIAL, PUNITIVE OR INCIDENTAL DAMAGES EVEN IF YOU GIVE NOTICE OF THE POSSIBILITY OF SUCH DAMAGE.

1.F.3.

LIMITED RIGHT OF REPLACEMENT OR REFUND — If you discover a defect in this electronic work within 90 days of receiving it, you can receive a refund of the money (if any) you paid for it by sending a written explanation to the person you received the work from. If you received the work on a physical medium, you must return the medium with your written explanation. The person or entity that provided you with the defective work may elect to provide a replacement copy in lieu of a refund. If you received the work electronically, the person or entity providing it to you may choose to give you a second opportunity to receive the work electronically in lieu of a refund. If the second copy is also defective, you may demand a refund in writing without further opportunities to fix the problem.

1.F.4.

Except for the limited right of replacement or refund set forth in paragraph 1.F.3, this work is provided to you 'AS-IS,' WITH NO OTHER WARRANTIES OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTIBILITY OR FITNESS FOR ANY PURPOSE.

1.F.5.

Some states do not allow disclaimers of certain implied warranties or the exclusion or limitation of certain types of damages. If any disclaimer or limitation set forth in this agreement violates the law of the state applicable to this agreement, the agreement shall be interpreted to make the maximum disclaimer or limitation permitted by the applicable state law. The invalidity or unenforceability of any provision of this agreement shall not void the remaining provisions.

1.F.6.

INDEMNITY — You agree to indemnify and hold the Foundation, the trademark owner, any agent or employee of the Foundation, anyone providing copies of Project Gutenberg™ electronic works in accordance with this agreement, and any volunteers associated with the production, promotion and distribution of Project Gutenberg™ electronic works, harmless from all liability, costs and expenses, including legal fees, that arise directly or indirectly from any of the following which you do or cause to occur: (a) distribution of this or any Project Gutenberg™ work, (b) alteration, modification, or additions or deletions to any Project Gutenberg™ work, and (c) any Defect you cause.

Section 2.

Information about the Mission of Project Gutenberg™

Project Gutenberg™ is synonymous with the free distribution of electronic works in formats readable by the widest variety of computers including obsolete, old, middle-aged and new computers. It exists because of the efforts of hundreds of volunteers and donations from people in all walks of life.

Volunteers and financial support to provide volunteers with the assistance they need, is critical to reaching Project Gutenberg™'s goals and ensuring that the Project Gutenberg™ collection will remain freely available for generations to come. In 2001, the Project Gutenberg Literary Archive Foundation was created to provide a secure and permanent future for Project Gutenberg™ and future generations. To learn more about the Project Gutenberg Literary Archive Foundation and how your efforts and donations can help, see Sections 3 and 4 and the Foundation web page at http://www.pglaf.org/.

Section 3.

Information about the Project Gutenberg Literary Archive Foundation

The Project Gutenberg Literary Archive Foundation is a non profit 501(c)(3) educational corporation organized under the laws of the state of Mississippi and granted tax exempt status by the Internal Revenue Service. The Foundation's EIN or federal tax identification number is 64-6221541. Its 501(c)(3) letter is posted at http://www.gutenberg.org/fundraising/pglaf. Contributions to the Project Gutenberg Literary Archive Foundation are tax deductible to the full extent permitted by U.S. federal laws and your state's laws.

The Foundation's principal office is located at 4557 Melan Dr. S. Fairbanks, AK, 99712., but its volunteers and employees are scattered throughout numerous locations. Its business office is located at 809 North 1500 West, Salt Lake City, UT 84116, (801) 596-1887, email business@pglaf.org. Email contact links and up to date contact information can be found at the Foundation's web site and official page at http://www.pglaf.org/

For additional contact information:

Dr. Gregory B. Newby
Chief Executive and Director
gbnewby@pglaf.org

Section 4.

Information about Donations to the Project Gutenberg Literary Archive Foundation

Project Gutenberg™ depends upon and cannot survive without wide spread public support and donations to carry out its mission of increasing the number of public domain and licensed works that can be freely distributed in machine readable form accessible by the widest array of equipment including outdated equipment. Many small donations ($1 to $5,000) are particularly important to maintaining tax exempt status with the IRS.

The Foundation is committed to complying with the laws regulating charities and charitable donations in all 50 states of the United States. Compliance requirements are not uniform and it takes a considerable effort, much paperwork and many fees to meet and keep up with these requirements. We do not solicit donations in locations where we have not received written confirmation of compliance. To SEND DONATIONS or determine the status of compliance for any particular state visit http://www.gutenberg.org/fundraising/donate

While we cannot and do not solicit contributions from states where we have not met the solicitation requirements, we know of no prohibition against accepting unsolicited donations from donors in such states who approach us with offers to donate.

International donations are gratefully accepted, but we cannot make any statements concerning tax treatment of donations received from outside the United States. U.S. laws alone swamp our small staff.

Please check the Project Gutenberg Web pages for current donation methods and addresses. Donations are accepted in a number of other ways including checks, online payments and credit card donations. To donate, please visit: http://www.gutenberg.org/fundraising/donate

Section 5.

General Information About Project Gutenberg™ electronic works.

Professor Michael S. Hart is the originator of the Project Gutenberg™ concept of a library of electronic works that could be freely shared with anyone. For thirty years, he produced and distributed Project Gutenberg™ eBooks with only a loose network of volunteer support.

Project Gutenberg™ eBooks are often created from several printed editions, all of which are confirmed as Public Domain in the U.S. unless a copyright notice is included. Thus, we do not necessarily keep eBooks in compliance with any particular paper edition.

Each eBook is in a subdirectory of the same number as the eBook's eBook number, often in several formats including plain vanilla ASCII, compressed (zipped), HTML and others.

Corrected editions of our eBooks replace the old file and take over the old filename and etext number. The replaced older file is renamed. Versions based on separate sources are treated as new eBooks receiving new filenames and etext numbers.

Most people start at our Web site which has the main PG search facility:

http://www.gutenberg.org

This Web site includes information about Project Gutenberg™, including how to make donations to the Project Gutenberg Literary Archive Foundation, how to help produce our new eBooks, and how to subscribe to our email newsletter to hear about new eBooks.

Table of Contents

Section 1.

Section 2.

Section 3.

Section 4.

Section 5.