Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package yocaml_syndication
Implementation of the RSS2 specification, documented here: specs.
Types
Types that briefly describe the RSS 2 specification. As the channel is closely linked to the description of a feed, the module does not export a channel type, as it is constructed when the feed is built.
Construction of elements
val cloud :
protocol:cloud_protocol ->
domain:string ->
port:int ->
path:string ->
register_procedure:string ->
cloudType describing the cloud attribute.
val enclosure :
url:string ->
media_type:Media_type.t ->
length:int ->
enclosureType describing the enclosure attribute.
val guid_from_title : guid_strategyInfer GUID from the item title.
val guid_from_link : guid_strategyInfer GUID from the item url.
val guid : is_permalink:bool -> string -> guid_strategyBuild a guid.
val source : title:string -> url:string -> sourceBuild a sourcee.
val image :
title:string ->
link:string ->
?description:string ->
?width:int ->
?height:int ->
url:string ->
unit ->
imageBuild an image.
val item :
?author:Person.t ->
?categories:Category.t list ->
?comments:string ->
?enclosure:enclosure ->
?guid:guid_strategy ->
?pub_date:Datetime.t ->
?source:source ->
title:string ->
link:string ->
description:string ->
unit ->
itemBuild an item.
Building a feed
val feed :
?encoding:string ->
?standalone:bool ->
?language:Lang.t ->
?copyright:string ->
?managing_editor:Person.t ->
?webmaster:Person.t ->
?pub_date:Datetime.t ->
?last_build_date:Datetime.t ->
?categories:Category.t list ->
?generator:Generator.t ->
?cloud:cloud ->
?ttl:int ->
?image:(title:string -> link:string -> image) ->
?text_input:Text_input.t ->
?skip_hours:int list ->
?skip_days:days list ->
title:string ->
link:string ->
url:string ->
description:string ->
('a -> item) ->
'a list ->
Xml.tBuild a RSS2 feed.
Arrows for building a feed
val from :
?encoding:string ->
?standalone:bool ->
?language:Lang.t ->
?copyright:string ->
?managing_editor:Person.t ->
?webmaster:Person.t ->
?pub_date:Datetime.t ->
?last_build_date:Datetime.t ->
?categories:Category.t list ->
?generator:Generator.t ->
?cloud:cloud ->
?ttl:int ->
?image:(title:string -> link:string -> image) ->
?text_input:Text_input.t ->
?skip_hours:int list ->
?skip_days:days list ->
title:string ->
site_url:string ->
feed_url:string ->
description:string ->
('a -> item) ->
('a list, string) Yocaml.Task.tAn arrow that build a feed that from an arbitrary list.
val from_articles :
?encoding:string ->
?standalone:bool ->
?language:Lang.t ->
?copyright:string ->
?managing_editor:Person.t ->
?webmaster:Person.t ->
?pub_date:Datetime.t ->
?categories:Category.t list ->
?generator:Generator.t ->
?cloud:cloud ->
?ttl:int ->
?image:(title:string -> link:string -> image) ->
?text_input:Text_input.t ->
?skip_hours:int list ->
?skip_days:days list ->
title:string ->
site_url:string ->
feed_url:string ->
description:string ->
unit ->
((Yocaml.Path.t * Yocaml.Archetype.Article.t) list, string) Yocaml.Task.tAn arrow that build a feed that fit with Yocaml.Archetype.Articles.fetch. link is concatenate with the given path to compute the link of an item.