Magento 2 PDF Catalog

Magento 2 PDF Catalog extension enables the admin to create thousands of PDF catalogs for Magento 2 store products and categories in a fraction of second!

 

Table of Content

  1. Extension Installation Guide
  2. Configuration
  3. Product List View Display Settings
  4. Product Grid View Display Settings
  5. Product Attribute Inclusion
  6. PDF Catalog in Frontend
  7. Printing PDF Catalog from Backend

 

  1. Extension Installation
  • Extract the zip folder and upload our extension to the root of your Magento 2 directory via FTP.
  • Download and install wkhtmltopdf.
  • Login to your SSH and run below commands step by step:
    • composer require staempfli/magento2-module-pdf
    • php bin/magento setup:upgrade
    • For Magento version 2.0.x to 2.1.x - php bin/magento setup:static-content:deploy
    • For Magento version 2.2.x & above - php bin/magento setup:static-content:deploy –f
    • php bin/magento cache:flush
  • That’s it.

Note: Don’t forget to install staempfli library to make PDF catalog work.

Also, after installing wkhtmltopdf, go to Stores > Configuration > Advanced > PDF Generation and make the following settings.

  

 

  1. Configuration
    For configuring the extension, login to Magento 2, move to Stores > Configuration > PDF Catalog where you can find various settings to enable the extension.
  • PDF Catalog: Enable the PDF Catalog extension from here.
  • Cover Page Background: Upload PDF cover page image.
  • Text Color: Set the color of the PDF text.
  • Product Attributes in PDF: Add product attributes to show their details along with the products in PDF.
  • Footer Text: Set text to show in the PDF footer.
  • Display Date in Header: Select YES to display the date in PDF header.
  • Date Display Format: Set the format of the date display in PDF.
  • Allowed Customer Groups: Select customer groups to allow printing PDF catalog from the category page.
  • Print Catalog for: Select for which products you want to allow printing the PDF catalog.
  • Arrange Product Sorting in PDF by: Select the sort option for the product arrangement in the PDF catalog.
  • Order Products in PDF by: Select order by option for the products in PDF catalog.


 

  1. Product List View Display Settings
    The extension allows both the users and the admin to print the catalog in two views. Make settings for the list view display of products in the PDF catalog.
     
  • Border Color: Set border color for the list view box.
  • Box Height: Set the height of the list view box.
  • Product Title Color: Set the color of the product title display in the PDF catalog.
  • Product Attribute Label Color: Set the color of the product attribute label display in the PDF catalog.
  • Product Attribute Value Color: Set the color of the product attribute value display in the PDF catalog.
  • Description Display Character Limit: Set the character limit display for the product description in PDF.
  • Display Read More Link: Set YES to display read more link for the product description.
  • Enable QR Codes: Set YES to enable QR codes for the products in the PDF catalog.


  

  1. Product Grid View Display Settings
    Make settings for the grid view display of products in the PDF catalog.

 

  • Enable Grid Border: Select YES to enable the border for the grid box in PDF.
  • Border Color: Set border color for the grid view box.
  • Per Page Products: Select the number of the products to be displayed per page in PDF.
  • Product Title Color: Set the color of the product title display in the PDF catalog.
  • Product Attribute Label Color: Set the color of the product attribute label display in the PDF catalog.
  • Product Attribute Value Color: Set the color of the product attribute value display in the PDF catalog.
  • Description Display Character Limit: Set the character limit display for the product description in PDF.
  • Display Read More Link: Set YES to display read more link for the product description.
  • Enable QR Codes: Set YES to enable QR codes for the products in the PDF catalog.


 
  1. Product Attribute Inclusion
    The extension only allows adding product attributes in the PDF catalog if it’s enabled for the extension. To enable product attributes to allow adding in the PDF catalog, go to Stores > Attributes > Product à Click on one of the product attributes > Attribute Information > Properties > Advanced Attribute Properties and select “Yes” to Allow Inclusion in PDF Catalog. Only product attributes with the option YES to “Allow Inclusion in PDF Catalog” will be shown in the configuration section.


  

  1. PDF Catalog in Frontend
    Once the required configurations are done, customers can see the “Print Catalog” button on the category page.



 

  • Print Catalog Options
    On the click of the “Print Catalog” button from the category page, customers get additional options to be selected prior to catalog PDF printing.
    • Print PDF Catalog Layout View: Select one of the catalog layout view options.
    • Product Categories/Sub Categories Headings: Tick the checkbox to print the category/subcategory name in PDF header.
    • Title/Cover Page: Tick the checkbox to print the cover page in PDF.
    • Table of Contents with Page Numbers: Tick the checkbox to print table of contents with page numbers in PDF catalog.



 

  • PDF Catalog Grid View


 

  • PDF Catalog List View


 

  1. Printing PDF Catalog from Backend
    Apart from the frontend, the admin can also print a PDF catalog from the Catalog > Manage Categories section in the backend. The admin gets the same download options for the PDF layout and other options prior to downloading the PDF catalog.