feed-1.0.0.0: Interfacing with RSS (v 0.9x, 2.x, 1.0) + Atom feeds.

Copyright(c) Galois Inc. 2008
(c) Sigbjorn Finne 2009-
LicenseBSD3
MaintainerSigbjorn Finne <sof@forkIO.com>
Stabilityprovisional
Safe HaskellSafe
LanguageHaskell98

Text.Feed.Constructor

Description

Description: Module for an abstraction layer between different kinds of feeds.

Synopsis

Documentation

data FeedKind #

The kinds of feed documents supported.

newFeed :: FeedKind -> Feed #

Construct an empty feed document, intending to output it in the fk feed format.

type FeedSetter a = a -> Feed -> Feed #

withFeedHTML :: FeedSetter URLString #

withFeedHTML sets the URL where an HTML version of the feed is published.

withFeedDescription :: FeedSetter Text #

withFeedHTML sets the URL where an HTML version of the feed is published.

withFeedDate :: FeedSetter DateString #

'withFeedDate dt' is the composition of withFeedPubDate and withFeedLastUpdate, setting both publication date and last update date to dt. Notice that RSS2.0 is the only format supporting both pub and last-update.

type ItemSetter a = a -> Item -> Item #

withItemTitle :: ItemSetter Text #

'withItemTitle myTitle' associates a new title, myTitle, with a feed item.

withItemLink :: ItemSetter URLString #

'withItemTitle myLink' associates a new URL, myLink, with a feed item.

withItemPubDate :: ItemSetter DateString #

'withItemPubDate dt' associates the creation/ publication date dt with a feed item.

withItemAuthor :: ItemSetter Text #

'withItemAuthor auStr' associates new author info with a feed item.

withItemCommentLink :: ItemSetter Text #

'withItemCommentLink url' sets the URL reference to the comment page to url.

withItemEnclosure :: Text -> Maybe Text -> ItemSetter (Maybe Integer) #

'withItemEnclosure url mbTy len' sets the URL reference to the comment page to url.

withItemFeedLink :: Text -> ItemSetter Text #

'withItemFeedLink name myFeed' associates the parent feed URL myFeed with a feed item. It is labelled as name.

withItemId :: Bool -> ItemSetter Text #

'withItemId isURL id' associates new unique identifier with a feed item. If isURL is True, then the id is assumed to point to a valid web resource.

withItemDescription :: ItemSetter Text #

'withItemDescription desc' associates a new descriptive string (aka summary) with a feed item.

withItemRights :: ItemSetter Text #

'withItemRights rightStr' associates the rights information rightStr with a feed item.