PG Metadata

Previous

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.6 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 directive inserts the PG header as generated from the metadata.

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

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

                                                                                                                                                                                                                                                                                                           

Clyx.com


Top of Page
Top of Page