/[drupal]/contributions/modules/print/README.txt
ViewVC logotype

Contents of /contributions/modules/print/README.txt

Parent Directory Parent Directory | Revision Log Revision Log | View Revision Graph Revision Graph


Revision 1.4.2.1.2.3.2.3 - (show annotations) (download)
Sat May 10 01:41:25 2008 UTC (18 months, 1 week ago) by jcnventura
Branch: DRUPAL-5--3
CVS Tags: DRUPAL-5--3-5
Changes since 1.4.2.1.2.3.2.2: +62 -167 lines
File MIME type: text/plain
Improve the documentation
1 DESCRIPTION
2 -----------
3
4 This module allows you to generate printer friendly versions of any node by
5 navigating to www.example.com/print/nid, where nid is the node id of content
6 to render.
7
8 A link is inserted in the each node (configurable in the content type
9 settings), that opens a version of the page with no sidebars, search boxes,
10 navigation pages, etc.
11
12 CONFIGURATION
13 -------------
14
15 - There are several settings that can be configured in the following places:
16
17 Administer › Site building › Modules (admin/build/modules)
18 Enable or disable the module. (default: disabled)
19
20 Administer › User management › Access control (admin/user/access)
21 Under print module:
22 access print: Enable access to the PF page and display of the PF link in
23 other pages. (default: disabled)
24 administer print: Enable access to the module settings page. (default:
25 disabled)
26
27 Administer › Content management › Content types (admin/content/types)
28 For each content type it is possible to enable or disable the PF link
29 via the "Show printer-friendly version link" checkbox. (default:
30 enabled)
31
32 Administer › Content management › Comments › Settings (admin/content/comment/settings)
33 It is possible to enabled or disable the PF link in individual comments
34 via the "Show printer-friendly version link in individual comments"
35 checkbox. (default: disabled)
36
37 Administer › Site configuration › Printer-friendly (admin/settings/print)
38 This is where all the module-specific configuration options can be set.
39
40 - To modify the template of printer friendly pages, simply edit the
41 print.tpl.php or the print.css files found in this directory.
42
43 - It is possible to set per-content-type and/or theme-specific templates
44 which are searched for in the following order:
45 1. print.node-__type__.tpl.php in the theme directory
46 2. print.node-__type__.tpl.php in the module directory
47 3. print.tpl.php in the theme directory
48 4. print.tpl.php in the module directory (supplied by the module)
49
50 API
51 ---
52
53 The following function is available to content developers that prefer to
54 place the printer-friendly link in a custom location. It is advisable to
55 disable the regular Printer-friendly link so that it is not shown in both
56 locations.
57
58 Calling the function like this:
59
60 print_insert_link()
61
62 will return the HTML for a link pointing to a Printer-friendly version of
63 the current page.
64
65 It is also possible to specify the link to the page yourself:
66
67 print_insert_link("print/42")
68
69 will return the HTML pointing to the printer-friendly version of node 42.
70
71
72 THEMEABLE FUNCTIONS
73 -------------------
74
75 The following themeable functions are defined:
76
77 theme_print_format_link()
78 Returns an array of formatted attributes for the Printer-friendly link.
79
80 theme_print_text
81 Returns an array of costumized text strings used in the printer-friendly
82 page.
83
84 MORE INFORMATION
85 ----------------
86
87 For more information, consult the modules' documentation at
88 http://drupal.org/node/190171.

  ViewVC Help
Powered by ViewVC 1.1.2