Reference manual

Version 0.99.5

Index

Lwt

Eliom

Main modules

Pages with Ocamlduce

XHTML pages typed with variants

Other pages

Eliompredefmod

Creating new kinds of pages

Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

Module Eliompredefmod

module Eliompredefmod: sig .. end

This modules contains predefined modules for generating forms and registering handlers, for several types of pages: XHTML pages typed with polymorphic variants, untyped (text) pages, actions, redirections, files ...

module type ELIOMSIG = sig .. end

The signature of such modules.

Module for registering Xhtml pages typed with polymorphic variants using `XHTML.M`

Creating links and forms

module type XHTMLFORMSSIG = sig .. end

Forms and registration functions

module Xhtml: sig .. end

Eliom forms and service registration functions for XHTML

Module to register subpages of type `block`

module Blocks: sig .. end

Use this module for example for XMLHttpRequests for block tags (e.g.

Functor to create modules to register subpages for other subtypes of XHTML

module SubXhtml: functor (T : sigtype content 
end) -> sig .. end

Untyped pages

module HtmlText: ELIOMSIG  with type page = stringand type form_content_elt = stringand type form_content_elt_list = stringand type form_elt = string and type a_content_elt = string and type a_content_elt_list = string and type a_elt = string and type a_elt_list = string and type div_content_elt = string and type div_content_elt_list = string and type uri = string and type link_elt = string and type script_elt = string and type textarea_elt = string and type select_elt = string and type input_elt = string and type pcdata_elt = string and type a_attrib_t = string and type form_attrib_t = string and type input_attrib_t = string and type textarea_attrib_t = string and type select_attrib_t = string and type link_attrib_t = string and type script_attrib_t = string and type input_type_t = string

Module to create forms and register untyped HTML pages

module CssText: Eliommkreg.ELIOMREGSIG  with type page = string

Module to register untyped CSS pages

module Text: Eliommkreg.ELIOMREGSIG  with type page = string * string

Module to register untyped text pages

Other kinds of services

module Actions: Eliommkreg.ELIOMREGSIG  with   type page = exn list

Actions do not generate any page.

module Unit: Eliommkreg.ELIOMREGSIG  with   type page = unit

Like actions, but the page is not reloaded.

module Redirections: Eliommkreg.ELIOMREGSIG  with   type page = string

Allows to create redirections towards other URLs.

module TempRedirections: Eliommkreg.ELIOMREGSIG  with   type page = string

Allows to create temporary redirections towards other URLs.

module Files: Eliommkreg.ELIOMREGSIG  with   type page = string

Allows to send files.

module Any: Eliommkreg.ELIOMREGSIG  with   type page = Eliomservices.result_to_send

Allows to create services that choose dynamically what they want to send.

module Streamlist: Eliommkreg.ELIOMREGSIG  with   type page = (((unit -> string Ocsistream.t Lwt.t) list) *                  string)

Allows to send raw data using Ocsigen's streams.