Safe Haskell	Safe-Inferred
Language	Haskell2010

Codec.Epub.Data.Metadata

Description

Data types for working with the metadata of epub documents

This module defines the Metadata structure which contains most of the taxonomic information about the literary work. Metadata is probably the most important data structure in this library.

Both commonly-used versions of epub (2.x and 3.x) are supported by these types.

Synopsis

data Creator = Creator {
- creatorRole :: Maybe String
- creatorFileAs :: Maybe String
- creatorSeq :: Maybe Int
- creatorText :: String
}
data DateEvent
- = Available
- | Created
- | Date
- | DateAccepted
- | DateCopyrighted
- | DateSubmitted
- | Epub
- | Issued
- | Modified
- | Valid
newtype DateValue = DateValue String
data Description = Description (Maybe String) String
data Identifier = Identifier {
- idId :: Maybe String
- idType :: Maybe String
- idScheme :: Maybe String
- idText :: String
}
data Metadata = Metadata {
- metaIds :: [Identifier]
- metaTitles :: [Title]
- metaLangs :: [String]
- metaContributors :: [Creator]
- metaCreators :: [Creator]
- metaDates :: Map DateEvent DateValue
- metaSources :: [Source]
- metaType :: Maybe String
- metaCoverages :: [String]
- metaDescriptions :: [Description]
- metaFormats :: [String]
- metaPublishers :: [String]
- metaRelations :: [String]
- metaRights :: [String]
- metaSubjects :: [String]
}
data Refinement = Refinement {
- refId :: String
- refProp :: String
- refScheme :: String
- refText :: String
}
data Source = Source {
- sourceType :: Maybe String
- sourceScheme :: Maybe String
- sourceSourceOf :: Maybe String
- sourceText :: String
}
data Title = Title {
- titleLang :: Maybe String
- titleType :: Maybe String
- titleSeq :: Maybe Int
- titleText :: String
}
dateEventFromString :: Maybe String -> Maybe DateEvent
dateEventToString :: DateEvent -> String
emptyMetadata :: Metadata
refineCreator :: [Refinement] -> (String, Creator) -> Creator
refineIdentifier :: [Refinement] -> Identifier -> Identifier
refineSource :: [Refinement] -> (String, Source) -> Source
refineTitle :: [Refinement] -> (String, Title) -> Title

Documentation

data Creator Source #

package/metadata/dc:creator or package/metadata/dc:contributor tags

This structure is used for both contributor and creator as they are exactly the same.

Constructors

Creator
Fields creatorRole :: Maybe String role from attribute or meta tag creatorFileAs :: Maybe String file-as from attribute or meta tag creatorSeq :: Maybe Int display-sequence property from meta creatorText :: String creator or contributor tag text

Instances

Instances details

Show Creator Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Creator -> ShowS # show :: Creator -> String # showList :: [Creator] -> ShowS #
Eq Creator Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Creator -> Creator -> Bool # (/=) :: Creator -> Creator -> Bool #

data DateEvent Source #

Constructors

Available
Created
Date
DateAccepted
DateCopyrighted
DateSubmitted
Epub
Issued
Modified
Valid

Instances

Instances details

Show DateEvent Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> DateEvent -> ShowS # show :: DateEvent -> String # showList :: [DateEvent] -> ShowS #
Eq DateEvent Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: DateEvent -> DateEvent -> Bool # (/=) :: DateEvent -> DateEvent -> Bool #
Ord DateEvent Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods compare :: DateEvent -> DateEvent -> Ordering # (<) :: DateEvent -> DateEvent -> Bool # (<=) :: DateEvent -> DateEvent -> Bool # (>) :: DateEvent -> DateEvent -> Bool # (>=) :: DateEvent -> DateEvent -> Bool # max :: DateEvent -> DateEvent -> DateEvent # min :: DateEvent -> DateEvent -> DateEvent #

newtype DateValue Source #

EPUB 2.x: package/metadata/dc:date tag, opf:event attribute, text | EPUB 3.x: package/metadata/dc:date tag | package/metadata/meta property="dcterms:issued" | package/metadata/meta property="dcterms:modified" | package/metadata/meta property="dcterms:..."

Constructors

DateValue String

Instances

Instances details

Show DateValue Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> DateValue -> ShowS # show :: DateValue -> String # showList :: [DateValue] -> ShowS #
Eq DateValue Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: DateValue -> DateValue -> Bool # (/=) :: DateValue -> DateValue -> Bool #

data Description Source #

package/metadata/dc:description tag, xml:lang attribute, text

Constructors

Description (Maybe String) String

Instances

Instances details

Show Description Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Description -> ShowS # show :: Description -> String # showList :: [Description] -> ShowS #
Eq Description Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Description -> Description -> Bool # (/=) :: Description -> Description -> Bool #

data Identifier Source #

package/metadata/dc:identifier tag

Constructors

Identifier
Fields idId :: Maybe String id attribute idType :: Maybe String identifier-type property from meta tag idScheme :: Maybe String scheme from attribute or meta tag idText :: String identifier tag text

Instances

Instances details

Show Identifier Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Identifier -> ShowS # show :: Identifier -> String # showList :: [Identifier] -> ShowS #
Eq Identifier Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Identifier -> Identifier -> Bool # (/=) :: Identifier -> Identifier -> Bool #

data Metadata Source #

package/metadata tag

This is perhaps the most useful data structure in this library. It contains most of the information tools will want to use to organize epub documents.

Constructors

Metadata

Fields

metaIds :: [Identifier]
at least one required
metaTitles :: [Title]
at least one required
metaLangs :: [String]
dc:language tags, at least one required
metaContributors :: [Creator]
metaCreators :: [Creator]
metaDates :: Map DateEvent DateValue
metaSources :: [Source]
dc:source tags
metaType :: Maybe String
dc:type tags
metaCoverages :: [String]
dc:coverage tags
metaDescriptions :: [Description]
metaFormats :: [String]
dc:format tags
metaPublishers :: [String]
dc:publisher tags
metaRelations :: [String]
dc:relation tags
metaRights :: [String]
dc:rights tags
metaSubjects :: [String]
dc:subject tags

Instances

Instances details

Show Metadata Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Metadata -> ShowS # show :: Metadata -> String # showList :: [Metadata] -> ShowS #
Formattable Metadata Source #
Instance details Defined in Codec.Epub.Format Methods format :: Metadata -> String Source #
Eq Metadata Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Metadata -> Metadata -> Bool # (/=) :: Metadata -> Metadata -> Bool #

data Refinement Source #

Refinements represent meta tags within the metadata section that refine other tags. These are used during the parsing phase and are discarded as their information is slotted into the data they refine (CreatorS, TitleS, IdentifierS, etc..)

This is specific to epub3

Constructors

Refinement
Fields refId :: String id attribute refProp :: String property attribute refScheme :: String scheme attribute refText :: String meta tag text

Instances

data Source Source #

package/metadata/dc:source tags

Constructors

Source
Fields sourceType :: Maybe String sourceScheme :: Maybe String sourceSourceOf :: Maybe String sourceText :: String

Instances

Instances details

Show Source Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Source -> ShowS # show :: Source -> String # showList :: [Source] -> ShowS #
Eq Source Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Source -> Source -> Bool # (/=) :: Source -> Source -> Bool #

data Title Source #

package/metadata/dc:title tag

Constructors

Title
Fields titleLang :: Maybe String lang attribute titleType :: Maybe String title-type property from meta tag titleSeq :: Maybe Int display-sequence property from meta titleText :: String title tag text

Instances

Instances details

Show Title Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Title -> ShowS # show :: Title -> String # showList :: [Title] -> ShowS #
Eq Title Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods (==) :: Title -> Title -> Bool # (/=) :: Title -> Title -> Bool #

dateEventFromString :: Maybe String -> Maybe DateEvent Source #

dateEventToString :: DateEvent -> String Source #

emptyMetadata :: Metadata Source #

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

refineCreator :: [Refinement] -> (String, Creator) -> Creator Source #

Used internally by Codec.Epub.Parse.Metadata to merge epub3 meta tag info into the data gathered from contributor and creator tags

refineIdentifier :: [Refinement] -> Identifier -> Identifier Source #

Used internally by Codec.Epub.Parse.Metadata to merge epub3 meta tag info into the data gathered from an identifier tag

refineSource :: [Refinement] -> (String, Source) -> Source Source #

Used internally by Codec.Epub.Parse.Metadata to merge epub3 meta tag info into the data gathered from contributor and creator tags

refineTitle :: [Refinement] -> (String, Title) -> Title Source #

Used internally by Codec.Epub.Parse.Metadata to merge epub3 meta tag info into the data gathered from a title tag

Show Refinement Source #
Instance details Defined in Codec.Epub.Data.Metadata Methods showsPrec :: Int -> Refinement -> ShowS # show :: Refinement -> String # showList :: [Refinement] -> ShowS #