Jump to content
Nico Knoll

MarkupSEO - The all-in-one SEO solution for ProcessWire.

Recommended Posts

I'm pretty sure MarkupSEO is causing issues when viewing form results generated by FormBuilder.

I posted the issue in the Form Builder Support but in case anyone isn't a member (VIP forum), here's the details.

Error on viewing FormBuilder entries

Error: Exception: Unknown Selector operator: '' -- was your selector value properly escaped? (in /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php line 247)

#0 /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php(284): Selectors->create('1.2', '', '')
#1 /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php(81): Selectors->extractString('1.2')
#2 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(165): Selectors->__construct('1.2')
#3 [internal function]: Pages->___find('1.2', Array)
#4 /home/sites/pretendy-url.com/public_html/wire/core/Wire.php(389): call_user_func_array(Array, Array)
#5 /home/sites/pretendy-url.com/public_html/wire/core/Wire.php(344): Wire->runHooks('find', Array)
#6 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(260): Wire->__call('find', Array)
#7 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(260): Pages->find('1.2', Array)
#8 /home/sites/pretend
This error message was shown because you are logged in as a Superuser. Error has been logged. 

Ryan's suggestion

Peter, I've looked at the site with the info you provided and was able to duplicate it there. But importing the form locally and testing here, I can't duplicate it. Unfortunately the debug backtrace error message we've got is truncated for some reason, so we can't see the full picture or pin it to a specific module. However, we can see that the exception is coming from a $pages->find("1.2"); operation. Since I can't duplicate it locally, and because FormBuilder doesn't do any $pages->find(), it's very likely that one of the other modules you've got installed (under Site) is monitoring the "id" property in the URL, thinking it's a page ID. If you can, I would start uninstalling modules one by one and testing your Entries screen, to determine which module it is. It's no doubt got to be an "autoload" module. If I can get FTP or SSH access to the server, I could track it down for you by doing a grep on the site modules directory. 

Uninstalling MarkupSEO makes the FB entries viewable again.

  • Like 1

Share this post


Link to post
Share on other sites

@Nico

Any updates planned to fix the problem when FormBuilder is installed?

I can just uninstall MarkupSEO for the mo but it's a great module. Would love to have it functioning  :rolleyes:

Share this post


Link to post
Share on other sites

I'am trying to validate html5 and get errors on metatags. Is there a solution for this? 

Bad value og:site_name for attribute name on element meta: Keyword og:site_name is not registered. 

Share this post


Link to post
Share on other sites

Could you add this as an issue on github? And what site_name have you defined in the module's settings?

Share this post


Link to post
Share on other sites

@ Nico:

I did some research for validation. Found a solution for html5 tags. Could you take a look at this please?

http://help.simplytestable.com/errors/html-validation/bad-value-w-for-attribute-x-on-element-y-z/bad-value-twittertitle-for-attribute-name-on-element-meta-keyword-twittertitle-is-not-registered/

Swap the name attribute for an otherwise-identical property attribute to create valid syntax

Share this post


Link to post
Share on other sites

I'm pretty sure MarkupSEO is causing issues when viewing form results generated by FormBuilder.

I posted the issue in the Form Builder Support but in case anyone isn't a member (VIP forum), here's the details.

Error on viewing FormBuilder entries

Error: Exception: Unknown Selector operator: '' -- was your selector value properly escaped? (in /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php line 247)

#0 /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php(284): Selectors->create('1.2', '', '')
#1 /home/sites/pretendy-url.com/public_html/wire/core/Selectors.php(81): Selectors->extractString('1.2')
#2 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(165): Selectors->__construct('1.2')
#3 [internal function]: Pages->___find('1.2', Array)
#4 /home/sites/pretendy-url.com/public_html/wire/core/Wire.php(389): call_user_func_array(Array, Array)
#5 /home/sites/pretendy-url.com/public_html/wire/core/Wire.php(344): Wire->runHooks('find', Array)
#6 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(260): Wire->__call('find', Array)
#7 /home/sites/pretendy-url.com/public_html/wire/core/Pages.php(260): Pages->find('1.2', Array)
#8 /home/sites/pretend
This error message was shown because you are logged in as a Superuser. Error has been logged. 

Ryan's suggestion

Uninstalling MarkupSEO makes the FB entries viewable again.

I had the same issue with ProcessDatabaseBackups. See the related github issue: https://github.com/NicoKnoll/MarkupSEO/issues/4

Share this post


Link to post
Share on other sites

Nice module :)

It looks like Piwik isn't integrated yet?

Will you write some more documentation and usage tips to the readme file and / or the descriptions?

Share this post


Link to post
Share on other sites

@ Joss: Thx, but validation is now ok!

I changed this line in MarkupSEO.module

$rendered .= '<meta name="'.$name.'" content="'.$content.'">'."\n\r";

into

$rendered .= '<meta property="'.$name.'" content="'.$content.'">'."\n\r";

  • Like 1

Share this post


Link to post
Share on other sites

So I think I'm going to change MarkupSEO back to creating "real" fields. This will allow multilanguage and has some other benefits as this module is used by a lot of you lately.

  • Like 5

Share this post


Link to post
Share on other sites

On my own standard profile I have og type and twitter type as page fields so that I can also add new variations on the fly - especially useful with open graph as there are so many potential content types. 

Share this post


Link to post
Share on other sites

So I think I'm going to change MarkupSEO back to creating "real" fields. This will allow multilanguage and has some other benefits as this module is used by a lot of you lately.

This is a good idea Nico especially also whenyou have lots of pages which use MarkupSEO. And Multilanguage is a must for modern SEO in Asia. Thanks!

  • Like 1

Share this post


Link to post
Share on other sites

Great idea, as that pagelimit was a real showstopper. Is there somewhere a full list of the fields this module generates as i would like  to implement this as a standard into my templates. 

Share this post


Link to post
Share on other sites

At the moment it will create the following fields:

  • seo_tab
  • seo_tab_END
  • seo_title
  • seo_keywords
  • seo_description
  • seo_custom
  • seo_image

Maybe there are one or two fields that will follow.


And it's going to be expandable. So each field starting with seo_ will be interpreted as extension. More to this when the new version is finished

Share this post


Link to post
Share on other sites

Just for interest, the fields I use in my sites are:

Title - for the specific page title

Meta Description (which is also used by og:description and twitter:description)

Meta Author 

Google Profile address

Business G+ profiles (which might be different)

A featured image (that is resized as a square on the template)

Twitter name

Twitter Card (page field)

Open Graph Type (page field)

Both the last two have create new options.

I am also thinking of adding bits for Schema, since those are also relevant to SEO, but obviously, if you added those, then people would have to manually add the relevant reference to their templates.

Share this post


Link to post
Share on other sites

Hmm.... reinstalled this module and got quite a few questions ...

1. In Module settings

1.1  "Include Generator" , what does this setting do ?

1.2  "Do you want to get the generated code included automatically or use hooks in your template files?"

What exactly does this do on automatic setting ?

In manual setting you are expected to add the fields manually in your template or are there any other hooks ?

1.3 The "custom" field does this has any form of safety or does this allow to simply inject anything you like into the template head?

(If it would allow to inject anything this still is only a minor security risk as the person who is setting this needs access to mudule settings and is able to install own custom modules.)

1.4 Maybe a switch for automatic redirect to https would be nice as i just read that Google  starts to prefer HTTPS Pages.

http://googlewebmastercentral.blogspot.de/2014/08/https-as-ranking-signal.html

http://www.golem.de/news/hsts-google-fuehrt-liste-von-reinen-https-seiten-1408-108531.html

http://www.spiegel.de/netzwelt/web/google-belohnt-https-verbindungen-im-ranking-a-984872.html

Just an idea?

2. In page seo settings.

2.1 Warning:

in_array() expects parameter 2 to be array, string given in /home/p4a/domains/009.pw4all.org/public_html/site/modules/MarkupSEO/MarkupSEO.module on line 76

2.2 Maybe an Image field for the image ? But i really have no idea for what reason there is a Image field in SEO settings of a page ?

2.3 Again the custom field , if its only meaned for metas maybe a small repeater woudl do the job better ? Or maybe at least add some Regex filter to stop the average writer from adding  unlimited Javascript into ths page.? 

Edit:

Ist just an idea but i have often seen an underscore added to tab fields like  _seo  and _seo_END so you can see its a tab field on first view  again, just an idea.

Share this post


Link to post
Share on other sites

Hey,

new version is almost finished and is going to be released in an hour I guess.

Most of your issues should be solved in this :)

And the image field is used for open graph and twitter cards.

And I normally do _stuff for tabs to but I thought it might be a little bit better to have the same schema for all of the seo fields that get generated automatically (and it's easier to delete them afterwards)

  • Like 1

Share this post


Link to post
Share on other sites

Update 0.5.0: 

This version is not compatible with further releases (and still beta).

https://github.com/NicoKnoll/MarkupSEO/blob/master/MarkupSEO.module

I did a lot of changes and almost wrote the complete code new. Here are some main changes:

  • Use normal fields instead of custom solution (this allows multilanguage and may prevents some compatibility problems)
  • Added Twitter Cards
  • Added an "Author" option
  • Added a "title format" option (and a way to disable auto include of title)
  • Rewrote most of fields descriptions
  • Custom meta tags have to have a special format now + sanitizer for security (it's self explaining in the module itself)
  • Fixed all issues
  • You have to choose which templates should have a SEO tab instead of excluding now

Let me hear what you think. And merry christmas :)

  • Like 3

Share this post


Link to post
Share on other sites

I would like to do a request. Is it possible to remove the line breaks? 

<title>titel</title><meta name="keywords" content="voorbeeld, voorbeeld, voorbeeld">

<meta name="description" content="Dit is de omschrijving">

<meta name="image" content="">

<meta name="canonical" content="http://www.testpagina/">

<meta name="generator" content="ProcessWire 2.5.3">

<meta name="author" content="">

<meta name="robots" content="index, follow">

<meta name="og:site_name" content="">

<meta name="og:title" content="titel">

<meta name="og:url" content="">

<meta name="og:description" content="Dit is de omschrijving">

<meta name="og:type" content="website">

<meta name="og:image" content="">

<meta name="twitter:card" content="summary">

<meta name="twitter:site" content="@">

<meta name="twitter:title" content="titel">

<meta name="twitter:url" content="">

<meta name="twitter:description" content="Dit is de omschrijving">

<meta name="twitter:image" content="">
  • Like 1

Share this post


Link to post
Share on other sites

Great Work !!!!

Small bug?

Warning: in_array() expects parameter 2 to be array, string given in /home/p4a/domains/009.pw4all.org/public_html/site/modules/MarkupSEO/MarkupSEO.module on line 92

Share this post


Link to post
Share on other sites

About global custom field.

A while ago i had some trouble whith google indexing HTML entities in my meta Descriptions rigth as that.

So when i loocked at google search results i was looking at some ü> and a few other.

I am not sure if this is still an issue as i don't do much SEO right now but if it is i guess we schould use a regex

filter that only allows word characters and a few choosen special chars and simply drops all other.

And again maybe its an option to make the global custom field whithout filter as it can be only edited by an admin.

What i did not test yet was if the global field is overridden by the page based one or if both are concatenated?

About image field in page SEO :

Is there a reason why this is still no Imagefield ? Maybe i missed something ?

About page SEO:

maybe add a field  for a per page Robots setting? This is no must have , but would make it almost feature complete :-)

Google Preview :

What do i have to do to get a google prewiew displayed ?

And again, great work, i love it!!! 

Share this post


Link to post
Share on other sites

Version 0.6.0:

  • Big feature: Google suggestion autocomplete
  • Google preview updates while you type
  • Custom contents only get sanitized now
  • Bugfixes

@NorbertH: This is not an image field because you can't have an image field in the modules config settings page. And I think this is good enough for now. Maybe I change my mind later on :)

@toothpaste: Why no line breaks?

  • Like 2

Share this post


Link to post
Share on other sites

@NorbertH: This is not an image field because you can't have an image field in the modules config settings page. And I think this is good enough for now. Maybe I change my mind later on  :)

Sorry, simply did not know that you cannot have Image fields in module config ...

As Google handles each subpage of a site as a seperate page (you often can see subpages ranking much better than the main page at least at a speciffic topic ) it may be a good Idea to have this image setting in the page speciffic settings  and use the one set on the home page as default maybe? 

Same goes for the Robot settings where user want to exclude certain pages or areas .

@toothpaste: Why no line breaks?

I guess hes is talking about the double linebreaks which look ugly and makes HTML source harder to read.

Personallly i would even prefer to add some tabs before the actual tags to have a propper formating of HTML source :

<head>
​    <title>titel</title><meta name="keywords" content="voorbeeld, voorbeeld, voorbeeld">
 
    <meta name="description" content="Dit is de omschrijving">
    <meta name="image" content="">
    <meta name="canonical" content="[url=http://www.testpagina/]http://www.testpagina/">[/url]
    <meta name="generator" content="ProcessWire 2.5.3">
    <meta name="author" content="">
    <meta name="robots" content="index, follow">
    <meta name="og:site_name" content="">
    <meta name="og:title" content="titel">
    <meta name="og:url" content="">
    <meta name="og:description" content="Dit is de omschrijving">
    <meta name="og:type" content="website">
    <meta name="og:image" content="">
    <meta name="twitter:card" content="summary">
    <meta name="twitter:site" content="@">
    <meta name="twitter:title" content="titel">
    <meta name="twitter:url" content="">
    <meta name="twitter:description" content="Dit is de omschrijving">
    <meta name="twitter:image" content="">
...
</head>
​
 

Last thing i found was a bunch of notices  while saving the page settings:

Notice: Undefined variable: page in [/size]/home/p4a/domains/009.pw4all.org/public_html/site/modules/MarkupSEO/MarkupSEO.module on line [/size]137

Notice: Trying to get property of non-object in [/size]/home/p4a/domains/009.pw4all.org/public_html/site/modules/MarkupSEO/MarkupSEO.module on line [/size]137

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