Safe Haskell	None

Data.Microformats2

Description

Microformats 2 types for Haskell.

Notes:

Pretty much all properties in MF2 are optional -- this is why we use Maybe when lists don't make sense.
We don't duplicate sub-properties in parent types. E.g. h-adr has both p-geo and p-latitude, p-longitude, p-altitude. Adr only has an Embedded Geo.
Lazy Text is used for storing texts, because it's the format used in Scotty, Hastache and other popular web libraries.

Synopsis

Documentation

type Link a = Text Source

An alias for lazy Text as a phantom type for storing the type of linked data.

data Embedded a Source

A type that represents all the ways Microformats objects can be embedded inside one another.

Constructors

Here a
Somewhere (Link a)
Nowhere

Instances

Typeable1 Embedded
Eq a => Eq (Embedded a)
Data a => Data (Embedded a)
Show a => Show (Embedded a)
ToJSON a0 => ToJSON (Embedded a0)
FromJSON a0 => FromJSON (Embedded a0)

hereFromMaybe :: Maybe a -> Embedded aSource

Converts a Maybe thing to an Embedded wrapping the same thing.

somewhereFromMaybe :: Maybe (Link a) -> Embedded aSource

Converts a Maybe Link to an Embedded referencing the same URL.

data Geo Source

A Geo type, based on h-geo http://microformats.org/wiki/h-geo

Constructors

Geo
Fields geoLatitude :: Maybe Double geoLongitude :: Maybe Double geoAltitude :: Maybe Double

Instances

Eq Geo
Data Geo
Show Geo
Typeable Geo
ToJSON Geo
FromJSON Geo

defaultGeo :: Geo Source

An empty Geo.

data Adr Source

An Adr type, based on h-adr http://microformats.org/wiki/h-adr

Constructors

Adr
Fields adrStreetAddress :: Maybe Text adrExtendedAddress :: Maybe Text adrPostOfficeBox :: Maybe Text adrLocality :: Maybe Text adrRegion :: Maybe Text adrPostalCode :: Maybe Text adrCountryName :: Maybe Text adrLabel :: Maybe Text adrGeo :: Embedded Geo

Instances

Eq Adr
Data Adr
Show Adr
Typeable Adr
ToJSON Adr
FromJSON Adr

defaultAdr :: Adr Source

An empty Adr.

data Card Source

A Card type, based on h-card http://microformats.org/wiki/h-card

Constructors

Card

Fields

cardName :: Maybe Text
cardHonorificPrefix :: Maybe Text
cardGivenName :: Maybe Text
cardAdditionalName :: Maybe Text
cardFamilyName :: Maybe Text
cardSortString :: Maybe Text
cardHonorificSuffix :: Maybe Text
cardNickname :: Maybe Text
cardEmail :: Maybe Text
cardLogo :: Maybe Text
cardPhoto :: Maybe Text
cardUrl :: Maybe Text
cardUid :: Maybe Text
cardCategory :: [Text]
cardAdr :: Embedded Adr
cardTel :: Maybe Text
cardNote :: Maybe Text
cardBday :: Maybe UTCTime
cardKey :: Maybe Text
cardOrg :: Embedded Card
cardJobTitle :: Maybe Text
cardRole :: Maybe Text
cardImpp :: [Text]
cardSex :: Maybe Text
cardGenderIdentity :: Maybe Text
cardAnniversary :: Maybe UTCTime

Instances

Eq Card
Data Card
Show Card
Typeable Card
ToJSON Card
FromJSON Card

defaultCard :: Card Source

An empty Card.

data Cite Source

A Cite type, based on h-cite http://microformats.org/wiki/h-cite

Constructors

Cite
Fields citeName :: Maybe Text citePublished :: Maybe UTCTime citeAuthor :: Embedded Card citeUrl :: Maybe Text citeUid :: Maybe Text citePublication :: Maybe Text citeAccessed :: Maybe UTCTime citeContent :: Maybe Text

Instances

Eq Cite
Data Cite
Show Cite
Typeable Cite
ToJSON Cite
FromJSON Cite

defaultCite :: Cite Source

An empty Cite.

type LocationReference = Either (Embedded Card) (Embedded Adr)Source

A location reference. Left means a Card is used, which is often used for checkins. Right means an Adr is used. If you only have a Geo, wrap it in an Adr.

type EntryReference = Either (Embedded Cite) (Link Entry)Source

An Entry reference.

data Entry Source

An Entry type, based on h-entry http://microformats.org/wiki/h-entry with popular extensions.

Constructors

Entry

Fields

entryName :: Maybe Text
entrySummary :: Maybe Text
entryContent :: Maybe Text
entryPublished :: Maybe UTCTime
entryUpdated :: Maybe UTCTime
entryAuthor :: Embedded Card
entryCategory :: [Text]
entryUrl :: Maybe Text
entryUid :: Maybe Text
entryLocation :: Maybe LocationReference
entryComments :: [EntryReference]
entrySyndication :: [Text]
entryInReplyTo :: Maybe EntryReference
entryLikeOf :: Maybe EntryReference
entryRepostOf :: Maybe EntryReference

Instances

Eq Entry
Data Entry
Show Entry
Typeable Entry
ToJSON Entry
FromJSON Entry

defaultEntry :: Entry Source

An empty Entry.