Jump to content
horst

Page Image Manipulator | API for 1 & 2

Recommended Posts

Wow, good find! ^-^

The ratio is stored as extended info for the image and not used further, so a very good find. (and a very stupid bug, info[2] holds the mimetype  :wacko: )

I will fix this with the next update.

Share this post


Link to post
Share on other sites

Hi Horst, I think I found one more.

PageImageManipulator.module, line 13: $this->optionNames is always NULL, because it doesn't get defined before (the class isn't even included at this point).

In consequence, param 2 and 3 are not working correctly as described here:

pimLoad

pimLoad($prefix, $param2=optional, $param3=optional)

  • param 1: $prefix - (string) = mandatory!
  • param 2: mixed, $forceRecreation or $options
  • param 3: mixed, $forceRecreation or $options

Share this post


Link to post
Share on other sites

Sorry, Horst, I don't want to be pesky, but how does this work:

PageImageManipulator.module, line 142:

if(!in_array(strtolower($outputFormat), array('gif','png','jpg'))) {
	$outputFormat = $p['extension'];
}
$outputFormat = strtolower($outputFormat);
if(empty($targetFilename)) {
	$targetFilename = $p['dirname'] .'/pim_'. $prefix .'_'. $p['filename'] .'.'. $outputFormat;
}

$outputFormat is always NULL, that's how it was defined in line 96.

As a result, $outputFormat is always set to the original extension the image has when it was uploaded. Assuming I'm doing a format conversion (png -> jpg), $targetFilename always points to the wrong extension (png instead of jpg), and this file is non-existant. Meaning: everytime all images are recreated, slowing down the page...

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

At line 13 there is only comments. Also without need to test, param 2 definitely work, because I often use it to force recreation of a variations. So you cannot be right with this.

Your post regarding outputFormat, have you tested this or do you see this just by reading the code?

Share this post


Link to post
Share on other sites

titanium, please can you provide the code line for that with pimLoad?

Ah sorry, a "1" is missing. It's in line 113.

Regarding the "outputFormat" problem: I noticed that my page was very slow with PageImage Manipulator. I took a closer look and noticed that the image files were created once again every time the page was loaded. After that, I was on a bug hunt...

Share this post


Link to post
Share on other sites

Ok, your first post is wrong, because the second and third param is processed by the function.

But you are right with the post regarding outputFormat. The options passed as 2 or 3 param gets processsed but not assigned to $outputFormat if it is a key in options, and unfortunately $outputFormat overrides $options['outputFormat'] at the end of the function.

It is in the todo now. But as a quick workaround for you, you may completly bypass sending the $options together with pimLoad(). Insteed use it this way:

pimLoad('prefix'[, true | false])->setOptions($options)-> ... ->pimSave();

This works as expected. (I will rewrite the pimLoad to use this internally the same way)

Sorry for the inconvenience.

Share this post


Link to post
Share on other sites

updated to version 0.1.3

  • fixed a bug with ignoring outputFormat when send as $options with method pimLoad found by @titanium
  • added support for php versions with buggy GD-lib for sharpening and unsharpMask
  • added support for the coming module PageimageNamingScheme into pimVariations()
  • Like 2

Share this post


Link to post
Share on other sites

Are there any known limits with this module?

I'm trying to grayscale 10+ images on a single page using $image->first()->width(320)->pimLoad('bw')->grayscale()->pimSave()->url; and it ends up returning the first 9 images correctly, followed by this error:
Error: Maximum execution time of 30 seconds exceeded

This even occurs when the grayscaled images already exist, still getting a timeout. I've resorted to using file_exists() to check for the grayscaled images manually. If they don't it runs the code above, so with a few page refreshes atfer new image uploads I'm able to eventually have all the images converted.

Any suggestions?

Share this post


Link to post
Share on other sites

There are no limits with this module but with your max execution time for PHP.

add one line into your loop like here:

foreach($images as $image) {
    ini_set('max_execution_time', 30);  // this line resets the timer for max_execution_time with every loop.
    // following your code ...

EDIT:

It shouldn't take that long if images are already rendered. Please can you post your code of the loop here?

Edited by horst

Share this post


Link to post
Share on other sites

Sure thing:

<?php foreach ($page->children as $article) {
	$coverimage = $article->cover_image->first()->width(320);
	$bw = $coverimage->pimLoad('bw')->grayscale()->pimSave()->url;
	?>
	<a class="archive-item" href="<?php echo $article->url; ?>">
		<div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw; ?>"></div>
		<div class="archive-item-text-container"><div class="archive-item-text">
			<?php
			echo "<div class='archive-item-title'>".$article->title."</div>";
			echo "<div>".$article->contributor->title."</div>";
			?>
		</div></div>
	</a>
<?php } ?>

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.
 

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Share this post


Link to post
Share on other sites

Horst,

a very helpful module! Thank you. However, I miss a feature that would be helpful: 

cropFromCenter(width, height); 

- Resizing and cropping in the original aspect ratio 

The image is reduced first to the width or the height. If it does not fit into the new format, the image is automatically cropped from the middle of the image.

Regards,

David

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

  • Like 2

Share this post


Link to post
Share on other sites

@David: this is already supported by the core ImageSizer. You can combine ImageSizer and PiM manipulations in any order you like:

$croppedVariation1 = $image->size($width, $height, array('cropping'=>true))->pimLoad('prefix')->grayscale()->pimSave();
$croppedVariation2 = $image->pimLoad('prefix')->grayscale()->pimSave()->size($width, $height);  // cropping is true by default in $config->imageSizerOptions in site/config.php

If this doesn't suite your needs, report back please.

Ah damn. Sorry, my mistake. :)

  • Like 1

Share this post


Link to post
Share on other sites

Hhm, you are not looping through images but childpages. You may try to debug the times for the images rendering.

Also you can do the resize to 320 and grayconvert in one step.

<?php   
$timerstotal = array();

foreach ($page->children as $article) {
    ini_set('max_execution_time', 30);
    $timers = array();
    $timer = Debug::timer();
    $timers[] = Debug::timer($timer);  // start image rendering
    $bw = $article->cover_image->first()->pimLoad('bw320')->width(320)->grayscale()->pimSave();
    $timers[] = Debug::timer($timer);  // finished image rendering
?>
    <a class="archive-item" href="<?php echo $article->url; ?>">
        <div class="archive-item-img"><img class="archive-item-img-overlay" src="<?php echo $bw->url; ?>"></div>
        <div class="archive-item-text-container"><div class="archive-item-text">
        <?php
            echo "<div class='archive-item-title'>".$article->title."</div>";
            echo "<div>".$article->contributor->title."</div>";
        ?>
        </div></div>
    </a>
<?php 
    $timers[] = Debug::timer($timer);  // none image stuff finished
    $timerstotal[] = $timers;
} 

// output timers
echo "<pre>\n"; // or "<!-- \n" to output it as HTML comment 
var_dump($timerstotal);
echo "\n</pre>"; // or "\n-->\n";
?>

Thanks for this horst, if I have more than 9 items in the loop it never actually executes the code which outputs the timings.

Stripped it back to 9 items, this is the output:

array(9) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0243"
    [2]=>
    string(6) "0.0280"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0150"
    [2]=>
    string(6) "0.0172"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0250"
    [2]=>
    string(6) "0.0267"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0484"
    [2]=>
    string(6) "0.0502"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1159"
    [2]=>
    string(6) "0.1179"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.2891"
    [2]=>
    string(6) "0.2927"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.8478"
    [2]=>
    string(6) "0.8514"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "2.8584"
    [2]=>
    string(6) "2.8602"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "10.3439"
    [2]=>
    string(7) "10.3459"
  }
}

Share this post


Link to post
Share on other sites

as you can see all image renderings are less than a second. Only number 7 = nearly 3 seconds and number 8 is more than 10 seconds!

It seems that this is a much to big image, maybe.

Also the ini_set('max_execution_time', 30); seems to be disabled / forbidden on your server.  :(

I would try to get this enabled. Can you ask your hoster about this? Also you can try to use set_time_limit(30) instead first, but I guess this will be disabled too. You should have a look to your phpinfo() under safe_mode and disabled functions.

Second point: do you really need that large images like under #8 that takes 10 seconds for rendering a 320 thumbnail? You can set a max dimension for width and height for the images-field under Setup -> Fields -> yourimagesfield -> Input -> Max Images Dimensions. This will render the uploaded image to these max dimensions (e.g. 1200 or 960 px or what ever you need) and takes this as source for all smaller sizes.

Also it looks that your images don't get cached? Do they get recreated every time you run that script? This is not the normal behave and sounds very strange if so. ??

Share this post


Link to post
Share on other sites

Hi horst, thanks for looking at this so quickly!

The last two images that are taking ~3s and ~10s, the originals are only 450 x 600px (25kb) and 536 x 712px (74kb). They're no bigger than any of the other images, actually quite small compared to some others. Seems strange that each image is taking progressively longer to render?

The process is also still taking this long even though the images aren't being recreated each time, they're all saved in the assets directory and aren't being overwritten as far as I can see.

EDIT: Is this looking like it's something to with my server configuration? This is all happening on my local XAMPP server.

Share this post


Link to post
Share on other sites

Yes, this is looking very weird. If it is on your local server, you can configure php.ini according to my suggestions above, (allowing set_time_limit(), etc). You need to check phpinfo().

Share this post


Link to post
Share on other sites

set_time_limit(300) did it. Could only load two more, but here's the output:

Last image took 158 seconds to render!

 

array(11) {
  [0]=>
  array(3) {
    [0]=>
    string(6) "0.0001"
    [1]=>
    string(6) "0.0880"
    [2]=>
    string(6) "0.0928"
  }
  [1]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0338"
    [2]=>
    string(6) "0.0357"
  }
  [2]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0454"
    [2]=>
    string(6) "0.0477"
  }
  [3]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.0879"
    [2]=>
    string(6) "0.0898"
  }
  [4]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.1946"
    [2]=>
    string(6) "0.1964"
  }
  [5]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "0.4132"
    [2]=>
    string(6) "0.4180"
  }
  [6]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "1.1618"
    [2]=>
    string(6) "1.1657"
  }
  [7]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(6) "3.4625"
    [2]=>
    string(6) "3.4644"
  }
  [8]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "11.8296"
    [2]=>
    string(7) "11.8319"
  }
  [9]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(7) "43.1316"
    [2]=>
    string(7) "43.1335"
  }
  [10]=>
  array(3) {
    [0]=>
    string(6) "0.0000"
    [1]=>
    string(8) "158.5707"
    [2]=>
    string(8) "158.5729"
  }
}

Share this post


Link to post
Share on other sites

hhm, but this is not the solution. There must be something completely wrong, because if the images once are rendered, it should only took 0.02 seconds for each image, regardless if it is the first or the 19. ??

Share this post


Link to post
Share on other sites

hi  @horst  :

i want to add a watermark for page image. and use this module then got an error:

Error: Call to a member function pimLoad() on a non-object 

this caused error:

 
$img = $page->images->first();

$wmi = $page->watermark->pimLoad('wmi')->colorize('red')->pimSave();

$imgsrc = $img->pimLoad('tw',true)->width(180)->grayscale()->watermarkLogo($wmi, 'southeast', 0)->pimSave();

echo "<img src='{$imgsrc->url}' /><br />";
 

i use this,its works well, i found the new image be created:

$img = $page->images->first();
$imgsrc = $img->pimLoad('myPrefix')->setOptions($options)->width(300)->pimSave();
echo "<img src='{$imgsrc->url}' /><br />";

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?
  • Like 1

Share this post


Link to post
Share on other sites

Hi @leoric,

I assume the error occures on the imagefield named watermark as you can use the pimLoad method with the field named images.

Here are a few questions:

  • Does your template / page have an imagefield with (exactly) that name?
  • Is this imagefield set to accept only a single image?

big help.

@horst, thank you!

Share this post


Link to post
Share on other sites

I was able to reproduce POWERFULHORSE's speed issue.

some images hang for 30-40 seconds on an operation after they have been successfully rendered once.  

PHP: 5.4

PW: 2.4

GD: 2.10 compatible

CODE:
 

foreach ( $albumimages as $albumimage ) 
{
//FAST
$imgSrc = $albumimage->size(1000,600,array('upscaling' => true,'cropping' => false,'quality' => 70))->url;
//Fast with some files, but killer slow with others
$imgSrc =$sized->pimLoad('watermarked')->watermarkText("Gail Gelburd", 20, 'SW', 5, 100, null)->pimSave()->url;
//... 
}

The PIM portion of this operation can hang the the page for many seconds, even after successful rendering of page it does not get any faster on subsequent  page loads.  I can Upload the offending images if that offers any clues as to what can be going on.  If I can offer any additional debug info that might give any helpful clues as to what is going on let me know. Thanks for a great module Horst. 

Share this post


Link to post
Share on other sites

Hi @neeks,
 
at first: I'm not really sure if you have the same effect as powerfulhorse has had, because he has used a loop through childpages and even has had large amount of processing times for cached images?! Doesn't make much sense, hhm?

second: especially the watermarkText method never was meant to be used in bulk rendering. It uses much cpu and memory for calling many memory image copy operations and also inspect images by histograms to autodetect the best used color for the text, etc. So that is a lot of work it does and that is time consuming, - sorry I haven't noted this in the first post here. It was meant for something like showing thumbnails without watermark text on a page and only watermark larger (single) images when requested. Also its text output can be a bit (or very) ugly!?! - If you want add the same text to all images, you should create and use a transparent png with a nice (and maybe smooth) text together with the watermarkLogo method instead.

third: you may use and inspect debug timers with your code. If there are no significant differences with images processed later (comparing to images processed first), everything seems to be ok. If you get significantly larger times only with later processed images in your loop, then this can be due to some (weird?) design in PHP? PiM uses the correct code to release and free memory (pointers) for all objetcs / instances, but the PHP interpreter internally only seems to set this objects to zero but do not really free the memory to the system site. Somewhere I have read about a discussion between the PHP Group and others and "the others" said that the PHP devs have said that it isn't necessary to release / free pointers because all pointers and handles will be released / freed at the end of every request, (because the complete php instance is closed / released then). I haven't investigated further on this, and maybe I have overlooked to release some objects. I will take a closer look to it when finding time for it. But don't expect it in the near future.

---

On the other hand do I use the watermarkLogo method within a loop on a gallery site where it sometimes create 100+ watermarked image variations [2] at first call of an album page without any drawbacks:

$gallery = "<div id='myGallery'>\n";
if(count($page->images)>0) {
    // display imageThumbs
    $num = -1;
    foreach($page->images as $image) {
[1]     set_time_limit(5);
        $imageName = pathinfo($image->name,PATHINFO_FILENAME);
        $imageDescription = strlen(trim($image->description))>0 ? ', ' . preg_replace('/[^0-9a-zA-ZöüäÖÜÄß -]/msi', '', trim($image->description)) : '';
        $num++;
[2]     $gallery .= "\t<a id='uid$num' rel='nofollow' title='{$imageName}{$imageDescription}' href='{$image->pimLoad('full',false)->watermarkLogo($wmPng)->pimSave()->url}'> </a>\n";
        ...
        ...
    }
}
$gallery .= "</div>\n";
set_time_limit(20);

All source images are max 1000 px and as you can see in the loop I use a time_limit of max 5 seconds [1] per loop.

  • Like 4

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 joshua
      ---
      Module Directory: https://modules.processwire.com/modules/privacy-wire/
      Github: https://github.com/blaueQuelle/privacywire/
      Packagist:https://packagist.org/packages/blauequelle/privacywire
      Module Class Name: PrivacyWire
      Changelog: https://github.com/blaueQuelle/privacywire/blob/master/Changelog.md
      ---
      This module is (yet another) way for implementing a cookie management solution.
      Of course there are several other possibilities:
      - https://processwire.com/talk/topic/22920-klaro-cookie-consent-manager/
      - https://github.com/webmanufaktur/CookieManagementBanner
      - https://github.com/johannesdachsel/cookiemonster
      - https://www.oiljs.org/
      - ... and so on ...
      In this module you can configure which kind of cookie categories you want to manage:

      You can also enable the support for respecting the Do-Not-Track (DNT) header to don't annoy users, who already decided for all their browsing experience.
      Currently there are four possible cookie groups:
      - Necessary (always enabled)
      - Functional
      - Statistics
      - Marketing
      - External Media
      All groups can be renamed, so feel free to use other cookie group names. I just haven't found a way to implement a "repeater like" field as configurable module field ...
      When you want to load specific scripts ( like Google Analytics, Google Maps, ...) only after the user's content to this specific category of cookies, just use the following script syntax:
      <script type="text/plain" data-type="text/javascript" data-category="statistics" data-src="/path/to/your/statistic/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing" data-src="/path/to/your/mareketing/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="external_media" data-src="/path/to/your/external-media/script.js"></script> <script type="text/plain" data-type="text/javascript" data-category="marketing">console.log("Inline scripts are also working!");</script> The data-attributes (data-type and data-category) are required to get recognized by PrivacyWire. the data-attributes are giving hints, how the script shall be loaded, if the data-category is within the cookie consents of the user. These scripts are loaded asynchronously after the user made the decision.
      If you want to give the users the possibility to change their consent, you can use the following Textformatter:
      [[privacywire-choose-cookies]] It's planned to add also other Textformatters to opt-out of specific cookie groups or delete the whole consent cookie.
      You can also add a custom link to output the banner again with a link / button with following class:
      <a href="#" class="privacywire-show-options">Show Cookie Options</a> <button class="privacywire-show-options">Show Cookie Options</button>  
      I would love to hear your feedback 🙂
      CHANGELOG
      You can find the always up-to-date changelog file here.
    • By joshua
      As we often use Matomo (former known as Piwik) instead of Google Analytics we wanted to embed Matomo not only in the template code but also via the ProcessWire backend.
      That's why I developed a tiny module for the implementation.
      The module provides the possibility to connect to an existing Matomo installation with the classical site tracking and also via the Matomo Tag Manager.
      If you have also PrivacyWire installed, you can tell MatomoWire to only load the script, if the user has accepted cookies via PrivacyWire.
      To offer an Opt-Out solution you can choose between the simple Opt-Out iFrame, delivered by your Matomo installation, or a button to choose cookies via PrivacyWire.
      You'll find the module both in the module directory and via github:
      ProcessWire Module Directory MatomoWire @ GitHub MatomoWire @ Packagist ->installable via composer require blauequelle/matomowire I'm looking forward to hear your feedback!


    • By Robin S
      If your module has a lot of config fields you might want to divide them into groups inside a tabbed interface. Here is a demonstration module showing how this can be done.
      https://github.com/Toutouwai/ModuleConfigTabs

      Thanks to @kixe for providing my starting point in this forum topic.
    • By FireWire
      Hello community!

      I want to share a new module I've been working on that I think could be a big boost for multi-language ProcessWire sites.

      Some background, I was looking for a way for our company website to be efficiently translated as working with human translators was pretty laborious and a lack of updating content created a divergence between languages. I, and several other devs here, have talked about translation integrations and have recognized the power that DeepL has. DeepL is an AI deep learning powered service that delivers translation quality beyond any automated service available. After access to the API was opened up to the US, I built Fluency, a DeepL translation integration for ProcessWire.
      Fluency brings automated translation to every multi-language field in the admin, and also provides a translation tool allowing the user to translate their text to any language without it being inside a template's field. With Fluency you can:
      Translate any plain textarea or text input Translate any CKEditor content (yes, with markup) Translate page names for fully localized URLs on every page Translate your in-template translation function wrapped strings Translate modules DeepL offers translations to the following languages: English (US), English (UK), German, French, Spanish, Portuguese (EU), Portuguese (Brazil, Italian, Dutch, Polish, Russian, Japanese, Chinese (Simplified)
      Installation and usage is completely plug and play. Whether you're building a new multi-language site, need to update a site to multi-language, or simply want to stop manually translating a site and make any language a one-click deal, it could not be easier to do it. Fluency works by having you match the languages configured in ProcessWIre to DeepL's. You can have your site translating to any or all of the languages DeepL translates to in minutes (quite literally).
      Let's break out the screenshots...
      When the default language tab is shown, a message is displayed to let users know that translation is available. Clicking on each tab shows a link that says "Translate from English". Clicking it shows an animated overlay with the word "Translating..." cycling through each language and a light gradient shift. Have a CKEditor field? All good. Fluency will translated it and use DeepL's ability to translate text within HTML tags. CKEditor fields can be translated as easily and accurately as text/textarea fields.

      Repeaters and AJAX created fields also have translation enabled thanks to a JavaScript MutationObserver that searches for multi-language fields and adds translation as they're inserted into the DOM. If there's a multi-language field on the page, it will have translation added.

      Same goes for image description fields. Multi-language SEO friendly images are good to go.

      Creating a new page from one of your templates? Translate your title, and also translate your page name for native language URLs. (Not available for Russian, Chinese, or Japanese languages due to URL limitations). These can be changed in the "Settings" tab for any page as well so whether you're translating new pages or existing pages, you control the URLs everywhere.

      Language configuration pages are no different. Translate the names of your languages and search for both Site Translation Files (including all of your modules)

      Translate all of the static text in your templates as well. Notice that the placeholders are retained. DeepL is pretty good at recognizing and keeping non-translatable strings like that. If it is changed, it's easy to fix manually.

      Fluency adds a "Translate" item to the CMS header. When clicked this opens up a modal with a full translation tool that lets the user translate any language to any language. No need to leave the admin if you need to translate content from a secondary language back to the default ProcessWire language. There is also a button to get the current API usage statistics. DeepL account owners can set billing limitations via character count to control costs. This may help larger sites or sites being retrofitted keep an eye on their usage. Fluency can be used by users having roles given the fluency-translate permission.

      It couldn't be easier to add Fluency to your new or existing website. Simply add your API key and you're shown what languages are currently available for translation from/to as provided by DeepL. This list and all configuration options are taken live from the API so when DeepL releases new languages you can add them to your site without any work. No module updates, just an easy configuration. Just match the language you configured in ProcessWire to the DeepL language you want it to be associated with and you're done. Fluency also allows you to create a list of words/phrases that will not be translated which can prevent items such as brands and company names from being translated when they shouldn't

       
      Limitations:
      No "translate page" - Translating multiple fields can be done by clicking multiple translation links on multiple fields at once but engineering a "one click page translate" is not feasible from a user experience standpoint. The time it takes to translate one field can be a second or two, but cumulatively that may take much longer (CKEditor fields are slower than plain text fields). There may be a workaround in the future but it isn't currently on the roadmap. No "translate site" - Same thing goes for translating an entire website at once. It would be great, but it would be a very intense process and take a very (very) long time. There may be a workaround in the future but it isn't on the roadmap. No current support for Inline CKEditor fields - Handling for CKEditor on-demand hasn't been implemented yet, this is planned for a future release though and can be done. I just forgot about it because I've never really used that feature personally.. Alpha release - This module is in alpha. Releases should be stable and usable, but there may be edge case issues. Test the module thoroughly and please report any bugs via a Gitlab issue on the repository or respond here. Please note that the browser plugin for Grammarly conflicts with Fluency (as it does with many web applications). To address this issue it is recommended that you disable Grammarly when using Fluency, or open the admin to edit pages in a private window where Grammarly may not be loaded. This is an issue that may not have a resolution as creating a workaround may not be possible. If you have insight as to how this may be solved please visit the Gitlab page and file a bugfix ticket.
      Requirements:
      ProcessWire  3.0+ UIKit Admin Theme That's Fluency in a nutshell. A core effort in this module is to create it so that there is nothing DeepL related hard-coded in that would require updating it when DeepL offers new languages. I would like this to be a future-friendly module that doesn't require developer work to keep it up-to-date.
      It's Free
      This is my first real module and I want to give it back to the community as thanks. This is the best CMS I've worked with (thank you Ryan & contributors) and a great community (thank you dear reader). The only cost to use this is a subscription fee for the DeepL Pro API. Find out more and sign up here.
      Download & Feedback
      Download the latest version here
      https://github.com/SkyLundy/Fluency-Translation/archive/main.zip
      Github repository:
      https://github.com/SkyLundy/Fluency-Translation
      File issues and feature requests here (your feedback and testing is greatly appreciated):
      https://github.com/SkyLundy/Fluency-Translation/issues
       
      Thank you! ¡Gracias! Ich danke Ihnen! Merci! Obrigado! Grazie! Dank u wel! Dziękuję! Спасибо! ありがとうございます! 谢谢你!

    • By Robin S
      An inputfield module that brings EasyMDE Markdown editor to ProcessWire.
      EasyMDE is a fork of SimpleMDE, for which there is an existing PW module. Inputfield EasyMDE has a few advantages though:
      EasyMDE seems to be more actively developed than SimpleMDE, which hasn't seen any updates for several years. You can define options for Inputfield EasyMDE. Inputfield EasyMDE can be used in Repeater fields and in custom fields for File/Image fields.  
      Inputfield EasyMDE
      EasyMDE (Easy Markdown Editor) as an inputfield for ProcessWire.
      EasyMDE is a Markdown editor with some nice features, allowing users who may be less experienced with Markdown to use familiar toolbar buttons and shortcuts. More information is at the EasyMDE website.

      Installation
      Install the Inputfield EasyMDE module.
      Usage
      Create a new textarea field, and in the "Inputfield Type" dropdown choose "EasyMDE". Save the field and if you like you can then configure the EasyMDE options for the field as described below.
      To convert Markdown to HTML you can install the core TextformatterMarkdownExtra module and apply the textformatter to the field. Alternatively you can use $sanitizer->entitiesMarkdown() on the field value, e.g.
      echo $sanitizer->entitiesMarkdown($page->your_field_name, ['fullMarkdown' => true]); Configuration
      On the "Input" tab of the field settings you can define EasyMDE options for the field in JSON format. Refer to the EasyMDE documentation for the available options. Keys in the JSON must be surrounded with double quotes.
      Example:
      "toolbar": ["bold", "italic", "heading", "|", "side-by-side"], "sideBySideFullscreen": false  
      https://github.com/Toutouwai/InputfieldEasyMDE
      https://processwire.com/modules/inputfield-easy-mde/
×
×
  • Create New...