Jump to content
Wanze

Pages2Pdf

Recommended Posts

Wow, just checked those examples on github. they're looking really good..maybe I'll change my custom mpdf thing to your wirepdf. 

But I'm doing screencasts for the customer and we're going live pretty soon, so no time right now..

nice work again wanze :) headsup

Share this post


Link to post
Share on other sites

Great input, thanks Wanze!

At the moment I'm waiting for the go from my client. They haven't signed off the project yet. So I'm still in the research phase. Once I start real work on the project I surely will consider your recommendations and will then keep you updated on my progress.

WirePDF module looks promising.

Have you ever experimented with client side PDF creation libraries like https://github.com/MrRio/jsPDF ?

Cheers

Gerhard

Share this post


Link to post
Share on other sites

Thanks Can, good luck with your project :)

The new version is now merged into the master branch, I also updated the README on GitHub.

With v.1.1.1, a new config option was introduced: Creation mode
This setting controls when the PDF files are generated and stored for caching purposes. The default value is still "on click", right before downloading a PDF file.

Now, the PDF files can also be created when saving pages in the ProcessWire admin. This new option is preferable if the PDFs are heavy and need some time for processing - the clients won't have to wait for it.

Please post any problems or questions regarding updating the module to the new version in this thread.

  • Like 4

Share this post


Link to post
Share on other sites

Great input, thanks Wanze!

At the moment I'm waiting for the go from my client. They haven't signed off the project yet. So I'm still in the research phase. Once I start real work on the project I surely will consider your recommendations and will then keep you updated on my progress.

WirePDF module looks promising.

Have you ever experimented with client side PDF creation libraries like https://github.com/MrRio/jsPDF ?

Cheers

Gerhard

You're welcome.

I don't have any experience with client side PDF creation tools. I have done some work with TCPDF in the past and now mPDF because the HTML/CSS support is better though still limited. If you need very complex layouts then maybe it is better to not use HTML at all but the native stuff from these libraries, e.g. positioning the cursor and output text/shapes/images exactly where you need it.

Personally, I prefer a server-side solution because JS can be manipulated by the visitor, not sure how to deal with saving PDF files then. On the other hand, if the PDF files are always created "on the fly", why not - if enough browser support is given.

Share this post


Link to post
Share on other sites

@Wanze

I set up a quick and dirty test for jsPDF library here: http://jspdf.webseiten-fuer-alle.de/

Underneath "Choose example" select "**NEW: addHTML()" and you will see the result instantly

It handles floating images and divs very well.

I like the way you can just drop in a complete HTML page and the result seems to be almost exactly what you see in the browser. So no more extra pdf templates. Definitely looks promising.

As for saving the pdfs, that's a good question. Browser support seems to be fine.

  • 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. :)

@horst Thanks horst but the file:/// protocol doesn't seem to work but I will keep the tip in mind for other use in PW  :)

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?

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.

Hi nfil,

Thanks and good to hear that it works on the live host. Though it's strange that it does not work locally, images are working fine here, also using MAMP. Using the file:// protocol should not be necessary. Another possibilty could be that you'v seen a cached version, if you enable the debug mode the module makes sure you always get a fresh PDF file.

  • Like 2

Share this post


Link to post
Share on other sites

Yes Wanze, thanks for keeping an excellent support. After a few tests I think it was indeed related with cache, it is working now in MAMP with PW 2.4.8 but at the time I was uploading the site from MAMP to a live server and noticed some weird behaviour using MAMP. I copied the live host version today and tested it today again on MAMP and it works flawlessly.  :)

Share this post


Link to post
Share on other sites

I've this image that is printed to the pdf if the value of the field is filled in the backend and its above 500000 but there are two variables, if one is not populated it will go to the next condition and print the value. How do I go about this one? Thanks.

  // image for output
  $visalogo = $pages->get("/")->logo_eurovisa;
  // if visavalue_b field is not populated it will show visavalue_a
  $visavalue_a = $page->price_a;
  $visavalue_b = $page->price_b;
  $count = "count()>1";
  // $visavalue_b is populated now check if it is greater than 500000
  if ($visavalue_b->($count)>=500000) {
    echo "<img src=\"{$visalogo->url}\" width=\"300\" height=\"176\" />"; 
    } else {
  if ($visavalue_a>=500000); { echo "<img src=\"{$visalogo->url}\" width=\"300\" height=\"176\" />"; 
  }
 }

Share this post


Link to post
Share on other sites

It should be something like this, count is for numberOfimagesChildren etc but I'm a newbie.

// image for output  
$visalogo = $pages->get("/")->logo_eurovisa; 
// if visavalue_b field is not populated it will show visavalue_a  
$visavalue_a = $page->price_a;  $visavalue_b = $page->price_b;  
// value is populated and greater than  
if(empty($visavalue_b)) {  $va = $visavalue_a>=500000;  
if ($va)   echo "";  }  $vb = $visavalue_b>=500000; 
if ($vb) {  echo "";  }
Sorry for being a bit off topic.

Share this post


Link to post
Share on other sites

It should be something like this, count is for numberOfimagesChildren etc but I'm a newbie.

// image for output  
$visalogo = $pages->get("/")->logo_eurovisa; 
// if visavalue_b field is not populated it will show visavalue_a  
$visavalue_a = $page->price_a;  $visavalue_b = $page->price_b;  
// value is populated and greater than  
if(empty($visavalue_b)) {  $va = $visavalue_a>=500000;  
if ($va)   echo "";  }  $vb = $visavalue_b>=500000; 
if ($vb) {  echo "";  }
Sorry for being a bit off topic.

Hi nfil,

I'm not sure, what's the issue? Is it the image that is not working?

If it is not related to mpdf, try to put your code in a "normal" Pw template under /site/templates/ and check if it works there.

When everything's correct, this module should render the same output. If there are differences, that is due to limited HTML/CSS support, but the images should work.

The first code example contains some errors, for example you can't write this:

$count = "count()>1";
  // $visavalue_b is populated now check if it is greater than 500000
  if ($visavalue_b->($count)>=500000) {

The second example contains no image output?

Sorry I don't have time to debug, I'm away some weeks from tomorrow and I need to pack all my stuff :)

If you have questions to general stuff Pw or PHP related, I'm sure other members can help you in this awesome forum somwhere.

Cheers

  • Like 1

Share this post


Link to post
Share on other sites

Hello wanze in the second example I was writing it on a tablet and some code was lost.

It's a over complicated snippet by a newbie like me to check if a field is empty than render another, also checking if both of these fields are higher or equal to 500000

  // image for output
  $visalogo = $pages->get("/")->logo_eurovisa;
  // if visavalue_b field is not populated it will show visavalue_a
  $visavalue_a = $page->price_a;
  $visavalue_b = $page->price_b;
  // value is populated and greater than
  if(empty($visavalue_b)) {
  $va = $visavalue_a>=500000;
  if ($va) 
  echo "<img src=\"{$visalogo->url}\" width=\"300\" height=\"176\" />";
  }
  $vb = $visavalue_b>=500000;
  if ($vb) {
  echo "<img src=\"{$visalogo->url}\" width=\"300\" height=\"176\" />";
  }

Share this post


Link to post
Share on other sites

hey guys, im using Pages2Pdf v1.0.1 and its been great as far, I have two questions:

echo '<table>';
  foreach($images as $image){
    $imageSmall = $image;
    echo '<tr><td><img id="'. $image->basename . $image->created .'" src="'. $imageSmall->url. '" /></td></tr>';
  }
echo '</table>';
<style>
.head {
	font-family: Times;
	font-weight: bold;
	font-size: 13pt;
}
table{
	text-align: center;
	vertical-align: middle;
	padding: 0;
	width: 100%;
}
img{
	margin: 0 auto;
}
</style>
  • Is there a way of bypassing the cache and making a request for a new pdf everytime? so that it creates a pdf with a timestamp maybe?

Share this post


Link to post
Share on other sites

Hi, im on mobile sorry for short answers.

1) not sure why it happens. You could try to update the module. The new pdf engine behind has better html and css support. You'd need to separate your css into a separate css file thought, see instructions on one of my earlier posts.

2) setting the cache time to zero will always generate a new pdf file.

Cheers

Share this post


Link to post
Share on other sites

Hello wanze.

I have a datetime field in my page with the Date/Time Output Format Code j/n/y

PW outputs the formatted date, yet Pages2Pdf will not render the j/n/y format.
 
Have you tried creating a pdf with a datetime field? Or am I doing something wrong. Thanks.
 
update: I get different results, this was probably due to PW dev 2.4.5 I tested your module with PW 2.5 and seems to be fine. 

Share this post


Link to post
Share on other sites
For anyone getting a screen full with “Warning: Cannot modify header information”

This is because you probably have Processwire in debug mode ($config->debug = true;)

Thx WillyC this old thread gave the answer

And thank you too Wanze for this great module.

Alfred

Share this post


Link to post
Share on other sites

Hello.

i'm trying to install this module, but i have an error: 

Module is not installable because not all required dependencies are currently met.

says it need the module "WirePDF". In the documentation, says: 

WirePDF

This module is a wrapper around the mPDF library. It is used by the Pages2Pdf module to create and store the PDF files, but can also be used independently to create/store/download PDF files.

how do i create this wrapping, and make the module work?

thanks

Share this post


Link to post
Share on other sites

Hi Isag,

The WirePDF module is included in Pages2Pdf, you should find it in your modules list.

After installing "WirePDF", you should be able to install "Pages2Pdf"... I'm not sure why this is not working out of the box, I thought that ProcessWire would install the dependencies automatically, if available. What version of Pw are you running?

Cheers

Share this post


Link to post
Share on other sites

@wanze: this may depend of the increased or somehow changed usage of modules cache since PW 2.5.

@Isag: Just for testing: I would try to hit refresh in the modules section manually. And then give it a new go.

@wanze: Maybe you can add a $this->modules->resetCache(); to the first line of your install routine?

@Isag: which PW version you are using? PW 2.5.??

Share this post


Link to post
Share on other sites

@lsag: I had the same issue trying to install via classname just now, on v2.5, but it installs fine if you just download from the module page and manually upload to your PW.

Share this post


Link to post
Share on other sites

Wanze, just wanted to say thanks for this module - worked without any flaws. Very easy to setup!

  • Like 1

Share this post


Link to post
Share on other sites

Hello. Could someone tell me what i have to put in this template file? is it like a normal processwire template?

checking the default template, i see 

$page->body

shouldn't this get me the entire content of the <body> tag? instead i get, as the only content, the page's url.

Thanks for the patience to this noob

Share this post


Link to post
Share on other sites

H Isag,

In the template files inside /site/templates/pages2pdf you put the markup that is rendered in the PDF file. It's like a "normal" ProcessWire template.

The $page->body does not output the content of the body tag. It outputs the value of a field called "body". This is just an example, you can output other fields and use the ProcessWire API to build your output.

Cheers

Share this post


Link to post
Share on other sites

Hello @ all,

I have setted up a multilanguage site and the Pages2pdf module provides the pdf for a page only in one language. Has someone tried to get one pdf-document for each language and how?

I cant figure out how this could be achieved (if it is possible).

Best regards Jürgen

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...