# $Id: README,v 1.2 2009/04/29 16:40:34 teus Exp $

This package will install cap.php and coap.php pdf form generation programs and required
library packages (tcpdf and utf8).
It will download (wget) dependent logos, font files, and library (versioned) file.
Change version number to download and install newer library package version.

It will generate php version 4 from php version 5 programs on the fly.

If unzip is not available on the target machine, it will use to tar (tgz) converted repackaged files. On a machine with unzip the repackage function is included for automatic tgz generation.
If rsync is not available on the target machine it will use scp and ssh to copy files to the remote machine.

The zapdingbats fonts will be generated when installed. The zapf dingbats font is only used as embedded font. It may not be part of the distributed tar ball. Similar for php library packages. The all are downloaded when at installation time.

It will only install dependent library files (not the who library distribution).

For TPDF library package some patches (bugs and feature extentions) have not made it yet to the package release and are provided as patch files. Currently they are:
ANCHER which allows <a name=ancher>..</a> html ancher tags as bookmarks (feature and bug).
SPACE which improves vertical spacing on printoutof html tags (feature)
TCPDFTAG disables <tcpdf tag handling so php methods cannot be called from html files.

Installation directory: INSTALLDIR (default empty).
ROOT is the root directory on the target machine and is / for the runtime php commands.
The installation dependent variables: ROOT (if INSTALLDIR == empty: bin else /chroot/), BINDIR (if INSTALLDIR == empty: ROOT/bin else ROOT/www/www), LIBDIR (if INSTALLDIR == empty: ROOT/BIN/ else ROOT/BIN/phpadmin/libraries). The php programs will be adjusted with these values on installation.

Howto use the make command:
runtime: (ROOT=/chroot/, BINDIR=ROOT/www.www, LIBDIR=ROOT/BIN/phpadmin/libraries TARGET=localhost)
make -e INSTALLDIR=/chroot/www/www TARGET=root@test1.cacert.at install
test: (ROOT=bin, BINDIR=ROOT/., LIBDIR=ROOT/.) (php will be enabled for test data)
make install

TARGET
The TARGET machine will be tested (ssh command) for php version and unzip command presence. If PHP 4 and/or no unzip php 5 code will be converted, zip'd files will be converted to tar gz. For libraries, fonts, etc the URL will be used to download the package on the fly.

Other usages:
make clean	delete all intermediate files
make uninstall	delete installation from install dir
make check	do a simple check if cap.php and coap.php generate pdf files
make install	install a test version in ./bin directory for tests: 
		eg FORM=empty php cap.php >cap.pdf # should generate a pdf form (empty) file
		eg FORM=noempty ORIENTATION=portrait FORMAT=Letter php cap.php >cap.pdf
make distr	Make distribution available for target machine (repackage zip files) and 
		include php4 special for tcpdf package.
make rsync	create target and rsync target dir to target machine
		make TARGET=root@test1.cacert.at INSTALLDIR=/chroot/www/www rsync
		will ready installation files and ship them to target machine

cap.pdf.php	generates pdf form file for CAcert Assurance Programme
		default: A4 landscape (2XA5 2-up)
cap.html.php	generates HTML form file with tooltips for help.
coap.pdf.php	generates pdf form file for CAcert Organisation Assurance Programme
		default: A4 portrait
coap.html.php	generates HTML form file for Org, Assurance program with toolip help
		support.

form_XYZ.php	are supportive php "library" inclusion php files, where XYZ=:
form_fies.php	central functions for html and pdf form generation
form_pdf.php	functions for pdf form generation
form_html.php	functions for html form generation
form_js.php	HTML JavaScript functions for form fields control
form_prnt.php	html print functions of forms.
form_css.php	html style info for html forms, CAcert house style
form_test.php	test data for example pdf/html field generation (FORM=example)
		FORM=form url parameters are taken fron environment eg name=..., dob=

transtab.php	central function to check transliteration following std table.

TO DO		Add MySQL statements to extract formk field data from database.
		Allow signing and encryption of form eg via url.