package yocaml_syndication

  1. Overview
  2. Docs
Yocaml plugin for dealing with RSS and Atom feed

Install 

dune-project
 Dependency

github.com Readme Changelog Edit opam file Versions (10)

Authors

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Maintainers

  1. T
    The XHTMLBoy <xhtmlboi@gmail.com>

Sources

yocaml-2.6.0.tbz
sha256=a006e9d52e520986d4262dfe7bfeba6a381f1423be32409494888d667d14ac73
sha512=8a25f1776e0bcd5e317484b681c67b0d6bb60952f0dd0942f44bf708fb3db03331522b4d8929e09c1926b213003bf14bb148468ddde35add0ad657b4d9237bd1

doc/yocaml_syndication/Yocaml_syndication/Rss1/index.html

Module Yocaml_syndication.Rss1Source

Implementation of the RSS1 specification, documented here: specs. RSS2 or Atom are to be preferred, but RSS1 is present for historical reasons (if a user does not want to migrate his feed).

As this specification is not widely recommended, no additional modules are implemented.

Types

Types that briefly describe the RSS 1 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.

Sourcetype image

Type describing an image associated with the feed.

Sourcetype item

Type describing an item.

Construction of elements

Sourceval image : title:string -> link:string -> url:string -> image

Build an image.

Sourceval item : title:string -> link:string -> description:string -> item

Build an item.

Building a feed

Sourceval feed : ?encoding:string -> ?standalone:bool -> ?image:image -> ?textinput:Text_input.t -> title:string -> url:string -> link:string -> description:string -> ('a -> item) -> 'a list -> Xml.t

Build a RSS1`feed. url is the rdf identifier of the feed (usually the url of the feed) and link is the link of the website attached to the feed.

Arrows for building a feed

Sourceval from : ?encoding:string -> ?standalone:bool -> ?image:image -> ?textinput:Text_input.t -> title:string -> url:string -> link:string -> description:string -> ('a -> item) -> ('a list, string) Yocaml.Task.t

An arrow that build a feed that from an arbitrary list.

Sourceval from_articles : ?encoding:string -> ?standalone:bool -> ?image:image -> ?textinput:Text_input.t -> title:string -> feed_url:string -> site_url:string -> description:string -> unit -> ((Yocaml.Path.t * Yocaml.Archetype.Article.t) list, string) Yocaml.Task.t

An arrow that build a feed that fit with Yocaml.Archetype.Articles.fetch.