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

Stabilityprovisional
MaintainerSigbjorn Finne <sof@forkIO.com>
Safe HaskellNone

Text.Feed.Constructor

Description

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

Synopsis

Documentation

data FeedKind Source

The kinds of feed documents supported.

Instances

newFeed :: FeedKind -> FeedSource

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

type FeedSetter a = a -> Feed -> FeedSource

withFeedHTML :: FeedSetter URLStringSource

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

withFeedDescription :: FeedSetter StringSource

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

withFeedDate :: FeedSetter DateStringSource

'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 -> ItemSource

withItemTitle :: ItemSetter StringSource

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

withItemLink :: ItemSetter URLStringSource

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

withItemPubDate :: ItemSetter DateStringSource

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

withItemAuthor :: ItemSetter StringSource

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

withItemCommentLink :: ItemSetter StringSource

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

withItemEnclosure :: String -> Maybe String -> ItemSetter (Maybe Integer)Source

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

withItemFeedLink :: String -> ItemSetter StringSource

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

withItemId :: Bool -> ItemSetter StringSource

'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 StringSource

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

withItemRights :: ItemSetter StringSource

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