package eliom
Install
Dune Dependency
Authors
Maintainers
Sources
md5=218bcb5cd275cc05be06574c5fa357fa
sha512=edbf8b084ec1b7439d4715199c22eb925a77a2dcfbe76bb5bbc4b9d076b70be1b0de74f9eab9dfb7854df28d65eb31a4c17380528d4a461d9c2a4222abe804cc
doc/eliom.server/Eliom_tools/index.html
Module Eliom_toolsSource
Helpers for (hierarchical) menu generation in HTML5. See the Eliom manual for more information about <<a_manual
chapter="misc" fragment="basic_menu"| menu>> or <<a_manual
chapter="misc" fragment="hier_menu"| hierarchical site>>.
type srv = | Srv : (unit, unit, Eliom_service.get, _, _, _, _, [ `WithoutSuffix ], unit, unit, Eliom_service.non_ocaml) Eliom_service.t -> srv
Hierarchical sites description. This is a pair (main page, subpages list). Each subpage is defined by the text to be displayed in menus and a hierarchical_site_item.
Menu entry description in a hierarchical site.
and main_page = | Main_page of srv(*Main page for your subsite: all the subpages are subsections of that page.
*)| Default_page of srv(*Like
*)Main_pagebut 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.
Tools for generating certain HTML elements
Menus with functional node semantics
Menus with DOM semantics
Record an (external) JavaScript file to be included in Eliom_tools.F.html.
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.tThis 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.
<<code language="ocaml"|
let user_eref = Eliom_reference.eref ~scope None
let anonymous_handler _ _ =
Lwt.return (html (head (title "not allowed")) (body []))
let authenticated_handler f =
Eliom_tools.wrap_handler
(fun () -> Eliom_reference.get user_eref)
anonymous_handler f
let guarded_service =
My_app.register_service ~path ~get_param
(authenticated_handler
(fun user get () ->
Lwt.return (html (head (title ("hello "^user))) (body []))))
>>