Module Eliom_tools


module Eliom_tools: sig .. end
Predefined boxes for Eliom


Menus


val menu : ?classe:XHTML.M.nmtoken list ->
([< Eliom_services.get_service_kind ] as 'a,
[< Eliom_services.registrable ] as 'b)
Eliom_tools_common.one_page * Xhtmltypes.a_content XHTML.M.elt list ->
(('a, 'b) Eliom_tools_common.one_page * Xhtmltypes.a_content XHTML.M.elt list)
list ->
?service:('a, 'b) Eliom_tools_common.one_page ->
sp:Eliom_sessions.server_params -> [> `Ul ] XHTML.M.elt
Creates a menu

Example:

menu ~classe:["mainmenu"] [ (home, <:xmllist< Home >>); (infos, <:xmllist< More infos >>) ] current sp


Hierchical sites


val hierarchical_menu_depth_first : ?classe:XHTML.M.nmtoken list ->
?whole_tree:bool ->
([< Eliom_services.get_service_kind ] as 'a,
[< Eliom_services.registrable ] as 'b,
Xhtmltypes.a_content XHTML.M.elt list)
Eliom_tools_common.hierarchical_site ->
?service:('a, 'b) Eliom_tools_common.one_page ->
sp:Eliom_sessions.server_params -> [> `Ul ] XHTML.M.elt list
hierarchical_menu_depth_first menu constructs a function taking as parameters a service and ~sp (server parameters) and displaying a hierarchical menu for this service.

The menu is constructed by exploring the tree using a depth-first algorithm. It means that the first menu item will be displayed, followed by the whole sub-menu for this item, then the second menu item with its sub-menu, and so on. By default, only the sub-menus corresponding to the current page are displayed. If you want all the sub-menus to be displayed, specify ?whole_tree=true.

val hierarchical_menu_breadth_first : ?classe:XHTML.M.nmtoken list ->
([< Eliom_services.get_service_kind ] as 'a,
[< Eliom_services.registrable ] as 'b,
Xhtmltypes.a_content XHTML.M.elt list)
Eliom_tools_common.hierarchical_site ->
?service:('a, 'b) Eliom_tools_common.one_page ->
sp:Eliom_sessions.server_params -> [> `Ul ] XHTML.M.elt list
hierarchical_menu_breadth_first menu constructs a function taking as parameters a service and ~sp (server parameters) and displaying a hierarchical menu for this service.

The menu is constructed by exploring the tree using a breadth_first algorithm. It means that the whole menu for one level will be displayed, followed by all sub-menus. Only the sub-menu corresponding to the current page is displayed.

val structure_links : ([< Eliom_services.get_service_kind ] as 'a,
[< Eliom_services.registrable ] as 'b,
Xhtmltypes.a_content XHTML.M.elt list)
Eliom_tools_common.hierarchical_site ->
?service:('a, 'b) Eliom_tools_common.one_page ->
sp:Eliom_sessions.server_params -> [> `Link ] XHTML.M.elt list
Returns the tags <link rel="subsection" ...> and <link rev="subsection" ...> for the given hierarchical site.