You are here

README.txt in Views PDF 6

Same filename and directory in other branches
  1. 8 README.txt
  2. 7.3 README.txt
  3. 7 README.txt
  4. 7.2 README.txt
With the Views PDF module you can output a view as a PDF document. Each field of
the view can be placed on the PDF page directly in the administration interface. 
Therefore a new display called "PDF" is added.

There are already some PDF solutions such as Print. But these solutions use the 
HTML output and converts this to PDF. The disadvantages of such an integration 
are:
    * No control over page flow (e.g. page break).
    * Little or no control over page header and footer.
    * You need HTML skills to change the layout.
    * The rendering is slow and need a lot of memory, because it need to render 
      the HTML.
    * Complex tables make troubles.
    * Vector graphics can not be implemented, therefore the printing of the doc-
      ument can be problematic.
    * You are limited by HTML's capabilities.



Installation instructions:
--------------------------
   1. Download the module or checkout the module.
   2. Upload the module to your Drupal instance.
   3. Download the required libraries. Download TCPDF and FPDI. Copy the files 
      to the lib directory in the module directory. The path must be so: 
      "sites/all/libraries/tcpdf/tcpdf.php" respectively "sites/all/libraries/fpdi/fpdi.php".
      If you are using the Libraries API then put them into the libraries folder.
   4. Check under reports if you setup everything correct.
   5. Setup a view with a PDF display.
   6. Use it.

Basic Usage
-----------
   1. Setup a new view or use an existing view. How to do this see in the 
      documentation of the Views module.
   2. In the view add the display "PDF Page".
   3. Select the new added display.
   4. Select the Style. You can use PDF unformatted to place the fields in no 
      structured way on the PDF. Use PDF table to place the fields in table with 
      a table header.
   5. In the settings of the style you can setup per field settings. Such as the
      position, the size of the field, the font and so on. Important: Switch to 
      the PDF Page display in the default display this options does not appear.
   6. Under PDF Page Setting you can setup the size of the page.
   7. Under PDF Font Settings you can setup the default fonts for the PDF.
   8. Under PDF Template Settings you can setup a background PDF.
   9. To add a page break, you can add a PDF page break field. When this field 
      is rendered new page is added. Reorder the fields if necessary.
  10. You can find also a page number field. You can use it to print the current
      page number. Important for positioning the field in the header or footer, 
      you need to set the relative position in the field settings to 
      "In header / footer".

File

README.txt
View source
  1. With the Views PDF module you can output a view as a PDF document. Each field of
  2. the view can be placed on the PDF page directly in the administration interface.
  3. Therefore a new display called "PDF" is added.
  4. There are already some PDF solutions such as Print. But these solutions use the
  5. HTML output and converts this to PDF. The disadvantages of such an integration
  6. are:
  7. * No control over page flow (e.g. page break).
  8. * Little or no control over page header and footer.
  9. * You need HTML skills to change the layout.
  10. * The rendering is slow and need a lot of memory, because it need to render
  11. the HTML.
  12. * Complex tables make troubles.
  13. * Vector graphics can not be implemented, therefore the printing of the doc-
  14. ument can be problematic.
  15. * You are limited by HTML's capabilities.
  16. Installation instructions:
  17. --------------------------
  18. 1. Download the module or checkout the module.
  19. 2. Upload the module to your Drupal instance.
  20. 3. Download the required libraries. Download TCPDF and FPDI. Copy the files
  21. to the lib directory in the module directory. The path must be so:
  22. "sites/all/libraries/tcpdf/tcpdf.php" respectively "sites/all/libraries/fpdi/fpdi.php".
  23. If you are using the Libraries API then put them into the libraries folder.
  24. 4. Check under reports if you setup everything correct.
  25. 5. Setup a view with a PDF display.
  26. 6. Use it.
  27. Basic Usage
  28. -----------
  29. 1. Setup a new view or use an existing view. How to do this see in the
  30. documentation of the Views module.
  31. 2. In the view add the display "PDF Page".
  32. 3. Select the new added display.
  33. 4. Select the Style. You can use PDF unformatted to place the fields in no
  34. structured way on the PDF. Use PDF table to place the fields in table with
  35. a table header.
  36. 5. In the settings of the style you can setup per field settings. Such as the
  37. position, the size of the field, the font and so on. Important: Switch to
  38. the PDF Page display in the default display this options does not appear.
  39. 6. Under PDF Page Setting you can setup the size of the page.
  40. 7. Under PDF Font Settings you can setup the default fonts for the PDF.
  41. 8. Under PDF Template Settings you can setup a background PDF.
  42. 9. To add a page break, you can add a PDF page break field. When this field
  43. is rendered new page is added. Reorder the fields if necessary.
  44. 10. You can find also a page number field. You can use it to print the current
  45. page number. Important for positioning the field in the header or footer,
  46. you need to set the relative position in the field settings to
  47. "In header / footer".