Codec.Epub.Opf.Metadata

Data types for working with the metadata of ePub documents

These data types were constructed by studying the IDPF OPF specification for ePub documents found here:

http://www.idpf.org/2007/opf/OPF_2.0_final_spec.html

Documentation

data OPFPackage

opf:package tag

Note that we are not yet storing the data that comes after /package/metadata in an OPF Package Document. But that may be added at a later time.

Constructors

OPFPackage

Fields

opVersion :: String

version attr

opUniqueId :: String

unique-identifier attr

opMeta :: EpubMeta

metadata child element contents

Instances

Eq OPFPackage

Show OPFPackage

data EMTitle

dc:title tag, xml:lang attr, content

Constructors

EMTitle (Maybe String) String

Instances

Eq EMTitle

Show EMTitle

data EMCreator

dc:creator tag, opf:role attr, opf:file-as attr, content

Constructors

EMCreator (Maybe String) (Maybe String) String

Instances

Eq EMCreator

Show EMCreator

data EMDate

dc:date tag, opf:event attr, content

Constructors

EMDate (Maybe String) String

Instances

Eq EMDate

Show EMDate

data EMId

dc:identifier tag, id attr, opf:scheme attr, content

Constructors

EMId String (Maybe String) String

Instances

Eq EMId

Show EMId

data EpubMeta

opf:metadata tag

Constructors

EpubMeta

Fields

emTitles :: [EMTitle]

at least one required

emCreators :: [EMCreator]

emContributors :: [EMCreator]

emSubjects :: [String]

dc:subject tags

emDescription :: Maybe String

dc:description tags

emPublisher :: Maybe String

dc:publisher tag

emDates :: [EMDate]

emType :: Maybe String

dc:type tag

emFormat :: Maybe String

dc:format tag

emIds :: [EMId]

at least one required

emSource :: Maybe String

dc:source tag

emLangs :: [String]

dc:language tags, at least one required

emRelation :: Maybe String

dc:relation tag

emCoverage :: Maybe String

dc:coverage tag

emRights :: Maybe String

dc:rights tag

Instances

Eq EpubMeta

Show EpubMeta

emptyEpubMeta :: EpubMeta

Note: This isn't valid as-is, some required values are empty lists!