Jump to content
Wanze

Pages2Pdf

Recommended Posts

Hi,

After reading this thread, I decided to make a module that helps generating PDF files of ProcessWire pages.

GitHub: https://github.com/wanze/Pages2Pdf

Modules Directory: http://modules.processwire.com/modules/pages2-pdf/

This module uses the mPDF library to generate the PDF files. It has fully UTF-8 and basic HTML/CSS support for rendering the PDF files.

The output is customizable with ProcessWire templates. 

Example

I've enabled generating PDF files for the skyscraper template of ryans Skyscrapers-profile with a template that outputs the data in a table along with the body text and the images:

one-atlantic-center-pdf-4177.pdf

Please take a look at the README on GitHub for instructions and further information/examples.

Cheers

Edited by Nico Knoll
Added the "module" tag and removed it from title.
  • Like 33

Share this post


Link to post
Share on other sites

This will be real timesaver and super useful module, thanks Wanze!

Share this post


Link to post
Share on other sites

Cool thanks! Bisch voll im Schuss!? ;-) Why didnt this post appear in my no read list?

Share this post


Link to post
Share on other sites

Great addition Wanze! Might need this soon. Already started looking at the wat luis generated pdf's, but this seems great!

Share this post


Link to post
Share on other sites

Looks great! Would it be possible to render multiple pages in a single .pdf using this?

Share this post


Link to post
Share on other sites

Thanks people,

Please report feedback or ideas for further improvements.

Looks great! Would it be possible to render multiple pages in a single .pdf using this?

Yep. The pdf is generated from a ProcessWire template in /site/templates/pages2pdf/.

Think of it as a normal Pw template: You can use $page, $pages, $users and all other variables to search and output your

content. The only restriction is that you have limited html support, so make sure you use supported html

tags in TCPDF (see link in first post).

There's also another module which generates pdfs from the Admin:

http://modules.processwire.com/modules/pdfcomposer/

Share this post


Link to post
Share on other sites

Just dropping in to say that I'll definitely try this module out soon, looks very promising. Thanks for making this!

For the record, I've used mPDF in the past for creating PDF versions of pages. It's HTML and CSS support seemed superior compared to other libraries at the time, at least for my use cases. Might have to switch one site to use this module instead of mPDF just to see how they really compare.

Taking a look at your code I'm seeing quite a bit similarities with these libraries; for an example seem to have identical method names. Interesting. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hi teppo,

Thanks.

This is very interesting, I didn't know mPDF before. Looks very promising if the html support is better plus the whole

library is very lightweight compared toTCPDF.

TCPDF and also mPDF are both extensions of FPDF. Some years ago, I used FPDF but the problem there

is the missung UTF-8 and HTML support.

As most of the libraries seem to depend on FPDF, this now has the advantage that one could easily exchange the library behind the module without changing much code.

Looking forward to your feedback! :)

  • Like 1

Share this post


Link to post
Share on other sites

Great module, I'll give it a good use.

Thank you for sharing Wanze.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks manviny!

If you have ideas for improvements, please share.

Haven't used the module myself actually :)

Cheers

Share this post


Link to post
Share on other sites

Hi Wanze, great work and very useful! :)

I have one question: do you plan to embedd the FPDI-Extension into it?

I know it from working with FPDF. In the past FPDI-Extension couldn't bundled with TCPDF a long time because of the licence, but this has changed a few year ago.
 

Would be useful to upload or otherwise specify a PDF as background on a 'per-Template-Basis'. (<= uh, ugly Denglish)

Share this post


Link to post
Share on other sites

Horst - thanks! :)

Never heard of the FPDI extension. I checked your link and read some docs on the website, but I'm not sure

how this should be integrated here.

Can you give me more details? :)

What do you mean with "background"? As far as I understand, FPDI is used to import pages from other

pdf's into your pdf.

Grüsse nach Deutschland!

Share this post


Link to post
Share on other sites

Horst - thanks! :)

Never heard of the FPDI extension. I checked your link and read some docs on the website, but I'm not sure

how this should be integrated here.

Can you give me more details? :)

What do you mean with "background"? As far as I understand, FPDI is used to import pages from other

pdf's into your pdf.

Grüsse nach Deutschland!

Hi Wanze, yes with the FPDI extension you can import other PDFs, but in different ways. What I mean with 'as Background' and what I'm find very useful is, for example:

You can take a PDF with your e.g. Briefkopf , assuming you have a first page with all your stuff (Logo, adress, bankinfo, tax number, etc.) and a second page with less data (maybe a smaller version of your Logo and only name and phone number), and use it as background-layers:

// example use of FPDI-Extension with FPDF.

	$tplfile = 'C:/fpdf/templates/mein_briefkopf.pdf';
	$pagecount = $this->pdf->setSourceFile($tplfile);              // defining the sourcefile returns Pagenumber of it
	for($i=1;$i<=$pagecount;$i++)
	{
		$this->fpdiTemplates['tpl_s'.$i] = $this->pdf->ImportPage($i);     // import each page and assign it to a variable
	}
	$this->Parser_Opened = TRUE;
	$this->Use_Template = $this->fpdiTemplates['tpl_s1'];
	...                                                            // write own stuff to the first page
                                                                       // switch the Template to the second page for all
                                                                       // following pages (optional)
        $this->Use_Template = $this->fpdiTemplates['tpl_s2'];
        ... // create more pages

With the use of FPDI-Templates you can add graphical stuff to your pdf-pages with less effort.

On my website one can add images to a virtual lightbox and can download them as a PDF.

There are three template pages: one for the image pages, one with my contact-data and copyright notice! and optional one for user notes.

..., und viele Grüße in die Schweiz :)

  • Like 3

Share this post


Link to post
Share on other sites

Wow horst - that is super awesome; I'll have to revisit this, because i need something like this for a site i'm currently working on, where there is a product and we want to generate a slick product sheet, downloadable pdf using the existing PW content and images...

Share this post


Link to post
Share on other sites

Hi Wanze, thanks for all your work on this, I'm excited to try it out.

Problem I have at the moment is the render call isn't outputting anything. I've definitely added my template in the module settings but there's no link or anything getting outputted.

Have you seen this issue before?

Thanks.

Share this post


Link to post
Share on other sites

Hi onjegolders,

I just noticed that I forgot to add an 'echo' in front of the render call in my first post - updated.

It should be:

echo $modules->get('Pages2Pdf')->render();

Was this the issue? (hope so... :))

Share this post


Link to post
Share on other sites

Yeah that sorted it thanks Wanze, I should have seen that!

Do you know what differences there are between this implementation and using HTML2PDF?

I have a very basic usage of that library and it seems to work "OK" but I'm guessing a PW way is better. Are there any other differences that you know of?

Thanks again for all your hard work Wanze.

Share this post


Link to post
Share on other sites

No problem - thanks you for finding this one! ^-^

I've never used html2pdf before, but it looks like it's an addition on top of tcpdf - the framework that this module is using.

Don't know the differences exactly. This module just integrates TCPDF into ProcessWire, making it easier for you to setup

everything. However, it could be the case that html2pdf has better html support built in for rendering the pdfs than tcpdf.

The module handles creating / caching pdf's for you and you can output the content with Pw templates. This means,

you have the full Pw API available if needed.

If anyone can confirm that other libraries, e.g. html2pdf or mPDF have actually better html support than TCPDF, I'll switch the

framework behind the module.

  • Like 1

Share this post


Link to post
Share on other sites
hi wanze, i have a problem with this module.

When i use english characters is working fine and it exports successfully the pdfs.

But with the greek chars i get question marks.

is there any solution for this; i have search the tcpdf examples but i can't make it  to work

thanks.

Share this post


Link to post
Share on other sites

Hi sakkoulas,

That's because the standard font set by the module does not have those characters included. I removed all fonts but the standard ones from the tcpdf folder so the module doesn't get too heavy.

You can do those steps:

  1. Download TCPDF
  2. Copy all files starting with freesans* or freeserif* to /site/modules/Pages2Pdf/tcpdf/fonts
  3. In your module configs, set freesans/freeserif under Default font

Then the greek characters work (make sure you enable debug mode or save the page to delete any cached pdfs).

I think this is the easiest solution. Disadvantage is that the pdf is a bit heavier due to this font which includes all unicode characters.

Another possibility is to convert a greek font to TCPDF according to the docs: http://www.tcpdf.org/fonts.php

Does this work for you?

  • Like 2

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Process refunds and send customer notifications from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory (alpha version only available via GitHub) SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Robin S
      This module is inspired by and similar to the Template Stubs module. The author of that module has not been active in the PW community for several years now and parts of the code for that module didn't make sense to me, so I decided to create my own module. Auto Template Stubs has only been tested with PhpStorm because that is the IDE that I use.
      Auto Template Stubs
      Automatically creates stub files for templates when fields or fieldgroups are saved.
      Stub files are useful if you are using an IDE (e.g. PhpStorm) that provides code assistance - the stub files let the IDE know what fields exist in each template and what data type each field returns. Depending on your IDE's features you get benefits such as code completion for field names as you type, type inference, inspection, documentation, etc.
      Installation
      Install the Auto Template Stubs module.
      Configuration
      You can change the class name prefix setting in the module config if you like. It's good to use a class name prefix because it reduces the chance that the class name will clash with an existing class name.
      The directory path used to store the stub files is configurable.
      There is a checkbox to manually trigger the regeneration of all stub files if needed.
      Usage
      Add a line near the top of each of your template files to tell your IDE what stub class name to associate with the $page variable within the template file. For example, with the default class name prefix you would add the following line at the top of the home.php template file:
      /** @var tpl_home $page */ Now enjoy code completion, etc, in your IDE.

      Adding data types for non-core Fieldtype modules
      The module includes the data types returned by all the core Fieldtype modules. If you want to add data types returned by one or more non-core Fieldtype modules then you can hook the AutoTemplateStubs::getReturnTypes() method. For example, in /site/ready.php:
      // Add data types for some non-core Fieldtype modules $wire->addHookAfter('AutoTemplateStubs::getReturnTypes', function(HookEvent $event) { $extra_types = [ 'FieldtypeDecimal' => 'string', 'FieldtypeLeafletMapMarker' => 'LeafletMapMarker', 'FieldtypeRepeaterMatrix' => 'RepeaterMatrixPageArray', 'FieldtypeTable' => 'TableRows', ]; $event->return = $event->return + $extra_types; }); Credits
      Inspired by and much credit to the Template Stubs module by mindplay.dk.
       
      https://github.com/Toutouwai/AutoTemplateStubs
      https://modules.processwire.com/modules/auto-template-stubs/
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.60
      Composer: rockett/jumplinks
      ⚠️ NOTICE: 1.5.60 is an important security patch-release for an XSS vulnerability discovered by @phlp. It's HIGHLY RECOMMENDED that all Jumplinks users update to the latest version as soon as possible.
      Jumplinks is an enhanced version of the original ProcessRedirects by Antti Peisa.
      The Process module manages your permanent and temporary redirects (we'll call these "jumplinks" from now on, unless in reference to redirects from another module), useful for when you're migrating over to ProcessWire from another system/platform. Each jumplink supports wildcards, shortening the time needed to create them.
      Unlike similar modules for other platforms, wildcards in Jumplinks are much easier to work with, as Regular Expressions are not fully exposed. Instead, parameters wrapped in curly braces are used - these are described in the documentation.
      Under Development: 2.0, to be powered by FastRoute
      As of version 1.5.0, Jumplinks requires at least ProcessWire 2.6.1 to run.
      View on GitLab
      Download via the Modules Directory
      Read the docs
      Features
      The most prominent features include:
      Basic jumplinks (from one fixed route to another) Parameter-based wildcards with "Smart" equivalents Mapping Collections (for converting ID-based routes to their named-equivalents without the need to create multiple jumplinks) Destination Selectors (for finding and redirecting to pages containing legacy location information) Timed Activation (activate and/or deactivate jumplinks at specific times) 404-Monitor (for creating jumplinks based on 404 hits) Additionally, the following features may come in handy:
      Stale jumplink management Legacy domain support for slow migrations An importer (from CSV or ProcessRedirects) Feedback & Feature Requests
      I’d love to know what you think of this module. Please provide some feedback on the module as a whole, or even regarding smaller things that make it whole. Also, please feel free to submit feature requests and their use-cases.
      Note: Features requested so far have been added to the to-do list, and will be added to 2.0, and not the current dev/master branches.
      Open Source

      Jumplinks is an open-source project, and is free to use. In fact, Jumplinks will always be open-source, and will always remain free to use. Forever. If you would like to support the development of Jumplinks, please consider making a small donation via PayPal.
      Enjoy! 🙂
    • By Robin S
      Add Image URLs
      Allows images/files to be added to Image/File fields by pasting URLs.

      Usage
      Install the Add Image URLs module.
      A "Paste URLs" button will be added to all image and file fields. Use the button to show a textarea where URLs may be pasted, one per line. Images/files are added when the page is saved.
       
      https://github.com/Toutouwai/AddImageUrls
      https://modules.processwire.com/modules/add-image-urls/
×
×
  • Create New...