Fix #696318 by JamesK: move body onload javascript into jQuery document.ready()
[project/print.git] / INSTALL.txt
1 INSTALLATION
2 ------------
3
4 Decompress the print-n.x-n.n.tar.gz file into your Drupal modules
5 directory (usually sites/all/modules, see http://drupal.org/node/176044 for
6 more information).
7
8 Enable the print module: Administer > Site building > Modules
9   (admin/build/modules)
10
11 PDF TOOL
12 --------
13
14 The print_pdf module requires the use of an external PDF generation tool.
15 The currently supported tools are dompdf and TCPDF. Please note that any
16 errors/bugs in those tools need to be reported and fixed by their
17 maintainers. DO NOT report bugs in those tools in the print module's issue
18 queue at Drupal.org.
19
20 dompdf support:
21   The dompdf tool produces results that are more faithful to the HTML
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.
25
26   1. Download dompdf from http://code.google.com/p/dompdf/downloads/list
27   2. Extract the contents of the downloaded package into the print module
28   lib directory (usually sites/all/modules/print/lib)
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
35   6. If you're using dompdf-0.6 or later, you can try to enable the Unicode
36   support, but you'll need to add some Unicode fonts. See 
37   http://groups.google.com/group/dompdf/browse_thread/thread/9f7bc0162b04d5cf
38   for further info on this.
39   7. Check http://code.google.com/p/dompdf/ for further information.
40
41 TCPDF support:
42   TCPDF seems to be more actively developed than dompdf, but it's support
43   for CSS is considerably worse. Unicode is supported (use of Unicode fonts
44   result in HUGE files). Page header and footer are supported. This module
45   requires TCPDF >= 4.0.000.
46
47   1. Download TCPDF from http://sourceforge.net/projects/tcpdf/
48   2. Extract the contents of the downloaded package into the print module
49   lib directory (usually sites/all/modules/print/lib). There is no need to
50   modify the config/tcpdf_config.php file, as the module self-configures
51   TCPDF.
52   3. Check http://tcpdf.sourceforge.net/ for further information.
53
54 wkhtmltopdf support:
55
56   1. Download wkhtmltopdf from
57   http://code.google.com/p/wkhtmltopdf/downloads/list. You can choose to
58   download the source and compile it or simply download the static binary,
59   which doesn't require you to complile anything.
60   2. Place the wkhtmltopdf executable into the print module lib directory
61   (usually sites/all/modules/print/lib). You can also place a symbolic link
62   to the executable.
63   3. Check http://code.google.com/p/wkhtmltopdf/ for further information.
64
65 UPDATE
66 ------
67
68 When updating from a previous version, just remove the print directory and
69 follow the instructions above. Make sure that you backup any costumization
70 to the print.tpl.php and print.css files.
71
72 ROBOTS
73 ------
74
75 Even though it is possible to set per-page robots settings, the following
76 can be placed in your robots.txt file after the User-agent line to prevent
77 search engines from even asking for the page:
78
79 Disallow: /print/
80
81 Also, for updates from older versions (<=4.7.x-1.0 and <=5.x-1.2) which used
82 node/nnn/print instead of print/nnn, the following lines can prevent
83 requests from Google for the obsolete print URLs:
84
85 Disallow: /*/print$
86
87 Note that pattern matching in robots.txt is a Google extension (see
88 http://www.google.com/support/webmasters/bin/answer.py?answer=40367 for more
89 information).
90
91 // $Id$