Contains the structure data of the Epub file (metadata, manifest, cover, Xml files, ...) More...

#include <epubexportStructure.h>

Inheritance diagram for EpubExportStructure:

Collaboration diagram for EpubExportStructure:

Public Member Functions
	EpubExportStructure ()

void	readMetadata (ScribusAPIDocumentMetadata metadata)
	Read the metadata, as provided by the ScribusAPI plugin.

ScribusAPIDocumentMetadata	getMetadata ()

void	setFilename (QString filename)

void	addToManifest (EpubExportStructureManifestItem item)
	add an EpubExportStructureManifestItem to the manifest.

void	addToManifest (QString id, QString path, QString mediatype)
	create an EpubExportStructureManifestItem and it to the manifest. More...

void	addToToc (QString id, QString path, QString title)
	create an EpubExportStructureManifestItem and it to the table of contents. More...

void	addToToc (EpubExportStructureManifestItem item)
	add an EpubExportStructureManifestItem to the table of contents.

QString	getOPF ()
	creates the xml string for the OPF file More...

QString	getNCX ()
	creates the xml string for the NCX file More...

QString	getContainer ()
	add META-INF/container.xml to the current epub file More...

void	setCover (QByteArray cover)

bool	hasCover ()

QByteArray	getCover ()

Detailed Description

Contains the structure data of the Epub file (metadata, manifest, cover, Xml files, ...)

Constructor & Destructor Documentation

EpubExportStructure::EpubExportStructure ( )

Store information related to the structure of content and return the strings for the "structural" files for the .epub file

Member Function Documentation

void EpubExportStructure::addToManifest	(	QString	id,
		QString	path,
		QString	mediatype
	)

create an EpubExportStructureManifestItem and it to the manifest.

Parameters

mediatype media-type as defined by http://www.iana.org/assignments/media-types/media-types.xhtml

void EpubExportStructure::addToToc	(	QString	id,
		QString	path,
		QString	title
	)

create an EpubExportStructureManifestItem and it to the table of contents.

Parameters

mediatype media-type as defined by http://www.iana.org/assignments/media-types/media-types.xhtml

QString EpubExportStructure::getContainer ( )

add META-INF/container.xml to the current epub file

 <?xml version="1.0" encoding="UTF-8" ?>
 <container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
   <rootfiles>
     <rootfile full-path="OEBPS/content.opf" media-type="application/oebps-package+xml"/>
   </rootfiles>
 </container>

QString EpubExportStructure::getNCX ( )

creates the xml string for the NCX file

 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE ncx PUBLIC "-//NISO//DTD ncx 2005-1//EN"
 "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd">
 <ncx version="2005-1" xml:lang="en" xmlns="http://www.daisy.org/z3986/2005/ncx/">
   <head>
     <meta name="dtb:uid" content="123456789X"/> 
     <meta name="dtb:depth" content="1"/> 
     <meta name="dtb:totalPageCount" content="0"/> 
     <meta name="dtb:maxPageNumber" content="0"/> 
   </head>
   <docTitle>
     <text>Pride and Prejudice</text>
   </docTitle>
   <docAuthor>
     <text>Austen, Jane</text>
   </docAuthor>
   <navMap>
     <navPoint class="chapter" id="chapter1" playOrder="1">
       <navLabel><text>Chapter 1</text></navLabel>
       <content src="chapter1.xhtml"/>
     </navPoint>
   </navMap>
 </ncx>

QString EpubExportStructure::getOPF ( )

creates the xml string for the OPF file

The OPF file, traditionally named content.opf, houses the EPUB book's metadata, file manifest, and linear reading order.

On the IDPF site you can find the full list of the possible metadata http://idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2

 <?xml version="1.0"?>
 <package version="2.0" xmlns="http://www.idpf.org/2007/opf" unique-identifier="BookId">
   <metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:opf="http://www.idpf.org/2007/opf">
     <dc:title>Pride and Prejudice</dc:title>
     <dc:language>en</dc:language>
     <dc:identifier id="BookId" opf:scheme="ISBN">123456789X</dc:identifier>
     <dc:creator opf:file-as="Austen, Jane" opf:role="aut">Jane Austen</dc:creator>
   </metadata>
   <manifest>
     <item id="chapter1" href="chapter1.xhtml" media-type="application/xhtml+xml"/>
     <item id="stylesheet" href="style.css" media-type="text/css"/>
     <item id="ch1-pic" href="ch1-pic.png" media-type="image/png"/>
     <item id="myfont" href="css/myfont.otf" media-type="application/x-font-opentype"/>
     <item id="ncx" href="toc.ncx" media-type="application/x-dtbncx+xml"/>
   </manifest>
   <spine toc="ncx">
     <itemref idref="chapter1" />
   </spine>
   <guide>
     <reference type="loi" title="List Of Illustrations" href="appendix.html#figures" />
   </guide>
 </package>

void EpubExportStructure::setCover ( QByteArray cover )

inline

Parameters

cover content of a PNG file as a byte stream

The documentation for this class was generated from the following files:

src/module/epubexportStructure.h
src/module/epubexportStructure.cpp

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation