Ocsigen - Reference manual

Ocsigen

Persistent data, writing in the logs, configuration file extension, Xhtml pretty printing


Ocsipersist
Persistent data on hard disk.
Ocsigen_messages
Writing messages in the logs
Ocsigen_parseconfig
Config file parsing
Simplexmlparser
Basic camlp4 parser for xml
Xhtmlpretty
XHTML pretty printing
Xhtmlcompact
XHTML "compact printing" (no pretty printing, no line breaks added)

Extending Ocsigen


Ocsigen_extensions
Writing extensions for Ocsigen
Ocsigen_headers
Getting informations from HTTP header.
Ocsigen_senders
Functions to create results for various kinds of documents
Ocsigen_http_frame
This table is to store cookie values for each path.
Ocsigen_http_client
Using Ocsigen as a HTTP client
Ocsigen_http_com
Sending and receiving HTTP frames
Ocsigen_stream
Streams are a means to read data block by block
Authbasic
Module Authbasic: Basic HTTP Authentication.

Eliom

Main modules


Eliom_services
This module allows to define services.
Eliom_parameters
This module defines the values used to declare the type of service parameters.
Eliom_sessions
This module contains the functions you need to get (or set) information about the request or the session.
Eliom_common
Low level functions for Eliom, exceptions and types.

Generating pages with OcamlDuce


Eliom_duce
Xhtmltypes_duce
Eliom_duce_tools

Generating pages typed with polymorphic variants


Eliom_predefmod.Xhtml
Eliom forms and service registration functions for XHTML
XHTML
Typesafe constructors for XHTML 1.1 documents.
Xhtmltypes
XHTML types with variants.
Eliom_tools
Predefined boxes for Eliom

Other kinds of pages


Eliom_predefmod
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 ...

Creating your own kinds of pages


Eliom_mkforms
This module defines the functor to use to creates modules generating form widgets for your own types of pages.
Eliom_mkreg
This module defines the functor to use to creates modules generating functions to register services for your own types of pages.
Xhtmlpretty
XHTML pretty printing

Indexes

Index of types
Index of exceptions
Index of values
Index of modules
Index of module types