scripts/lib/cocanwiki_pages.mli

   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.6 2006/08/04 12:45:33 rich Exp $
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  *)
  21
  22 open Cocanwiki
  23
  24 (* Page (URL) or title. *)
  25 type pt = Page of string | Title of string
  26
  27 type section =
  28     string option * string option * string option * string
  29     (* (sectionname, divname, jsgo, content) *)
  30
  31 type model = {
  32   id : int32;                           (* Original page ID (0 = none). *)
  33   pt : pt;                              (* Page of title (only used if id=0) *)
  34   description : string;                 (* Description. *)
  35   keywords : string option;             (* Keywords. *)
  36   redirect : string option;             (* Redirect to. *)
  37   contents_ : section list;             (* List of sections. *)
  38 }
  39
  40 exception SaveURLError
  41 exception SaveConflict of int32 * int32 * string * string option
  42   (** New version, old version, URL, CSS. *)
  43
  44 val new_page : pt -> model
  45   (** Create a new, blank page. *)
  46
  47 val new_page_with_title : string -> model
  48   (** Friendlier version of {!new_page} which creates a new page from
  49     * a title and begins an introductory paragraph for the user.
  50     *)
  51
  52 val load_page : PGOCaml.pa_pg_data PGOCaml.t -> int32 -> url:string -> ?version:int32 -> unit -> model
  53   (** Load a page from the database.  A non-current version can be
  54     * specified with the optional [?version] parameter, otherwise the
  55     * latest version is loaded.
  56     *
  57     * @raise Not_found If the page cannot be found.
  58     *)
  59
  60 val save_page : Apache.Request.t -> PGOCaml.pa_pg_data PGOCaml.t -> int32 -> ?user:user_t -> model -> string * int32
  61   (** Save a page.  If the page is new, this creates a new page in the
  62     * database.  If the page is old, then the page is edited.
  63     *
  64     * Notification emails are not sent.
  65     *
  66     * @raise SaveURLError Duplicate URL or bad URL (happens only when creating
  67     *   new pages).
  68     *
  69     * @raise SaveConflict If there was an editing conflict.
  70     *
  71     * @return (url, pageid)
  72     *)