Reference manual

Version 1.0.0

Index

Lwt

Eliom

Main modules

Pages with Ocamlduce

XHTML pages typed with variants

Other pages

Eliom_predefmod

Creating new kinds of pages

Ocsigen

This is a preliminary version of the documentation. Help us to improve it by filling tickets. We are looking for native english speakers to proof read the documentation. Contact us!

Module Eliom_duce_tools

module Eliom_duce_tools: sig .. end

val attrib_list : string list -> string

type ('a, 'b) one_page = (unit, unit, 'a, [ `WithoutSuffix ], unit, unit, 'b) Eliom_services.service

val menu_class : string

val last_class : string

val current_class : string

val disabled_class : string

val first_class : string

val level_class : string

val menu : ?classe:string list ->
       (unit, unit, [< Eliom_services.get_service_kind ] as 'a,
        [< Eliom_services.suff ] as 'b, 'c, 'd,
        [< Eliom_services.registrable ] as 'e)
       Eliom_services.service * {{Eliom_duce.Blocks.a_content_elt_list}} ->
       ((unit, unit, 'a, 'b, 'c, 'd, 'e) Eliom_services.service *
        {{Eliom_duce.Blocks.a_content_elt_list}})
       list ->
       service:(unit, unit, 'a, 'b, 'c, 'd, 'e) Eliom_services.service ->
       sp:Eliom_sessions.server_params -> {{ul}}

type ('a, 'b, 'c) hierarchical_site_item =

`\|`	`Disabled`
`\|`	`Site_tree of ('a, 'b, 'c) hierarchical_site`

type ('a, 'b, 'c) main_page =

`\|`	`Main_page of ('a, 'b) one_page`
`\|`	`Default_page of ('a, 'b) one_page`
`\|`	`Not_clickable`

type ('a, 'b, 'c) hierarchical_site = ('a, 'b, 'c) main_page *
       ('c * ('a, 'b, 'c) hierarchical_site_item) list

val find_in_hierarchy : ('a, 'b) one_page ->
       'c * ('d * ('a, 'b, 'd) hierarchical_site_item) list ->
       int list

val hierarchical_menu_depth_first : ?classe:string list ->
       ?whole_tree:bool ->
       'a *
       ({{Eliom_duce.Blocks.a_content_elt_list}} *
        ([< Eliom_services.get_service_kind ] as 'b,
         [< Eliom_services.registrable ] as 'c,
         {{Eliom_duce.Blocks.a_content_elt_list}})
        hierarchical_site_item)
       list ->
       service:('b, 'c) one_page ->
       sp:Eliom_sessions.server_params -> {{ul}} list

val hierarchical_menu_breadth_first : ?classe:string list ->
       ([< Eliom_services.get_service_kind ] as 'a,
        [< Eliom_services.registrable ] as 'b, Eliom_duce.Blocks.a_content_elt_list)
       hierarchical_site ->
       service:('a, 'b) one_page ->
       sp:Eliom_sessions.server_params -> Xhtmltypes_duce.ul list

val structure_links : ([< Eliom_services.get_service_kind ] as 'a,
        [< Eliom_services.registrable ] as 'b, 'c)
       main_page *
       ('d * ('a, 'b, 'd) hierarchical_site_item) list ->
       service:('a, 'b) one_page ->
       sp:Eliom_sessions.server_params -> {{link}} list