Jump to content

Pages2Pdf


Wanze

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
Link to comment
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/

Link to comment
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
Link to comment
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
Link to comment
Share on other sites

  • 4 weeks later...

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)

Link to comment
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!

Link to comment
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
Link to comment
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...

Link to comment
Share on other sites

  • 3 weeks later...

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.

Link to comment
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... :))

Link to comment
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.

Link to comment
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
Link to comment
Share on other sites

  • 3 weeks later...
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.
Link to comment
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
Link to comment
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now
  • Recently Browsing   0 members

    • No registered users viewing this page.
  • Similar Content

    • By MarkE
      This fieldtype and inputfield bundle was built for storing measurement values within a field, rendering them in a variety of formats and converting them to other units or otherwise modifying them via the API.
      The API consists of a number of predefined functions, some of which include...
      render() for rendering the measurement object, valueAs() for converting the value to another unit value, convertTo() for converting the whole measurement object to different units, and add() and subtract() for creating a new measurement object from the sum or difference between two other objects. In the admin the inputfield includes a checkbox (which can be optionally disabled) for converting values on page save. For an example if a value was typed in as centimeters, the unit was changed to metres, and the page saved with this checkbox selected, said value would be automatically converted so that e.g. 170 cm becomes 1.7 m.
      A simple length field using Fieldtype Measurement and Inputfield Measurement.
      Combination units (e.g. feet and inches) are also supported.
      Please note that this module is 'proof of concept' at the moment - there are limited units available and quite a lot of code tidying to do. More units will be added shortly.
      See the GitHub at https://github.com/MetaTunes/FieldtypeMeasurement for full details and updates.
    • By tcnet
      File Manager for ProcessWire is a module to manager files and folders from the CMS backend. It supports creating, deleting, renaming, packing, unpacking, uploading, downloading and editing of files and folders. The integrated code editor ACE supports highlighting of all common programming languages.
      https://github.com/techcnet/ProcessFileManager

      Warning
      This module is probably the most powerful module. You might destroy your processwire installation if you don't exactly know what you doing. Be careful and use it at your own risk!
      ACE code editor
      This module uses ACE code editor available from: https://github.com/ajaxorg/ace

      Dragscroll
      This module uses the JavaScript dragscroll available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability to drag the table horizontally with the mouse pointer.
      PHP File Manager
      This module uses a modified version of PHP File Manager available from: https://github.com/alexantr/filemanager
       
    • By tcnet
      This module implements the website live chat service from tawk.to. Actually the module doesn't have to do much. It just need to inserted a few lines of JavaScript just before the closing body tag </body> on each side. However, the module offers additional options to display the widget only on certain pages.
      Create an account
      Visit https://www.tawk.to and create an account. It's free! At some point you will reach a page where you can copy the required JavaScript-code.

      Open the module settings and paste the JavaScript-code into the field as shown below. Click "Submit" and that's all.

      Open the module settings
      The settings for this module are located int the menu Modules=>Configure=>LiveChatTawkTo.

       
    • By tcnet
      Session Viewer is a module for ProcessWire to list session files and display session data. This module is helpful to display the session data of a specific session or to kick out a logged in user by simply delete his session file. After installation the module is available in the Setup menu.

      The following conditions must be met for the module to work properly:
      Session files
      Session data must be stored in session files, which is the default way in ProcessWire. Sessions stored in the database are not supported by this module. The path to the directory where the session files are stored must be declared in the ProcessWire configuration which is by default: site/assets/sessions.
      Serialize handler
      In order to transform session data easier back to a PHP array, the session data is stored serialized. PHP offers a way to declare a custom serialize handler. This module supports only the default serialize handlers: php, php_binary and php_serialize. WDDX was dropped in PHP 7.4.0 and is therefore not supported by this module as well as any other custom serialize handler. Which serialize handler is actually used you can find out in the module configuration which is available under Modules=>Configure=>SessionViewer.

      Session data
      The session data can be displayed in two different ways. PHP's default output for arrays print_r() or by default for this module nice_r() offered on github: https://github.com/uuf6429/nice_r. There is a setting in the module configuration if someone prefers print_r(). Apart from the better handling and overview of the folded session data the output of nice_r() looks indeed nicer.

      Links
      ProcessWire module directory
      github.com
    • By Robin S
      Repeater Easy Sort
      Adds a compact "easy-sort" mode to Repeater and Repeater Matrix, making those fields easier to sort when there are a large number of items.
      The module also enhances Repeater Matrix by allowing a colour to be set for each matrix type. This colour is used in the item headers and in the "add new" links, to help visually distinguish different matrix types in the inputfield.
      Screencasts
      A Repeater field

      A Repeater Matrix field with custom header colours

      Easy-sort mode
      Each Repeater/Matrix item gets an double-arrow icon in the item header. Click this icon to enter easy-sort mode.
      While in easy-sort mode:
      The items will reduce in width so that more items can be shown on the screen at once. The minimum width is configurable in the field settings. Any items that were in an open state are collapsed, but when you exit easy-sort mode the previously open items will be reopened. You can drag an item left/right/up/down to sort it within the items. The item that you clicked the icon for is shown with a black background. This makes it easier to find the item you want to move in easy-sort mode. You can click an item header to open the item. An "Exit easy-sort mode" button appears at the bottom of the inputfield. Configuration
      In the field settings for Repeater and Repeater Matrix fields you can define a minimum width in pixels for items in easy-sort mode. While in easy-sort mode the items will be sized to neatly fill the available width on any screen size but will never be narrower than the width you set here.
      In the field settings for Repeater Matrix you can define a custom header colour for each matrix type using an HTML "color" type input. The default colour for this type of input is black, so when black is selected in the input it means that no custom colour will be applied to the header.
      Exclusions
      The easy-sort mode is only possible on Repeater/Matrix fields that do not use the "item depth" option.
       
      https://github.com/Toutouwai/RepeaterEasySort
      https://processwire.com/modules/repeater-easy-sort/
×
×
  • Create New...