NAME¶
Eliom_tools - Helpers for (hierarchical) menu generation in HTML5 and XHTML.
Module¶
Module Eliom_tools
Documentation¶
Module
Eliom_tools
:
sig end
Helpers for (hierarchical) menu generation in HTML5 and XHTML. 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 ], 'b)
hierarchical_site =
('a, [< Eliom_service.registrable ] as 'c)
main_page * ('b * ('a, 'c, 'b) 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 ], 'b)
hierarchical_site_item =
| Disabled (* The menu entry is disabled. *)
| Site_tree
of ('a, [< Eliom_service.registrable ] as 'c, 'b)
hierarchical_site (* The menu entry as a label and subsections.
*)
module Html5 : sig end
module Xhtml : sig end
Menu and hierarchical site for XHTML