Jump to content
Pete

ProcessEmailToPage

Recommended Posts

Yes, I've tried it without ==blog== written in also hoping it would just write the the body field but nothing. It's very odd, it successfully brings the title across. And as the title is coming across it would make sense that the connection to the mail server is successful. The mail server is on a separate box but connection appears to succeed.

I did have the module stored in the root of the modules directory, but since then I've uninstalled the module, moved the files to /site/modules/ProcessEmailToPage and reinstalled.

Is there anything else I can try as I really like the idea of the module.

had the same issue. it works if you make following change in ProcessEmailToPage.php on line 271:

//$message['html'] = str_replace(' ', '', $message['html']);
// change to
$message['html'] = str_replace(' ', '', $message['text']);
  • Like 1

Share this post


Link to post
Share on other sites

had the same issue. it works if you make following change in ProcessEmailToPage.php on line 271:

//$message['html'] = str_replace(' ', '', $message['html']);
// change to
$message['html'] = str_replace(' ', '', $message['text']);

Bingo! Yes it does indeed. Thank you. I'm assuming this is because my email was encoded as plain text and not html

Share this post


Link to post
Share on other sites

Hi Pete,

Just playing with this module for the first time - looks fantastic - thank you.

Just a couple of things:

  1. there are lots of undefined variable and undefined index notices on the module config page that would be nice to have cleaned up.
     
  2. You still have "live" in the js file. I like the approach that Wanze took with live vs on in the batcher module depending on the version of jquery.
     
  3. Also, the "Add another category" button seems to be missing - I am guessing this is a class issue with Ryan's new default admin theme that I am testing it with.

Thanks a lot for looking into these.

Share this post


Link to post
Share on other sites

is this great module working ok with the latest dev version 2.3.11 with default admin-theme?

the problem i see is, that on module-admin page following fields can`t get saved: "publishDefault":"","emailAddress":"","emailCategory":0,"emailTemplate":"","categoryData":""

Share this post


Link to post
Share on other sites

ok, for my case it was possible to fix it by adding the categoryData array manually to the modules json via mysql. something like

[{\"emailAddress\":\"my@me.com\",\"emailCategory\":\"1013\",\"emailTemplate\":\"46\"}]
  • Like 1

Share this post


Link to post
Share on other sites

Thanks for this great module, pete.

Unfortunately i've got some problems with the setup.

In my testenviroment ( pw 2.4 ) there is no possibility to save email categories. The button "add new category" simply lacks.

Could you give me any advice, what i supposed to do.

Thanks a lot!

Share this post


Link to post
Share on other sites

I have attached a revised version of the module. I know Pete is pretty busy with other things at the moment, so I thought I'd try to help out.

I haven't tested this thoroughly, but I think it should take care of things. It also includes a few other fixes, like adding delete buttons for each category and also fixing a bunch of PHP warnings.

If you could test and let me know if everything is working fine and then I'll submit a pull request for Pete.

My forked version

  • Like 2

Share this post


Link to post
Share on other sites

Thanks adrian,

now the button is visible. I can setup an email-categorie but now a server error occurs, when i´m calling the Cron-Job url

Error: Exception: There was an error connecting to the server (in /kunden/...xxx....site/modules/ProcessEmailToPage/flourishlib/fMailbox.php line 981)

I´ve tried serveral email-server setup combinations without any success ( imap/pop3 over secure or unsecured ports - 143 or 995 ).

Are there anny known fixes or functioning setups?

Share this post


Link to post
Share on other sites

Glad that sorted out the category adding issue. I'll submit that pull request to Pete.

As for the server connection issue - I am really not sure, but I don't think it is related to this module. Perhaps there are some issues with the Flourish library (included in this module) and your pop/imap server, or a firewall issue.

Maybe someone who has been using the module more might have a better idea.

Share this post


Link to post
Share on other sites

Ok, I decided to do some testing at my end on the connection issue. I was trying with a gmail account using imap and found I needed to force a secure connection:

http://flourishlib.com/docs/fMailbox

It seems to me like this module should have an config option to define this true/false, but for the moment I just changed this line in the .module file from:

$mailbox = new fMailbox($this->emailType, $this->emailHost, $category->emailAddress, $this->emailPassword, $this->emailPort);

to:

$mailbox = new fMailbox($this->emailType, $this->emailHost, $category->emailAddress, $this->emailPassword, NULL, TRUE);

I was having connection or username/password issues until I made this change, but now it works perfectly and pages are created as expected.

Can you let me know if that works for you and if it does I'll add a config setting for it and add that to the pull request to Pete.

Share this post


Link to post
Share on other sites

Just added a new forceSecure option to the config. Also made sure that if port is left blank, that it sends NULL, rather than blank which seems to be a requirement.

Also added a fix for the HTML vs text email issue reported by @martind

All these will go to another PR for Pete in a few minutes.

Please let me know if the attached version works for you now.

My forked version

  • Like 3

Share this post


Link to post
Share on other sites

adrian - sorry for my delayed answer. the time delay...i had to sleep ;-)

great job, thank you - i think it seems to work now. but i have to continue testing, because there is still an error occurring after the cron-call:

Error: Call to a member function add() on a non-object (line 345 of /kunden/.../pw/site/modules/ProcessEmailToPage/ProcessEmailToPage.module)

i think the reason for this could be an incorrect setup of the template ( missing/wrong fields ?! ).

my email contains only the subject and a jpg-file. after the cron-call the jpg has been downloaded in pw-folder ( root ). from the subject the module builds a child of the category i´ve chosen in the modules - setup ( as it should, i think ). but although i added an image field to the template, the image won´t appear in the "category". there is only the title ( email-subject ).

Share this post


Link to post
Share on other sites

I am curious as to the name of your images field. That error you are getting makes me think you don't have a field called "images". The module currently has the field hardcoded as "images" so clearly that needs to be made flexible so that other fields can be used. Not sure the best approach for this though. If there is only one image field in the selected template, it's easy, but if there is more than one we'd have to either just choose the first, or ask what field to use in the config settings, which might be best. Also, if there is more than one image attached, and the chosen field is set to only store one image, then there is also an issue. Also I see that there isn't anything to determine if the attachment is in fact an image which is something that should also be checked, and if it's not should the file be added to a files field on the page?

Anyway, please check that your images field is in fact named "images" and see if that helps. I am curious about nothing showing up in the body of your page though. Do you have a "body" field in the selected template? Sorry, I see that you didn't enter any text in the body of the email, so this is expected. Regardless, I think this is something else that needs to be made configurable - at the moment the body field must be named "body" as this is the hardcoded name.

EDIT: I haven't narrowed down why yet, but if I send the email from Mac Mail, no attachments get converted to images, but if I send them from gmail from within the web interface, everything works perfectly - maybe there is some limitation with flourish and its ability to detect attachments in some case, or maybe it is the crazy way Macs attach files :)

ANOTHER UPDATE: I just sent an email with an attached image from MS Outlook and it also works perfectly, so I am beginning to think there really is something amiss with attachments and the Flourish/Mac Mail combination. Can anyone else confirm this with the version of the module attached to my previous message?

AND ANOTHER: I have added support for inline attachments and this seems to be helping with Mac Mail. I had also been using this setting:

defaults write com.apple.mail DisableInlineAttachmentViewing -bool yes

on my Mac, but reversing that (change yes to false), along with the new inline support and images are now being added. The one outstanding problem I can see at the moment is that if a Mac Mail message also has text in it, the image won't work, so test without anything but the image for now if you are using Mac Mail.  Turns out this needed "related", not "inline". I have added support for this in the new version attached this morning.

One other thing I think might be a nice addition to this module is support for embedding images into the body field if they were embedded inline in the email. I need sleep now, but might look into this tomorrow!

My forked version

Edited by adrian
  • Like 3

Share this post


Link to post
Share on other sites

Ok, I have just added support for images that are embedded into the text within an email. These images are now added to the page's images field and then embedded into the body RTE field, just as they appeared in the email.

Minimal testing so far, but seems to work great even with multiple images. Would appreciate some testing of the attached version before I submit to Pete.

My forked version

ProcessEmailToPage.zip

  • Like 4

Share this post


Link to post
Share on other sites

great job, adrian!

i´ve tested it with an attached file and as an embedded image. both works ( tested with outlook for mac and iPhone ).

but let me know your thoughts about embedding the image into the body. in my opinion ( when the image was sent embedded ) the image has to be treated separately ( over the field images e.g. ), then the developer can decide what happens with the image in the FE.

what do you think?

Another question: when the mail was sent over iphone there is same strange behaviour with the folder ( assets/files/1283/ ) the image is saved in.

you can see it in the attaced pic.post-2037-0-81347800-1393311019_thumb.pn

Share this post


Link to post
Share on other sites

Thanks for the feedback. I may not have time to look into the ios issue today, but will get to it as soon as I can. Could you please let me know the actual filename of that image in the 1283 folder?

Regarding the behaviour of images and whether they should automatically end up in the body field or not. My thought was that if they were attached images, they should just end up in the images field and not embedded into the body field, but if they were embedded in the email text (html), then they should be embedded in the body field, just as they were in the email. Perhaps I could add an option to control this behaviour. The complication to all this seems to be that Mac Mail always sends images inline within the message body, which being relatively new to Mac, is still a mystery to me. I think we can end up with something pretty robust here, but it might take some testing with different email clients and some tweaking to get everything always working as expected.

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for all the updates adrian - I've commited the latest updates on Github and am looking forward to your latest addition for embedded images.

I wonder if it might be worth making the embedded images feature optional though? I'm thinking of a case where this could be used in a company where people have images in their email signatures and these would come through as well - just a thought.

Share this post


Link to post
Share on other sites

Hey Pete - no problem. Thanks for committing those initial bug fixes. 

Good point about the email signatures for sure. The issue I have is how Mac Mail seems to embed all attachments. Maybe someone else can enlighten me as to firstly why this is a good idea and how we can use flourish to determine the difference between signature images which should really be html with a linked image, vs an image that was attached to the message. Maybe it's a matter of playing around more with flourish's inline vs related options. I'll look into it more later.

Share this post


Link to post
Share on other sites

Adrian.

There´re two images saved in this folder 1283. One named foto.jpg and one thumb named foto.0x100.jpg

Share this post


Link to post
Share on other sites

Good to know. So that image named "1283" in the images folder is something extra, rather than an image that you emailed that was somehow corrupted then?

Share this post


Link to post
Share on other sites

no - there was only one foto submitted. that "image" is no image. i think it´s some kind of waste due to the email-sending process ;-)

Share this post


Link to post
Share on other sites

Ok, this is a really quickly assembled update. It adds an option to determine whether embedded images will be added to the body field of the page or not. This seems to work great but would appreciate you checking it, especially from different devices / email clients. At the moment this setting is site-wide, but it might potentially make more sense to have it for each email address / category.

The other change will hopefully fix that ghost image you had, although I haven't been able to replicate it at my end, so haven't really been able to test. Please let me know if it fixes it for you.

My forked version

Share this post


Link to post
Share on other sites

Cheers adrian - I'll check it out later unless someone beats me to it.

The problem I found is that even just between Thunderbird and Outlook signatures are treated a bit differently and there's no code in the source of the email to say when a signature starts in an email unfortunately. I honestly don't think that until someone big enough like Google (joining forces with Microsoft and possibly supermom) redesigns how emails should work from the ground up we'll ever see a satisfactory standard for handling email signatures :)

  • Like 1

Share this post


Link to post
Share on other sites

Hey Pete - agreed signatures are currently horrible, especially when people insist on embedding images in their signature, rather than writing them in HTML with a linked image, often resulting in every email from that person having the image show up as an attachment depending on the combination of the sending and receiving email client and settings.

My biggest beef is Mac Mail's displaying of images/pdfs inline in the body even if they were added as attachments. Just my opinion, but I think Outlook and others got this right, but I am ranting now :)

Share this post


Link to post
Share on other sites

First thank you very much for this!

Read the whole treat....may i've missed it.

get a connection error for wrong PW and Username....

All settings are done so far - where i have to set the username? this one is missing to set since it is not the emailadress it is like PW: mypass USER: webxxxp1

regards mr-fan

***Realy great module if it works - it would complete/extend my Recipe HTML App for my wife to collect there cooking power digital ;)

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