Jump to content
Nico Knoll

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

Recommended Posts

7 minutes ago, tpr said:

I guess you could check $page->seo->description and if it's empty, set it to your likings, eg. in ready.php or in your template php file (latter untested).


if($page->seo_description === "") {
	$page->seo_description = 'whatever';
}

 

Thank you for the answer.

The problem is, that i activated the "automatically" method to insert the code on my page. And the module inserts the empty description metatag anyway.

I don't know, if your code example will help me in this case?

Share this post


Link to post
Share on other sites

Just fast from mobile....

You have to use a hook on pagesave and check the SEO fields there....I ve some functions for creating keywords and description from some given fields... May tomorow I can post an example...

Share this post


Link to post
Share on other sites
On 31.7.2017 at 0:29 PM, tpr said:

It should.

YES! It works!
Thank you very much!!!

I unchecked the option "smart description" an add the code below in my template.

<?
    if($page->seo_description === "") {
       // Remove HTML tags
       $description = strip_tags($page->mytext);

       // Remove linebreaks
       $description = preg_replace( "/\r|\n/", " ", $description );

       // Shorten text
       $description = substr($description, 0, 160)." …";

       // Set new metadescription
       $page->seo_description = $description;
    }
    ?>

 

Share this post


Link to post
Share on other sites

Ok great that it works for you....a more complex solution with a hook on saveReady if SEO fields are empty put some own magic in there....if tey not empty do nothing...

functions that i use:

Spoiler

/**
 * Wordlimiter cuts a textarea only after complete words not between
 * used in admin.php for seo function and in some templates
 */
function wordLimiter($str = '', $limit = 200, $endstr = '...'){

	if($str == '') return '';

	if(strlen($str) <= $limit) return $str;

	$out = substr($str, 0, $limit);
	$pos = strrpos($out, " ");
	if ($pos>0) {
		$out = substr($out, 0, $pos);
	}
	$out .= $endstr;
	return $out;

}

/**
 * Alternative with regex for striptags function
 * used in admin.php for seo function and in some templates
 */
function ripTags($string) {

    // ----- remove HTML TAGs -----
    $string = preg_replace ('/<[^>]*>/', ' ', $string);

    // ----- remove control characters -----
    $string = str_replace("\r", '', $string);    // --- replace with empty space
    $string = str_replace("\n", ' ', $string);   // --- replace with space
    $string = str_replace("\t", ' ', $string);   // --- replace with space

    // ----- remove multiple spaces -----
    $string = trim(preg_replace('/ {2,}/', ' ', $string));

    return $string;

}
      
/**
 * Finds all of the keywords (words that appear most) on param $str
 * and return them in order of most occurrences to less occurrences.
 * @param string $str The string to search for the keywords.
 * @param int $minWordLen[optional] The minimun length (number of chars) of a word to be considered a keyword.
 * @param int $minWordOccurrences[optional] The minimun number of times a word has to appear
 * on param $str to be considered a keyword.
 * @param boolean $asArray[optional] Specifies if the function returns a string with the
 * keywords separated by a comma ($asArray = false) or a keywords array ($asArray = true).
 * @return mixed A string with keywords separated with commas if param $asArray is true,
 * an array with the keywords otherwise.
 */
function extractKeywords($str, $minWordLen = 5, $minWordOccurrences = 2, $asArray = false)
{
	function keyword_count_sort($first, $sec)
	{
		return $sec[1] - $first[1];
	}
	$str = preg_replace('/[^\p{L}0-9 ]/', ' ', $str);
	$str = trim(preg_replace('/\s+/', ' ', $str));

	$words = explode(' ', $str);
	$keywords = array();
	while(($c_word = array_shift($words)) !== null)
	{
		if(strlen($c_word) < $minWordLen) continue;

		$c_word = strtolower($c_word);
		if(array_key_exists($c_word, $keywords)) $keywords[$c_word][1]++;
		else $keywords[$c_word] = array($c_word, 1);
	}
	usort($keywords, 'keyword_count_sort');

	$final_keywords = array();
	foreach($keywords as $keyword_det)
	{
		if($keyword_det[1] < $minWordOccurrences) break;
		array_push($final_keywords, $keyword_det[0]);
	}
	return $asArray ? $final_keywords : implode(', ', $final_keywords);
}

 

the hook itself works in admin.php under site/templates/:

Spoiler

/**
 * Hook for changing seo_* fields if empty on Page Publish
 */
$pages->addHookAfter('saveReady', null, 'changeSeoFields');
function changeSeoFields(HookEvent $event) {
    $page = $event->arguments[0];
    //for this template only
    if($page->template == 'artikel'|| $page->template == 'seite') {
        // page is about to be published
        if($page->isChanged('status') && !$page->is(Page::statusUnpublished)) {
            // check if seo_title fields are exist and if they are empty
            if (!$page->seo_title) {
                //get the default value that would used as fallback
                if ($page->headline) {
                    //Headline field is used for seo_title
                    $default_title = ripTags($page->headline);
                } else {
                    //Headline field empty - page title is used
                    $default_title = ripTags($page->title);
                }
                //set seo_title on publishing
                $page->set ('seo_title', $default_title);
            }
            // check if seo_description fields are exist and if they are empty
            if (!$page->seo_description) {
                //get the default value that would used as fallback
                if ($page->kurztext) {
                    $default_desc = ripTags($page->kurztext);
                } else {
                    //is there a main content block as pagetable field pt_inhalt?
                    if(count($page->pt_inhalt)>0) {
                        //get the first text field in the pagetable and use it for the seo description
                        $first_item = $page->pt_inhalt->get("template=part_text|part_text_image_left|part_text_image_right|part_text_spalten");
                        $first_content = ripTags($first_item->text);
                        $default_desc = wordLimiter($first_content, 160);
                    }
                }
                //set seo_description on publishing
                $page->set ('seo_description', $default_desc);
            }
            // check if seo_keywords fields are exist and if they are empty
            if (!$page->seo_keywords) {
                //get the string that should be used to generate automatical keywords for this page
                //we use all textfields in the pagetable from the main content and collect them
                $keyword_texts = '';
                //is there a main content block as pagetable field pt_inhalt?
                if(count($page->pt_inhalt)>0) {
                    foreach ($page->pt_inhalt as $keyword_text) {
                        if ($keyword_text->title) $keyword_texts .= $keyword_text->title;
                        if ($keyword_text->text) $keyword_texts .= $keyword_text->text;
                        if ($keyword_text->text2) $keyword_texts .= $keyword_text->text2;
                        if ($keyword_text->text3) $keyword_texts .= $keyword_text->text3;
                    }
                } else {
                    $keyword_texts = $page->headline.' '.$page->kurztext.' '.$page->title;
                }
                //rip tags
                $keyword_string = ripTags($keyword_texts);

                $default_keywords = extractKeywords($keyword_string);

                //set seo_title on publishing
                $page->set ('seo_keywords', $default_keywords);
            }
        }
    }
}

 

As always it is not the best PHP code since im no professional....but it works for me....if i somedays get some time i could add something like that with optionfields to the module itself. ;)

Best regards mr-fan

  • Like 1

Share this post


Link to post
Share on other sites
1 hour ago, mr-fan said:

Ok great that it works for you....a more complex solution with a hook on saveReady if SEO fields are empty put some own magic in there....if tey not empty do nothing...

functions that i use:

  Hide contents


/**
 * Wordlimiter cuts a textarea only after complete words not between
 * used in admin.php for seo function and in some templates
 */
function wordLimiter($str = '', $limit = 200, $endstr = '...'){

	if($str == '') return '';

	if(strlen($str) <= $limit) return $str;

	$out = substr($str, 0, $limit);
	$pos = strrpos($out, " ");
	if ($pos>0) {
		$out = substr($out, 0, $pos);
	}
	$out .= $endstr;
	return $out;

}

/**
 * Alternative with regex for striptags function
 * used in admin.php for seo function and in some templates
 */
function ripTags($string) {

    // ----- remove HTML TAGs -----
    $string = preg_replace ('/<[^>]*>/', ' ', $string);

    // ----- remove control characters -----
    $string = str_replace("\r", '', $string);    // --- replace with empty space
    $string = str_replace("\n", ' ', $string);   // --- replace with space
    $string = str_replace("\t", ' ', $string);   // --- replace with space

    // ----- remove multiple spaces -----
    $string = trim(preg_replace('/ {2,}/', ' ', $string));

    return $string;

}
      
/**
 * Finds all of the keywords (words that appear most) on param $str
 * and return them in order of most occurrences to less occurrences.
 * @param string $str The string to search for the keywords.
 * @param int $minWordLen[optional] The minimun length (number of chars) of a word to be considered a keyword.
 * @param int $minWordOccurrences[optional] The minimun number of times a word has to appear
 * on param $str to be considered a keyword.
 * @param boolean $asArray[optional] Specifies if the function returns a string with the
 * keywords separated by a comma ($asArray = false) or a keywords array ($asArray = true).
 * @return mixed A string with keywords separated with commas if param $asArray is true,
 * an array with the keywords otherwise.
 */
function extractKeywords($str, $minWordLen = 5, $minWordOccurrences = 2, $asArray = false)
{
	function keyword_count_sort($first, $sec)
	{
		return $sec[1] - $first[1];
	}
	$str = preg_replace('/[^\p{L}0-9 ]/', ' ', $str);
	$str = trim(preg_replace('/\s+/', ' ', $str));

	$words = explode(' ', $str);
	$keywords = array();
	while(($c_word = array_shift($words)) !== null)
	{
		if(strlen($c_word) < $minWordLen) continue;

		$c_word = strtolower($c_word);
		if(array_key_exists($c_word, $keywords)) $keywords[$c_word][1]++;
		else $keywords[$c_word] = array($c_word, 1);
	}
	usort($keywords, 'keyword_count_sort');

	$final_keywords = array();
	foreach($keywords as $keyword_det)
	{
		if($keyword_det[1] < $minWordOccurrences) break;
		array_push($final_keywords, $keyword_det[0]);
	}
	return $asArray ? $final_keywords : implode(', ', $final_keywords);
}

 

the hook itself works in admin.php under site/templates/:

  Hide contents

/**
 * Hook for changing seo_* fields if empty on Page Publish
 */
$pages->addHookAfter('saveReady', null, 'changeSeoFields');
function changeSeoFields(HookEvent $event) {
    $page = $event->arguments[0];
    //for this template only
    if($page->template == 'artikel'|| $page->template == 'seite') {
        // page is about to be published
        if($page->isChanged('status') && !$page->is(Page::statusUnpublished)) {
            // check if seo_title fields are exist and if they are empty
            if (!$page->seo_title) {
                //get the default value that would used as fallback
                if ($page->headline) {
                    //Headline field is used for seo_title
                    $default_title = ripTags($page->headline);
                } else {
                    //Headline field empty - page title is used
                    $default_title = ripTags($page->title);
                }
                //set seo_title on publishing
                $page->set ('seo_title', $default_title);
            }
            // check if seo_description fields are exist and if they are empty
            if (!$page->seo_description) {
                //get the default value that would used as fallback
                if ($page->kurztext) {
                    $default_desc = ripTags($page->kurztext);
                } else {
                    //is there a main content block as pagetable field pt_inhalt?
                    if(count($page->pt_inhalt)>0) {
                        //get the first text field in the pagetable and use it for the seo description
                        $first_item = $page->pt_inhalt->get("template=part_text|part_text_image_left|part_text_image_right|part_text_spalten");
                        $first_content = ripTags($first_item->text);
                        $default_desc = wordLimiter($first_content, 160);
                    }
                }
                //set seo_description on publishing
                $page->set ('seo_description', $default_desc);
            }
            // check if seo_keywords fields are exist and if they are empty
            if (!$page->seo_keywords) {
                //get the string that should be used to generate automatical keywords for this page
                //we use all textfields in the pagetable from the main content and collect them
                $keyword_texts = '';
                //is there a main content block as pagetable field pt_inhalt?
                if(count($page->pt_inhalt)>0) {
                    foreach ($page->pt_inhalt as $keyword_text) {
                        if ($keyword_text->title) $keyword_texts .= $keyword_text->title;
                        if ($keyword_text->text) $keyword_texts .= $keyword_text->text;
                        if ($keyword_text->text2) $keyword_texts .= $keyword_text->text2;
                        if ($keyword_text->text3) $keyword_texts .= $keyword_text->text3;
                    }
                } else {
                    $keyword_texts = $page->headline.' '.$page->kurztext.' '.$page->title;
                }
                //rip tags
                $keyword_string = ripTags($keyword_texts);

                $default_keywords = extractKeywords($keyword_string);

                //set seo_title on publishing
                $page->set ('seo_keywords', $default_keywords);
            }
        }
    }
}

 

As always it is not the best PHP code since im no professional....but it works for me....if i somedays get some time i could add something like that with optionfields to the module itself. ;)

Best regards mr-fan

WOW, that seems to be the sophisticated version ... :-)

An optionfiled in the module would be great!!!

Best regards!

 

Share this post


Link to post
Share on other sites

Can I revive the subject ? :)

I want to use this module for a website I inherited, (I didn't use the processwire before)

There is one thing that makes me uncertain.

In:  Choose the templates which should get a SEO tab 
There is a note Be careful with this field. If you remove an entry all of it's "seo_*" fields get deleted (including the data).

Is there any risk there

An do I have to type in the Author and Sitename?

2017-10-25_102907.jpg

Share this post


Link to post
Share on other sites
4 hours ago, Marudor said:

Is there any risk there

This simply means that if you assign a template that can use the SEO fields and then you actually use them on a page and then remove the template from the list, the SEO fields will be deleted from the template and, therefore, the pages assigned to it.

4 hours ago, Marudor said:

An do I have to type in the Author and Sitename?

I believe the module's <head> markup might require it, so yes, I'd fill those out.

Share this post


Link to post
Share on other sites

OK thanks

Just to clarify - The author here - means the author of the module or the author of the website  or it doesn't matter what I type in there.

I don't want to blow up the site...:-X

Share this post


Link to post
Share on other sites
2 hours ago, Marudor said:

OK thanks

Just to clarify - The author here - means the author of the module or the author of the website  or it doesn't matter what I type in there.

I don't want to blow up the site...:-X

:lol: Author of the site. I think you can exclude it as I'd imagine the module won't include the relevant tag if it hasn't been specified. You'd need to "view source" in your browser to check if everything is okay. As far as I'm concerned, only the site title is important in terms of meta data.

Share this post


Link to post
Share on other sites

Ok I have chosen the template to MarkupSEO module.  

I does change the meta description and meta keyword which is very handy.

But it didn't change the meta title tag.

It's still the one withe the suffix added that comes from the homepage title 

Eventhough i have type in the short one Employer branding - pracownik staje się klientem - Poznań, Warszawa

I still have Employer branding - pracownik staje się klientem - Agencja PR Q&A Communications – Poznań, Warszawa

Where is the problem ? Why id doesn't change the title tag????

Share this post


Link to post
Share on other sites
2 hours ago, Marudor said:

Ok I have chosen the template to MarkupSEO module.  

I does change the meta description and meta keyword which is very handy.

But it didn't change the meta title tag.

It's still the one withe the suffix added that comes from the homepage title 

Eventhough i have type in the short one Employer branding - pracownik staje się klientem - Poznań, Warszawa

I still have Employer branding - pracownik staje się klientem - Agencja PR Q&A Communications – Poznań, Warszawa

Where is the problem ? Why id doesn't change the title tag????

Changing the title in the SEO tab only affects the SEO title (<meta property="og:title" content="...SEO title...">). Your page title in the browser is the one you set in the <title> tag of your HTML. If you are referring to Google showing the old one, then you will need to wait a while for it to be re-indexed.

Edit: I apologise, it seems I'm incorrect. MarkupSEO will include a <title> tag for you if you fill out "Title Format" in that case, make sure you don't have your own <title> tag as well.

Share this post


Link to post
Share on other sites

I tough this is the module to change the meta title tag and meta description tag.

It changes the description and keyword all right...but the meta title  stays the same.

I  have the article title -  Employer branding - pracownik staje się klientem

But I want the meta title Employer branding - pracownik staje się klientem - Poznań, Warszawa

At the moment the meta title on every psgr is a mix of 2  - the article title and the suffix from the homepage title Agencja PR Q&A Communications – Poznań, Warszawa

I have even changed it in the code from 

<title><?php if($page->id > 1) { echo $page->title .' - '; } echo $home->title ?></title>
TO
<title><?php echo $page->title; ?></title>

BUT still the same. The mix of title with the suffix Agencja PR Q&A Communications – Poznań, Warszawa

added to all article titles makes the meta tag title too long. It Is more than 70 characters on every page. which is no good.

Share this post


Link to post
Share on other sites
21 hours ago, Marudor said:

<title><?php if($page->id > 1) { echo $page->title .' - '; } echo $home->title ?></title>
TO
<title><?php echo $page->title; ?></title>

BUT still the same.

It sounds like you need to change it somewhere else. Because ProcessWire based sites always depend on the developer to implement the frontend, it can be tricky to find the right piece of code. Have you tried something like  <title>AAAAAA<?php echo $page->title; ?></title> for example? As a last resort I always type in some fake string which can be easily searched. If it is not in the source code of the rendered page then that is not right part of the code to change it. You probably need to dig in more, unfortunately.

Share this post


Link to post
Share on other sites

Hello, I found & fixed an issue wich gives you an illegal string offset error in the latest PHP version. (7.1). 

Around line 429 you declare $return = ''; and then fill it up as an array doing $return[$key] = $value; at line 435.

All you got to do is declare $return = array(); instead of $return = ''; and it should be fixed. Filling up an empty string as an array caused the errors. Can you fix this and push it to github? :)

Kind regards,
Jonathan

 

	private function parseCustom($custom) {
		if(trim($custom) == '') return;

		$return = array();
		$lines = explode(PHP_EOL, $custom);
		foreach($lines as $line) {
			list($key, $value) = explode(':=', $line);
			$key = preg_replace('%[^A-Za-z0-9\-\.\:\_]+%', '', str_replace(' ', '-', trim($key)));	
			$value = trim(wire('sanitizer')->text(html_entity_decode($value)));

			$return[$key] = $value;
		}
		
		return $return;
	}

 

  • Thanks 1

Share this post


Link to post
Share on other sites

Hi,
I'm having a problem with this module. I't installed with Processwire ver3.
The problem is -> on localhost plugin is working fine, but on live server plugin is not working (strange is that it was working fine, but stopped without any reason ):
when i type title, keywords and description and click SAVE, page is reloaded without errors, but i see old entries, so cannot update existing entries.
I was able to edit Title and description, but next attempts fails. So it saves SEO daya randomly, sometimes im able to edit and save, and sometimes it will just return previous values.

Does anybody has this issue ? Thanks.

Actually im seeing this on edit page in SEO TAB

image.png.2c9ee50f8dfef7641101278db0765e35.png

Share this post


Link to post
Share on other sites

If anyone is interested, I have a new fork of this module available here: https://github.com/adrianbj/MarkupSEO/commits/various-fixes-enhancements

It's very much a work in progress, but it includes several bug fixes and lots of new features. Please read the commit log to learn about what's fixed and what's new.

At the moment you should not upgrade an existing site (new fields won't be created) and probably don't use it on a live site just yet.

It's not well tested at all yet, so use at your own peril :) 

I'd really appreciate any feedback on it.

  • Like 14
  • Thanks 2

Share this post


Link to post
Share on other sites

@adrian

Hi Adrian, thank you for the awesome updates and improvements.

I would suggest to take a look on the Canonical link field and make it ready for multi language websites .

Meaning that he can detect if there are any other languages present and canonicalize them properly according to the languages. 

 

  • Like 1

Share this post


Link to post
Share on other sites
3 hours ago, B3ta said:

I would suggest to take a look on the Canonical link field and make it ready for multi language websites .

Hi @B3ta - I'm afraid I don't really have time to look into this at the moment. I am extending this module for my needs and I rarely have multi-language websites so it's not high on my list. I am happy to accept PRs though so together we can build a better version of this module. Once we are all happy with the stability/functionality of the new version I'll try contacting Nico to see what we can do about getting it into the main repo. Hope you understand where I am coming from.

  • Like 3

Share this post


Link to post
Share on other sites

@Nico Knoll for the images, it requires a URL; I am curious if I change those to file upload field will it affect the module? just want to confirm before I try, thank you

Share this post


Link to post
Share on other sites
30 minutes ago, neosin said:

@Nico Knoll for the images, it requires a URL; I am curious if I change those to file upload field will it affect the module? just want to confirm before I try, thank you

In my fork (linked above), the field is an images field (for the page specific SEO tab, not the default image).

  • Like 1

Share this post


Link to post
Share on other sites
49 minutes ago, adrian said:

In my fork (linked above), the field is an images field (for the page specific SEO tab, not the default image).

thank you, I will check it out now

@adrian I've uninstalled the SEO and installed your version however the SEO image fields still show up as url text fields. Do I need to change the fields to images?

Share this post


Link to post
Share on other sites

Hi,

EDIT: Found it, change it in the module configuration. Can't be overwritten by field definition.

 

i cannot change the length of the seo_title field. I changed the field max length to 100 but it is still 60 at the input field. i tried to remove the counter to check, does not work. Tried to change the title and description of the field, this works. I'm confused.

 

Thx for any help!

seotitle.jpg

Share this post


Link to post
Share on other sites
On 3/25/2018 at 8:48 AM, neosin said:

thank you, I will check it out now

@adrian I've uninstalled the SEO and installed your version however the SEO image fields still show up as url text fields. Do I need to change the fields to images?

Sorry I missed this - not getting emails on @ pings anymore. If you upgrade from an old install of this module, you will need to manually change the field type.

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-11-15 2019-10-18 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 Robin S
      I have had this module sitting in a 95% complete state for a while now and have finally made the push to get it out there. Thanks to @teppo for his Hanna Code Helper module which I referred to and borrowed from during development.
      http://modules.processwire.com/modules/hanna-code-dialog/
      https://github.com/Toutouwai/HannaCodeDialog
      HannaCodeDialog
      Provides a number of enhancements for working with Hanna Code tags in CKEditor. The main enhancement is that Hanna tags in a CKEditor field may be double-clicked to edit their attributes using core ProcessWire inputfields in a modal dialog.
      Requires the Hanna Code module and >= ProcessWire v3.0.0.
      Installation
      Install the HannaCodeDialog module using any of the normal methods.
      For any CKEditor field where you want the "Insert Hanna tag" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "HannaDropdown" to the "CKEditor Toolbar" settings field.
      Module configuration
      Visit the module configuration screen to set any of the following:
      Exclude prefix: Hanna tags named with this prefix will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Exclude Hanna tags: Hanna tags selected here will not appear in the CKEditor toolbar dropdown menu for Hanna tag insertion. Background colour of tag widgets: you can customise the background colour used for Hanna tags in CKEditor if you like. Dialog width: in pixels Dialog height: in pixels Features
      Insert tag from toolbar dropdown menu
      Place the cursor in the CKEditor window where you want to insert your Hanna tag, then select the tag from the "Insert Hanna tag" dropdown.

      Advanced: if you want to control which tags appear in the dropdown on particular pages or templates you can hook HannaCodeDialog::getDropdownTags. See the forum support thread for examples .
      Edit tag attributes in modal dialog
      Insert a tag using the dropdown or double-click an existing tag in the CKEditor window to edit the tag attributes in a modal dialog.

      Tags are widgets
      Hanna tags that have been inserted in a CKEditor window are "widgets" - they have a background colour for easy identification, are protected from accidental editing, and can be moved within the text by drag-and-drop.

      Options for tag attributes may be defined
      You can define options for a tag attribute so that editors must choose an option rather than type text. This is useful for when only certain strings are valid for an attribute and also has the benefit of avoiding typos.
      Add a new attribute for the Hanna tag, named the same as the existing attribute you want to add options for, followed by "__options". The options themselves are defined as a string, using a pipe character as a delimiter between options. Example for an existing attribute named "vegetables":
      vegetables__options=Spinach|Pumpkin|Celery|Tomato|Brussels Sprout|Potato You can define a default for an attribute as normal. Use a pipe delimiter if defining multiple options as the default, for example:
      vegetables=Tomato|Potato Dynamic options
      Besides defining static options as above, you can use one Hanna tag to dynamically generate options for another. For instance, you could create a Hanna tag that generates options based on images that have been uploaded to the page, or the titles of children of the page.
      Your Hanna tag that generates the options should echo a string of options delimited by pipe characters (i.e. the same format as a static options string).
      You will probably want to name the Hanna tag that generates the options so that it starts with an underscore (or whatever prefix you have configured as the "exclude" prefix in the module config), to avoid it appearing as an insertable tag in the HannaCodeDialog dropdown menu.
      Example for an existing attribute named "image":
      image__options=[[_images_on_page]] And the code for the _images_on_page tag:
      <?php $image_names = array(); $image_fields = $page->fields->find('type=FieldtypeImage')->explode('name'); foreach($image_fields as $image_field) { $image_names = array_unique( array_merge($image_names, $page->$image_field->explode('name') ) ); } echo implode('|', $image_names); Choice of inputfield for attribute
      You can choose the inputfield that is used for an attribute in the dialog.
      For text attributes the supported inputfields are text (this is the default inputfield for text attributes so it isn't necessary to specify it if you want it) and textarea. Note: any manual line breaks inside a textarea are removed because these will break the CKEditor tag widget.
      Inputfields that support the selection of a single option are select (this is the default inputfield for attributes with options so it isn't necessary to specify it if you want it) and radios.
      Inputfields that support the selection of multiple options are selectmultiple, asmselect and checkboxes.
      You can also specify a checkbox inputfield - this is not for attributes with defined options but will limit an attribute to an integer value of 1 or 0.
      The names of the inputfield types are case-insensitive.
      Example for an existing attribute named "vegetables":
      vegetables__type=asmselect Descriptions and notes for inputfields
      You can add a description or notes to an attribute and these will be displayed in the dialog.
      Example for an existing attribute named "vegetables":
      vegetables__description=Please select vegetables for your soup. vegetables__notes=Pumpkin and celery is a delicious combination. Notes
      When creating or editing a Hanna tag you can view a basic cheatsheet outlining the HannaCodeDialog features relating to attributes below the "Attributes" config inputfield.
      Advanced
      Define or manipulate options in a hook
      You can hook HannaCodeDialog::prepareOptions to define or manipulate options for a Hanna tag attribute. Your Hanna tag must include a someattribute__options attribute in order for the hook to fire. The prepareOptions method receives the following arguments that can be used in your hook:
      options_string Any existing string of options you have set for the attribute attribute_name The name of the attribute the options are for tag_name The name of the Hanna tag page The page being edited If you hook after HannaCodeDialog::prepareOptions then your hook should set $event->return to an array of option values, or an associative array in the form of $value => $label.
      Build entire dialog form in a hook
      You can hook after HannaCodeDialog::buildForm to add inputfields to the dialog form. You can define options for the inputfields when you add them. Using a hook like this can be useful if you prefer to configure inputfield type/options/descriptions/notes in your IDE rather than as extra attributes in the Hanna tag settings. It's also useful if you want to use inputfield settings such as showIf.
      When you add the inputfields you must set both the name and the id of the inputfield to match the attribute name.
      You only need to set an inputfield value in the hook if you want to force the value - otherwise the current values from the tag are automatically applied.
      To use this hook you only have to define the essential attributes (the "fields" for the tag) in the Hanna Code settings and then all the other inputfield settings can be set in the hook.
      Example buildForm() hook
      The Hanna Code attributes defined for tag "meal" (a default value is defined for "vegetables"):
      vegetables=Carrot meat cooking_style comments The hook code in /site/ready.php:
      $wire->addHookAfter('HannaCodeDialog::buildForm', function(HookEvent $event) { // The Hanna tag that is being opened in the dialog $tag_name = $event->arguments(0); // Other arguments if you need them /* @var Page $edited_page */ $edited_page = $event->arguments(1); // The page open in Page Edit $current_attributes = $event->arguments(2); // The current attribute values $default_attributes = $event->arguments(3); // The default attribute values // The form rendered in the dialog /* @var InputfieldForm $form */ $form = $event->return; if($tag_name === 'meal') { $modules = $event->wire('modules'); /* @var InputfieldCheckboxes $f */ $f = $modules->InputfieldCheckboxes; $f->name = 'vegetables'; // Set name to match attribute $f->id = 'vegetables'; // Set id to match attribute $f->label = 'Vegetables'; $f->description = 'Please select some vegetables.'; $f->notes = "If you don't eat your vegetables you can't have any pudding."; $f->addOptions(['Carrot', 'Cabbage', 'Celery'], false); $form->add($f); /* @var InputfieldRadios $f */ $f = $modules->InputfieldRadios; $f->name = 'meat'; $f->id = 'meat'; $f->label = 'Meat'; $f->addOptions(['Pork', 'Beef', 'Chicken', 'Lamb'], false); $form->add($f); /* @var InputfieldSelect $f */ $f = $modules->InputfieldSelect; $f->name = 'cooking_style'; $f->id = 'cooking_style'; $f->label = 'How would you like it cooked?'; $f->addOptions(['Fried', 'Boiled', 'Baked'], false); $form->add($f); /* @var InputfieldText $f */ $f = $modules->InputfieldText; $f->name = 'comments'; $f->id = 'comments'; $f->label = 'Comments for the chef'; $f->showIf = 'cooking_style=Fried'; $form->add($f); } }); Troubleshooting
      HannaCodeDialog includes and automatically loads the third-party CKEditor plugins Line Utilities and Widget. If you have added these plugins to your CKEditor field already for some purpose and experience problems with HannaCodeDialog try deactivating those plugins from the CKEditor field settings.
    • By horst
      Wire Mail SMTP

      An extension to the (new) WireMail base class that uses SMTP-transport

      This module integrates EmailMessage, SMTP and SASL php-libraries from Manuel Lemos into ProcessWire. I use this continously evolved libraries for about 10 years now and there was never a reason or occasion not to do so. I use it nearly every day in my office for automated composing and sending personalized messages with attachments, requests for Disposition Notifications, etc. Also I have used it for sending personalized Bulkmails many times.

      The WireMailSmtp module extends the new email-related WireMail base class introduced in ProcessWire 2.4.1 (while this writing, the dev-branch only).
       
      Here are Ryans announcement.



      Current Version 0.4.2
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
      get it from the Modules Directory Install and Configure

      Download the module into your site/modules/ directory and install it.

      In the config page you fill in settings for the SMTP server and optionaly the (default) sender, like email address, name and signature.
      You can test the smtp settings directly there. If it says "SUCCESS! SMTP settings appear to work correctly." you are ready to start using it in templates, modules or bootstrap scripts.


      Usage Examples
      The simplest way to use it:
      $numSent = wireMail($to, $from, $subject, $textBody); $numSent = wireMail($to, '', $subject, $textBody); // or with a default sender emailaddress on config page This will send a plain text message to each recipient.
       
      You may also use the object oriented style:
      $mail = wireMail(); // calling an empty wireMail() returns a wireMail object $mail->to($toEmail, $toName); $mail->from = $yourEmailaddress; // if you don't have set a default sender in config // or if you want to override that $mail->subject($subject); $mail->body($textBody); $numSent = $mail->send(); Or chained, like everywhere in ProcessWire:
      $mail = wireMail(); $numSent = $mail->to($toEmail)->subject($subject)->body($textBody)->send(); Additionaly to the basics there are more options available with WireMailSmtp. The main difference compared to the WireMail BaseClass is the sendSingle option. With it you can set only one To-Recipient but additional CC-Recipients.
      $mail = wireMail(); $mail->sendSingle(true)->to($toEmail, $toName)->cc(array('person1@example.com', 'person2@example.com', 'person3@example.com')); $numSent = $mail->subject($subject)->body($textBody)->send(); The same as function call with options array:
      $options = array( 'sendSingle' => true, 'cc' => array('person1@example.com', 'person2@example.com', 'person3@example.com') ); $numSent = wireMail($to, '', $subject, $textBody, $options); There are methods to your disposal to check if you have the right WireMail-Class and if the SMTP-settings are working:
      $mail = wireMail(); if($mail->className != 'WireMailSmtp') { // Uups, wrong WireMail-Class: do something to inform the user and quit echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; return; } if(!$mail->testConnection()) { // Connection not working: echo "<p>Couldn't connect to the SMTP server. Please check the {$mail->className} modules config settings!</p>"; return; }  
      A MORE ADVANCED DEBUG METHOD!
      You can add some debug code into a template file and call a page with it:
      $to = array('me@example.com'); $subject = 'Wiremail-SMTP Test ' . date('H:i:s') . ' äöü ÄÖÜ ß'; $mail = wireMail(); if($mail->className != 'WireMailSmtp') { echo "<p>Couldn't get the right WireMail-Module (WireMailSmtp). found: {$mail->className}</p>"; } else { $mail->from = '--INSERT YOUR SENDER ADDRESS HERE --'; // <--- !!!! $mail->to($to); $mail->subject($subject); $mail->sendSingle(true); $mail->body("Titel\n\ntext text TEXT text text\n"); $mail->bodyHTML("<h1>Titel</h1><p>text text <strong>TEXT</strong> text text</p>"); $dump = $mail->debugSend(1); } So, in short, instead of using $mail->send(), use $mail->debugSend(1) to get output on a frontend testpage.
      The output is PRE formatted and contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection, like this one:
       
      Following are a ...


      List of all options and features


      testConnection () - returns true on success, false on failures


      sendSingle ( true | false ) - default is false

      sendBulk ( true | false ) - default is false, Set this to true if you have lots of recipients (50+)


      to ($recipients) - one emailaddress or array with multiple emailaddresses

      cc ($recipients) - only available with mode sendSingle, one emailaddress or array with multiple emailaddresses

      bcc ($recipients) - one emailaddress or array with multiple emailaddresses

       
      from = 'person@example.com' - emailaddress, can be set in module config (called Sender Emailaddress) but it can be overwritten here

      fromName = 'Name Surname' - optional, can be set in module config (called Sender Name) but it can be overwritten here


      priority (3) - 1 = Highest | 2 = High | 3 = Normal | 4 = Low | 5 = Lowest

      dispositionNotification () or notification () - request a Disposition Notification


      subject ($subject) - subject of the message

      body ($textBody) - use this one alone to create and send plainText emailmessages

      bodyHTML ($htmlBody) - use this to create a Multipart Alternative Emailmessage (containing a HTML-Part and a Plaintext-Part as fallback)

      addSignature ( true | false ) - the default-behave is selectable in config screen, this can be overridden here
      (only available if a signature is defined in the config screen)

      attachment ($filename, $alternativeBasename = "") - add attachment file, optionally alternative basename


      send () - send the message(s) and return number of successful sent messages


      debugSend(1) - returns and / or outputs a (pre formatted) dump that contains the areas: SETTINGS, RESULT, ERRORS and a complete debuglog of the server connection. (See above the example code under ADVANCED DEBUG METHOD for further instructions!)


      getResult () - returns a dump (array) with all recipients (to, cc, bcc) and settings you have selected with the message, the message subject and body, and lists of successfull addresses and failed addresses,


      logActivity ($logmessage) - you may log success if you want

      logError ($logmessage) - you may log warnings, too. - Errors are logged automaticaly
       
       
      useSentLog (true | false) - intended for usage with e.g. third party newsletter modules - tells the send() method to make usage of the sentLog-methods - the following three sentLog methods are hookable, e.g. if you don't want log into files you may provide your own storage, or add additional functionality here

      sentLogReset ()  - starts a new LogSession - Best usage would be interactively once when setting up a new Newsletter

      sentLogGet ()  - is called automaticly within the send() method - returns an array containing all previously used emailaddresses

      sentLogAdd ($emailaddress)  - is called automaticly within the send() method
      Changelog: https://github.com/horst-n/WireMailSmtp/blob/master/CHANGELOG.md
       
       
    • By Robin S
      Sanitizer EasySlugger
      Allows the use of the EasySlugger library as Sanitizer methods.
      Installation
      Install the Sanitizer EasySlugger module.
      Usage
      The module adds four new sanitizer methods.
      slugger($string, $options)
      Similar to $sanitizer->pageName() - I'm not sure if there are any advantages over that method. Included because it is one of the methods offered by EasySlugger.
      $slug = $sanitizer->slugger('Lorem Ipsum'); // Result: lorem-ipsum utf8Slugger($string, $options)
      Creates slugs from non-latin alphabets.
      $slug = $sanitizer->utf8Slugger('这个用汉语怎么说'); // Result: zhe-ge-yong-han-yu-zen-me-shuo seoSlugger($string, $options)
      Augments the string before turning it into a slug. The conversions are related to numbers, currencies, email addresses and other common symbols.
      $slug = $sanitizer->seoSlugger('The price is $5.99'); // Result: the-price-is-5-dollars-99-cents See the EasySlugger readme for some more examples.
      seoUtf8Slugger($string, $options)
      A combination of utf8Slugger() and seoSlugger().
      $slug = $sanitizer->seoUtf8Slugger('价钱是 $5.99'); // Result: jia-qian-shi-5-dollars-99-cents $options argument
      Each of the methods can take an $options array as a second argument.
      separator (string): the character that separates words in the slug. Default: - unique (bool): Determines whether a random suffix is added at the end of the slug. Default: false $slug = $sanitizer->utf8Slugger('这个用汉语怎么说', ['separator' => '_', 'unique' => true]); // Result: zhe_ge_yong_han_yu_zen_me_shuo_3ad66c4  
      https://github.com/Toutouwai/SanitizerEasySlugger
      https://modules.processwire.com/modules/sanitizer-easy-slugger/
    • By Robin S
      If you've ever needed to insert links to a large number of files within CKEditor you may have found that the standard PW link modal is a somewhat slow way to do it.
      This module provides a quicker way to insert links to files on the page being edited. You can insert a link to an individual file, or insert an unordered list of links to all files on the page with a single click.
      CKEditor Link Files
      Adds a menu to CKEditor to allow the quick insertion of links to files on the page being edited.

      Features
      Hover a menu item to see the "Description" of the corresponding file (if present). Click a menu item to insert a link to the corresponding file at the current cursor position. The filename is used as the link text. If you Alt-click a menu item the file description is used as the link text (with fallback to filename if no description entered). If text is currently selected in the editor then the selected text is used as the link text. Click "* Insert links to all files *" to insert an unordered list of links to all files on the page. Also works with the Alt-click option. Menu is built via AJAX so newly uploaded files are included in the menu without the page needing to be saved. However, descriptions are not available for newly uploaded files until the page is saved. There is an option in the module config to include files from Repeater fields in the edited page. Nested Repeater fields (files inside a Repeater inside another Repeater) are not supported. Installation
      Install the CKEditor Link Files module.
      For any CKEditor field where you want the "Insert link to file" dropdown menu to appear in the CKEditor toolbar, visit the field settings and add "LinkFilesMenu" to the "CKEditor Toolbar" settings field.
       
      http://modules.processwire.com/modules/cke-link-files/
      https://github.com/Toutouwai/CkeLinkFiles
×
×
  • Create New...