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 dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

    • By kongondo
      Media Manager
       
      Released 31 March 2016
      https://processwireshop.pw/plugins/media-manager/
      Documentation 
      http://mediamanager.kongondo.com/
      As of 10 May 2019 ProcessWire versions earlier than 3.x are not supported
      *******************************************************   ORIGINAL POST   *******************************************************
      API Example (frontend; will be added to documentation site)
      Accessing and outputting the contents of the MediaManager field(s) in your template is quite simple. The fields are accessed like many other ProcessWire fields. The fields return an array of type MediaManagerArray that need to be looped to output each media within. Assuming you created a field of type MediaManager named 'media', you can loop through it for a given page as shown below.
        @note: Each MediaManager object has the following 5 basic properties:   DATABASE (saved properties) 1. id => pageID of the page where the media lives (hidden in admin and not important to know about) 2. type => integer denoting media type (1=audio; 2=document; 3=image [for variations this will be 3x, where x is the number of the variation of an original image]; 4=video)   RUNTIME 3. typeLabel => user friendly string denoting media type (audio, document, image, video) 4. media => a ProcessWire Image/File Object including all their properties (ext, filesizeStr, height, width, description, tags, filename, basename, etc.) 5. title => title of media (@note: this is the title of the page where the media lives; may or may not be the same as the name of the media file itself). This can be used as a user-friendly name for your media $media = $page->media;// returns a MediaManagerArray. Needs to be looped through foreach ($media as $m) { echo $m->id;// e.g. 1234 (hidden page in /admin/media-manager/media-parent/) echo $m->type;// e.g. 3 (a media of type image) OR 1 (a media of type audio) echo $m->typeLabel;// e.g. 'document' (i.e. type would be 2) echo $m->title;// e.g. 'My Nice Trip' (whose media file could be my-nice-trip.mp4) /* @note: - $m->media returns an object; either a ProcessWire Image (for image media) or File object (for audio, document and video media) - This means you have access to all the properties of that object, e.g. ext, tags, description, url, filename, basename, width, height, modified, created, filesize, filesizeStr, etc as well as associated methods, e.g. size() */ echo $m->media->tags; } // only output images foreach ($media as $m) { if($m->typeLabel =='image') { echo "<img src='" . $m->media->size(100,75)->url . "'><br>"; } } // There's also a toString() method so you can do: echo $page->media; /* All your media will be output wrapped in appropriate HTML tags, i.e.: audio: <audio></audio>; document: <a></a>; image: <img>; video: <video></video>; */  
      *******************************************************   ORIGINAL POST   *******************************************************
       
      The topic of a central media manager feature for ProcessWire has come up several times:
       
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42578
      https://processwire.com/talk/topic/4330-get-image-from-other-pages-via-images-field/?p=42582
      https://processwire.com/talk/topic/425-file-manager/
      https://processwire.com/talk/topic/425-file-manager/?p=13802
      https://processwire.com/talk/topic/425-file-manager/?p=13861
      https://processwire.com/talk/topic/10763-asset-manager-asset-selector/
       
      More recently, regarding my Visual Page Selector module, I have been asked several times why the module does not have an in-built feature to upload images.
       
      There's two camps on the topic of a central media manager: those who like them (especially those coming in to PW from other CMSes) and those who don't like them (primarily because of the chaotic way some CMSes (dis)organise their media management) . I think that we can have our cake and eat it too! If done the right way, closely following the principles of and harnessing the power of ProcessWire, we can have a well-implemented, organised, feature-rich, site-wide media manager.
       
      Introducing Media Manager: (a commercial module)
       
      Alongside a number of modules I am currently working on (both free and commercial), I have been developing  a centralised Media Manager for ProcessWire. Before you cast the first stone, no, this is not going to be a one-large-media-bucket as in other CMS where it gets very messy very quickly . In the backend things are neatly stored away, yes, in pages. However, those are pages you will not see (just like repeater pages). Before anyone has a go at pages, remember a page is not that thing you see on the ProcessWire Tree (that's just its visual representation); A page is a record/row in the database    . For the end-user of Media Manager, all they will see is the 'familiar media bucket' to select their media from. As long as it works efficiently, I don't think they care about the wizardry behind the scenes  . 
       
      The module allows for the comprehensive management of several media types:
      Audio Video Images Documents Each media type will be handled by its own sub-module so the user can pick and install/choose the type of media management they want.
       
      Features include:
      Access controls Centralized uploads of media Bulk management of media: tag, delete, describe, replace, etc. Bulk upload: zip; scan, single Quick upload in page edit mode Usage stats across pages (maybe?) Etc.. Would love to hear your thoughts and any feature suggestions. I think there's enough demand for such a module. If not, please let me know so that I can instead focus on other things  , thanks.
       
      How other CMS do it

       
      The more efficient (PW) way of doing it

    • By Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      A module for ProcessWire CMS/CMF. Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.
      ![Hanna tag widget]
      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Advanced: define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
×
×
  • Create New...