This is server API (go to client)

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

Index of types


A
a_attrib_t [Eliom_duce_types]
a_attrib_t [Eliom_mkforms.​FORMS_PARAM]
a_content_elt [Eliom_duce_types]
a_content_elt [Eliom_mkforms.​FORMS_PARAM]
a_content_elt_list [Eliom_duce_types]
a_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
a_elt [Eliom_duce_types]
a_elt [Eliom_mkforms.​FORMS_PARAM]
a_elt_list [Eliom_duce_types]
a_elt_list [Eliom_mkforms.​FORMS_PARAM]
a_s [Eliom_services]

You can call register function only on registrable services

acontent [Eliom_pervasives.​XML]
all_scope [Eliom_common]
aname [Eliom_pervasives.​XML]
anyxml [Eliom_duce_types]
appl [Eliom_output.​Eliom_appl]
appl_service [Eliom_output_base]
appl_service [Eliom_output]
appl_service_options [Eliom_output]
application_content [Eliom_output]
application_name [Eliom_output]
attached [Eliom_services]
attached_service_kind [Eliom_services]
attrib [Eliom_pervasives.​XML]
authentication_result [Eliom_openid]

The result of an authentication.

author [Atom_feed]

B
base [Atom_feed]
binsum [Eliom_parameters]

This type is used by some form widgets like Eliom_output.​Html5_forms.​int_button that may be used against services expecting one parameter of that name, or services expecting any number of parameters of that name.

block_content [Eliom_output]
blocks [Eliom_duce_types]
browser_content [Eliom_output]
button_attrib_t [Eliom_duce_types]
button_attrib_t [Eliom_mkforms.​FORMS_PARAM]
button_content_elt [Eliom_duce_types]
button_content_elt [Eliom_mkforms.​FORMS_PARAM]
button_content_elt_list [Eliom_duce_types]
button_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
button_elt [Eliom_duce_types]
button_elt [Eliom_mkforms.​FORMS_PARAM]
button_type_t [Eliom_duce_types]
button_type_t [Eliom_mkforms.​FORMS_PARAM]

C
caml [Eliom_parameters]

suffix_const v is used only inside suffixes (do nothing for regular parameters).

caml_content [Eliom_output]
caml_event [Eliom_pervasives.​XML]
category [Atom_feed]
check_fun [Eliom_openid]

The type of the authenticate function.

client_expr [Eliom_pervasives]
client_process_scope [Eliom_common]
comet_scope [Eliom_comet.​Channels]

v t is the type of server-to-client communication channels transporting data of type v

content [Atom_feed]
contributor [Atom_feed]
cookie [Eliom_cookies]

Type used for cookies to set.

cookie_scope [Eliom_common]

Eliom is using regular (browser) cookies but can also use browser tab cookies (only if you are using a client side program)

cookieset [Eliom_cookies]
coordinates [Eliom_parameters]

coordinates is for the data sent by an <input type="image" ...>.


D
data_session [Eliom_state.​Session_admin]
dateConstruct [Atom_feed]

E
econtent [Eliom_pervasives.​XML]
eliom_extension_sig [Eliom_extensions]
elt [Eliom_pervasives.​XML]
emailAddress [Atom_feed]
ename [Eliom_pervasives.​XML]
entry [Atom_feed]
entryOAttr [Atom_feed]

Children tags allowed for the entry tag

eref [Eliom_references]

The type of Eliom references.

event [Eliom_pervasives.​XML]
extension [Eliom_openid]

An extension yielding values of type 'a


F
feed [Eliom_atom]

Needed when used with Pubsubhubbub

feed [Atom_feed]
feedOAttr [Atom_feed]

Children tags allowed for the feed tag

field [Eliom_openid]

A field you can request to the provider

file_info [Eliom_pervasives]
form_attrib_t [Eliom_duce_types]
form_attrib_t [Eliom_mkforms.​FORMS_PARAM]
form_content_elt [Eliom_duce_types]
form_content_elt [Eliom_mkforms.​FORMS_PARAM]
form_content_elt_list [Eliom_duce_types]
form_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
form_elt [Eliom_duce_types]
form_elt [Eliom_mkforms.​FORMS_PARAM]
fullsessionname [Eliom_common]

G
generator [Atom_feed]
get_page [Eliom_tools_common]
get_service_kind [Eliom_services]
getpost [Eliom_services]
global_scope [Eliom_common]

H
hierarchical_site [Eliom_tools_common]
hierarchical_site_item [Eliom_tools_common]

Hierchical sites

href [Atom_feed]
hrefLang [Atom_feed]
html [Eliom_duce_types]
http_service [Eliom_output_base]
http_service [Eliom_output]

I
icon [Atom_feed]
id [Atom_feed]
input_attrib_t [Eliom_duce_types]
input_attrib_t [Eliom_mkforms.​FORMS_PARAM]
input_elt [Eliom_duce_types]
input_elt [Eliom_mkforms.​FORMS_PARAM]
input_type_t [Eliom_duce_types]
input_type_t [Eliom_mkforms.​FORMS_PARAM]
internal [Eliom_services]
internal_service_kind [Eliom_services]

K
kind [Eliom_output]

L
label [Atom_feed]
lang [Atom_feed]
leftright [Eliom_pervasives]
length [Atom_feed]
link [Atom_feed]
linkOAttr [Atom_feed]

Children tags allowed for the link tag

link_attrib_t [Eliom_duce_types]
link_attrib_t [Eliom_mkforms.​FORMS_PARAM]
link_elt [Eliom_duce_types]
link_elt [Eliom_mkforms.​FORMS_PARAM]
listnames [Eliom_parameters]

Type used for parameters of type bynary sum

logo [Atom_feed]
ltitle [Atom_feed]

M
main_page [Eliom_tools_common]
mediaType [Atom_feed]
metaAttr [Atom_feed]

Common optional attributes


N
na_s [Eliom_services]
ncname [Atom_feed]
nl_params_set [Eliom_parameters]

Use this type to give non localized parameters to a link or a form

no_param_name [Eliom_parameters]

Type for parameters of a web page.

non_caml_service [Eliom_output_base]
non_caml_service [Eliom_output]
non_localized_params [Eliom_parameters]

Non localized parameters

nonattached [Eliom_services]

O
one_page [Eliom_tools_common]

Menus

oneradio [Eliom_parameters]

This type is used by some form widgets like Eliom_output.​Html5_forms.​int_input that may be used against services expecting one parameter of that name, or services expecting an optional parameter of that name, or services expecting any number of parameters of that name.

openid_error [Eliom_openid]

Error that may happen when identifiying an user

optgroup_attrib_t [Eliom_duce_types]
optgroup_attrib_t [Eliom_mkforms.​FORMS_PARAM]
option_attrib_t [Eliom_duce_types]
option_attrib_t [Eliom_mkforms.​FORMS_PARAM]
option_elt [Eliom_duce_types]
option_elt [Eliom_mkforms.​FORMS_PARAM]
option_elt_list [Eliom_duce_types]
option_elt_list [Eliom_mkforms.​FORMS_PARAM]
options [Eliom_duce_sigs.​BLOCKS_REGISTRATION]
options [Eliom_duce_sigs.​XML_LIST_REGISTRATION]
options [Eliom_duce_sigs.​XML_REGISTRATION]
options [Eliom_duce_sigs.​XHTML_REGISTRATION]
options [Eliom_atom.​Reg]
options [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
options [Eliom_mkreg.​REG_PARAM]
options [Eliom_mkreg.​MakeRegister_AlphaReturn]
options [Eliom_mkreg.​MakeRegister]
options [Eliom_output.​Customize]
options [Eliom_output.​Streamlist]
options [Eliom_output.​Any]
options [Eliom_output.​Files]
options [Eliom_output.​String_redirection]
options [Eliom_output.​Redirection]
options [Eliom_output.​Unit]
options [Eliom_output.​Action]
options [Eliom_output.​Text]
options [Eliom_output.​CssText]
options [Eliom_output.​HtmlText]
options [Eliom_output.​Make_TypedXML_Registration]
options [Eliom_output.​Blocks]
options [Eliom_output.​Blocks5]
options [Eliom_output.​Eliom_appl]
options [Eliom_output.​Xhtml_registration]
options [Eliom_output.​Xhtml]
options [Eliom_output.​Html5_registration]
options [Eliom_output.​Html5]

P
page [Eliom_duce_sigs.​BLOCKS_REGISTRATION]
page [Eliom_duce_sigs.​XML_LIST_REGISTRATION]
page [Eliom_duce_sigs.​XML_REGISTRATION]
page [Eliom_duce_sigs.​XHTML_REGISTRATION]
page [Eliom_atom.​Reg]
page [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
page [Eliom_mkreg.​REG_PARAM]
page [Eliom_mkreg.​MakeRegister_AlphaReturn]
page [Eliom_mkreg.​MakeRegister]
page [Eliom_output.​Customize]
page [Eliom_output.​Streamlist]
page [Eliom_output.​Any]
page [Eliom_output.​Files]
page [Eliom_output.​String_redirection]
page [Eliom_output.​Redirection]
page [Eliom_output.​Unit]
page [Eliom_output.​Action]
page [Eliom_output.​Text]
page [Eliom_output.​CssText]
page [Eliom_output.​HtmlText]
page [Eliom_output.​Make_TypedXML_Registration]
page [Eliom_output.​Blocks]
page [Eliom_output.​Blocks5]
page [Eliom_output.​Eliom_appl]
page [Eliom_output.​Xhtml_registration]
page [Eliom_output.​Xhtml]
page [Eliom_output.​Html5_registration]
page [Eliom_output.​Html5]

Service registration

pape [Eliom_openid]

The pape data returned by the server

param_name [Eliom_parameters]

empty type used when it is not possible to use the parameter in a form

params_type [Eliom_parameters]

Types used by the module

path [Eliom_pervasives.​Url]
pcdata_elt [Eliom_duce_types]
pcdata_elt [Eliom_mkforms.​FORMS_PARAM]
persistent_session [Eliom_state.​Session_admin]
persistent_table [Eliom_state]

The type of persistent state data tables.

personConstruct [Atom_feed]

Children tags allowed for the author and contributor tags

poly [Eliom_pervasives]
post_service_kind [Eliom_services]
published [Atom_feed]

R
racontent [Eliom_pervasives.​XML]
raw_input_type_t [Eliom_duce_types]
raw_input_type_t [Eliom_mkforms.​FORMS_PARAM]
ref_tree [Eliom_pervasives.​XML]
registrable [Eliom_services]
rel [Atom_feed]
request [Eliom_lazy]
request_scope [Eliom_common]
result [Eliom_duce_sigs.​BLOCKS_REGISTRATION]
result [Eliom_duce_sigs.​XML_LIST_REGISTRATION]
result [Eliom_duce_sigs.​XML_REGISTRATION]
result [Eliom_duce_sigs.​XHTML_REGISTRATION]
result [Eliom_atom.​Reg]
result [Eliom_openid]

The result yielded by the authentication process

result [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
result [Eliom_mkreg.​REG_PARAM]
result [Eliom_mkreg.​MakeRegister_AlphaReturn]
result [Eliom_mkreg.​MakeRegister]
result [Eliom_output.​Customize]
result [Eliom_output.​Streamlist]
result [Eliom_output.​Any]
result [Eliom_output.​Files]
result [Eliom_output.​String_redirection]
result [Eliom_output.​Redirection]
result [Eliom_output.​Unit]
result [Eliom_output.​Action]
result [Eliom_output.​Text]
result [Eliom_output.​CssText]
result [Eliom_output.​HtmlText]
result [Eliom_output.​Make_TypedXML_Registration]
result [Eliom_output.​Blocks]
result [Eliom_output.​Blocks5]
result [Eliom_output.​Eliom_appl]
result [Eliom_output.​Xhtml_registration]
result [Eliom_output.​Xhtml]
result [Eliom_output.​Html5_registration]
result [Eliom_output.​Html5]
return [Eliom_duce_sigs.​BLOCKS_REGISTRATION]
return [Eliom_duce_sigs.​XML_LIST_REGISTRATION]
return [Eliom_duce_sigs.​XML_REGISTRATION]
return [Eliom_duce_sigs.​XHTML_REGISTRATION]
return [Eliom_atom.​Reg]
return [Eliom_mkreg.​REG_PARAM_ALPHA_RETURN]
return [Eliom_mkreg.​REG_PARAM]
return [Eliom_mkreg.​MakeRegister_AlphaReturn]
return [Eliom_mkreg.​MakeRegister]
return [Eliom_output.​Customize]
return [Eliom_output.​Streamlist]
return [Eliom_output.​Any]
return [Eliom_output.​Files]
return [Eliom_output.​String_redirection]
return [Eliom_output.​Redirection]
return [Eliom_output.​Unit]
return [Eliom_output.​Action]
return [Eliom_output.​Text]
return [Eliom_output.​CssText]
return [Eliom_output.​HtmlText]
return [Eliom_output.​Make_TypedXML_Registration]
return [Eliom_output.​Blocks]
return [Eliom_output.​Blocks5]
return [Eliom_output.​Eliom_appl]
return [Eliom_output.​Xhtml_registration]
return [Eliom_output.​Xhtml]
return [Eliom_output.​Html5_registration]
return [Eliom_output.​Html5]

S
scheme [Atom_feed]
scope [Eliom_common]
scope_name [Eliom_common]

That function cannot be used when the site information is not available, that is, outside a request or the initialisation phase of your Eliom module (while reading the configuration file).

script_attrib_t [Eliom_duce_types]
script_attrib_t [Eliom_mkforms.​FORMS_PARAM]
script_elt [Eliom_duce_types]
script_elt [Eliom_mkforms.​FORMS_PARAM]
select_attrib_t [Eliom_duce_types]
select_attrib_t [Eliom_mkforms.​FORMS_PARAM]
select_content_elt [Eliom_duce_types]
select_content_elt [Eliom_mkforms.​FORMS_PARAM]
select_content_elt_list [Eliom_duce_types]
select_content_elt_list [Eliom_mkforms.​FORMS_PARAM]
select_elt [Eliom_duce_types]
select_elt [Eliom_mkforms.​FORMS_PARAM]
select_opt [Eliom_output_base.​Html5_forms]

The type for <select> options and groups of options.

select_opt [Eliom_duce_sigs.​XHTML_FORMS]

The type for <select> options and groups of options.

select_opt [Eliom_output.​HtmlText]
select_opt [Eliom_output.​Xhtml_forms]
select_opt [Eliom_output.​Xhtml]
select_opt [Eliom_output.​Html5_forms]
select_opt [Eliom_output.​Html5]
select_opt [Eliom_mkforms.​MakeForms]

The type for <select> options and groups of options.

separator [Eliom_pervasives.​XML]
servcoserv [Eliom_services]
server_params [Eliom_types_base]
server_params [Eliom_types]
service [Eliom_services]
service_kind [Eliom_services]
service_session [Eliom_state.​Session_admin]

timeout duration in seconds

session_group_scope [Eliom_common]
session_scope [Eliom_common]
setone [Eliom_parameters]

This type is used by some form widgets like Eliom_output.​Html5_forms.​int_image_input that may be used against services expecting one parameter of that name or services expecting an optional parameter of that name.

setoneradio [Eliom_parameters]

Type for names of page parameters (given to the functions to construct forms, for example in Eliom_output.​Html5_forms.​get_form).

sitedata [Eliom_types_base]
sitedata [Eliom_types]
soption [Eliom_output_base.​Html5_forms]
soption [Eliom_duce_sigs.​XHTML_FORMS]
soption [Eliom_output.​HtmlText]
soption [Eliom_output.​Xhtml_forms]
soption [Eliom_output.​Xhtml]
soption [Eliom_output.​Html5_forms]
soption [Eliom_output.​Html5]
soption [Eliom_mkforms.​MakeForms]
source [Atom_feed]
sourceOAttr [Atom_feed]

Children tags allowed for the source tag

state_data [Eliom_state]

The type used for getting data from a state.

state_status [Eliom_state]

The following functions return the current state of the state for a given scope: Alive_state means that data has been recorded for this scope, Empty_state means that there is no data for this scope, Expired_state means that data for this scope has been removed because the timeout has been reached. The default scope is `Session.

suff [Eliom_services]

Types of services


T
t [Eliom_bus]
t [Eliom_react.​S.​Down]
t [Eliom_react.​Up]
t [Eliom_react.​Down]
t [Eliom_comet.​Channels]
t [Eliom_pervasives.​Ip_address]
t [Eliom_pervasives.​Url]
term [Atom_feed]
textConstruct [Atom_feed]
textarea_attrib_t [Eliom_duce_types]
textarea_attrib_t [Eliom_mkforms.​FORMS_PARAM]
textarea_elt [Eliom_duce_types]
textarea_elt [Eliom_mkforms.​FORMS_PARAM]
timeout [Eliom_state.​Session_admin]

Type used to describe session timeouts


U
unknown_content [Eliom_output]
unwrap_id [Eliom_wrap]

unwrap *

unwrapper [Eliom_wrap]
updated [Atom_feed]
uri [Eliom_duce_types]
uri [Atom_feed]
uri [Eliom_mkforms.​FORMS_PARAM]
uri [Eliom_pervasives.​Url]
user_scope [Eliom_common]

V
volatile_table [Eliom_state]

The type of (volatile) state data tables.


W
wrapped_value [Eliom_wrap]
wrapper [Eliom_wrap]

Y
yesnomaybe [Eliom_pervasives]