NAME

       Eliom_tools - Helpers for (hierarchical) menu generation in HTML5.

Module

       Module   Eliom_tools

Documentation

       Module Eliom_tools
        : sig end

       Helpers  for  (hierarchical)  menu  generation  in  HTML5.  See  the Eliom manual for more
       information about  or .

       type  ('a,  [<  Eliom_service.registrable  ],  [<  Eliom_registration.non_caml_service  ])
       one_page = (unit, unit, 'a, [ `WithoutSuffix ], unit, unit, [< Eliom_service.registrable ]
       as 'b, [< Eliom_registration.non_caml_service ] as 'c) Eliom_service.service

       Restriction of Eliom_service.service to services without parameters that do not returns  a
       marshalled OCaml value.

       type     get_page     =     (Eliom_service.get_service_kind,    Eliom_service.registrable,
       Eliom_registration.non_caml_service) one_page

       Restriction of Eliom_service.service to registrable GET services without  parameters  that
       do not returns a marshalled OCaml value.

       type   ('a,   [<   Eliom_service.registrable   ],   'c)   hierarchical_site   =   ('a,  [<
       Eliom_service.registrable ] as 'b) main_page * ('c * ('a, 'b, 'c)  hierarchical_site_item)
       list

       Hierarchical  sites  description.  This  is  is  a  pair (main page, subpages list) . Each
       subpage   is   defined   by   the   text   to   be    displayed    in    menus    and    a
       Eliom_tools.hierarchical_site_item .

       type ('a, [< Eliom_service.registrable ]) main_page =
        |     Main_page     of     ('a,     [<     Eliom_service.registrable     ]     as     'b,
       Eliom_registration.non_caml_service) one_page  (* Main page  for  your  subsite:  all  the
       subpages are subsections      of that page. *)
        |  Default_page  of  ('a,  'b,  Eliom_registration.non_caml_service)  one_page    (* Like
       Main_page but is not taken into account for computing      which is the  current  page  in
       the  menu.  Use  it  for  example when      there is no main page, but you want one of the
       subpages to  be       the  default  page  for  your  subsite.   The  service  you  use  as
            default page must appear another time in the subtree! *)
        |  Not_clickable   (*  When  you  do  not  want  the menu entry to be a link but you want
       subpages. *)

       Main page description for a section of a hierarchical site.

       type ('a, [< Eliom_service.registrable ], 'c) hierarchical_site_item =
        | Disabled  (* The menu entry is disabled. *)
        | Site_tree of ('a, [< Eliom_service.registrable ] as 'b, 'c) hierarchical_site   (*  The
       menu entry as a label and subsections. *)

       module type HTML5_TOOLS = sig end

       module F : HTML5_TOOLS

       Menus with functional node semantics

       module D : HTML5_TOOLS

       Menus with DOM semantics

       val with_js_file : string list -> unit

       Record an (external) JavaScript file to be included in Eliom_tools.F.html .

       val with_css_file : string list -> unit

       Record an CSS file to be included in Eliom_tools.F.html .

       === Other tools ===

       val  wrap_handler  :  (unit -> 'a option Lwt.t) -> ('get -> 'post -> 'res Lwt.t) -> ('a ->
       'get -> 'post -> 'res Lwt.t) -> 'get -> 'post -> 'res Lwt.t

       This function allows one to wrap a service handler easily  depending  on  whether  certain
       information is available or not.

       The  first  arguments provides that information ( Some value ) of not ( None ), the second
       argument is called just with two arguments when the information is not available (the  two
       arguments  are  suggesting  GET  and  POST parameters of a request). The third argument is
       called with that information if available and the parameters.