components/content_pres/boxPp.mli

   1 (* Copyright (C) 2005, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26   (**
  27    * @param map_unicode_to_tex if true converts multibye unicode sequences to
  28    *  TeX-like macros (when possible). Default: true
  29    * @return rows list of rows *)
  30 val render_to_strings:
  31   map_unicode_to_tex:bool ->
  32   (CicNotationPres.boxml_markup Mpresentation.mpres Box.box list -> CicNotationPres.boxml_markup) ->
  33   int -> CicNotationPres.markup -> string list
  34
  35   (** helper function
  36    * @param map_unicode_to_tex as above
  37    * @return s, concatenation of the return value of render_to_strings above
  38    * with newlines as separators *)
  39 val render_to_string:
  40   map_unicode_to_tex:bool ->
  41   (CicNotationPres.boxml_markup Mpresentation.mpres Box.box list -> CicNotationPres.boxml_markup) ->
  42   int -> CicNotationPres.markup -> string
  43