Skip to main content

Introduction

Welcome to the documentation for PDF Generator, your complete solution for creating dynamic PDFs in Joomla! 4 and beyond. Whether you're a website owner or administrator, this extension simplifies the process of turning your content into professional-quality PDF files.

Key Features​

  • Seamless Integration: PDF Generator smoothly integrates with your Joomla website, streamlining PDF generation.

  • Content Compatibility: Enjoy native support for Joomla's com_content and FLEXIcontent through dedicated plugins. This ensures straightforward PDF creation from articles and custom content types.

  • Future-Proof: Our commitment to enhancing your experience means we're continually developing new plugins, expanding support to popular Joomla extensions like HikaShop and others (let us know your needs).

  • Easy Template Creation : At the core of PDF Generator is the concept of template-based PDF generation. Customize templates for specific content types, such as Joomla categories or FLEXIcontent types. These templates are designed for user-friendliness and flexibility.

  • Visual Editing Made Simple : Use the intuitive GrapesJS visual editor to design templates effortlessly. No technical expertise required. Craft visually appealing templates that align with your website's branding seamlessly.

  • Generate PDFs On Your Terms : PDF Generator puts you in control of PDF file generation. Whether it's individual files/documents or entire catalogs/books, you decide when to create them. This flexibility allows you to experiment with templates and make modifications while always having PDFs ready for download.

  • Creating Files : Once your template is ready, generating PDF files is straightforward. A file or PDF file associates your template with compatible articles/items. The robust Dompdf library ensures high-quality PDFs, preserving visual integrity and quality.

  • Creating Catalogs/Books : Take PDF generation to the next level by assembling your created files into catalogs/books. These compilations are created with the help of the Setasign FPDI library, enabling you to create comprehensive documents that bring together multiple content pieces into a cohesive whole.

Operating Principle​

Two types of PDFs can be created:

  1. Free-form PDFs, such as a cover page.
  2. PDFs generated from content data (e.g., com_content article, FLEXIcontent item).

In both cases, creation involves the use of a template that defines the PDF layout. In the first case, the template directly integrates the content, while in the second case, the content is dynamically called using shortcodes (replaced during document generation) and must be specifically associated with a data and content type.

The templates can be of three types:

  • Content: for any type of PDF.
  • Header: which can be used alongside several other ("content" and "footer") templates.
  • Footer: which can be used alongside several other ("content" and "header") templates.

Create as many templates for a single item/article as needed: several PDFs can be generated from different templates for specific layouts from the same content.

Making PDFs available for download on your site is done via a module. A download button will only display if a corresponding PDF exists and has been generated beforehand.

In this documentation, we will guide you through every aspect of PDF Generator, from installation and configuration to advanced tips and tricks. Our goal is to make your experience with PDF generation in Joomla seamless, productive, and capable of producing professional-quality documents.