feed-0.3.7: Interfacing with RSS (v 0.9x, 2.x, 1.0) + Atom feeds.Source codeContentsIndex
Text.RSS.Syntax
Stabilityprovisional
MaintainerSigbjorn Finne <sof@galois.com>
Contents
Core Types
Default Constructors:
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
data RSS = RSS {
rssVersion :: String
rssAttrs :: [Attr]
rssChannel :: RSSChannel
rssOther :: [Element]
}
type URLString = String
type DateString = String
data RSSChannel = RSSChannel {
rssTitle :: String
rssLink :: URLString
rssDescription :: String
rssItems :: [RSSItem]
rssLanguage :: Maybe String
rssCopyright :: Maybe String
rssEditor :: Maybe String
rssWebMaster :: Maybe String
rssPubDate :: Maybe DateString
rssLastUpdate :: Maybe DateString
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]
}
data RSSItem = RSSItem {
rssItemTitle :: Maybe String
rssItemLink :: Maybe URLString
rssItemDescription :: Maybe String
rssItemAuthor :: Maybe String
rssItemCategories :: [RSSCategory]
rssItemComments :: Maybe URLString
rssItemEnclosure :: Maybe RSSEnclosure
rssItemGuid :: Maybe RSSGuid
rssItemPubDate :: Maybe DateString
rssItemSource :: Maybe RSSSource
rssItemAttrs :: [Attr]
rssItemOther :: [Element]
}
data RSSSource = RSSSource {
rssSourceURL :: URLString
rssSourceAttrs :: [Attr]
rssSourceTitle :: String
}
data RSSEnclosure = RSSEnclosure {
rssEnclosureURL :: URLString
rssEnclosureLength :: Integer
rssEnclosureType :: String
rssEnclosureAttrs :: [Attr]
}
data RSSCategory = RSSCategory {
rssCategoryDomain :: Maybe String
rssCategoryAttrs :: [Attr]
rssCategoryValue :: String
}
data RSSGuid = RSSGuid {
rssGuidPermanentURL :: Maybe Bool
rssGuidAttrs :: [Attr]
rssGuidValue :: String
}
data RSSImage = RSSImage {
rssImageURL :: URLString
rssImageTitle :: String
rssImageLink :: URLString
rssImageWidth :: Maybe Integer
rssImageHeight :: Maybe Integer
rssImageDesc :: Maybe String
rssImageOther :: [Element]
}
data RSSCloud = RSSCloud {
rssCloudDomain :: Maybe String
rssCloudPort :: Maybe String
rssCloudPath :: Maybe String
rssCloudRegister :: Maybe String
rssCloudProtocol :: Maybe String
rssCloudAttrs :: [Attr]
}
data RSSTextInput = RSSTextInput {
rssTextInputTitle :: String
rssTextInputDesc :: String
rssTextInputName :: String
rssTextInputLink :: URLString
rssTextInputAttrs :: [Attr]
rssTextInputOther :: [Element]
}
nullRSS :: String -> URLString -> RSS
nullChannel :: String -> URLString -> RSSChannel
nullItem :: String -> RSSItem
nullSource :: URLString -> String -> RSSSource
nullEnclosure :: URLString -> Integer -> String -> RSSEnclosure
newCategory :: String -> RSSCategory
nullGuid :: String -> RSSGuid
nullPermaGuid :: String -> RSSGuid
nullImage :: URLString -> String -> URLString -> RSSImage
nullCloud :: RSSCloud
nullTextInput :: String -> String -> URLString -> RSSTextInput
Core Types
data RSS Source
Constructors
RSS
rssVersion :: String
rssAttrs :: [Attr]
rssChannel :: RSSChannel
rssOther :: [Element]
type URLString = StringSource
type DateString = StringSource
RFC 822 conforming.
data RSSChannel Source
Constructors
RSSChannel
rssTitle :: String
rssLink :: URLString
rssDescription :: String
rssItems :: [RSSItem]
rssLanguage :: Maybe String
rssCopyright :: Maybe String
rssEditor :: Maybe String
rssWebMaster :: Maybe String
rssPubDate :: Maybe DateStringrfc 822 conforming.
rssLastUpdate :: Maybe DateStringrfc 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]
data RSSItem Source
Constructors
RSSItem
rssItemTitle :: Maybe String
rssItemLink :: Maybe URLString
rssItemDescription :: Maybe Stringif 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]
data RSSSource Source
Constructors
RSSSource
rssSourceURL :: URLString
rssSourceAttrs :: [Attr]
rssSourceTitle :: String
data RSSEnclosure Source
Constructors
RSSEnclosure
rssEnclosureURL :: URLString
rssEnclosureLength :: Integer
rssEnclosureType :: String
rssEnclosureAttrs :: [Attr]
data RSSCategory Source
Constructors
RSSCategory
rssCategoryDomain :: Maybe String
rssCategoryAttrs :: [Attr]
rssCategoryValue :: String
data RSSGuid Source
Constructors
RSSGuid
rssGuidPermanentURL :: Maybe Bool
rssGuidAttrs :: [Attr]
rssGuidValue :: String
data RSSImage Source
Constructors
RSSImage
rssImageURL :: URLString
rssImageTitle :: String
rssImageLink :: URLString
rssImageWidth :: Maybe Integer
rssImageHeight :: Maybe Integer
rssImageDesc :: Maybe String
rssImageOther :: [Element]
data RSSCloud Source
Constructors
RSSCloud
rssCloudDomain :: Maybe String
rssCloudPort :: Maybe String
rssCloudPath :: Maybe String
rssCloudRegister :: Maybe String
rssCloudProtocol :: Maybe String
rssCloudAttrs :: [Attr]
data RSSTextInput Source
Constructors
RSSTextInput
rssTextInputTitle :: String
rssTextInputDesc :: String
rssTextInputName :: String
rssTextInputLink :: URLString
rssTextInputAttrs :: [Attr]
rssTextInputOther :: [Element]
Default Constructors:
nullRSSSource
:: Stringchannel title
-> URLStringchannel link
-> RSS
nullChannelSource
:: StringrssTitle
-> URLStringrssLink
-> RSSChannel
nullItemSource
:: Stringtitle
-> RSSItem
nullSourceSource
:: URLStringsource URL
-> Stringtitle
-> RSSSource
nullEnclosureSource
:: URLStringenclosure URL
-> Integerenclosure length
-> Stringenclosure type
-> RSSEnclosure
newCategorySource
:: Stringcategory Value
-> RSSCategory
nullGuidSource
:: Stringguid value
-> RSSGuid
nullPermaGuidSource
:: Stringguid value
-> RSSGuid
nullImageSource
:: URLStringimageURL
-> StringimageTitle
-> URLStringimageLink
-> RSSImage
nullCloud :: RSSCloudSource
nullTextInputSource
:: StringinputTitle
-> StringinputName
-> URLStringinputLink
-> RSSTextInput
Produced by Haddock version 2.6.0