Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package yocaml_syndication
Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Module Yocaml_syndication.Rss2Source
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.
Type describing days (for skip days).
Type describing the cloud protocol.
Type describing the cloud attribute.
Type describing the enclosure attribute.
Type describing the guid attribute.
Type describing the guid inference attribute.
Type describing the source attribute.
Type describing the image attribute.
Type describing an item.
Construction of elements
Source
val cloud :
protocol:cloud_protocol ->
domain:string ->
port:int ->
path:string ->
register_procedure:string ->
cloudType describing the cloud attribute.
Type describing the enclosure attribute.
Infer GUID from the item title.
Infer GUID from the item url.
Build a guid.
Source
val image :
title:string ->
link:string ->
?description:string ->
?width:int ->
?height:int ->
url:string ->
unit ->
imageBuild an image.
Source
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
Source
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
Source
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.
Source
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.