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.0.0.tbz
sha256=fddf61500e828ac88d86ba982084cc817299302082a6e797b36787ff18235ec2
sha512=8b71a8cecd3e101df55eef0bba7a24d4dde9d66b5ecedd9f6d55834fcdc8d33fd875092ca73a398e1715664caee06cdc1bdb1b4da85bff0a687faac5c0445023

doc/yocaml_syndication/Yocaml_syndication/Opml/index.html

Module Yocaml_syndication.OpmlSource

Implementation of the OPML (1 and 2) specification documented here:

In fact, a document complying with the OPML2 specification is broadly compatible with specification 1, so it is recommended to use specification 2.

Types

Sourcetype t

Describes an OPML feed.

Sourcetype outline

Describes an Outline. An outline is an XML element containing at least one required attribute, text, and zero or more additional attributes. An outline may contain zero or more outline sub-elements. No attribute may be repeated within the same outline element.

Construction of elements

Sourceval outline : ?typ:string -> ?is_comment:bool -> ?is_breakpoint:bool -> ?xml_url:string -> ?html_url:string -> ?attr:Xml.Attr.t list -> ?categories:string list -> ?title:string -> text:string -> outline list -> outline

Describes an Outline. An outline is an XML element containing at least one required attribute, text, and zero or more additional attributes. An outline may contain zero or more outline sub-elements. No attribute may be repeated within the same outline element.

Sourceval inclusion : url:string -> text:string -> outline

Describes a special outlines that can be opened (or included) into an OPML reader.

Sourceval subscription : ?version:string -> ?description:string -> ?html_url:string -> ?language:string -> title:string -> feed_url:string -> unit -> outline

Describes a special outlines that describes a subscription to an RSS/ATOM feed.

Sourceval feed : ?title:string -> ?date_created:Datetime.t -> ?date_modified:Datetime.t -> ?owner:Person.t -> ?expansion_state:int list -> ?vert_scroll_state:int -> ?window_top:int -> ?window_left:int -> ?window_bottom:int -> ?window_right:int -> outline list -> t

Construct a feed of outlines associated with an Head element.

Generating OPML feeds

Sourceval to_opml2 : ?encoding:string -> ?standalone:bool -> t -> Xml.t

Generates an OPML stream in accordance with specification 2.

Sourceval to_opml1 : ?encoding:string -> ?standalone:bool -> t -> Xml.t

Generates an OPML stream in accordance with specification 1.

Arrows for building a feed

Sourceval from : ?title:string -> ?date_created:Datetime.t -> ?date_modified:Datetime.t -> ?owner:Person.t -> ?expansion_state:int list -> ?vert_scroll_state:int -> ?window_top:int -> ?window_left:int -> ?window_bottom:int -> ?window_right:int -> unit -> (outline list, t) Yocaml.Task.t

An arrow that build a feed that from a list of outlines.

Sourceval opml2_from : ?encoding:string -> ?standalone:bool -> ?title:string -> ?date_created:Datetime.t -> ?date_modified:Datetime.t -> ?owner:Person.t -> ?expansion_state:int list -> ?vert_scroll_state:int -> ?window_top:int -> ?window_left:int -> ?window_bottom:int -> ?window_right:int -> unit -> (outline list, string) Yocaml.Task.t

An arrow that build an OPML2 representation that from a list of outlines.

Sourceval opml1_from : ?encoding:string -> ?standalone:bool -> ?title:string -> ?date_created:Datetime.t -> ?date_modified:Datetime.t -> ?owner:Person.t -> ?expansion_state:int list -> ?vert_scroll_state:int -> ?window_top:int -> ?window_left:int -> ?window_bottom:int -> ?window_right:int -> unit -> (outline list, string) Yocaml.Task.t

An arrow that build an OPML1 representation that from a list of outlines.