Description
===========

Prosper-online (in conjunction with prosper-make) allows you to make your
Prosper presentation available for consultation from the Web.

Prosper-online offers you several options to customize the visual aspect of the
html output:
  - differents styles are provided,
  - the presentation can be in color or in black & with,
  - incremental display can be enabled or disabled,
  - possibility to add a caption at the bottom of every slide,
  - slides can have the size that you want.


System requirements
===================

You need:
  - prosper-make package (for the Makefile),
  - perl,
  - convert program (from the ImageMagick package),
  - pdf2ps (Ghostscript tool)
  - the source file of the presentation that you want to put online (the
    presentation must be contained in a single source file).
 

Installation
============

  - Move the script generate-online into a directory which is included in the
    system search path.

  - Type 'make check' to see if your installation is OK.


Use
===

  - Copy the Makefile in the directory of your the presentation.
  - Copy the online-templates directory in the directory of your presentation.
  - Edit the Makefile and adjust the variables.
  - Prosper class options are passed from the Makefile. So the documentclass
    command of your presentation must have the following form:
    \documentclass[]{prosper}
  - Type 'make online' to generate html output of the presentation.

Tips:
  - You can pass variable to the Makefile from the command line : 
    make online ONLINE_VISUAL=color ONLINE_STYLE=w3c
    will override the ONLINE_VISUAL and ONLINE_STYLE variables specified in the
    Makefile.
  - Read the Makefile and adjust options to your needs.
  - You can customize the generated document by editing the template files.


Detail on targets
=================
  - make online:Generate presentation in the html format.
  		Output filename is <source>-online.html, which is a link to the
		main html file.
		All generated html files are located in the 
		./<source>-online/<online_style> directory.
  - make onlineclean:
  		Clean all generated files for html output (in ./ and 
		./<source>-online).


How does it works
=================

The reference document to generate html is a ps output of the presentation.
The Makefile will build this ps file depending on the ONLINE_VISUAL and
ONLINE_OVERLAYS variables as follow:
ONLINE_VISUAL | ONLINE_OVERLAYS
    color     |       with 	=> build a pdf file (with PDF_OVERLAY=with),
	      | 		   then pdf2ps it.
    color     |      without	=> build a pdf file (with PDF_OVERLAY=without),
	      | 		   then pdf2ps it.
      bw      |      without	=> build the 'normal' ps file.
      bw      |       with	=> build a ps file with [pdf, slideBW, nocolorBG
	      |			   PS_STYLE] Prosper options.

Next, we convert each page of the ps file into a image (in the format specified
in the ONLINE_GRAPHIC variable and with a size specified in the ONLINE_SCALE
variable). Files are named <source>-slide<nnn>.<format> (with <nnn> egal to the
slide number, in %03d format) and are located in the
./<source>-online/graphics/slides directory.

The html output is then generated with the generate-online script. To do this,
the script uses:
  - the templates files (located in ./online-templates/<online_style>),
  - the image files,
  - ONLINE_STYLE and ONLINE_CAPTION variables,
  - the source of the presentation (to construct the toc).

The output filename is <source>-online.html, which is a link to the main html
file. All generated html files are located in the
./<source>-online/<online_style> directory.


Contact
=======

Prosper-online was written by Alain Bannay <albannay@club-internet.fr>.
If you are having trouble installing and/or running it, feel free to e-mail me.

The Prosper-online Web page is at:
	http://perso.club-internet.fr/albannay/prosper/prosper-online

Comments, suggestions, bug reports are welcome.


Copyright
=========

   Prosper-online - Make your Prosper presentation available for consultation
   from the Web.
   Copyright (C) 2003 Alain Bannay

   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

   For more details see the file COPYING.


