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
Character set encoding: utf-8
***START OF THE PROJECT GUTENBERG EBOOK THE GUIDE TO PGTEI***
Transcribers note: In this format the character “Latin small letter i with
macron” has been replaced with plain “i” and the character “Latin small
letter o with macron” has been replaced with plain “o”.
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
**
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: *
*. A closing tag has a
slash after the first bracket: *
*.
Here’s an example of how you would mark up a paragraph:
’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.’
Don’t worry about the line breaks, the text will get reformatted anyway.
The formatter knows where a paragraph ends by the *
* tag and does not
care about empty lines and such.
Let’s do some more markup. In TEI the ** element stands for
emphasized text:
’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.’
In TEI the ** element stands for quoted text:
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.
Every opening tag needs a corresponding closing tag. Opening and closing
tags must always nest like parentheses in a mathematical equation.
This is right:
...
and this is wrong:
...
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.
... Above all, why should the second man write up the
German word Rache before
decamping? ...
In TEI the ** 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.
... Above all, why should the second man write up the German
word Rache before
decamping? ...
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.)
... Among other things I bought these brown boots
— gave six dollars for them — and had one
stolen before ever I had them on my feet.
In TEI the entity *—* represents an em-dash. Substituting *—*
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 ** 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 ** 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
** or ** tags.
If you encounter a passage in a foreign language unknown to you just use
the bare **. 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 .
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. Whatever they do, they will have
followers.
Un sot trouve toujours un plus sot qui
l’admire.
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 (http://www.xmlsoft.org/)
And here is the PGTEI DTD
(http://www.gutenberg.org/tei/marcello/0.4/dtd/).
For all of you who don’t want to install a validator on your own PC there
is an online validation service
(http://www.gutenberg.org/tei/services/tei-online) 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 (http://www.tei-c.org/Lite/) 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 (http://www.tei-c.org/Vault/Bare)
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 (http://www.tei-
c.org/P4X/) by C. M. Sperberg-McQueen, and L. Burnard editors, 2002.
The homepage of the Text Encoding Initiative Consortium (http://www.tei-
c.org) has many other interesting stuff and links.
More Links
Language Codes: Code for the Representation of the Names of Languages.
(http://xml.coverpages.org/iso639a.html) From ISO 639, revised 1989
STANDARD HEADER FOR PG SUBMISSION
These are examples for the official header and footer in a PGTEI text. The
** section is mandatory.
Alice’s Adventures in WonderlandIllustrated byJohn TennielLewis CarrollJohn Tenniel
Edition 30
Project GutenbergJanuary, 199111
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
#1 in our series by Lewis Carroll1
Unknown
Library of Congress ClassificationPRAliceJanuary 1991AnonymousProject Gutenberg edition 10March 1994AnonymousProject Gutenberg edition 30March 2003Marcello PerathonerTEI Markup
Contents
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:
And this is an example for the footer:
Footnotes
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:
...
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 }
...
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:
instead of:
The results will be exactly the same.
Of course you can also mix classes and declarations like this:
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 ** section if (and only if) this char map was applied
in the conversion process.
...
Transcribers note: the character
Yogh has been replaced with the character
"3".
YoghLATIN CAPITAL LETTER YOGH3yoghLATIN SMALL LETTER YOGH3
...
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 ** root
node with one or more ** children.
...
...
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.
...
strych-ninesov-er-eignneverhyphenatethisword
...
**
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 ** only if there are footnotes. In a text
with footnotes it will create a ** in the HTML output format but not
in the PDF output format.
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.
\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
ykcowrebbaJ sevot yhtils eht dna ,gillirb sawT’ ebaw eht ni elbmig dna eryg diD ,sevogorob eht erew ysmim llA .ebargtuo shtar emom eht dnA
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 ** 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
** 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.
The Eighth Is̱ẖráq
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 (http://www.tei-
c.org/Lite/).
3. The Structure of a TEI Text
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-struc.html)
Composite texts are not supported.
**
Unsupported
**
Unsupported.
4. Encoding the Body
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-body.html)
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.
Chapter 2
...
*page-break-before: right*
This element starts a new right-hand page.
Part 2
...
*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.
White Rabbit checking watch.
*
*
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:
Chapter 1. The Spread of Evolution
His book on animals and plants ...
C. Darwin to T.H.Huxley
...
...
Chapter 1. The Spread of Evolution
His book on animals and plants ...
C. Darwin to T. H. Huxley
...
...
4.2. Headings and Closings
**
Use ** for the main header and ** for any subtitle.
It is up to you to decide which title is main and which are sub.
Part I
Being a Reprint from the Reminiscences of
John H. Watson, M.D. late of the Army Medical Department
Mr. Sherlock Holmes
In the year 1878 I took my degree of Doctor ...
The campaign brought honours and promotion to many, ...
...
The Science of Deduction
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.
...
...
...
4.3. Prose, Verse and Drama
**
Attribute *part*; only the values, *I, M* and *F* are supported.
Example:
There was a young lady of Riga,Who smiled as she rode on a tiger;They came back from the rideWith the lady inside,And the smile on the face of the tiger.
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.
**
MargareteVersprich mir, Heinrich!FaustWas ich kann!MargareteNun sag, wie hast du’s mit der Religion?Du bist ein herzlich guter Mann,Allein ich glaub, du hältst nicht viel davon.
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. (http://www.tei-c.org/Lite/U5-pln.html)
**
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.
**
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.
-------------------------------------
* * * * * * * * * * * *
6. Marking Highlighted Phrases
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-hilites.html)
6.1. Changes of Typeface, etc.
This are the supported values for the *rend* attribute when applied to
inline elements such as **:
*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.
I have left everything in
statu quo until I hear from you.
**
The default rendering for ** without any *rend* attribute is
_font-style: italic_.
6.2. Quotations and Related Features
**
Attribute *rend* takes the following values:
*pre: none*
This quote has no opening mark.
*post: none*
This quote has no closing mark.
*pre: ’‘’*
This quote has the specified opening mark.
*post: ’’’*
This quote has the specified closing mark.
*display*
This quote is rendered as a block quote and has no quote mark.
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.
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. (http://www.tei-c.org/Lite/U5-notes.html)
**
The *place* attribute supports only the values of *foot*, *end* and
*margin*.
The *n* attribute is not supported.
**
Inserts a footnote marker at the exact point in the text. There should be
no space between the commented text and the opening **, any space
should be moved after the closing **.
When I was a boy, there was but one permanent
ambition among my comrades in our village
Hannibal, Missouri.
on the west bank of the Mississippi River.
That was, to be a steamboatman. ...
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 ** at the book back. In
HTML the footnote marker will be linked to the footnote text.
**
These notes must be collected with a **. 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.
**
(M1)
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. (http://www.tei-c.org/Lite/U5-ptrs.html)
Note: links work only in the HTML and PDF formats.
8.1. Simple Cross References
**, **
Use these for internal links.
Attribute *target* supports only one destination.
See: Chapter 42.
...
Chapter 42
The Answer
Wouldn’t you like to know? ...
...
8.2. Extended Pointers
**, **
Use these for external links.
Attribute *doc* is not supported.
New attribute *url*. Enter the link destination here.
The homepage of TEI.
8.3. Linking Attributes
9. Editorial Interventions
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-edit1.html)
10. Omissions, Deletions, and Additions
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-edit2.html)
11. Names, Dates, Numbers and Abbreviations
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-names.html)
11.1. Names and Referring Strings
** and ** 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. (http://www.tei-c.org/Lite/U5-lists.html)
**
*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:
**
First
Second
Third
**
- First
- Second
- Third
**
1. First
2. Second
3. Third
**
1. First Paragraph
2. Second Paragraph
3. Third Paragraph
**
First Term
First Gloss
Second Term
Second Gloss
Third Term
Third Gloss
**
I. First
II. Second
III. Third
**
a. First
b. Second
c. Third
**
α. 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, agri, M. _
field
_audio, -ire, -ivi, -itus_
hear, listen (to)
_bellum, -i, 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. (http://www.tei-c.org/Lite/U5-bibls.html)
14. Tables
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-tables.html)
*
*
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
(http://wolfram.schneider.org/bsd/7thEdManVol2/tbl/tbl.pdf)
preprocessor.
**
Attribute *role* not supported.
15. Figures and Graphics
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-figs.html)
**
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.
White Rabbit checking watch.
16. Interpretation and Analysis
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-anal.html)
16.1. Orthographic Sentences
16.2. General-Purpose Interpretation Elements
17. Technical Documentation
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-techdoc.html)
17.1. Additional Elements for Technical Documents
**
Use for examples. This is a block element, with line breaks preserved. In
HTML it is also rendered as a shaded box.
Example
Example
Example
Will be rendered:
Example
Example
Example
**
Attribute *notation* can take following values:
*tex*
In PDF output mode this will pipe the contents of the **
element directly through to the TeX processor.
In HTML output mode the contents of the ** 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 ** 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 **
element will be converted to an image and inserted into the file.
In all other output modes it will be ignored.
Example:
This is an inlined formula:
$\int_0^\infty f: x\,dx$.
And this is some more text after the inlined formula.
Will be rendered as:
This is an inlined formula: [formula]. And this is some more text after
the inlined formula.
Example:
Note the use of a CDATA section to avoid having to replace all &s with
*&*. A CDATA section starts with .
Will be rendered as:
[formula]
An embedded SVG image.
]]>
Will be rendered as:
[svg illustration]
17.2. Generated Divisions
**
Although this is called ** actually it generates only the contents
of a *
*. You must always surround this tag with a *
* and provide
a suitable ** and optional ** tags as well.
Attribute *type* supports following values:
*titlepage*
Generates a standard title page from the ** element.
*toc*
Generates a table of contents from ** 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 ** tags found
in the text.
*endnotes*
Generates an endnotes section. This section is automatically
populated with the contents of the ** 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 ** 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 ** element makes the
** collect only endnotes from that section of the text.
Footnotes
To produce a list of figures, use:
List of Figures
...
The Gnutenberg Press
17.3. Index Generation
**
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 *—*) 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 ** attribute *level1* will default to the contents of the
next ** element.
18. Character Sets, Diacritics, etc.
See the TEI-Lite introduction. (http://www.tei-c.org/Lite/U5-chars.html)
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 | ¢ | ¢ |
+------------+-----------+--------+
|Hexadecimal | ¢ | ¢ |
+------------+-----------+--------+
|Named | ¢ | ¢ |
+------------+-----------+--------+
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 |
+-----------+-----------+
|& |*&* |
+-----------+-----------+
|< |*<* |
+-----------+-----------+
|> |*>* |
+-----------+-----------+
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 |
+---------+--------------+-----------------------------------------------+
|Œ | *Œ* | The OE ligature used in French texts. |
+---------+--------------+-----------------------------------------------+
|œ | *œ* | The oe ligature used in French texts. |
+---------+--------------+-----------------------------------------------+
|>< | ** | Zero-width joiner. Use: shelf**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. |
+---------+--------------+-----------------------------------------------+
|> < | * * | A non-breaking space. Use: |
| | | Mr.* *Sherlock Holmes |
+---------+--------------+-----------------------------------------------+
|> < | * * | A space the size of an n. |
+---------+--------------+-----------------------------------------------+
|> < | * * | A space the size of an m. A typografical |
| | | quad. |
+---------+--------------+-----------------------------------------------+
|> < | * * | 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 ** tag. |
+---------+--------------+-----------------------------------------------+
|– | *–* | This is the right dash to use between |
| | | numbers. Eg: 1914*–*18 The great war of |
| | | 1914–18. |
+---------+--------------+-----------------------------------------------+
|— | *—* | Use instead of --. |
+---------+--------------+-----------------------------------------------+
|—— | *&qdash;* | Use instead of ----. A quote dash or |
| | | two-em-dash is used to indicate missing |
| | | letters: _Mr. P—— woke up._ |
+---------+--------------+-----------------------------------------------+
|‘ | *‘* | |
+---------+--------------+-----------------------------------------------+
|’ | *’* | |
+---------+--------------+-----------------------------------------------+
|‚ | *‚* | |
+---------+--------------+-----------------------------------------------+
|“ | *“* | |
+---------+--------------+-----------------------------------------------+
|” | *”* | |
+---------+--------------+-----------------------------------------------+
|„ | *„* | |
+---------+--------------+-----------------------------------------------+
|† | *†* | |
+---------+--------------+-----------------------------------------------+
|‡ | *‡* | |
+---------+--------------+-----------------------------------------------+
|• | *•* | bullet |
+---------+--------------+-----------------------------------------------+
|… | *…* | Horizontal ellipsis. Use instead of three |
| | | dots. Note how the ellipsis dots are spaced |
| | | farther apart than if you enter three dots: |
| | | ... |
+---------+--------------+-----------------------------------------------+
|‰ | *‰* | |
+---------+--------------+-----------------------------------------------+
|′ | *′* | Use for coordinates. |
+---------+--------------+-----------------------------------------------+
|″ | *″* | Use for coordinates. |
+---------+--------------+-----------------------------------------------+
|‹ | *‹* | French guillemet |
+---------+--------------+-----------------------------------------------+
|› | *›* | French guillemet |
+---------+--------------+-----------------------------------------------+
|€ | *€* | |
+---------+--------------+-----------------------------------------------+
|™ | *™* | |
+---------+--------------+-----------------------------------------------+
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̽ḍ
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. (http://www.tei-c.org/Lite/U5-fronbac.html)
19.1. Front Matter
19.1.1. Title Page
**
“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.
**
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. (http://www.tei-c.org/Lite/U5-header.html)
Experimental
Partially supported through the ** element.
It is easier to just copy the provided header template and modify the
appropriate entries than to build a conformant ** 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 conversion process. From TEI thru XSLT to HTML. From TEI thru XSLT
and pdfTeX tp PDF. From TEI thru XSLT and nroff to TXT. All 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
(http://www.gnu.org/licenses/gpl.html).
You may download the Gnutenberg Press
(http://www.gutenberg.org/tei/marcello/0.4/src/gnutenberg-press-0.4.tgz).
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
(http://www.xmlsoft.org/).
Perl
The Pathologically Eclectic Rubbish Lister by Larry Wall in a
version >= 5.8.0. Get Perl from the Comprehensive Perl Archive
Network (http://www.cpan.org/). 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 (http://www.tug.org/interest.html).
nroff
Get GNU groff (http://www.gnu.org/software/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.
M1 This is a margin note. Margin notes work best with short words.
***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-0.txt or 20000-0.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.
***FINIS***