Issue #1299150 by pluess: rules action to send an e-nail of a configured node.
[project/print.git] / README.txt
1 DESCRIPTION
2 -----------
3
4 This module allows you to generate the following printer-friendly versions
5 of any node:
6
7     * Web page printer-friendly version (at www.example.com/print/nid)
8     * PDF version (at www.example.com/printpdf/nid)
9     * Send by-email (at www.example.com/printmail/nid)
10
11 where nid is the node id of content to render.
12
13 A link is inserted in the each node (configurable in the content type
14 settings), that opens a version of the page with no sidebars, search boxes,
15 navigation pages, etc.
16
17 INSTALLATION
18 ------------
19
20 Follow the instructions in the provided INSTALL.txt file.
21
22 CONFIGURATION
23 -------------
24
25 - There are several settings that can be configured in the following places:
26
27   Administer > Site building > Modules (admin/build/modules)
28     Enable or disable the module. (default: disabled)
29
30   Administer > User management > Permissions (admin/user/permissions)
31     Under print module:
32     access print: Enable access to the PF page and display of the PF link in
33     other pages. (default: disabled)
34     administer print: Enable access to the module settings page. (default:
35     disabled)
36
37   Administer > Content management > Content types (admin/content/types)
38     For each content type it is possible to enable or disable the PF link
39     via the "Show printer-friendly version link" checkbox. (default:
40     enabled)
41     It is also possible to enable or disable the PF link in individual
42     comments via the "Show printer-friendly version link in individual
43     comments" checkbox. (default: disabled)
44
45   Administer > Site configuration > Printer-friendly (admin/settings/print)
46     This is where all the module-specific configuration options can be set.
47
48 - To modify the template of printer friendly pages, simply edit the
49 print.tpl.php or the css/print.css files.
50
51 - It is possible to set per-content-type and/or theme-specific templates
52   which are searched for in the following order: 
53    1. print_[format].node-[type].tpl.php in the theme directory
54    2. print_[format].node-[type].tpl.php in the module directory 
55    3. print_[format].tpl.php in the theme directory
56    4. print_[format].tpl.php in the module directory 
57    5. print.node-[type].tpl.php in the theme directory
58    6. print.node-[type].tpl.php in the module directory 
59    7. print.tpl.php in the theme directory
60    8. print.tpl.php in the module directory (supplied by the module)
61
62   format is either html, mail or pdf, and type is Drupal's node type (e.g.
63   page, story, etc.)
64
65 API
66 ---
67
68 print_insert_link(), print_mail_insert_link(), print_pdf_insert_link()
69
70 The *_insert_link functions are available to content developers that prefer
71 to place the printer-friendly link in a custom location. It is advisable to
72 disable the regular Printer-friendly link so that it is not shown in both
73 locations.
74
75 Calling the function like this:
76
77   print_insert_link()
78
79 will return the HTML for a link pointing to a Printer-friendly version of
80 the current page.
81
82 It is also possible to specify the link to the page yourself:
83
84   print_insert_link("print/42")
85
86 will return the HTML pointing to the printer-friendly version of node 42.
87
88 THEMEABLE FUNCTIONS
89 -------------------
90
91 The following themeable functions are defined:
92
93   * theme_print_format_link()
94   * theme_print_mail_format_link()
95   * theme_print_pdf_format_link()
96       Returns an array of formatted attributes for the Printer-friendly
97       link.
98
99   * print_pdf_dompdf_footer($html)
100     Format the dompdf footer contents
101
102   * print_pdf_tcpdf_header($pdf, $html, $font)
103     Format the TCPDF header
104
105   * print_pdf_tcpdf_page($pdf)
106     Format the TCPDF page settings (margins, etc)
107
108   * print_pdf_tcpdf_content($pdf, $html, $font)
109     Format the TCPDF page content
110
111   * print_pdf_tcpdf_footer($pdf, $html, $font)
112     Format the TCPDF footer contents
113
114   * print_pdf_tcpdf_footer2($pdf)
115     Format the TCPDF footer layout
116
117 MORE INFORMATION
118 ----------------
119
120 For more information, consult the modules' documentation at
121 http://drupal.org/node/190171.
122
123 ACKNOWLEDGMENTS
124 ---------------
125 The print, pdf and mail icons are copyright Plone Foundation. Thanks for
126 letting me use them!
127