Update dompdf download URL
[project/print.git] / INSTALL.txt
CommitLineData
623692c4
JV
1INSTALLATION
2------------
1aaa7127 3
623692c4
JV
4Decompress the print-n.x-n.n.tar.gz file into your Drupal modules
5directory (usually sites/all/modules, see http://drupal.org/node/176044 for
6more information).
1aaa7127 7
623692c4
JV
8Enable the print module: Administer > Site building > Modules
9 (admin/build/modules)
1aaa7127 10
40cbc88e
JV
11PDF TOOL
12--------
13
14The print_pdf module requires the use of an external PDF generation tool.
15The currently supported tools are dompdf and TCPDF. Please note that any
16errors/bugs in those tools need to be reported and fixed by their
17maintainers. DO NOT report bugs in those tools in the print module's issue
18queue at Drupal.org.
19
20dompdf support:
21 The dompdf tool produces results that are more faithful to the HTML
4052e997
JV
22 printer-friendly page. Unicode is not supported (only ISO-8859-1).
23 This tool is not supported and there are several known bugs that result
24 from its incomplete implementation.
40cbc88e 25
ef61890e 26 1. Download dompdf from http://code.google.com/p/dompdf/downloads/list
40cbc88e 27 2. Extract the contents of the downloaded package into the print module
ef61890e 28 lib directory (usually sites/all/modules/print/lib)
40cbc88e
JV
29 3. Check if dompdf_config.inc.php fits your installation. In 99% of cases,
30 no changes are necessary, so just try to use it and only edit anything if
31 the PDF generation fails.
32 4. Grant write access to the lib/fonts directory to your webserver user.
33 5. If you're using dompdf-0.5.1, delete the dompdf.php file as it contains
34 a security vulnerability
ef61890e 35 6. Check http://code.google.com/p/dompdf/ for further information.
40cbc88e
JV
36
37TCPDF support:
38 TCPDF seems to be more actively developed than dompdf, but it's support
4052e997
JV
39 for CSS is considerably worse. Unicode is supported (use of Unicode fonts
40 result in HUGE files). Page header and footer are supported. This module
41 requires TCPDF >= 4.0.000.
40cbc88e
JV
42
43 1. Download TCPDF from http://sourceforge.net/projects/tcpdf/
44 2. Extract the contents of the downloaded package into the print module
ef61890e 45 lib directory (usually sites/all/modules/print/lib). There is no need to
b08256cd
JV
46 modify the config/tcpdf_config.php file, as the module self-configures
47 TCPDF.
40cbc88e
JV
48 3. Check http://tcpdf.sourceforge.net/ for further information.
49
b08256cd
JV
50wkhtmltopdf support:
51
52 1. Download wkhtmltopdf from
53 http://code.google.com/p/wkhtmltopdf/downloads/list. You can choose to
54 download the source and compile it or simply download the static binary,
55 which doesn't require you to complile anything.
ef61890e 56 2. Place the wkhtmltopdf executable into the print module lib directory
b08256cd
JV
57 (usually sites/all/modules/print/lib). You can also place a symbolic link
58 to the executable.
59 3. You will need a running X Server or the virtual (headless) X
60 framebuffer server: Xvfb. Place the Xvfb binary or a symbolic link to it
ef61890e 61 in the print module lib directory (usually sites/all/modules/print/lib).
b08256cd
JV
62 4. Check http://code.google.com/p/wkhtmltopdf/ for further information.
63
623692c4
JV
64UPDATE
65------
30ff938c 66
623692c4
JV
67When updating from a previous version, just remove the print directory and
68follow the instructions above. Make sure that you backup any costumization
69to the print.tpl.php and print.css files.
bbdd5784 70
623692c4
JV
71ROBOTS
72------
73
74Even though it is possible to set per-page robots settings, the following
75can be placed in your robots.txt file after the User-agent line to prevent
76search engines from even asking for the page:
bbdd5784
JV
77
78Disallow: /print/
79
623692c4
JV
80Also, for updates from older versions (<=4.7.x-1.0 and <=5.x-1.2) which used
81node/nnn/print instead of print/nnn, the following lines can prevent
82requests from Google for the obsolete print URLs:
bbdd5784 83
bbdd5784
JV
84Disallow: /*/print$
85
623692c4
JV
86Note that pattern matching in robots.txt is a Google extension (see
87http://www.google.com/support/webmasters/bin/answer.py?answer=40367 for more
88information).
bbdd5784 89
623692c4 90// $Id$