.TH "Eliom_tools" 3o 2012-06-11 OCamldoc ""
.SH NAME
Eliom_tools \- Helpers for (hierarchical) menu generation in HTML5 and XHTML.
.SH Module
Module   Eliom_tools
.SH Documentation
.sp
Module
.BI "Eliom_tools"
 : 
.B sig  end

.sp
Helpers for (hierarchical) menu generation in HTML5 and XHTML\&. See
the Eliom manual for more information about  or \&.
.sp

.sp

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

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

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

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

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

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

.sp
.I type 
.B ('a, [< Eliom_service.registrable ])
.I main_page 
=
 | Main_page
.B of 
.B ('a, [< Eliom_service.registrable ] as 'b,
.B  Eliom_registration.non_caml_service)
.B one_page
.I "  "
(* Main page for your subsite: all the subpages are subsections
	of that page\&. *)
 | Default_page
.B of 
.B ('a, 'b, Eliom_registration.non_caml_service) one_page
.I "  "
(* Like 
.B 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\&. *)
 
.sp
Main page description for a section of a hierarchical site\&.
.sp

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

.sp
.I module Html5 : 
.B sig  end

.sp

.sp
.I module Xhtml : 
.B sig  end

.sp
Menu and hierarchical site for XHTML
.sp

.sp