Jump to content
Martijn Geerts

TextformatterImageInterceptor

Recommended Posts

TextformatterImageInterceptor

( Textformatter module )

Let editors use WYSIWYG images, but let you control the image size, aspect ratio & behaviour.

How to install

  • Copy the TextformatterImageInterceptor.module file to your /site/modules/ directory (or place it in /site/modules/TextformatterImageInterceptor/).
  • Click check for new modules in ProcessWire Admin Modules screen. Click install for the module labeled: "Image Interceptor".
  • Go to the module config screen and set the settings you wish.

How to use

  • Edit your body field in Setup > Fields (or whatever field(s) you will be placing controlled images in). On the details tab, find the Text Formatters field and select "Image Interceptor". Save.

About the settings

Render Inline styles

  • If checked, some inline styles are added to the image.

High Density

  • Double the pixel width of an image if the percentage is not set. (fixed image size)

Default there are settings for landscape & portrait images. Squared images will inherit all settings belonging to portrait settings and there's a way to escape the default settings. But before we dive deeper in tagged sets I want to spread some light on the landscape/portrait settings. All images portrait/landscape wil get the class name .default.

 

ps, All images including tagged set images get the image orientation as class (.landscape / .portrtait) 

Percentage

  • The width of the image in percentage. This setting makes the image responsive or if left blank the image wil be fixed size. Images receive a .responsive and a .p-50 class (where 50 is the width in percentage)

Width

  • The width of the image in pixels. So the width of the image in percentage and the pixel width combined wil be the key to pixel desity.

Alignment

  • There are 5 different ways to align an image. leftcenterrightinherit (inherits from the WYSIWYG editor) and not aligned.

  • If render inline styles is checked the aligment wil be set directly in the inline style of the image. Alignment classes wil be added to the image.

Aspect Ratio (cropping)

  • if an aspect ratio is given, the image will be cropped to the given ratio. If you type 2:1 in the landscape settings. Images 800 pixels wide, will be croped to a 800x400 image. The image gets the following classes: .cropped and .crop-2x1

Image Captions

Type here your class name(s) for the caption. When a class name is provided and an image has a description, the image is wrapped (if not already) and *has-* is set in front of the class name(s). For the caption a div is created with the class name(s) and the image description as text.

 

Next to these settings. You can give custom classes to images. This way you can give it framework specific classes for example. And you're allowed to wrap the images with custom HTML. (Some frameworks needs additional HTML to make images more fancy) Then additional styles could be added to images if render inline styles is checked.

 

Tagged sets

 

Tagged sets are an image tag followed by settings specific for images with that tag.

 

To enable tagged sets, the image field need "Use Tags?" to be checked. Go to setup, then fields go to your image field and under the details tab check "Use Tags?".

 

Taged sets are a good way to escape the default image behaviour. Say you have a bunch of nicely ordered images on the page, but you want to show a company logo on 150px floated left. With tagged sets it's no problem. type: (logo 150px left) on one line and you've created your first tagged set. (don't forget to tag the image to)

 

If you want captions for a tagged set, keep in mind that captions need at least 1 class. The format to enter: caption.class-name
 
For an image wrapper we use the same rules. The only difference is we start typing wrapper followed by class names starting with a dot. example: wrapper.logo.stand-out.
 

You can have a multitude of sets, every set on it's own line. Every set needs at least a tag-name and a pixel width.

 

Note: If you use a wrapper or captions (wrapper will be created if none is set), the inline styles and specific width & alignment classes will be set to the wrapper and removed from the image. This way no duplication of styles wil take place.

 

post-577-0-67643900-1375184786_thumb.png

 

github

modules directory

Edited by Martijn Geerts
  • Like 14

Share this post


Link to post
Share on other sites

I'm liking this, thanks! Am not crazy about the "hijack" name though ;)

Share this post


Link to post
Share on other sites

WOW! Martijn I love this idea, fantastic. I see this becoming a must-have for many of my clients. Thanks.

PS: I'm ok with the name, but if we're suggesting hmmmmnnn, maybe ImageInterceptor or ImageMaster  ...  ImageCommander or simple ImageRules?

  • Like 1

Share this post


Link to post
Share on other sites

Hi Martijn,

This is great. I can't wait to give it a go. Stupid question: what happens if the image is square?

Regards

Marty

Share this post


Link to post
Share on other sites

@adam a recognizable (can see what it does name) has my preference. I like the name ImageInterceptor all though it sounds a little to advanced for the task it does. I will keep this name in mind.

@Marty, squared images are now considered as portrait. In my experience most customers just drop in images if they can ( I almost always disable image input in WYSIWYG )

I can think of using image tags on the image field to give some control. When giving images a tag of logo. it wil be less wide then other images. or have a higher density of pixels. (Soma had a nice math script for "visual image weight", calculation also based on aspect ratio)

  • Like 1

Share this post


Link to post
Share on other sites

Thanks Martijn. Does this also remove with the <p> tags that get wrapped around an image in TinyMCE? - I've been using jQuery for this. -Marty

Share this post


Link to post
Share on other sites

that reminds me of a game on the good old amiga 500: F/A-18 Interceptor...i started from a aircraft carrier and i flew with maximum speed through the golden gate bridge... :D

  • Like 3

Share this post


Link to post
Share on other sites

I'm on vacation, but the yesterday it starts with rain. (little spare time & good excuse to continue this module).

A lot of progress is made with this module, It's now to the point of testing / bug fixing & fine tuning. I've added it to the modules directory and it is in a pending state.

If you have a little spare time, please test this module.

Thank You,

Martijn.

  • Like 1

Share this post


Link to post
Share on other sites

Ok, I just installed your module but I don't want to use the percent, width etc settings. I really just want the captions option. So, I emptied those dimensions fields, but the width is a required field. Can you have an option to disable this part of interceptor's options?

Also, noticed that it resizes images up. I wonder if those dimension settings should be max so that images will only be sized down (or at least make it an option) - sizing up could result in some blurry images.

Minor text correction: 

Append the style attribut to images.

should be "attribute"

  • Like 1

Share this post


Link to post
Share on other sites

Changed the typo.

Width is required right now. Didn't thought about using this module for captions only.

(Module was meant for the evil editors who messes up your site with all different sizes & alignments etc.)

I will think off inheriting the size of the image.

And I put the "get alt text from original rte, with fallback to image->description." as todo

(if you want captions only, consider Teppo's solution. )

Share this post


Link to post
Share on other sites

Yeah, I see that is has evolved for sure :)

I actually don't think you should necessarily grab the alt text from the RTE as the default. Maybe make it an option. See my reasoning in the first two bullet points in this post: http://processwire.com/talk/topic/1344-captions-for-images-in-tinymce/?p=40291. This is why Teppo's solution doesn't work for me.

One more thing - it seems the pattern match for the Additional Inline Styles field is maybe a little off. 

You are using:

([\w-]+:[0-9\w .]+;\s?)+

But this doesn't allow for # which is necessary if someone wants to add a hex color, eg: color:#990000;

I think you should also include an example of the required format here, eg: font-size:0.8em; making note that the ";" is also required. I actually had to look at the source of the page to see the regex to figure out what to enter here :)

Share this post


Link to post
Share on other sites

I'm in a restaurant now, will come back on this topic tomorrow. I love all the input you give! Lets make an awesome module.

Today we go for a few days to bratislava, so I don't know if I have the time to come back on the topic within the next few days.

ps, I removed the pattern for the inline style at all & updated the source code on git.

Edited by Martijn Geerts
  • Like 1

Share this post


Link to post
Share on other sites

Just installed ImageInterceptor but getting the following error on rendering:

PHP Notice: Undefined offset: 0 in C:\CustomerData\webspaces\webspace_00125655\wwwroot\pw.appsolo.com\site\modules\TextformatterImageInterceptor\TextformatterImageInterceptor.module on line 172
PHP Notice: Undefined offset: 0 in C:\CustomerData\webspaces\webspace_00125655\wwwroot\pw.appsolo.com\site\modules\TextformatterImageInterceptor\TextformatterImageInterceptor.module on line 172

I have a single image in a body field (textarea), created using CKEditor. I added the image to an Image field and selected that single image in the WYSIWYG editor. The module is installed with no errors. Any ideas?

Thanks,

J

UPDATE: wiped the images from the Image field in the same page. Deleted any references in the body field to the (now missing) image. Then added the same image to the Image field and dragged into the body. Now working. Clue?

Share this post


Link to post
Share on other sites

The wrapper needs a double pipe, to split. ||

Will correct this issue soon.

Gonna dive into the other issue tomorrow.

Thank you for your report.

  • Like 1

Share this post


Link to post
Share on other sites

Not error but notice. And debug mode on.

  • Like 1

Share this post


Link to post
Share on other sites

Could the errors of John Kelleher be due to an incorrect order of the textformatters?

As I change the order I get quite the same error (using TinyMCE)

Share this post


Link to post
Share on other sites

The errors (notices) tell me that the wrapper couldn't split up in two parts. The wrapper should have a double pipe || to split.

Can you tell me more about the problem.

- Version of PW,

- Is it a single or multiimage field.

- etc.

 (Textformatters order is important thing as one formats the other. )

Share this post


Link to post
Share on other sites

if "Maximum files allowed" was set to 1, the module was not able to get the image.

(ADMIN > SETUP > FIELDS > imagefield )

Latest update fixed this bug.

  • Like 1

Share this post


Link to post
Share on other sites

Hey Martijn,

I just sent you a pull request to add the ability to specify the maximum filesize for an image once inserted in an RTE.

I needed this functionality because clients were uploading very high resolution images and embedding those - nasty! Training only works for some people and only some of the time :)

The interceptor will automatically compress this image until it reaches the limit specified in the module settings.

If the limit is set too low, it can obviously result in some poor quality images. I wonder if it would be good to have a bit of a sliding scale for this setting based on the physical dimensions that the image is going to be displayed at.

Let me know what you think and definitely feel free to ignore, or give me your ideas for a different approach. I am also open to making this a separate module if you'd prefer.

Share this post


Link to post
Share on other sites

@Adrian, I did the merge it should be in the module now.

I will look at the module later, when there's more time.

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By teppo
      Needed a really simple solution to embed audio files within page content and couldn't find a module for that, so here we go. Textformatter Audio Embed works a bit like Textformatter Video Embed, converting this:
      <p>https://www.domain.tld/path/to/file.mp3</p> Into this:
      <audio controls class="TextformatterAudioEmbed"> <source src="https://www.domain.tld/path/to/file.mp3" type="audio/mpeg"> </audio> The audio element has pretty good browser support, so quite often this should be enough to get things rolling 🙂
      GitHub repository: https://github.com/teppokoivula/TextformatterAudioEmbed Modules directory: https://modules.processwire.com/modules/textformatter-audio-embed/
    • By Richard Jedlička
      Tense    
      Tense (Test ENvironment Setup & Execution) is a command-line tool to easily run tests agains multiple versions of ProcessWire CMF.
      Are you building a module, or a template and you need to make sure it works in all supported ProcessWire versions? Then Tense is exactly what you need. Write the tests in any testing framework, tell Tense which ProcessWire versions you are interested in and it will do the rest for you.

      See example or see usage in a real project.
      How to use?
      1. Install it: 
      composer global require uiii/tense 2. Create tense.yml config:
      tense init 3. Run it:
      tense run  
      For detailed instructions see Github page: https://github.com/uiii/tense
       
      This is made possible thanks to the great wireshell tool by @justb3a, @marcus and others.
       
      What do you think about it? Do you find it useful? Do you have some idea? Did you find some bug? Tell me you opinion. Write it here or in the issue tracker.
    • By Chris Bennett
      Hi all, I am going round and round in circles and would greatly appreciate if anyone can point me in the right direction.
      I am sure I am doing something dumb, or missing something I should know, but don't. Story of my life 😉

      Playing round with a module and my basic problem is I want to upload an image and also use InputfieldMarkup and other Inputfields.
      Going back and forth between trying an api generated page defining Fieldgroup, Template, Fields, Page and the InputfieldWrapper method.

      InputfieldWrapper method works great for all the markup stuff, but I just can't wrap my head around what I need to do to save the image to the database.
      Can generate a Field for it (thanks to the api investigations) but not sure what I need to do to link the Inputfield to that. Tried a lot of stuff from various threads, of varying dates without luck.
      Undoubtedly not helped by me not knowing enough.

      Defining Fieldgroup etc through the api seems nice and clean and works great for the images but I can't wrap my head around how/if I can add/append/hook the InputfieldWrapper/InputfieldMarkup stuff I'd like to include on that template as well. Not even sure if it should be where it is on ___install with the Fieldtype stuff or later on . Not getting Tracy errors, just nothing seems to happen.
      If anyone has any ideas or can point me in the right direction, that would be great because at the moment I am stumbling round in the dark.
       
      public function ___install() { parent::___install(); $page = $this->pages->get('name='.self::PAGE_NAME); if (!$page->id) { // Create fieldgroup, template, fields and page // Create new fieldgroup $fmFieldgroup = new Fieldgroup(); $fmFieldgroup->name = MODULE_NAME.'-fieldgroup'; $fmFieldgroup->add($this->fields->get('title')); // needed title field $fmFieldgroup->save(); // Create new template using the fieldgroup $fmTemplate = new Template(); $fmTemplate->name = MODULE_NAME; $fmTemplate->fieldgroup = $fmFieldgroup; $fmTemplate->noSettings = 1; $fmTemplate->noChildren = 1; $fmTemplate->allowNewPages = 0; $fmTemplate->tabContent = MODULE_NAME; $fmTemplate->noChangeTemplate = 1; $fmTemplate->setIcon(ICON); $fmTemplate->save(); // Favicon source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFavicon'; $fmField->label = 'Favicon'; $fmField->focusMode = 'off'; $fmField->gridMode = 'grid'; $fmField->extensions = 'svg png'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Favicon Silhouette source $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeImage"); $fmField->name = 'fmFaviconSilhouette'; $fmField->label = 'SVG Silhouette'; $fmField->notes = 'When creating a silhouette/mask svg version for Safari Pinned Tabs and Windows Tiles, we recommend setting your viewbox for 0 0 16 16, as this is what Apple requires. In many cases, the easiest way to do this in something like illustrator is a sacrificial rectangle with no fill, and no stroke at 16 x 16. This forces the desired viewbox and can then be discarded easily using something as simple as notepad. Easy is good, especially when you get the result you want without a lot of hassle.'; $fmField->focusMode = 'off'; $fmField->extensions = 'svg'; $fmField->columnWidth = 50; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon(ICON); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($fmField); // Create: Open Settings Tab $tabOpener = new Field(); $tabOpener->type = new FieldtypeFieldsetTabOpen(); $tabOpener->name = 'fmTab1'; $tabOpener->label = "Favicon Settings"; $tabOpener->collapsed = Inputfield::collapsedNever; $tabOpener->addTag(MODULE_NAME); $tabOpener->save(); // Create: Close Settings Tab $tabCloser = new Field(); $tabCloser->type = new FieldtypeFieldsetClose; $tabCloser->name = 'fmTab1' . FieldtypeFieldsetTabOpen::fieldsetCloseIdentifier; $tabCloser->label = "Close open tab"; $tabCloser->addTag(MODULE_NAME); $tabCloser->save(); // Create: Opens wrapper for Favicon Folder Name $filesOpener = new Field(); $filesOpener->type = new FieldtypeFieldsetOpen(); $filesOpener->name = 'fmOpenFolderName'; $filesOpener->label = 'Wrap Folder Name'; $filesOpener->class = 'inline'; $filesOpener->collapsed = Inputfield::collapsedNever; $filesOpener->addTag(MODULE_NAME); $filesOpener->save(); // Create: Close wrapper for Favicon Folder Name $filesCloser = new Field(); $filesCloser->type = new FieldtypeFieldsetClose(); $filesCloser->name = 'fmOpenFolderName' . FieldtypeFieldsetOpen::fieldsetCloseIdentifier; $filesCloser->label = "Close open fieldset"; $filesCloser->addTag(MODULE_NAME); $filesCloser->save(); // Create Favicon Folder Name $fmField = new Field(); $fmField->type = $this->modules->get("FieldtypeText"); $fmField->name = 'folderName'; $fmField->label = 'Favicon Folder:'; $fmField->description = $this->config->urls->files; $fmField->placeholder = 'Destination Folder for your generated favicons, webmanifest and browserconfig'; $fmField->columnWidth = 100; $fmField->collapsed = Inputfield::collapsedNever; $fmField->setIcon('folder'); $fmField->addTag(MODULE_NAME); $fmField->save(); $fmFieldgroup->add($tabOpener); $fmFieldgroup->add($filesOpener); $fmFieldgroup->add($fmField); $fmFieldgroup->add($filesCloser); $fmFieldgroup->add($tabCloser); $fmFieldgroup->save(); /////////////////////////////////////////////////////////////// // Experimental Markup Tests $wrapperFaviconMagic = new InputfieldWrapper(); $wrapperFaviconMagic->attr('id','faviconMagicWrapper'); $wrapperFaviconMagic->attr('title',$this->_('Favicon Magic')); // field show info what $field = $this->modules->get('InputfieldMarkup'); $field->name = 'use'; $field->label = __('How do I use it?'); $field->collapsed = Inputfield::collapsedNever; $field->icon('info'); $field->attr('value', 'Does this even begin to vaguely work?'); $field->columnWidth = 50; $wrapperFaviconMagic->add($field); $fmTemplate->fields->add($wrapperFaviconMagic); $fmTemplate->fields->save(); ///////////////////////////////////////////////////////////// // Create page $page = $this->wire( new Page() ); $page->template = MODULE_NAME; $page->parent = $this->wire('pages')->get('/'); $page->addStatus(Page::statusHidden); $page->title = 'Favicons'; $page->name = self::PAGE_NAME; $page->process = $this; $page->save(); } }  
    • By Sebi
      Since it's featured in ProcessWire Weekly #310, now is the time to make it official:
      Here is Twack!
      I really like the following introduction from ProcessWire Weekly, so I hope it is ok if I use it here, too. Look at the project's README for more details!
      Twack is a new — or rather newish — third party module for ProcessWire that provides support for reusable components in an Angular-inspired way. Twack is implemented as an installable module, and a collection of helper and base classes. Key concepts introduced by this module are:
      Components, which have separate views and controllers. Views are simple PHP files that handle the output for the component, whereas controllers extend the TwackComponent base class and provide additional data handling capabilities. Services, which are singletons that provide a shared service where components can request data. The README for Twack uses a NewsService, which returns data related to news items, as an example of a service. Twack components are designed for reusability and encapsulating a set of features for easy maintainability, can handle hierarchical or recursive use (child components), and are simple to integrate with an existing site — even when said site wasn't originally developed with Twack.
      A very basic Twack component view could look something like this:
      <?php namespace ProcessWire; ?> <h1>Hello World!</h1> And here's how you could render it via the API:
      <?php namespace Processwire; $twack = $modules->get('Twack'); $hello = $twack->getNewComponent('HelloWorld'); ?> <html> <head> <title>Hello World</title> </head> <body> <?= $hello->render() ?> </body> </html> Now, just to add a bit more context, here's a simple component controller:
      <?php namespace ProcessWire; class HelloWorld extends TwackComponent { public function __construct($args) { parent::__construct($args); $this->title = 'Hello World!'; if(isset($args['title'])) { $this->title = $args['title']; } } } As you can see, there's not a whole lot new stuff to learn here if you'd like to give Twack a try in one of your projects. The Twack README provides a really informative and easy to follow introduction to all the key concepts (as well as some additional examples) so be sure to check that out before getting started. 
      Twack is in development for several years and I use it for every new project I build. Also integrated is an easy to handle workflow to make outputs as JSON, so it can be used to build responses for a REST-api as well. I will work that out in one section in the readme as well. 
      If you want to see the module in an actual project, I have published the code of www.musical-fabrik.de in a repository. It runs completely with Twack and has an app-endpoint with ajax-output as well.
      I really look forward to hear, what you think of Twack🥳!
      Features Installation Usage Quickstart: Creating a component Naming conventions & component variants Component Parameters directory page parameters viewname Asset handling Services Named components Global components Ajax-Output Configuration Versioning License Changelog
    • By Robin S
      Page Reference Default Value
      Most ProcessWire core inputfield types that can be used with a Page Reference field support a "Default value" setting. This module extends support for default values to the following core inputfield types:
      Page List Select Page List Select Multiple Page Autocomplete (single and multiple) Seeing as these inputfield types only support the selection of pages a Page List Select / Page List Select Multiple is used for defining the default value instead of the Text / Textarea field used by the core for other inputfield types. This makes defining a default value a bit more user-friendly.
      Note that as per the core "Default value" setting, the Page Reference field must be set to "required" in order for the default value to be used.
      Screenshot

       
      https://github.com/Toutouwai/PageReferenceDefaultValue
      https://modules.processwire.com/modules/page-reference-default-value/
×
×
  • Create New...