Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source
Page
Library
Module
Module type
Parameter
Class
Class type
Source
package yocaml_syndication
Module Yocaml_syndication.AtomSource
Implementation of the ATOM specification, documented here: specs.
Types
Types that briefly describe the Atom specification.
A Text construct contains human-readable text, usually in small quantities. The content of Text constructs is Language-Sensitive.
Define the kind of a link. Formally the rel attribute.
Defines a reference from an entry or feed to a Web resource. This specification assigns no meaning to the content (if any) of this element.
If an entry is copied from one feed into another feed, then the source feed's metadata (all child elements of feed other than the atom:entry elements) MAY be preserved within the copied entry by adding an source child element, if it is not already present in the entry, and including some or all of the source feed's Metadata elements as the source element's children. Such metadata SHOULD be preserved if the source feed contains any of the child elements author, contributor, rights, or category and those child elements are not present in the source entry.
The content element either contains or links to the content of the entry. The content of atom:content is Language-Sensitive.
The "entry" element represents an individual entry, acting as a container for metadata and data associated with the entry. This element can appear as a child of the feed element, or it can appear as the document (i.e., top-level) element of a stand-alone Atom Entry Document.
Defines how the feed's updated field will be calculated.
Construction of elements
Text Construct
A Text construct contains human-readable text, usually in small quantities. The content of Text constructs is Language-Sensitive.
text s constructs an element of type text_construct textual.
html s constructs an element of type text_construct HTML.
xhtml ?need_prefix s constructs an element of type text_construct XHTML. If need_prefix is true, every children of the given node will be prefixed by the xhtml namespace.
Links
Defines a reference from an entry or feed to a Web resource. This specification assigns no meaning to the content (if any) of this element.
Source
val link :
?rel:link_rel ->
?media_type:Media_type.t ->
?hreflang:string ->
?length:int ->
?title:string ->
string ->
linkConstructs a link (an external source).
Source
val alternate :
?media_type:Media_type.t ->
?hreflang:string ->
?length:int ->
?title:string ->
string ->
linkalternate is link ~rel:Alternate.
related is link ~rel:related.
Source
val self :
?media_type:Media_type.t ->
?hreflang:string ->
?length:int ->
?title:string ->
string ->
linkself is link ~rel:Self.
Source
val enclosure :
?media_type:Media_type.t ->
?hreflang:string ->
?length:int ->
?title:string ->
string ->
linkenclosure is link ~rel:enclosure.
Source
val via :
?media_type:Media_type.t ->
?hreflang:string ->
?length:int ->
?title:string ->
string ->
linkvia is link ~rel:Via.
Source
If an entry is copied from one feed into another feed, then the source feed's metadata (all child elements of feed other than the entry elements) MAY be preserved within the copied entry by adding an source child element, if it is not already present in the entry, and including some or all of the source feed's Metadata elements as the source element's children. Such metadata SHOULD be preserved if the source feed contains any of the child elements author, contributor, rights, or category and those child elements are not present in the source entry.
Source
val source :
?subtitle:text_construct ->
?contributors:Person.t list ->
?categories:Category.t list ->
?generator:Generator.t option ->
?icon:string ->
?logo:string ->
?links:link list ->
?rights:text_construct ->
?updated:Datetime.t ->
?title:text_construct ->
?authors:Person.t list ->
?id:string ->
unit ->
sourceConstruct a source.
Content
The content element either contains or links to the content of the entry. The content of content is Language-Sensitive.
content_xhtml ?need_prefix s constructs an XHTML content (like xhtml).
content_mime ?media_type value constructs a mime content.
content_src ?media_type uri constructs a source content.
Entry
The "entry" element represents an individual entry, acting as a container for metadata and data associated with the entry. This element can appear as a child of the feed element, or it can appear as the document (i.e., top-level) element of a stand-alone Atom Entry Document.
Source
val entry :
?authors:Person.t list ->
?contributors:Person.t list ->
?links:link list ->
?categories:Category.t list ->
?published:Datetime.t ->
?rights:text_construct ->
?source:source ->
?summary:text_construct ->
?content:content ->
title:text_construct ->
id:string ->
updated:Datetime.t ->
unit ->
entryConstructs an entry.
Building a feed
Uses entries to describe the last update date. If no entry is provided, the date provisioned by default_value will be used.
Use a fixed updated value.
Source
val feed :
?encoding:string ->
?standalone:bool ->
?subtitle:text_construct ->
?contributors:Person.t list ->
?categories:Category.t list ->
?generator:Generator.t option ->
?icon:string ->
?logo:string ->
?links:link list ->
?rights:text_construct ->
updated:updated_strategy ->
title:text_construct ->
authors:Person.t Yocaml.Nel.t ->
id:string ->
('a -> entry) ->
'a list ->
Xml.tBuild an Atom feed.
Arrows for building a feed
Source
val from :
?encoding:string ->
?standalone:bool ->
?subtitle:text_construct ->
?contributors:Person.t list ->
?categories:Category.t list ->
?generator:Generator.t option ->
?icon:string ->
?logo:string ->
?links:link list ->
?rights:text_construct ->
updated:updated_strategy ->
title:text_construct ->
authors:Person.t Yocaml.Nel.t ->
id:string ->
('a -> entry) ->
('a list, string) Yocaml.Task.tAn arrow that build a feed that from an arbitrary list.
Source
val from_articles :
?encoding:string ->
?standalone:bool ->
?subtitle:text_construct ->
?contributors:Person.t list ->
?categories:Category.t list ->
?generator:Generator.t option ->
?icon:string ->
?logo:string ->
?links:link list ->
?rights:text_construct ->
?updated:updated_strategy ->
?id:string ->
site_url:string ->
feed_url:string ->
title:text_construct ->
authors:Person.t Yocaml.Nel.t ->
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 url of an item.