Warning: Reason support is experimental. We are looking for beta-tester and contributors.

Index of modules


A
Action [Registration]

Eliom service registration for services that only execute actions.

Any [Registration]

Eliom service registration for services that choose dynamically what they want to send.

App [Registration]

Functor for application creation.


B
Bus

Broadcasting facilities between clients and server


C
C [Content.Html]

Creation of HTML content from client-side values.

C [Content.Svg]

Creation of content from client-side values.

Channel [Comet]

Basic primitives needed for server push.

Client
Comet

Primitives to push data to the client, without explicit request.

Config

This module makes also possible get information from the configuration file.

Content

This module allows creating valid HTML content, or other XML formats.

Content_sigs
Cscache

Client-server cache for Eliom applications, that is used both for keeping data on client side or keeping values in memory during a request.

CssText [Registration]

Eliom service registration for services that returns CSS.

Custom_data [Content.Html]

Type-safe custom data for HTML.

Customize [Registration]

The Customize functor allows specialization of service registration functions by customizing the page type.


D
D [Tools]

Menus with DOM semantics

D [Content.Html]

Creation of HTML content with DOM semantics (referable, see also Content ).

D [Content.Svg]

Typed interface for building valid SVG tree (DOM semantics).

Down [Eliom_react.S]
Down [Eliom_react]

Event from server to client.


E
Eliom_client_value

Client and shared values

Eliom_common

Low level functions for Eliom, exceptions and types.

Eliom_react

Propagate events occurrences from the server to the client and the other way around.

Eliom_syntax
Eliom_tmpl [Registration]
Eliom_types

Types shared by client and server.

Eliom_uri

Low-level functions for relative or absolute URL calculation.

Ext [State]
Ext [Reference]

This module allows access to references for other groups, sessions, or client processes.

Ext [Reference.Volatile]
Ext [Notif.S]
Extension

Allows Ocsigen's extension to access Eliom data.


F
F [Tools]

Menus with functional node semantics

F [Content.Html]

Creation of Functional HTML5 content (copy-able but not referable, see also Content ).

F [Content.Svg]

Typed interface for building valid SVG tree (functional semantics).

FakeReactiveData [Shared]

This is a dummy ReactiveData module that allows us to refer to client-side ReactiveData types on the server side, without actually linking against ReactiveData.

File [Registration]

Eliom service registration for services that returns file contents.

File_ct [Registration]

Same as file but makes possible to specify the content type for each file.

Flow5 [Registration]

Eliom service registration and forms creation for fragment of HTML page.

Form [Content_sigs.LINKS_AND_FORMS]
Form_sigs
Full_state_name_table [Eliom_common]

H
Html [Registration]

Eliom service registration for services that return HTML pages.

Html [Content]

Building and printing valid HTML5 tree.

Html_text [Registration]

Eliom service registration and forms creation for untyped HTML page.


I
Id [Content.Html]

Node identifiers

Id [Content.Svg]

Node identifiers.

Infix [Shared_sigs.S]

Infix operators


L
Lib

A few common functions used by Eliom.

Low_level [State.Ext]
Lwt [Shared_sigs.RLIST]

Cooperative versions of the ReactiveData operators

Lwt [Shared_sigs.S]

Cooperative versions of the React operators


M
Make [Notif]

Use this functor if you need to customise your notifications with client-specific data (or block notifications for specific clients).

Make [Mkreg]

Creates modules to register services for one type of pages

Make_Simple [Notif]

Use this functor if you have no need of customising your notifications with client-specific data.

Make_poly [Mkreg]

Creating modules to register services for one type of parametrised pages

Mkreg

This module defines the functor to use to creates modules generating functions to register services for your own types of pages.


N
Notif

Server to client notifications.


O
Ocaml [Registration]

Eliom service registration for services that send marshalled OCaml values.

Ocsipersist [Eliom_common]

P
Parameter
Parameter_sigs

Ad-hoc runtime type representation for service parameters.

Printer [Content.Html]

"Polyglot" HTML printer.

Printer [Content.Svg]

SVG printer.


R
R [Content.Html]

Creation of HTML content from shared reactive signals and data (Shared ).

R [Content.Svg]

Creation of SVG content from shared reactive signals and data (Shared ).

RList [Shared.ReactiveData]
RList [Shared.FakeReactiveData]
Raw [Content.Html.D]
Raw [Content.Html.F]
Raw [Content.Svg.R]
Raw [Content.Svg.D]
Raw [Content.Svg.F]
React [Shared]

Shared implementation of React

ReactiveData [Shared]

Shared implementation of ReactiveData

Redirection [Registration]

Eliom service registration for services that returns a redirections towards another service.

Reference

Server side state data, a.k.a Eliom references

Registration

Eliom services registration for various kinds of page content: Eliom application, valid Registration.Html, actions, redirections, static files, ...

Registration_sigs
Request_info

This module contains the functions you need to get (or set) information about current request.


S
S [Shared.React]
S [Eliom_react]
Service

Creation and manipulation of Eliom services.

Service_sigs
Shared

This module implements shared (i.e., client-server) versions of the React and ReactiveData libraries.

Shared_sigs

Accessing shared values

State

Storing server-side values for your applications or sessions.

String [Registration]

Eliom service registration for services that returns "byte"-string contents.

String_redirection [Registration]

Eliom service registration for services that returns a redirections towards a string-URL.

Svg [Content]

Building and pretty-printing valid SVG tree.


T
Tools

Helpers for (hierarchical) menu generation in HTML5.


U
Unit [Registration]

Similar to Actions with `NoReload option.

Up [Eliom_react]

Event from client to server.


V
Value [Shared]

Accessing shared values

Volatile [Reference]

Same functions as in Reference but a non-Lwt interface for non-persistent Eliom references.


W
Wrap

X
Xml [Content]

Low-level XML manipulation.

Xml_shared [Content]