It is up to the builder to make sure there are no collisions. Metadata are just key value pairs.
| public addCustomMetadata ( string $name, string $content ) | ||
| $name | string | |
| $content | string | |
/**
* @param EPub $book
* @param string $seriesName
* @param string $seriesIndex
* @param string $sortTitle
*/
public static function setCalibreMetadata($book, $seriesName, $seriesIndex, $sortTitle = null)
{
$book->addCustomMetadata("calibre:series", $seriesName);
$book->addCustomMetadata("calibre:series_index", "" . $seriesIndex);
if (!empty($sortTitle)) {
$book->addCustomMetadata("calibre:title_sort", $sortTitle);
}
}
// Not needed, but included for the example, Language is mandatory, but EPub defaults to "en". Use RFC3066 Language codes, such as "en", "da", "fr" etc.
$book->setDescription("This is a brief description\nA test ePub book as an example of building a book in PHP");
$book->setAuthor("John Doe Johnson", "Johnson, John Doe");
$book->setPublisher("John and Jane Doe Publications", "http://JohnJaneDoePublications.com/");
// I hope this is a non existent address :)
$book->setDate(time());
// Strictly not needed as the book date defaults to time().
$book->setRights("Copyright and licence information specific for the book.");
// As this is generated, this _could_ contain the name or licence information of the user who purchased the book, if needed. If this is used that way, the identifier must also be made unique for the book.
$book->setSourceURL("http://JohnJaneDoePublications.com/books/TestBook.html");
$book->addDublinCoreMetadata(DublinCore::CONTRIBUTOR, "PHP");
$book->setSubject("Test book");
$book->setSubject("keywords");
$book->setSubject("Chapter levels");
// Insert custom meta data to the book, in this cvase, Calibre series index information.
$book->addCustomMetadata("calibre:series", "PHPePub Test books");
$book->addCustomMetadata("calibre:series_index", "1");
$log->logLine("Set up parameters");
$cssData = "body {\n margin-left: .5em;\n margin-right: .5em;\n text-align: justify;\n}\n\np {\n font-family: serif;\n font-size: 10pt;\n text-align: justify;\n text-indent: 1em;\n margin-top: 0px;\n margin-bottom: 1ex;\n}\n\nh1, h2 {\n font-family: sans-serif;\n font-style: italic;\n text-align: center;\n background-color: #6b879c;\n color: white;\n width: 100%;\n}\n\nh1 {\n margin-bottom: 2px;\n}\n\nh2 {\n margin-top: -2px;\n margin-bottom: 2px;\n}\n";
$log->logLine("Add css");
$book->addCSSFile("styles.css", "css1", $cssData);
// This test requires you have an image, change "demo/cover-image.jpg" to match your location.
$log->logLine("Add Cover Image");
$book->setCoverImage("Cover.jpg", file_get_contents("demo/cover-image.jpg"), "image/jpeg");
// A better way is to let EPub handle the image itself, as it may need resizing. Most e-books are only about 600x800
// pixels, adding mega-pixel images is a waste of place and spends bandwidth. setCoverImage can resize the image.
// When using this method, the given image path must be the absolute path from the servers Document root.
/* $book->setCoverImage("/absolute/path/to/demo/cover-image.jpg"); */
// setCoverImage can only be called once per book, but can be called at any point in the book creation.
$log->logLine("Set Cover Image");
$cover = $content_start . "<h1>Test Book</h1>\n<h2>By: John Doe Johnson</h2>\n" . $bookEnd;