helm/uwobo/src/ocaml/uwobo_engine.mli

   1
   2 (* Copyright (C) 2002, HELM Team.
   3  *
   4  * This file is part of HELM, an Hypertextual, Electronic
   5  * Library of Mathematics, developed at the Computer Science
   6  * Department, University of Bologna, Italy.
   7  *
   8  * HELM is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * HELM is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with HELM; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  21  * MA  02111-1307, USA.
  22  *
  23  * For details, see the HELM World-Wide-Web page,
  24  * http://cs.unibo.it/helm/.
  25  *)
  26
  27   (**
  28     @param logger logger for processing messages
  29     @param styles stylesheets object
  30     @param keys (ordered) list of stylesheet names to be applied
  31     @param params function mapping stylesheet names to parameters list
  32     @param props xml:output properties
  33     @param input URI of input document
  34     @param channel on which write final output
  35     @return a triple: 1st element is a function that takes an out_channel and
  36     write the result document on it, 2nd element is a string option representing
  37     the desired media-type, 3rd is a string option representing the desired
  38     encoding
  39   *)
  40 val apply:
  41   logger: Uwobo_logger.sysLogger ->
  42   styles: Uwobo_styles.styles ->
  43   keys: string list ->
  44   params: (string -> (string * string) list) ->
  45   props: (string * string) list ->
  46   input: Gdome.document ->
  47   (out_channel -> unit) * string option * string option
  48