Space to separate "&&" so that all "&$var" can be made into "$var" later
[openemr.git] / library / html2pdf / _read_me.txt
blob9a6031f402e37a3cf4f0e200ac39e807179ba586
1 *********************************************************
2 ** This program is distributed under the LGPL License, **
3 ** for more information see file _LGPL.txt or          **
4 ** http://www.gnu.org/licenses/lgpl.html               **
5 **                                                     **
6 **  Copyright 2000-2010 by Laurent Minguet             **
7 *********************************************************
8 *******************************
9 * HTML2PDF v3.31 - 2010-05-21 *
10 *******************************
12 How to use :
13 ------------
14  - You need at least PHP 4.3.10
16  - Look at the examples provided to see how it works.
18  - forms work only with ADOBE READER 8 and 9.0
20  - It is very important to provide valid HTML 4.01 to the converter,
21    but only what is in the <body>
23  - for borders: it is advised that they are like "solid 1mm #000000"
25  - for padding, they are applicable only on tags table, th, td, div, li
27  - You can chose the encoding. A specific font must be used. The encodings available are: 
28     cp1250, cp1251, cp1252, cp1253, cp1254, cp1255, cp1257, cp1258, cp874,
29     ISO-8859-1, ISO-8859-2, ISO-8859-4, ISO-8859-5, ISO-8859-7, ISO-8859-9,
30     ISO-8859-11, ISO-8859-15, ISO-8859-16, KOI8-R, KOI8-U
31   To use it: $html2pdf->setEncoding('cp1250');
32   
33  - A default font can be specified, if the requested font does not exist or if no font is specified:
34      $html2pdf->setDefaultFont('Arial');
36  - The possibility to protect your PDF is present, CF Example 7.
37        
38  - Some tests can be enabled (true) or disabled (false) :
39      * setTestIsImage method:      test that images must exist
40      * setTestTdInOnePage method:  test that the contents of TDs fit on one page
41      * setTestIsDeprecated method: test that old properties of specific tags are not used anymore
43   - A DEBUG mode to know the resources used is present
44    It is activated by adding the following command just after the contructor (see Example 0):
45       $htmlpdf->setModeDebug();
46       
47  - Some specific tags have been introduced:
48      * <page></page>  (CF Exemple 7) :
49        determines the orientation, margins left, right, top and bottom, the background image
50        and the background color of a page, its size and position, the footer.
51        It is also possible to keep the header and footer of the previous pages,
52        through the attribut pageset="old" (see Example 3)
54      * <page_header></page_header> (CF Example 3)
55      
56      * <page_footer></page_footer> (CF Example 3)
57      
58      * <nobreak></nobreak> :
59          used to force the display of a section on the same page.
60          If this section does not fit into the rest of the page, a page break is done before.
62      * <barcode></barcode>  (CF Examples 0 et 9) :
63          can insert barcodes in pdfs, CF Examples 0 and 9
64          The possible types od codebar are: EAN13, UPCA, C39.
66      * <qrcode></qrcode> (CF Exemple 13) :
67          permet d'inserer un codebar à 2 dimensions de type QRcode
68          voici un exemple d'utilisation :
69            <qrcode value="votre message ici" size="1mm" ec="M" style="color: black; background-color: white"></qrcode>
70          seul le parametre "value" est obligatoire
71          les différentes valeurs de type de correction sont L, M, Q, H
72          (QR Code is registered trademark of DENSO WAVE INCORPORATED | http://www.denso-wave.com/qrcode/)
73          ATTENTION : l'utilisation des QRCODE nécessite l'utilisation de PHP5
75      * <bookmark></bookmark>  (CF Examples 7 et About) :
76          can insert bookmark in pdfs, CF Example 7 and About.
77          It is also possible to automatically create an index at the end of
78          documentv  CF Example About.
79           
80      * css property "rotate" :
81          values : 0, 90, 180, 270
82          works only on div (cf example 8)
83                  
84 change log :
85 -----------
86  see on this page : http://html2pdf.fr/en/download
88 Help & Support :
89 ---------------
90  For questions and bug reports, thank you to use only the support link below.
91  I will answer to your questions only on it... 
93 Informations :
94 -------------
95  Programmer : Spipu
96       email    : webmaster@html2pdf.fr
97       web site : http://html2pdf.fr/
98       wiki     : http://html2pdf.fr/en/wiki
99       support  : http://html2pdf.fr/en/forum
101 Thanks :
102 -------
103  * Olivier Plathey: for have made FPDF
104  * Nicola Asuni: for the changes he has agreed to make to TCPDF
105  * yAronet: for hosting support forum
106  * everyone who helped me to develop this library and to bring the texts