You are here

Home » API reference » Printer and PDF versions for Drupal 8+ 8

README.txt in Printer and PDF versions for Drupal 8+ 8

Same filename and directory in other branches
  1. 2.x README.txt
CONTENTS
--------
 * INTRODUCTION
 * REQUIREMENTS
 * INSTALLATION
 * CONFIGURATION

INTRODUCTION
------------

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

    * Web page printer-friendly version (at /node/<nid>/printable/print)
    * PDF version (at /node/<nid>/printable/pdf)

where nid is the node id of content to render.

REQUIREMENTS
------------

 * This module is depends upon PDF Generator API (https://www.drupal.org/project/pdf_api)

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

(This will simplify a lot once https://www.drupal.org/project/drupal/issues/2494073
is fixed).

- Download this module either using composer or by getting it directly from
  drupal.org:

  composer require drupal/printable

- Install this module's composer dependencies - they can be found in
  composer.json in the project directory. Run composer require for each
  dependency from the Drupal root:

  composer require "wa72/htmlpagedom": "1.3.*"
  composer require "smalot/pdfparser": "*"

- Enable printable:

  drush en -y printable

PDF GENERATION
--------------

- Download and install the pdf_api module. Check the contents of its
  composer.json and run composer require from the Drupal root for each
  library, as was done for this module above.

- Enable this module's PDF support, which will also now be able to enable
  pdf_api.

  drush en -y printable_pdf

- Install a library for generating PDFs (mPDF, TCPDF, wkhtmltopdf and dompdf
  are supported. Test status at 18 January 2018 is as follows (Ubuntu Xenial
  VM):
  - mPDF: Needs more testing.
  - TCPDF: Just works.
  - wkhtmltopdf: Fails with an error that print_api doesn't send back or
    display. I've opened an issue with print_api regarding suppling a patch
    or taking over maintaining the module.
  - dompdf: Needs more testing.

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

- Configure your PDF library at /admin/config/user-interface/printable/pdf.
  For wkhtmltopdf, after you submit the form with wkthmltopdf selected, the
  form will gain an extra field allowing you to enter the path to the binary.
  Fill this field and submit again.

- Under /admin/config/user-interface/printable/linksi/pdf, click on the PDF
  second level tab and choose where PDF links should appear.

File

README.txt
View source 
  1. CONTENTS

  2. --------

  3.  * INTRODUCTION

  4.  * REQUIREMENTS

  5.  * INSTALLATION

  6.  * CONFIGURATION

  7. 

  8. INTRODUCTION

  9. ------------

  10. 

  11. This module allows you to generate the following printer-friendly versions

  12. of any node:

  13. 

  14.     * Web page printer-friendly version (at /node//printable/print)

  15.     * PDF version (at /node//printable/pdf)

  16. 

  17. where nid is the node id of content to render.

  18. 

  19. REQUIREMENTS

  20. ------------

  21. 

  22.  * This module is depends upon PDF Generator API (https://www.drupal.org/project/pdf_api)

  23. 

  24. INSTALLATION

  25. ------------

  26. 

  27. (This will simplify a lot once https://www.drupal.org/project/drupal/issues/2494073

  28. is fixed).

  29. 

  30. - Download this module either using composer or by getting it directly from

  31.   drupal.org:

  32. 

  33.   composer require drupal/printable

  34. 

  35. - Install this module's composer dependencies - they can be found in

  36.   composer.json in the project directory. Run composer require for each

  37.   dependency from the Drupal root:

  38. 

  39.   composer require "wa72/htmlpagedom": "1.3.*"

  40.   composer require "smalot/pdfparser": "*"

  41. 

  42. - Enable printable:

  43. 

  44.   drush en -y printable

  45. 

  46. PDF GENERATION

  47. --------------

  48. 

  49. - Download and install the pdf_api module. Check the contents of its

  50.   composer.json and run composer require from the Drupal root for each

  51.   library, as was done for this module above.

  52. 

  53. - Enable this module's PDF support, which will also now be able to enable

  54.   pdf_api.

  55. 

  56.   drush en -y printable_pdf

  57. 

  58. - Install a library for generating PDFs (mPDF, TCPDF, wkhtmltopdf and dompdf

  59.   are supported. Test status at 18 January 2018 is as follows (Ubuntu Xenial

  60.   VM):

  61.   - mPDF: Needs more testing.

  62.   - TCPDF: Just works.

  63.   - wkhtmltopdf: Fails with an error that print_api doesn't send back or

  64.     display. I've opened an issue with print_api regarding suppling a patch

  65.     or taking over maintaining the module.

  66.   - dompdf: Needs more testing.

  67. 

  68. CONFIGURATION

  69. -------------

  70. 

  71. - Configure your PDF library at /admin/config/user-interface/printable/pdf.

  72.   For wkhtmltopdf, after you submit the form with wkthmltopdf selected, the

  73.   form will gain an extra field allowing you to enter the path to the binary.

  74.   Fill this field and submit again.

  75. 

  76. - Under /admin/config/user-interface/printable/linksi/pdf, click on the PDF

  77.   second level tab and choose where PDF links should appear.