Jump to content
Wanze

Pages2Pdf

Recommended Posts

Hi,

I'm working on the pdf layout and do not get it managed to have several images of PW pages in line on one pdf page.

I have only pages with images so the pdf file includes the images of the selected pages of the session, but they are all listed among each other.

EDIT:

It was a stupid question from me ...

-> table layout and a simple php for loop does the job.

:-[

Share this post


Link to post
Share on other sites

Great work Wanze, thanks for this module!!

Everything works fine after figuring out what works in pdf files and what not^^

One thing I noticed, is that the "page orientation" in the module settings is getting saved but the value in the field switchs back to P so I have to reset this everytime when I change some values.

Cheers Can

Thanks Can, glad it works for you :)

I'm currently rewriting the module and will switch the pdf engine behind to mpdf which seems to have much better support for html.

@Bacelo

There are no stupid questions  ^_^

  • Like 4

Share this post


Link to post
Share on other sites

Great to hear Wanze. I'll await this with joy  :)

Do you already have a possible release date?  :-[

Cheers

hmm..it's working quite okay as I said, but seems to only work for pages under a specific parent

got one other page where I want to prove PDF version..it uses the same template and I'm not checking for this parent or something so there shouldn't be any exclusion

the PDF is getting created but only with header and footer without content..hmm :/

strange..I'm just posting this because maybe someone else could need the hint

solved pdf not working for certain page by duplicating the page via core page clone module and voila it's working without any other changes or creating the page from scratch again :)

Edited by Can

Share this post


Link to post
Share on other sites

Thanks Can, glad it works for you :)

I'm currently rewriting the module and will switch the pdf engine behind to mpdf which seems to have much better support for html.

Would be great to have the option to specify a page. So generate the pdf link for given page instead of the current page?

So it gets more flexible :)

  • Like 2

Share this post


Link to post
Share on other sites

Would be great to have the option to specify a page. So generate the pdf link for given page instead of the current page?

So it gets more flexible :)

You can do this directly in your template pwFoo.

I have this in the template I want to generate the PDF from

if($sanitizer->text($input->get->pdf) === '1') $modules->get('Pages2Pdf')->render();

And in the template where I´m linking to the page I just add ?pdf=1 at the end of the link.

like <a href="{$chlid->url}?pdf=1">PDF Version</a>

You probably need to create a PDF template in /site/templates/pages2pdf folder

That's it.

Share this post


Link to post
Share on other sites

Thanks Can, I'll try it again that way. Maybe it would work the second time. First time it loads the page instead to generate and download a pdf.

Would be great to set a page/ id and get a pdf download link without load the page itself.

  • Like 1

Share this post


Link to post
Share on other sites

yeah pdf generation seems to be kind of 1980. it probably get's better after wanze's update

do you created a page specific template under /templates/pages2pdf/ ?
it was important for me and and hat to tweak a lot

I'm outputting only via heredoc to keep all "double quotes" instead of 'single quotes' (you could escape them of course)

  • Like 1

Share this post


Link to post
Share on other sites

Yes, I'll build a simple pdf template which works fine so long linked and used at current page.

But don't get it work as a download link from another page.

But for now your way would be fine to get it work. After the module update maybe it's easier to do ;)

  • Like 1

Share this post


Link to post
Share on other sites
@Bacelo

There are no stupid questions  ^_^

O0  Thank you Wanze

Hi,

I'm working on the pdf layout and do not get it managed to have several images of PW pages in line on one pdf page.

I have only pages with images so the pdf file includes the images of the selected pages of the session, but they are all listed among each other.

EDIT:

It was a stupid question from me ...

-> table layout and a simple php for loop does the job.

:-[

I'm still optimizing the layout of the generated pdf file.

I got it managed to have one table for each 5 pages (pictures).

I tried everything with the table width, but I can't get it done to have the tables / cells  always fit to their content (pictures only) with no space left in the cells.

The tables always seams to have the full page width. I have no width set for any table attribute so actually it should be fine.

Any clue? :wacko:

Share this post


Link to post
Share on other sites

Hello and thank you for this module!

I'm planning to use it on a client's side, but with some extended features:

Users can add pages to some type of "shopping cart". All pages in the cart are then merged into a pdf that is offered for download.

I am not talking about a webshop here, just the cart functionality.

There is an extension for Joomla that does exactly that: http://netamity.com/extensions/contented-pdf

I'm currently researching possibilities to build this with PW as I'm switching more and more over to PW from Joomla. So it would be great if you could give me any pointers on how to achieve the pdf cart thing in PW.

Another idea is to create the PDFs for every page on save from admin. Then have the cart functionality which collects the already created pages and merges them into one downloadable pdf file. This would be less workload for the server (only merging existing files, no creation on the fly).

Can we hook into your module from the admin on creating/saving a page?

Cheers

Gerhard

Share this post


Link to post
Share on other sites

Should be possible to have it like a search, kind off.

You store selected pages via page field in the cart and then in the pdf template you iterate through them and output as pdf

just ask if you need more help

Share this post


Link to post
Share on other sites

Thanks Can for your ideas.

After browsing through available modules, I think I'm going to use a modified version of Apeisa's cart module https://github.com/apeisa/Shop-for-ProcessWire/blob/master/ShoppingCart.module to add pages to a cart.

Do you have any idea how to hook into the pages2pdf module on save/update of pages in the admin? I found this post https://processwire.com/talk/topic/2331-doing-additional-logic-after-saving-a-new-page/

Not sure though if that goes in the right direction and how to hook into pdf creation from there.

Cheers

Gerhard

  • Like 1

Share this post


Link to post
Share on other sites

Think you could make your own little "cart"

just a littly form with a hidden field for storing the page->id or if this form is on the same page you want to add to the cart you don't even need the hidden field.

 
if($input->post->addtocart && !$cart) {
  $cart = new Page();
    $cart->parent = $pages->get(5771);
    $cart->template = 'cart';
    $cart->title  = 'session_id()'; //for example
    $cart->save();
    $cart->of(false);
    $cart->items = $pages->id; //not a hundred percent sure right now but should work (think I've done it like this already)
  }
}

items field would be multi page fieldtype 

you would then include this "$modules->get('Pages2Pdf')->render();" into the page template you want to generate the pdf's from

on the cart page you add a link for the customer, think it should work when you just link to one of the pages and append ?pdf=1 to the url, which will then create the pdf

create a new template under /templates/pages2pdf/ with the same name as the template you put the "$modules->get('Pages2Pdf')->render();" in

in this template you iterate through the pages in the cart like you would on a blog page or similar and output everything you need

for me the final output worked only with heredoc syntax, seems that proper double quotes are needed by tcpdf (you could echo as "normal" but then you would need to escape the double quotes)

hoffe es ist einigermaßen verständlich und klappt (hope it's understandable and works)

  • Like 3

Share this post


Link to post
Share on other sites

Hello Can,

thanks a lot for your input. I will give this a shot and let you know how it works out.

Vielen Dank!

Gerhard

  • Like 1

Share this post


Link to post
Share on other sites

may have found a bug: the module settings doesnt seem to allow L instead of P for the orientation, I ended up changing the module defaults to do it - all other fields seem to validate fine.

  • Like 1

Share this post


Link to post
Share on other sites

@benbyf

it worked for me, but I had to change the field in the settings everytime I changed any setting.

once set it works.

By the way I just changed to mpdf without any module and it's working really great

really easy to set up

file caching is the only thing missing at the moment.

but that shouldn't be too hard, maybe I'll can dig into pages2pdf and "copy" this part or something

  • Like 1

Share this post


Link to post
Share on other sites

@Can - could you possibly share how you setup mpdf with PW? maybe on a tutorial thread?

cheers!

  • Like 3

Share this post


Link to post
Share on other sites

@benbyf

nice website you have there. I particularly like the way you present your works. Elegant animation on the buttons and the filter effect is way cool.

  • Like 2

Share this post


Link to post
Share on other sites

@Can - many thanks, looking forward to studying your post!

Share this post


Link to post
Share on other sites

Hi folks,

I have refactored the module and a new version is available on the dev branch here: 

https://github.com/wanze/Pages2Pdf/tree/dev

The module now uses mpdf in the background which has superior HTML/CSS support compared to TCPDF, but the library is slightly heavier.

What's new?

  • Creating PDFs is handled by a separate module "WirePDF". This module is just a wrapper around mpdf and you could also use it independently from Pages2Pdf as a Service to create/save/download PDF files from ProcessWire templates
  • All the configuration options related to configure mpdf (margins, document orientation...) are now defined in the module WirePDF
  • Some new config options in module pages2pdf. You can configure the PDF filename and the GET variable that is used when requesting a download
  • You can download a PDF from any page
  • The default templates have changed, with mpdf you now can use a separate stylesheet to separate CSS from HTML markup
  • Triggering the creation/download of a PDF file is handled earlier: After the ProcessWire API is ready but before page rendering is initialized. This should improve the performance.
  • Calling the render() method is technically no longer required, but it can still be used to output the download link. However, you could write the link by yourself if you prefer.

If you'd like to test out the new version and upgrade the module:

  • Please note down all the current settings
  • Uninstall pages2pdf module, then replace it with the current one
  • Install the new version
  • Maybe add your previous settings in the WirePDF module. Some settings are no longer supported or have changed slightly
  • If you created manual links to triggering the download in your templates, e.g. added ?pdf=1, you should change the GET variable in the module configs from 'pages2pdf' to 'pdf'
  • Take a look at the default_templates in /site/modules/Pages2Pdf. With mpdf, it's better to separate CSS from HTML, so you can create a "styles.css" in /site/modules/templates/pages2pdf/ and define all CSS styles there. The styles are then availalble in your templates.

I hope that's the most important stuff. I'm short in time today (going to a festival), so I can't support :)

Cheers

  • Like 12

Share this post


Link to post
Share on other sites

hello wanze. Thanks for the update. I have tested it, but now it does not render the images, I have this is my template:

if (count($page->images)) {
$someImages = $page->images->slice(0, 4);
foreach ($someImages as $someImg) {
	$someImgThumb = $someImg->size(290, 195);
	echo "<TD WIDTH='25%'><img src=\"{$someImgThumb->url}\" width=\"{$someImgThumb->width}\" height=\"{$someImgThumb->height}\" /></TD>";
}
}

I followed your instructions, is there some other way to render the images?

Also in the previous version, I couldn't create/view the pdf as a guest, only if I was logged in as a superuser or as an editor.  Is there some setting that I should change to create/view the pdf as a guest?

Thanks!

update: the new updated module was not generating the images in MAMP is working fine on a live host.
I can now also view the pdfs as a guest on the live host, in the previous version, even after saving the page as a superuser, after login off I could not view the pdfs in the live host. It seems to be working very well now. Thanks again waze for this great module.

  • Like 1

Share this post


Link to post
Share on other sites

@nfil: just a quick thought: you may try to use the file:/// protocol (with three slashes), e.g.

echo "<TD WIDTH='25%'><img src=\"file:///{$someImgThumb->filename}\" width=\"{$someImgThumb->width}\" height=\"{$someImgThumb->height}\" /></TD>";

Haven't tested and don't know if it can work with mpdf, - just a quick thought. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hello and thank you for this module!

I'm planning to use it on a client's side, but with some extended features:

Users can add pages to some type of "shopping cart". All pages in the cart are then merged into a pdf that is offered for download.

I am not talking about a webshop here, just the cart functionality.

There is an extension for Joomla that does exactly that: http://netamity.com/extensions/contented-pdf

I'm currently researching possibilities to build this with PW as I'm switching more and more over to PW from Joomla. So it would be great if you could give me any pointers on how to achieve the pdf cart thing in PW.

Another idea is to create the PDFs for every page on save from admin. Then have the cart functionality which collects the already created pages and merges them into one downloadable pdf file. This would be less workload for the server (only merging existing files, no creation on the fly).

Can we hook into your module from the admin on creating/saving a page?

Cheers

Gerhard

Hi Gerhard,

If you grab the latest version of the module (1.1.0 is now in the master) you have several possibilites to solve this.

1) Use pages2pdf module:

Do you already have a template that shows/lists the pages inside the shopping cart for a user? If so, you could create a corresponding template in /site/templates/pages2pdf/ and list the products there too. This way, the module does most of the work for you, including caching of the PDF files.

What you'd need here is to delete the cached PDF file if the user adds or removes a page in the shopping cart.

Simplest way of doing this is to trigger saving the shopping cart page, then the module will delete the cached PDF file.

2) Use WirePDF module:

WirePDF is just wrapper around mPDF that is optimized to work with ProcessWire. If you want to create the PDF files independently from Pages2Pdf module,

you may want to check out those examples: https://github.com/wanze/Pages2Pdf#wirepdf

  • 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
      Status update links (inside this thread) for SnipWire development will be always posted here:
      2019-08-08
      2019-06-15
      2019-06-02
      2019-05-25
      If you are interested, you can test the current state of development:
      https://github.com/gadgetto/SnipWire
      Please note that the software is not yet intended for use in a production system (alpha version).
      If you like, you can also submit feature requests and suggestions for improvement. I also accept pull requests.
      ---- INITIAL POST FROM 2019-05-25 ----
      I wanted to let you know that I am currently working on a new ProcessWire module that fully integrates the Snipcart Shopping Cart System into ProcessWire. (this is a customer project, so I had to postpone the development of my other module GroupMailer).
      The new module SnipWire offers full integration of the Snipcart Shopping Cart System into ProcessWire.
      Here are some highlights:
      simple setup with (optional) pre-installed templates, product fields, sample products (quasi a complete shop system to get started immediately) store dashboard with all data from the snipcart system (no change to the snipcart dashboard itself required) Integrated REST API for controlling and querying snipcart data webhooks to trigger events from Snipcart (new order, new customer, etc.) multi currency support self-defined/configurable tax rates etc. Development is already well advanced and I plan to release the module in the next 2-3 months.
      I'm not sure yet if this will be a "Pro" module or if it will be made available for free.
      I would be grateful for suggestions and hints!
      (please have a look at the screenshots to get an idea what I'm talking about)
       




    • By apeisa
      Update 31.7.2019: AdminBar is now maintained by @teppo. Modules directory entry has been updated, as well as the "grab the code" link below.
      ***
      Latest screencast: http://www.screencas...73-ab3ba1fea30c
      Grab the code: https://github.com/teppokoivula/AdminBar
      ***
      I put this Adminbar thingy (from here: http://processwire.c...topic,50.0.html) to modules section and to it's own topic.
      I recorded quick and messy screencast (really, my first screencast ever) to show what I have made so far. You can see it from here: http://www.screencas...18-1bc0d49841b4
      When the modal goes off, I click on the "dark side". I make it so fast on screencast, so it might seem a little bit confusing. Current way is, that you can edit, go back to see the site (without saving anything), continue editing and save. After that you still have the edit window, but if you click "dark side" after saving, then the whole page will be reloaded and you see new edits live.
      I am not sure if that is best way: there are some strengths in this thinking, but it is probably better that after saving there shouldn't be a possibility to continue editing. It might confuse because then if you make edits, click on dark side -> *page refresh* -> You lose your edits.
      ***
      When I get my "starting module" from Ryan, I will turn this into real module. Now I had to make some little tweaks to ProcessPageEdit.module (to keep modal after form submits). These probably won't hurt anything:
      if($this->redirectUrl) $this->session->redirect($this->redirectUrl); if(!empty($_GET['modal'])) $this->session->redirect("./?id={$this->page->id}&modal=true"); // NEW LINE else $this->session->redirect("./?id={$this->page->id}");   and...
      if(!empty($_GET['modal'])) { $form->attr('action', './?id=' . $this->id . '&modal=true'); } else { $form->attr('action', './?id=' . $this->id); // OLD LINE }  
    • By Mike Rockett
      Jumplinks for ProcessWire
      Release: 1.5.54
      Composer: rockett/jumplinks
      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 nbcommunication
      I've spent the last while experimenting with srcset implementation - and PageimageSrcset is the result:
      PageimageSrcset
      Provides configurable srcset and sizes properties/methods for Pageimage.
      Overview
      The main purpose of this module is to make srcset implementation as simple as possible in your template code. It does not handle images rendered in CKEditor or similar fields.
      For an introduction to srcset and sizes, please read this Mozilla article about responsive images.
      Pageimage::srcset()
      // The property, which uses the set rules in the module configuration $srcset = $image->srcset; // A method call, using a set rules string // Delimiting with a newline (\n) would also work, but not as readable $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x"); // The same as above but using an indexed/sequential array $srcset = $image->srcset([ "320", "480", "640x480 768w", "1240", "2048 2x", ]); // The same as above but using an associative array // No rule checking is performed $srcset = $image->srcset([ "320w" => [320], "480w" => [480], "768w" => [640, 480], "1240w" => [1240], "2x" => [2048], ]); // Use the default set rules with portrait images generated for mobile/tablet devices $srcset = $image->srcset(true); // Return the srcset using all arguments $srcset = $image->srcset("320, 480, 640x480 768w, 1240, 2048 2x", [ "portrait" => "320, 640", ]); // The set rules above are a demonstration, not a recommendation! Image variations are only created for set rules which require a smaller image than the Pageimage itself. On large sites this may still result in a lot of images being generated. If you have limited storage, please use this module wisely.
      Portrait Mode
      In many situations, the ratio of the image does not need to change at different screen sizes. However, images that cover the entire viewport are an exception to this and are often the ones that benefit most from srcset implementation.
      The main problem with cover images is that they need to display landscape on desktop devices and portrait when this orientation is used on mobile and tablet devices.
      You can automatically generate portrait images by enabling portrait mode. It is recommended that you use this in combination with Pageimage::focus() so that the portrait variations retain the correct subject.
      The generated variations are HiDPI/Retina versions. Their height is determined by the portrait ratio (e.g. 9:16). Variations are always generated, regardless of whether the original image is smaller. Upscaling is disabled though, so you may find that some variations are actually smaller than they say they are in their filename.
      The sizes attribute should be used when portrait mode is enabled. Pageimage::sizes will return (orientation: portrait) and (max-width: {maxWidth}px) 50vw by default, which handles the use of these images for retina devices. The maximum width used in this rule is the largest set width.
      Pageimage::sizes()
      There is no option to configure default sizes because in most cases 100vw is all you need, and you do not need to output this anyway as it is inferred when using the srcset attribute. You can use the method for custom sizes though:
      // The property $sizes = $image->sizes; // Returns 100vw in most cases // Returns '(orientation: portrait) and (max-width: {maxWidth}px)50vw' if portrait mode enabled // A method call, using a mixture of integer widths and media query rules // Integer widths are treated as a min-width media query rule $sizes = $image->sizes([ 480 => 50, "(orientation: portrait) and (max-width: 640px)" => 100, 960 => 25, ]); // (min-width: 480px) 50vw, (orientation: portrait) and (max-width: 640px) 100vw, (min-width: 960px) 25vw // Determine widths by UIkit 'child-width' classes $sizes = $image->sizes([ "uk-child-width-1-2@s", "uk-child-width-1-3@l", ]); // (min-width: 640px) 50vw, (min-width: 1200px) 33.33vw // Determine widths by UIkit 'width' classes $sizes = $image->sizes([ "uk-width-1-2@m", "uk-width-1-3@xl", ]); // (min-width: 960px) 50vw, (min-width: 1600px) 33.33vw // Return the portrait size rule $sizes = $image->sizes(true); // (orientation: portrait) and (max-width: {maxWidth}px) 50vw // The arguments above are a demonstration, not a recommendation! Pageimage::render()
      This module extends the options available to this method with:
      srcset: When the module is installed, this will always be added, unless set to false. Any values in the formats described above can be passed. sizes: Only used if specified. Any values in the formats described above can be passed. uk-img: If passed, as either true or as a valid uk-img value, then this attribute will be added. The srcset attribute will also become data-srcset. Please refer to the API Reference for more information about this method.
      // Render an image using the default set rules echo $image->render(); // <img src='image.jpg' alt='' srcset='{default set rules}'> // Render an image using custom set rules echo $image->render(["srcset" => "480, 1240x640"]); // <img src='image.jpg' alt='' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w'> // Render an image using custom set rules and sizes // Also use the `markup` argument echo $image->render("<img class='image' src='{url}' alt='Image'>", [ "srcset" => "480, 1240", "sizes" => [1240 => 50], ]); // <img class='image' src='image.jpg' alt='Image' srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 1240px) 50vw'> // Render an image using custom set rules and sizes // Enable uk-img echo $image->render([ "srcset" => "480, 1240", "sizes" => ["uk-child-width-1-2@m"], "uk-img" => true, ]); // <img src='image.jpg' alt='' data-uk-img data-srcset='image.480x0-srcset.jpg 480w, image.1240x640-srcset.jpg 1240w' sizes='(min-width: 960px) 50vw'> // Render an image using portrait mode // Default rule sets used: 320, 640, 768, 1024, 1366, 1600 // Portrait widths used: 320, 640, 768 // Original image is 1000px wide // Not possible to use portrait mode and custom sets or portrait widths in render() // Sizes attribute automatically added echo $image->render(["srcset" => true]); // <img src='image.jpg' alt='' srcset='image.320x569-srcset-hidpi.jpg 320w, image.640x1138-srcset-hidpi.jpg 640w, image.768x1365-srcset-hidpi.jpg 768w, image.jpg 1024w' sizes='(orientation: portrait) and (max-width: 768px) 50vw'> Configuration
      To configure this module, go to Modules > Configure > PageimageSrcset.
      Set Rules
      These are the default set rules that will be used when none are specified, e.g. when calling the property: $image->srcset.
      Each set rule should be entered on a new line, in the format {width}x{height} {inherentwidth}w|{resolution}x.
      Not all arguments are required - you will probably find that specifying the width is sufficient for most cases. Here's a few examples of valid set rules and the sets they generate:
      Set Rule Set Generated Arguments Used 320 image.320x0-srcset.jpg 320w {width} 480x540 image.480x540-srcset.jpg 480w {width}x{height} 640x480 768w image.640x480-srcset.jpg 768w {width}x{height} {inherentwidth}w 2048 2x image.2048x0-srcset.jpg 2x {width} {resolution}x How you configure your rules is dependent on the needs of the site you are developing; there are no prescriptive rules that will meet the needs of most situations. This article gives a good overview of some of the things to consider.
      When you save your rules, a preview of the sets generated and an equivalent method call will be displayed to the right. Invalid rules will not be used, and you will be notified of this.
      Portrait Mode
      Set Widths
      A comma limited list of widths to create HiDPI/Retina portrait variations for.
      Crop Ratio
      The portrait ratio that should be used to crop the image. The default of 9:16 should be fine for most circumstances as this is the standard portrait ratio of most devices. However, you can specify something different if you want. If you add a landscape ratio, it will be switched to portrait when used.
      Any crops in the set rules ({width}x{height}) are ignored for portrait mode variations as this ratio is used instead.
      UIkit Widths
      If your website theme uses UIkit, you can pass an array of UIkit width classes to Pageimage::sizes to be converted to sizes. The values stored here are used to do this. If you have customised the breakpoints on your theme, you should also customise them here.
      Please note that only 1- widths are evaluated by Pageimage::sizes, e.g. uk-width-2-3 will not work.
      Remove Variations
      If checked, the image variations generated by this module are cleared on Submit. On large sites, this may take a while. It makes sense to run this after you have made changes to the set rules.
      Image Suffix
      You will see this field when Remove Variations is checked. The value is appended to the name of the images generated by this module and is used to identify variations. You should not encounter any issues with the default suffix, but if you find that it conflicts with any other functionality on your site, you can set a custom suffix instead.
      Debug Mode
      When this is enabled, a range of information is logged to pageimage-srcset.
      PageimageSrcsetDebug.js is also added to the <head> of your HTML pages. This will console.log a range of information about the images and nodes using srcset on your page after a window.onresize event is triggered. This can assist you in debugging your implementation.
      The browser will always use the highest resolution image it has loaded or has cached. You may need to disable browser caching to determine whether your set rules are working, and it makes sense to work from a small screen size and up. If you do it the other way, the browser is going to continue to use the higher resolution image it loaded first.
      UIkit Features
      This module implements some additional features that are tailored towards UIkit being used as the front-end theme framework, but this is not required to use the module.
      Installation
      Download the zip file at Github or clone the repo into your site/modules directory. If you downloaded the zip file, extract it in your sites/modules directory. In your admin, go to Modules > Refresh, then Modules > New, then click on the Install button for this module. ProcessWire >= 3.0.123 is required to use this module.
×
×
  • Create New...