library/html2pdf/README.md

   1 HTML2PDF v4.5.0 - 2015-12-18
   2 ============================
   3
   4 License:
   5 --------
   6 ```
   7  This program is distributed under the LGPL License,
   8  for more information see file _LGPL.txt or
   9  http://www.gnu.org/licenses/lgpl.html
  10
  11  Copyright 2008-2015 by Laurent Minguet
  12 ```
  13
  14 How to use:
  15 -----------
  16
  17  * You need at least PHP 5.3.2
  18
  19  * Use composer to install it
  20    * Composer : https://getcomposer.org/
  21    * Official Package : spipu/html2pdf
  22
  23  * If you install html2pdf without using composer, it will not work directly.
  24    You must do "composer install" on the html2pdf folder
  25    in order to install the TCPDF dependency.
  26
  27  * Look at the examples provided to see how it works.
  28
  29  * It is very important to provide valid HTML 4.01 to the converter,
  30    but only what is in the `<body>`. Use the `<page>` tag.
  31
  32  * for borders: it is advised that they are like `solid 1mm #000000`
  33
  34  * for padding, they are applicable only on tags table, th, td, div, li
  35
  36  * A default font can be specified, if the requested font does not exist or if no font is specified:
  37
  38  `$html2pdf->setDefaultFont('Arial');`
  39
  40  * The possibility to protect your PDF is present, CF Example 7.
  41
  42  * Some tests can be enabled (true) or disabled (false):
  43
  44   * setTestIsImage method:      test that images must exist
  45
  46   * setTestTdInOnePage method:  test that the contents of TDs fit on one page
  47
  48   * setTestIsDeprecated method: test that old properties of specific tags are not used anymore
  49
  50  * A DEBUG mode to know the resources used is present.
  51 It is activated by adding the following command just after the contructor (see Example 0):
  52 `$htmlpdf->setModeDebug();`
  53
  54 * Some specific tags have been introduced:
  55
  56   * <page></page>  (CF Exemple 7 & wiki)
  57     * Determines the orientation, margins left, right, top and bottom, the background image
  58     * and the background color of a page, its size and position, the footer.
  59     * It is also possible to keep the header and footer of the previous pages,
  60     * through the attribut pageset="old" (see Example 3 & 4 & wiki)
  61
  62   * <page_header></page_header> (CF Example 3 & wiki)
  63
  64   * <page_footer></page_footer> (CF Example 3 & wiki)
  65
  66   * <nobreak></nobreak> (CF wiki)
  67     * Used to force the display of a section on the same page.
  68     * If this section does not fit into the rest of the page, a page break is done before.
  69
  70   * <barcode></barcode>  (CF Examples 0 & 9 & wiki)
  71     * Can insert barcodes in pdfs, CF Examples 0 and 9
  72     * the possible types of codebar are alls of TCPDF
  73
  74   * <qrcode></qrcode> (CF Example 13 & wiki)
  75     * can insert QRcode 2D barcodes
  76     * (QR Code is registered trademark of DENSO WAVE INCORPORATED | http://www.denso-wave.com/qrcode/)
  77
  78   * <bookmark></bookmark> (CF Examples 7 & About & wiki)
  79     * Can insert bookmark in pdfs, CF Example 7 and About.
  80     * It is also possible to automatically create an index at the end of document (CF Example About & wiki)
  81
  82   * css property "rotate":
  83     * Values : 0, 90, 180, 270
  84     * Works only on div (cf example 8)
  85
  86 Change log:
  87 -----------
  88
  89 See on this page: http://html2pdf.fr/en/download
  90
  91 Help & Support:
  92 ---------------
  93
  94 For questions and bug reports, thank you to use only the support link below.
  95 I will answer to your questions only on it...
  96
  97 Informations:
  98 -------------
  99
 100 * Programmer: Spipu
 101 * Web Site  : http://html2pdf.fr/
 102 * Wiki      : http://html2pdf.fr/en/wiki
 103 * Support   : http://html2pdf.fr/en/forum
 104
 105 Thanks:
 106 -------
 107
 108  * Olivier Plathey: for have made FPDF
 109  * Nicola Asuni: for the changes he has agreed to make to TCPDF
 110  * yAronet: for hosting support forum
 111  * Everyone who helped me to develop this library and to bring the texts