.TH "Eliom_tools_common" 3o 2014-07-10 OCamldoc ""
.SH NAME
Eliom_tools_common \-  Menus 
.SH Module
Module   Eliom_tools_common
.SH Documentation
.sp
Module
.BI "Eliom_tools_common"
 : 
.B sig  end

.sp

.B Menus 

.sp

.sp

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

.sp

.B Menus 

.sp

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

.sp

.sp
.I type 
.B ('a, [< Eliom_service.registrable ], 'c)
.I hierarchical_site_item 
=
 | Disabled
 | Site_tree
.B of 
.B ('a, [< Eliom_service.registrable ] as 'b, 'c)
.B hierarchical_site
 
.sp

.B Hierchical sites 

.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_ocaml_service)
.B one_page
 | Default_page
.B of 
.B ('a, 'b, Eliom_registration.non_ocaml_service) one_page
 | Not_clickable
 
.sp

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

.sp

.sp

.PP

.B === The type of hierarchical sites\&.
.B     A hierarchical site is a pair (main page, subpages)\&.
.B 
.B     The difference between
.B     Main_page, Default_page and Not_clickable is a bit subtle:
.B 
.B \- Main_page is when you want to create a main page for your
.B     subsite\&. All the subpages are subsections of that page\&.
.B 
.B \- Default_page is like Main_page but is not taken into account
.B     for computing which is the current page in the menu\&.
.B     Use it for example when there is no main page, but you want
.B     one of the subpages to be the default page for your subsite\&.
.B     The service you use as default page
.B     must appear another time in the subtree!
.B 
.B \- Not_clickable is when you do not want the menu entry to be a link
.B     but you want subpages\&.
.B 
.B     Each subpage is defined by the text to be displayed in menus
.B     and a hierarchical_site_item\&.
.B     If the latter is Disabled, the menu entry is disabled\&. ===

.PP