You are here

README.txt in Printer, email and PDF versions 5.x

DESCRIPTION
-----------

This module allows you to generate the following printer-friendly versions
of any node:

    * Web page printer-friendly version (at www.example.com/print/nid)
    * PDF version (at www.example.com/printpdf/nid)
    * Send by-email (at www.example.com/printmail/nid)

where nid is the node id of content to render.

A link is inserted in the each node (configurable in the content type
settings), that opens a version of the page with no sidebars, search boxes,
navigation pages, etc.

INSTALLATION
------------

Follow the instructions in the provided INSTALL.txt file.

CONFIGURATION
-------------

- There are several settings that can be configured in the following places:

  Administer > Site building > Modules (admin/build/modules)
    Enable or disable the module. (default: disabled)

  Administer > User management > Permissions (admin/user/permissions)
    Under print module:
    access print: Enable access to the PF page and display of the PF link in
    other pages. (default: disabled)
    administer print: Enable access to the module settings page. (default:
    disabled)

  Administer > Content management > Content types (admin/content/types)
    For each content type it is possible to enable or disable the PF link
    via the "Show printer-friendly version link" checkbox. (default:
    enabled)
    It is also possible to enable or disable the PF link in individual
    comments via the "Show printer-friendly version link in individual
    comments" checkbox. (default: disabled)

  Administer > Site configuration > Printer-friendly (admin/settings/print)
    This is where all the module-specific configuration options can be set.

- To modify the template of printer friendly pages, simply edit the
print.tpl.php or the css/print.css files.

- It is possible to set per-content-type and/or theme-specific templates
  which are searched for in the following order: 
   1. print_[format].node-[type].tpl.php in the theme directory
   2. print_[format].node-[type].tpl.php in the module directory 
   3. print_[format].tpl.php in the theme directory
   4. print_[format].tpl.php in the module directory 
   5. print.node-[type].tpl.php in the theme directory
   6. print.node-[type].tpl.php in the module directory 
   7. print.tpl.php in the theme directory
   8. print.tpl.php in the module directory (supplied by the module)

  format is either html, mail or pdf, and type is Drupal's node type (e.g.
  page, story, etc.)

API
---

print_insert_link(), print_mail_insert_link(), print_pdf_insert_link()

The *_insert_link functions are available to content developers that prefer
to place the printer-friendly link in a custom location. It is advisable to
disable the regular Printer-friendly link so that it is not shown in both
locations.

Calling the function like this:

  print_insert_link()

will return the HTML for a link pointing to a Printer-friendly version of
the current page.

It is also possible to specify the link to the page yourself:

  print_insert_link("print/42")

will return the HTML pointing to the printer-friendly version of node 42.

THEMEABLE FUNCTIONS
-------------------

The following themeable functions are defined:

  * theme_print_format_link()
  * theme_print_mail_format_link()
  * theme_print_pdf_format_link()
      Returns an array of formatted attributes for the Printer-friendly
      link.

  * print_pdf_dompdf_footer($html)
    Format the dompdf footer contents

  * print_pdf_tcpdf_header($pdf, $html, $font)
    Format the TCPDF header

  * print_pdf_tcpdf_page($pdf)
    Format the TCPDF page settings (margins, etc)

  * print_pdf_tcpdf_content($pdf, $html, $font)
    Format the TCPDF page content

  * print_pdf_tcpdf_footer($pdf, $html, $font)
    Format the TCPDF footer contents

  * print_pdf_tcpdf_footer2($pdf)
    Format the TCPDF footer layout

MORE INFORMATION
----------------

For more information, consult the modules' documentation at
http://drupal.org/node/190171.

ACKNOWLEDGMENTS
---------------
The print, pdf and mail icons are copyright Plone Foundation. Thanks for
letting me use them!

File

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