package eliom
Install
Dune Dependency
Authors
Maintainers
Sources
md5=c8c67fe5fb8d3f44a3b17cc4a93a0e62
sha512=e58557a1b525efd011e0eb539b112b53e6c012ac3fb2153c251be030eda483dd3b19de625707cf5ffebd97fa6a7fabfb8a6aae8e8a61c79e0bd7ad2d289df9a9
doc/eliom.server/Eliom_tools/D/index.html
Module Eliom_tools.DSource
Menus with DOM semantics
Simple menu
The function menu elts (), where elts is a list of pair (service, content), creates a list of link towards the services. See the Eliom manual for an <<a_manual
chapter="misc" fragment="basic_menu"|example of menu>>.
The optional parameter service is used to find which item(s) to highlight (by adding the class eliomtools_current to the corresponding <li> node). The default is to highlight the item corresponding to the current url.
The optional parameters id and classe allow to specify the corresponding attributes in the generated <ul> node. The default class for the <ul> node is eliomtools_menu.
Hierchical sites
The function hierarchical_menu_depth_first site () constructs a hieranrchical menu by exploring the hierarchical site description using a depth-first algorithm: 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 for to the url corresponding to the optional argument service are displayed, others sub-menu are collapsed. If you want all the sub-menus to be displayed, specify ~whole_tree:true. If the optional parameter service is not given, the current page is used.
See menu for a description of the optional parameters id and classe.
The function hierarchical_menu_breadth_first site () constructs a hierarchical menu by exploring the hierarchical site description using a breadth_first algorithm: the whole menu for one level will be displayed, followed by the sub-menu leading to the current service, and so one.
By default the current service correspond to the current url. The optional parameter service allow to override the current service.
See menu for a description of the optional parameters id and classe.
val structure_links :
[< Html_types.a_content ] Eliom_content.Html.elt list hierarchical_site ->
?service:
(unit,
unit,
Eliom_service.get,
_,
_,
_,
_,
[ `WithoutSuffix ],
unit,
unit,
Eliom_service.non_ocaml)
Eliom_service.t ->
unit ->
[> `Link ] Eliom_content.Html.elt listThe function structure_links site () returns the tags <link rel="subsection" ...> and <link rev="subsection" ...> for the given hierarchical site.
By default the current service correspond to the current url. The optional parameter service allow to override the current service.
val head :
title:string ->
?css:string list list ->
?js:string list list ->
?other:[< Html_types.head_content_fun ] Eliom_content.Html.elt list ->
unit ->
[ `Head ] Eliom_content.Html.eltAn auxiliary function for creating an HTML head elements. Resources (JS, CSS) are taken from the static directory.
val html :
title:string ->
?a:[< Html_types.html_attrib ] Eliom_content.Html.attrib list ->
?css:string list list ->
?js:string list list ->
?other_head:[< Html_types.head_content_fun ] Eliom_content.Html.elt list ->
[ `Body ] Eliom_content.Html.elt ->
[ `Html ] Eliom_content.Html.elt