/usr/lib/ocaml/eliom/server/eliom_duce_tools.mli is in libeliom-ocaml-dev 2.2.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 | (* Ocsigen
* Copyright (C) 2005 Vincent Balat
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, with linking exception;
* either version 2.1 of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*)
(** Predefined boxes for Eliom *)
open Eliom_service
open Eliom_parameter
open Eliom_state
open Eliom_tools_common
(** {2 Menus } *)
val menu :
?classe:string list ->
?id:string ->
(([< get_service_kind ] as 'a, [< registrable ] as 'b, [< Eliom_registration.non_caml_service ] as 'c) one_page *
'elts Eliom_duce_types.a_content_elt_list)
->
(('a, 'b, 'c) one_page *
'elts Eliom_duce_types.a_content_elt_list)
list ->
?service:('a, 'b, 'c) one_page ->
unit ->
Xhtml_types_duce.ul
(** Creates a menu
Example:
[menu ~classe:["mainmenu"]
[
(home, <:xmllist< Home >>);
(infos, <:xmllist< More infos >>)
] current sp]
The [service] argument is used to find which item(s) to highlight. If
service is [None], the current url is used.
*)
(** {2 Hierchical sites } *)
(**
[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 for to the url corresponding to
the argument [service] are displayed. If you want all the sub-menus to be
displayed, specify [?whole_tree=true]. If [service] is [None], the current
page is used.
*)
val hierarchical_menu_depth_first :
?classe:string list ->
?id:string ->
?whole_tree:bool ->
([< Eliom_service.get_service_kind ] as 'a,
[< Eliom_service.registrable ] as 'b,
'elts Eliom_duce_types.a_content_elt_list)
hierarchical_site ->
?service:('a, 'b, [< Eliom_registration.non_caml_service ]) one_page ->
unit ->
{{ [Xhtml_types_duce.ul*] }}
(**
[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-menus for to the url corresponding to the argument [service]
are displayed. If [service] is [None], the current url is used.
*)
val hierarchical_menu_breadth_first :
?classe:string list ->
?id:string ->
([< Eliom_service.get_service_kind ] as 'a,
[< Eliom_service.registrable ] as 'b,
'elts Eliom_duce_types.a_content_elt_list)
hierarchical_site ->
?service:('a, 'b, [< Eliom_registration.non_caml_service ]) one_page ->
unit ->
{{ [Xhtml_types_duce.ul*] }}
(** Returns the tags [<link rel="subsection" ...>] and
[<link rev="subsection" ...>] for the given hierarchical site.
*)
val structure_links :
([< Eliom_service.get_service_kind ] as 'a,
[< Eliom_service.registrable ] as 'b,
'elts Eliom_duce_types.a_content_elt_list)
hierarchical_site ->
?service:('a, 'b, [< Eliom_registration.non_caml_service ]) one_page ->
unit ->
{{ [Xhtml_types_duce.link*] }}
|