1 (* COCANWIKI - a wiki written in Objective CAML.
2 * Written by Richard W.M. Jones <rich@merjis.com>.
3 * Copyright (C) 2004 Merjis Ltd.
4 * $Id: cocanwiki_pages.mli,v 1.1 2004/10/11 14:13:04 rich Exp $
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; see the file COPYING. If not, write to
18 * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
24 (* Page (URL) or title. *)
25 type pt = Page of string | Title of string
28 id : int; (* Original page ID (0 = none). *)
29 pt : pt; (* Page of title (only used if id=0) *)
30 description : string; (* Description. *)
31 redirect : string; (* Redirect to ("" = none). *)
32 contents : (string * string * string) list;
33 (* (sectionname, divname, content)
34 * for each section. *)
37 exception SaveURLError
38 exception SaveConflict of int * int * string * string
40 val new_page : pt -> model
41 (** Create a new, blank page. *)
43 val new_page_with_title : string -> model
44 (** Friendlier version of {!new_page} which creates a new page from
45 * a title and begins an introductory paragraph for the user.
48 val load_page : Dbi.connection -> int -> url:string -> ?version:int -> unit -> model
49 (** Load a page from the database. A non-current version can be
50 * specified with the optional [?version] parameter, otherwise the
51 * latest version is loaded.
53 * @raise Not_found If the page cannot be found.
56 val save_page : Dbi.connection -> int -> ?user:user_t -> ?r:Apache.Request.t -> model -> string * int
57 (** Save a page. If the page is new, this creates a new page in the
58 * database. If the page is old, then the page is edited.
60 * Notification emails are not sent.
62 * @raise SaveURLError Duplicate URL or bad URL (happens only when creating
65 * @raise SaveConflict If there was an editing conflict.
67 * @return (url, pageid)