.TH "Atom_feed" 3o 2012-06-11 OCamldoc "" .SH NAME Atom_feed \- Everything we need to make an atom feed. .SH Module Module Atom_feed .SH Documentation .sp Module .BI "Atom_feed" : .B sig end .sp Everything we need to make an atom feed\&. .sp .sp .sp .sp .I type uri = .B Eliom_content_core.Xml.uri .sp .sp .I type lang = .B string .sp .sp .I type base = .B uri .sp .sp .I type ncname = .B string .sp .sp .I type dateConstruct = .B string .sp .sp .I type emailAddress = .B string .sp .sp .I type mediaType = .B string .sp .sp .I type length = .B int .sp .sp .I type href = .B Eliom_content_core.Xml.uri .sp .sp .I type hrefLang = .B string .sp .sp .I type rel = .B string .sp .sp .I type ltitle = .B string .sp .sp .I type scheme = .B string .sp .sp .I type label = .B string .sp .sp .I type term = .B string .sp .sp .I type metaAttr = .B [ `Base of base | `Lang of lang ] .sp Common optional attributes .sp .sp .I type personConstruct = .B [ `Email of emailAddress | `Uri of uri ] .sp Children tags allowed for the author and contributor tags .sp .sp .I type author .sp .sp .I type contributor .sp .sp .I type generator .sp .sp .I type id .sp .sp .I type icon .sp .sp .I type category .sp .sp .I type link .sp .sp .I type logo .sp .sp .I type published .sp .sp .I type updated .sp .sp .I type source .sp .sp .I type entry .sp .sp .I type feed .sp .sp .I type content .sp .sp .I type textConstruct .sp .sp .I type linkOAttr = .B [ `Base of base .B | `Hrefl of hrefLang .B | `Lang of lang .B | `Length of length .B | `Medtype of mediaType .B | `Rel of rel .B | `Title of ltitle .B | `Type of string ] .sp Children tags allowed for the link tag .sp .sp .I type sourceOAttr = .B [ `Authors of author list .B | `Base of base .B | `Cats of category list .B | `Contribs of contributor list .B | `Gen of generator .B | `Icon of icon .B | `Lang of lang .B | `Links of link list .B | `Logo of logo .B | `Rights of textConstruct .B | `Sub of textConstruct ] .sp Children tags allowed for the source tag .sp .sp .I type entryOAttr = .B [ `Authors of author list .B | `Base of base .B | `Cats of category list .B | `Content of content .B | `Contribs of contributor list .B | `Lang of lang .B | `Links of link list .B | `Pub of published .B | `Rights of textConstruct .B | `Source of source .B | `Sum of textConstruct ] .sp Children tags allowed for the entry tag .sp .sp .I type feedOAttr = .B [ `Authors of author list .B | `Base of base .B | `Cats of category list .B | `Contribs of contributor list .B | `Gen of generator .B | `Icon of icon .B | `Lang of lang .B | `Links of link list .B | `Logo of logo .B | `Rights of textConstruct .B | `Sub of textConstruct ] .sp Children tags allowed for the feed tag .sp .sp .I val xml_of_feed : .B feed -> Eliom_content_core.Xml.elt .sp .sp .I val inlineC : .B ?meta:[> metaAttr ] list -> .B ?html:bool -> string list -> [> `Content of content ] .sp An inline text or html content .sp .sp .I val xhtmlC : .B ?meta:[> metaAttr ] list -> .B [ `A .B | `Abbr .B | `Acronym .B | `Address .B | `B .B | `Bdo .B | `Big .B | `Blockquote .B | `Br .B | `Button .B | `Cite .B | `Code .B | `Del .B | `Dfn .B | `Div .B | `Dl .B | `Em .B | `Fieldset .B | `Form .B | `H1 .B | `H2 .B | `H3 .B | `H4 .B | `H5 .B | `H6 .B | `Hr .B | `I .B | `Iframe .B | `Img .B | `Input .B | `Ins .B | `Kbd .B | `Label .B | `Map .B | `Noscript .B | `Object .B | `Ol .B | `P .B | `PCDATA .B | `Pre .B | `Q .B | `Ruby_complex .B | `Ruby_simple1 .B | `Ruby_simple2 .B | `Samp .B | `Script .B | `Select .B | `Small .B | `Span .B | `Strong .B | `Sub .B | `Sup .B | `Table .B | `Textarea .B | `Tt .B | `Ul .B | `Var ] Eliom_content_core.Xhtml.F.elt list -> .B [> `Content of content ] .sp An xhtml content, embedded in a div .sp .sp .I val inlineOtherC : .B ?meta:[> metaAttr ] list -> .B string * Eliom_content_core.Xml.elt list -> .B [> `Content of content ] .sp Inline content from another kind .sp .sp .I val outOfLineC : .B ?meta:[> metaAttr ] list -> .B string * uri -> [> `Content of content ] .sp Every other content .sp .sp .I val plain : .B ?meta:[> metaAttr ] list -> .B ?html:bool -> string -> textConstruct .sp Plain text construct .sp .sp .I val xhtml : .B ?meta:[> metaAttr ] list -> .B [ `A .B | `Abbr .B | `Acronym .B | `Address .B | `B .B | `Bdo .B | `Big .B | `Blockquote .B | `Br .B | `Button .B | `Cite .B | `Code .B | `Del .B | `Dfn .B | `Div .B | `Dl .B | `Em .B | `Fieldset .B | `Form .B | `H1 .B | `H2 .B | `H3 .B | `H4 .B | `H5 .B | `H6 .B | `Hr .B | `I .B | `Iframe .B | `Img .B | `Input .B | `Ins .B | `Kbd .B | `Label .B | `Map .B | `Noscript .B | `Object .B | `Ol .B | `P .B | `PCDATA .B | `Pre .B | `Q .B | `Ruby_complex .B | `Ruby_simple1 .B | `Ruby_simple2 .B | `Samp .B | `Script .B | `Select .B | `Small .B | `Span .B | `Strong .B | `Sub .B | `Sup .B | `Table .B | `Textarea .B | `Tt .B | `Ul .B | `Var ] Eliom_content_core.Xhtml.F.elt list -> textConstruct .sp XHTML text construct .sp .sp .I val rights : .B textConstruct -> [> `Rights of textConstruct ] .sp Rights tag .sp .sp .I val subtitle : .B textConstruct -> [> `Sub of textConstruct ] .sp Subtitle tag .sp .sp .I val summary : .B textConstruct -> [> `Sum of textConstruct ] .sp Summary tag .sp .sp .I val feed : .B updated:CalendarLib.Calendar.t -> .B id:uri -> .B title:textConstruct -> .B ?fields:[> feedOAttr ] list -> .B entry list -> feed .sp Feed tag .sp .sp .I val entry : .B updated:CalendarLib.Calendar.t -> .B id:uri -> .B title:textConstruct -> .B [> entryOAttr ] list -> entry .sp Entry tag .sp .sp .I val source : .B updated:CalendarLib.Calendar.t -> .B id:uri -> .B title:textConstruct -> .B [> sourceOAttr ] list -> [> `Source of source ] .sp Source tag .sp .sp .I val link : .B ?elt:[> linkOAttr ] list -> href -> link .sp Link tag .sp .sp .I val links : .B link list -> [> `Links of link list ] .sp We need a list of links, this is only a converter from link list to `Links .sp .sp .I val email : .B string -> [> `Email of string ] .sp email tag .sp .sp .I val uri : .B uri -> [> `Uri of uri ] .sp uri tag, basically, simply a converter .sp .sp .I val author : .B ?elt:[> personConstruct ] list -> string -> author .sp author tag .sp .sp .I val authors : .B author list -> [> `Authors of author list ] .sp We need a list of authors, this is only a converter from author list to `Authors .sp .sp .I val contributor : .B ?elt:[> personConstruct ] list -> string -> contributor .sp contributor tag .sp .sp .I val contributors : .B contributor list -> [> `Contribs of contributor list ] .sp We need a list of contributors, this is only a converter from contributor list to `Contributors .sp .sp .I val icon : .B uri -> [> `Icon of icon ] .sp icon tag, basically, simply a converter .sp .sp .I val logo : .B uri -> [> `Logo of logo ] .sp logo tag, basically, simply a converter .sp .sp .I val category : .B ?meta:[> metaAttr ] list -> .B ?scheme:scheme -> .B ?label:label -> .B term -> Eliom_content_core.Xml.elt list -> category .sp category tag .sp .sp .I val categories : .B category list -> [> `Cats of category list ] .sp We need a list of categories, this is only a converter from category list to `Categories .sp .sp .I val published : .B CalendarLib.Calendar.t -> [> `Pub of published ] .sp .sp .I val insert_hub_links : .B uri list -> feed -> feed .sp Technically not used elsewhere than in eliom_feed\&.ml, since the links tags related to each hub are added when registering the feed\&. .sp .sp