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

Stabilityprovisional
MaintainerSigbjorn Finne <sof@galois.com>

Text.RSS.Syntax

Contents

Description

Description: The basic syntax for putting together feeds. For instance, to create a feed with a single item item: (nullRSS "rss title" "link") {rssChannel=(nullChannel "channel title" "link") {rssItems=[(nullItem "item title")]}}

Synopsis

Core Types

data RSS

Constructors

RSS 

Fields

rssVersion :: String
 
rssAttrs :: [Attr]
 
rssChannel :: RSSChannel
 
rssOther :: [Element]
 

Instances

Show RSS 

type URLString = String

type DateString = String

RFC 822 conforming.

data RSSChannel

Constructors

RSSChannel 

Fields

rssTitle :: String
 
rssLink :: URLString
 
rssDescription :: String
 
rssItems :: [RSSItem]
 
rssLanguage :: Maybe String
 
rssCopyright :: Maybe String
 
rssEditor :: Maybe String
 
rssWebMaster :: Maybe String
 
rssPubDate :: Maybe DateString

rfc 822 conforming.

rssLastUpdate :: Maybe DateString

rfc 822 conforming.

rssCategories :: [RSSCategory]
 
rssGenerator :: Maybe String
 
rssDocs :: Maybe URLString
 
rssCloud :: Maybe RSSCloud
 
rssTTL :: Maybe Integer
 
rssImage :: Maybe RSSImage
 
rssRating :: Maybe String
 
rssTextInput :: Maybe RSSTextInput
 
rssSkipHours :: Maybe [Integer]
 
rssSkipDays :: Maybe [String]
 
rssChannelOther :: [Element]
 

Instances

Show RSSChannel 

data RSSItem

Constructors

RSSItem 

Fields

rssItemTitle :: Maybe String
 
rssItemLink :: Maybe URLString
 
rssItemDescription :: Maybe String

if not present, the title is. (per spec, at least.)

rssItemAuthor :: Maybe String
 
rssItemCategories :: [RSSCategory]
 
rssItemComments :: Maybe URLString
 
rssItemEnclosure :: Maybe RSSEnclosure
 
rssItemGuid :: Maybe RSSGuid
 
rssItemPubDate :: Maybe DateString
 
rssItemSource :: Maybe RSSSource
 
rssItemAttrs :: [Attr]
 
rssItemOther :: [Element]
 

Instances

Show RSSItem 

data RSSSource

Constructors

RSSSource 

Fields

rssSourceURL :: URLString
 
rssSourceAttrs :: [Attr]
 
rssSourceTitle :: String
 

Instances

Show RSSSource 

data RSSEnclosure

Constructors

RSSEnclosure 

Instances

data RSSCategory

Constructors

RSSCategory 

Fields

rssCategoryDomain :: Maybe String
 
rssCategoryAttrs :: [Attr]
 
rssCategoryValue :: String
 

Instances

data RSSGuid

Constructors

RSSGuid 

Fields

rssGuidPermanentURL :: Maybe Bool
 
rssGuidAttrs :: [Attr]
 
rssGuidValue :: String
 

Instances

Show RSSGuid 

data RSSImage

Constructors

RSSImage 

Fields

rssImageURL :: URLString
 
rssImageTitle :: String
 
rssImageLink :: URLString
 
rssImageWidth :: Maybe Integer
 
rssImageHeight :: Maybe Integer
 
rssImageDesc :: Maybe String
 
rssImageOther :: [Element]
 

Instances

Show RSSImage 

data RSSCloud

Constructors

RSSCloud 

Fields

rssCloudDomain :: Maybe String
 
rssCloudPort :: Maybe String
 
rssCloudPath :: Maybe String
 
rssCloudRegister :: Maybe String
 
rssCloudProtocol :: Maybe String
 
rssCloudAttrs :: [Attr]
 

Instances

Show RSSCloud 

data RSSTextInput

Constructors

RSSTextInput 

Fields

rssTextInputTitle :: String
 
rssTextInputDesc :: String
 
rssTextInputName :: String
 
rssTextInputLink :: URLString
 
rssTextInputAttrs :: [Attr]
 
rssTextInputOther :: [Element]
 

Instances

Default Constructors:

nullRSS

Arguments

:: String

channel title

-> URLString

channel link

-> RSS 

nullChannel

Arguments

:: String

rssTitle

-> URLString

rssLink

-> RSSChannel 

nullItem

Arguments

:: String

title

-> RSSItem 

nullSource

Arguments

:: URLString

source URL

-> String

title

-> RSSSource 

nullEnclosure

Arguments

:: URLString

enclosure URL

-> Integer

enclosure length

-> String

enclosure type

-> RSSEnclosure 

newCategory

Arguments

:: String

category Value

-> RSSCategory 

nullGuid

Arguments

:: String

guid value

-> RSSGuid 

nullPermaGuid

Arguments

:: String

guid value

-> RSSGuid 

nullImage

Arguments

:: URLString

imageURL

-> String

imageTitle

-> URLString

imageLink

-> RSSImage 

nullTextInput

Arguments

:: String

inputTitle

-> String

inputName

-> URLString

inputLink

-> RSSTextInput