The Project Gutenberg RST Manual

Chapter 2

Chapter 22,642 wordsPublic domain

L_orem ipsum_ dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

The lines option (PDF only) specifies how many lines the dropcap should span. Default is 2.

The indents option (PDF only) can specifiy up to 2 length values. The first one is the indent of the first line, the second one the indent of the following lines. The indent is calculated from the right border of the dropcap letter. Defaults are 0em and 0.5em.

The image option specifies the image url. In plain text and EPUB the image will not be used.

.. clearpage::

.. dropcap:: G :image: images/G.png :lines: 4

Gorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

__orem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.

Tables

Be careful with tables because the table support of many ereaders is weak or nil.

Tables also support these options:

width Makes the table that wide.

widths A space-separated list of unitless values, each specifying the relative width of one table column.

If you don’t use the option widths, the column widths are calculated from the layout of the table in your source file.

aligns Horizontally align the columns.

A space-separated list of alignments, each specifying the alignment of one column.

Valid alignments values are: left, center, right and justify.

vertical-aligns Vertically align the columns.

A space-separated list of vertical alignments, each specifying the alignment of one column.

Valid alignments values are: top, middle, and bottom.

Note: vertical alignment is fully supported in HTML only. Other formats may support it in varying degrees.

summary (HTML only.) Puts a summary attribute on the table element.

These are the extra classes supported by PG-RST:

norules Omits the rules between table rows. (Not the rule between header and body nor the rules at the top and bottom of the table.)

Use this class when the eye can follow the table rows without the aid of rules.

.. table:: Demo Table :width: 100% :align: center :widths: 3 1 1 1 :aligns: justify justify center right :vertical−aligns: top middle bottom top :summary: This table contains valuable data.

+−−−−−−−−−−−−−−−−−−−−−−−−+−−−−−−−−−−−+−−−−−−−−−−+−−−−−−−−−−−+ | Header row, column 1 | Justified | Centered | Price ($) | | (header rows optional) | | | | +========================+===========+==========+===========+ | row 1 | column | column | 1.23 | +−−−−−−−−−−−−−−−−−−−−−−−−+−−−−−−−−−−−+−−−−−−−−−−+−−−−−−−−−−−+ | row 2 | col col | col | 45.67 | | | col col | | | | | col col | | | | | col | | | +−−−−−−−−−−−−−−−−−−−−−−−−+−−−−−−−−−−−+−−−−−−−−−−+−−−−−−−−−−−+ | row 3 | Cells may span columns. | | | Lorem ipsum dolor sit amet, | | | consetetur sadipscing elitr, sed | | | nonumy eirmod tempor invidunt ut | | | labore et dolore magna aliquyam | | | sed diam voluptua. At vero eos | | | accusam et justo duo dolores et | | | rebum. | +−−−−−−−−−−−−−−−−−−−−−−−−+−−−−−−−−−−−+−−−−−−−−−−+−−−−−−−−−−−+ | Cells may span rows and | Cells | row 4 | | columns. Lorem ipsum dolor sit | may span +−−−−−−−−−−−+ | amet, consetetur adipiscing. | rows. | row 5 | +−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−−+−−−−−−−−−−+−−−−−−−−−−−+

Demo Table

────────────────────────────────────────────────────────────────── Header row, column 1 (header Justified Centered Price ($) rows optional) ────────────────────────────────────────────────────────────────── row 1 column column 1.23 ────────────────────────────────────────────────────────────────── row 2 col col col 45.67 col col col col col ────────────────────────────────────────────────────────────────── row 3 Cells may span columns. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam sed diam voluptua. At vero eos accusam et justo duo dolores et rebum. ────────────────────────────────────────────────────────────────── Cells may span rows and columns. Lorem Cells may row 4 ipsum dolor sit amet, consetetur span ──────────── adipiscing. rows. row 5 ──────────────────────────────────────────────────────────────────

.. table:: Truth table for “and” :class: norules :align: center :width: 50%

===== ===== ========= A B A and B ===== ===== ========= False False False True False False False True False True True True ===== ===== =========

Truth table for “and”

───────────────────────────────── A B A and B ───────────────────────────────── False False False ───────────────────────────────── True False False ───────────────────────────────── False True False ───────────────────────────────── True True True ─────────────────────────────────

PG Metadata

Top Boilerplate

This section explains the PG boilerplate that you must put at the top of your PG-RST file.

It looks like this:

.. −*− encoding: utf−8 −*− (1)

.. meta:: (2) :PG.Id: 181 :PG.Title: Very Short Title :PG.Released: 2010−11−25 :PG.Rights: Public Domain :PG.Producer: Woody Guthrie :PG.Producer: Pete Seeger :PG.Producer: The Almanac Singers :PG.Credits: This file was produced from images stolen from the Louvre. :DC.Creator: Jane Austen :MARCREL.edt: Mark Twain :MARCREL.ill: Édouard Manet :DC.Title: Full Title Statement :DC.Language: en :DC.Language: fr :DC.Language: de :DC.Created: 1900 :coverpage: images/cover.jpg

=========== Short Title (3) ===========

.. pgheader:: (4)

(1) Insert this line verbatim. It must be the first line in the text.⁶ This tells the converter to use UTF-8 encoding and is also recognized by many editors. (2) The metadata directive: see section below. (3) This will be the first line of the generated files. It should say: “The Project Gutenberg Ebook of Title” or just “Title”. Use ’=’ above and below the title. (4) This directive inserts the PG header as generated from the metadata.

⁶ A unicode BOM is allowed before this. In fact most Windows editors will add a BOM without asking you.

Metadata Directive

The metadata directive contains all data that is used to generate the PG header and the PG catalog entry.

The scheme is the part before the dot.

PG Scheme

The PG scheme holds data that is relevant to Project Gutenberg only.

Fields In the PG Scheme

──────────────────────────────────────────────── Name Contents ──────────────────────────────────────────────── PG.Id The ebook number. ──────────────────────────────────────────────── PG.Released The PG release date in YYYY-MM-DD format. ──────────────────────────────────────────────── PG.Rights Either ’Public Domain’ or ’Copyrighted’. ──────────────────────────────────────────────── PG.Title A much shortened form of the title. Used in the PG boilerplate in the lines that say: “Start of this PG ebook …” and “End of this PG ebook …”. ──────────────────────────────────────────────── PG.Producer A personal name or organization that helped produce this text. This field may appear more than once. Don’t put more than one name into one field. Repeat the field if necessary. ──────────────────────────────────────────────── PG.Credits A line acknowledging the source of the images or other stuff. ────────────────────────────────────────────────

DC Scheme

This scheme holds standard Dublincore stuff and is used by many search engines and the PG cataloguing software.

Fields In the DC Scheme

──────────────────────────────────────────────── Name Contents ──────────────────────────────────────────────── DC.Creator Author. A personal name or organization that created the text. May appear more than once. Don’t put more than one name into one field. Repeat the field if necessary. ──────────────────────────────────────────────── DC.Title The full title statement as found on the book’s title page. ──────────────────────────────────────────────── DC.Language The 2 or 3 letter code for all languages used for substantial portions of the text. May appear more than once. Don’t put more than one code into one field. Repeat the field if necessary. The languages listed here are indicative for the catalog and do not set the text language and hyphenation rules. Use the option class language- for that. ──────────────────────────────────────────────── DC.Created The year of original publication if known. ────────────────────────────────────────────────

MARCREL Scheme

This is used to record contributors to the text. All these fields may appear more than once. Don’t put more than one name into one field. Repeat the field if necessary.

Fields In the MARCREL Scheme

──────────────────────────────────────────────── Name Contents ──────────────────────────────────────────────── MARCREL.edt Editor ──────────────────────────────────────────────── MARCREL.ill Illustrator ──────────────────────────────────────────────── MARCREL.trl Translator ──────────────────────────────────────────────── MARCREL.* See the full list of MARC relator codes. ────────────────────────────────────────────────

No Scheme

Some fields are associated with none of the above schemes.

Fields Without Scheme

──────────────────────────────────────────────── Name Contents ──────────────────────────────────────────────── coverpage A coverpage for those formats (eg. Kindle) that support a cover page. This image must be included in the upload but must not necessarily be put in the text flow. ────────────────────────────────────────────────

Bottom Boilerplate

You must put this at the very bottom of your PG-RST file.

.. pgfooter:: (1)

(1) This directive inserts the PG footer and license.

PG-RST Best Practices

Images

Specify a width option in images and a figwidth option in figures and express it in percent.

If you don’t specify a width, the converter will calculate the width percentile for you, using the formula:

image_width / (980px * 0.8) * 100

(980px is the approx. wide of a browser window with scrollbar on a 1024px wide screen, 0.8 are 10% margins left and right.)

Expressing the image size relative to the screen width is the best way to get images right on a wide variety of devices form iPhones to print.

.. toc−entry:: Richard and Drucilla Martin

.. figure:: images/cover.jpg :align: center :alt: Richard and Drucilla Martin

:lb:`Richard Martin was a slave in Memphis, Tennessee. Drucilla Martin was a slave in Giles County, Tennessee.`

The legend consists of all elements after the caption. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.

The legend consists of all elements after the caption. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum.

[pg!2]

Tests and Examples

Notice

The rest of this file contains tests. You may look at the RST source to learn how things are done.

A generated local table of contents:

Section 3.1 Section 3.2 Section 3.3

A local table of contents as highlights:

Kingston — Instructive remarks on early English history — Instructive observations on carved oak and life in general — Sad case of Stivvings, junior — Musings on antiquity — I forget that I am steering — Interesting result — Hampton Court Maze — Harris as a guide.

ÄÖÜ äöüß Æsop Œdipus cœr. Đ. †‡ ウ. §2.1

‘’ ‚‛ “ ” ‹› em — en –.

“ ‘Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.’ ”

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. [pg 3] At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

――――

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

[pg 4]

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

‘Speak roughly to your little boy, And beat him when he sneezes: He only does it to annoy, Because he knows it teases.’

CHORUS.

(In which the cook and the baby joined):—

‘Wow! wow! wow!’

Summer wanes, the children are grown; Fun and frolic no more he knows; Robert of Lincoln’s a humdrum crone; Off he flies and we sing as he goes: Bob-o’link, bob-o’-link, Spink, spank, spink; When you can pipe that merry old strain, Robert of Lincoln, come back again. Chee, chee, chee.

And now a quote by Lorem Ipsum:

Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita [pg 5] kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

―― Lorem Ipsum

[pg 7]

Section 3.1

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.

Simple List with hyphens

- Wash left ear. - Wash right ear. - Brush teeth.

Simple List with bullets

• Wash left ear. • Wash right ear. • Brush teeth.

Nested List

1. Item 1. a) Item 1a. b) Item 1b. I) Item 1.a.I II) Item 1.a.II III) Item 1.a.III IV) Item 1.a.IV 2. A) i) Item 2.A.i [pg 8] ii) Item 2.A.ii B) i) Item 2.B.i ii) Item 2.B.ii iii) Item 2.B.iii C) Item 2.C 3. Item 3.

Definition List

term Definition.

term 2 Definition 2

Definition 2 paragraph 2.

long term 3 Definition 3

Option List (not used by PG)

-a , command-line option "a" -1 _file_ , --one =_file_ , --two _file_ , Multiple options with arguments.

[pg 123]

Section 3.2⁷

⁷ This title contains a footnote reference. The footnote reference will not show up in the TOC.

Some text so this section isn’t empty.

Section 3.3

THE MAN WHO PLEASES.

_The dearest friend to me, the kindest man,_ _The best-conditioned and unwearied spirit_ _In doing courtesies._

_―― Merchant of Venice._

_He hath a daily beauty in his life._

_―― Othello._

_Such a man would win any woman in the world_ _if a’ could get her good will._

_―― Much Ado About Nothing._

There are few subjects of deeper interest to men and women than that of personal fascination,

«Ora si comincia per quelli di fuori e per quelli di dentro a far grandissima e crudel guerra.»

_Istorie pistolesi._

_TABLE 8_ Types of Computers Used in the Systems Reported

────────────────────────────────── Type Number ────────────────────────────────── ASI 210 1 ─────────────────────────── (3) ASI 2100 2 ────────────────────────────────── CDC 160A 2 ─────────────────────────── (3) CDC 3100 1 ──────────────────────────────────

total computer cost 0.22 ± 0.06 by averaging −−−−−−−−−−−−−−−−−−−−−−−− = 0.23 −> separate ratios for each cost of bare accelerator system

[pg!10]

[pg 99]

Transcriber’s Note

Minor spelling errors have been silently corrected.

Hyphenation has been made consistent.