You are here

README.txt in Printer, email and PDF versions 5.3

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.

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 > Access control (admin/user/access)
    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)

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.

  * theme_print_text()
    Returns an array of costumized text strings used in the printer-friendly
    page.

  * 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. CONFIGURATION
  13. -------------
  14. - There are several settings that can be configured in the following places:
  15. Administer > Site building > Modules (admin/build/modules)
  16. Enable or disable the module. (default: disabled)
  17. Administer > User management > Access control (admin/user/access)
  18. Under print module:
  19. access print: Enable access to the PF page and display of the PF link in
  20. other pages. (default: disabled)
  21. administer print: Enable access to the module settings page. (default:
  22. disabled)
  23. Administer > Content management > Content types (admin/content/types)
  24. For each content type it is possible to enable or disable the PF link
  25. via the "Show printer-friendly version link" checkbox. (default:
  26. enabled)
  27. It is also possible to enable or disable the PF link in individual
  28. comments via the "Show printer-friendly version link in individual
  29. comments" checkbox. (default: disabled)
  30. Administer > Site configuration > Printer-friendly (admin/settings/print)
  31. This is where all the module-specific configuration options can be set.
  32. - To modify the template of printer friendly pages, simply edit the
  33. print.tpl.php or the css/print.css files.
  34. - It is possible to set per-content-type and/or theme-specific templates
  35. which are searched for in the following order:
  36. 1. print_[format].node-[type].tpl.php in the theme directory
  37. 2. print_[format].node-[type].tpl.php in the module directory
  38. 3. print_[format].tpl.php in the theme directory
  39. 4. print_[format].tpl.php in the module directory
  40. 5. print.node-[type].tpl.php in the theme directory
  41. 6. print.node-[type].tpl.php in the module directory
  42. 7. print.tpl.php in the theme directory
  43. 8. print.tpl.php in the module directory (supplied by the module)
  44. API
  45. ---
  46. print_insert_link(), print_mail_insert_link(), print_pdf_insert_link()
  47. The *_insert_link functions are available to content developers that prefer
  48. to place the printer-friendly link in a custom location. It is advisable to
  49. disable the regular Printer-friendly link so that it is not shown in both
  50. locations.
  51. Calling the function like this:
  52. print_insert_link()
  53. will return the HTML for a link pointing to a Printer-friendly version of
  54. the current page.
  55. It is also possible to specify the link to the page yourself:
  56. print_insert_link("print/42")
  57. will return the HTML pointing to the printer-friendly version of node 42.
  58. THEMEABLE FUNCTIONS
  59. -------------------
  60. The following themeable functions are defined:
  61. * theme_print_format_link()
  62. * theme_print_mail_format_link()
  63. * theme_print_pdf_format_link()
  64. Returns an array of formatted attributes for the Printer-friendly
  65. link.
  66. * theme_print_text()
  67. Returns an array of costumized text strings used in the printer-friendly
  68. page.
  69. * print_pdf_dompdf_footer($html)
  70. Format the dompdf footer contents
  71. * print_pdf_tcpdf_header($pdf, $html, $font)
  72. Format the TCPDF header
  73. * print_pdf_tcpdf_page($pdf)
  74. Format the TCPDF page settings (margins, etc)
  75. * print_pdf_tcpdf_content($pdf, $html, $font)
  76. Format the TCPDF page content
  77. * print_pdf_tcpdf_footer($pdf, $html, $font)
  78. Format the TCPDF footer contents
  79. * print_pdf_tcpdf_footer2($pdf)
  80. Format the TCPDF footer layout
  81. MORE INFORMATION
  82. ----------------
  83. For more information, consult the modules' documentation at
  84. http://drupal.org/node/190171.
  85. ACKNOWLEDGMENTS
  86. ---------------
  87. The print, pdf and mail icons are copyright Plone Foundation. Thanks for
  88. letting me use them!