Jump to content
Nico Knoll

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

Recommended Posts

This module adds a "SEO" tab to every page where you can define a special title, description, keywords, etc.

Try it

http://aluminum-j4f.lightningpw.com/processwire/

Name: demo

Pass: demo123

How to use

You can choose between include automatically or use the following methods:

$config->seo // includes all the default values and configuration settings

// e.g.:
$config->seo->title
$config->seo->keywords
$page->seo // includes all the default values mixed with the page related seo data

// e.g.:
$page->seo->title
$page->seo->keywords

// for rendering:
$page->seo->render

.

.

Screenshot

post-140-0-83570900-1413719034_thumb.png

post-140-0-66456700-1413719029_thumb.png

Download

You can download it in the modules repository: http://modules.processwire.com/modules/markup-seo/

  • Like 34

Share this post


Link to post
Share on other sites

This is a module that shall bring thou great honor, Mr. Knoll!!!

How does it work? Does it create fields for those tags? I guess, you still have to insert the markup into the template files yourself? Or is it "more userfrendly" already and does everything for you?

Share this post


Link to post
Share on other sites

@ivan: it doesn't create fields and works out of the box. Just enjoy it :) (it uses virtual fields)

Share this post


Link to post
Share on other sites

Nico: thanks, this looks interesting! Testing it right now, so might have more comments later, but first things first: you might want to add some isset-checks to module config. Seeing quite a few notices and warnings before saving module config.

Sorry, forget that, it's not about config. The problem is occurring in init(), when trying to check for $this->page->template. While viewing the module settings, $this->page doesn't seem to be available yet, which is causing some issues :)

Edit: here's a diff for changes I had to make locally to get this module running. Wouldn't work at all before that, possibly because I've got debug mode on. Not sure if they're all required, implemented the way you'd want them, etc. and some of them might be specific to my environment.

Also, moving the hooks from init() to ready() should ensure that API is ready by that time, but it could cause other (potentially unwanted) side-effects..

diff --git a/MarkupSEO.module b/MarkupSEO.module
index fecc6a3..c2ebb86 100644
--- a/MarkupSEO.module
+++ b/MarkupSEO.module
@@ -57,7 +57,7 @@ class MarkupSEO extends WireData implements Module, ConfigurableModule {
         * Initializing the hooks
         *
         */
-       public function init() {
+       public function ready() {
                $this->addHookAfter("ProcessPageEdit::buildFormContent", $this, 'addSEOTab');
                $this->addHookBefore("ProcessPageEdit::execute", $this, 'saveSEOTab');
                
@@ -85,9 +85,10 @@ class MarkupSEO extends WireData implements Module, ConfigurableModule {
                $page = wire('pages')->get($this->config->input->get->id);
                $pageData = $this->getPageSEO($page->id);
                $configData = wire('modules')->getModuleConfigData($this);
-               $mixedData = array_merge((array)array_filter($configData), (array)array_filter($pageDataDefault));
+               $mixedData = array_merge((array)array_filter($configData), (array)array_filter($pageData));
                
                
+               $this->modules->get('FieldtypeFieldsetTabOpen');
                $field = new InputfieldFieldsetTabOpen;
                $field->name = $this->prefix."meta";
                $field->label = $this->_('SEO');
@@ -158,6 +159,7 @@ class MarkupSEO extends WireData implements Module, ConfigurableModule {
                $e->return->add($field);
                
                
+               $this->modules->get('FieldtypeFieldsetClose');
                $field = new InputfieldFieldsetClose;
                $field->name = $this->prefix."meta_END";
                
@@ -204,7 +206,19 @@ class MarkupSEO extends WireData implements Module, ConfigurableModule {
         */
        private function getPageSEO($id) {
                $dataOrg = wire('modules')->getModuleConfigData($this);
-               return $dataOrg['pages'][$id];
+               if (isset($dataOrg['pages']) && isset($dataOrg['pages'][$id])) {
+                       return $dataOrg['pages'][$id];
+               } else {
+                       return array(
+                               'title' => '',
+                               'keywords' => '',
+                               'description' => '',
+                               'image' => '',
+                               'canonical' => '',
+                               'robots' => '',
+                               'custom' => '',
+                       );
+               }
        }
        
        /**
Edited by teppo
  • Like 3

Share this post


Link to post
Share on other sites

This looks excellent! I've been manually creating my SEO tabs. So this is a huge relief! And I really dig the preview. (Better than what it looks like with WordPress SEO, for sure.)

Kudos!  ^-^  :D

  • Like 1

Share this post


Link to post
Share on other sites

Thanks for this. Hopefully this will shut the WP up a bit. BTW you have a typo:

"A good length for a description is 160 charakters."

  • Like 1

Share this post


Link to post
Share on other sites

I know :) But at least the open graph stuff is really useful and custom title and description isn't bad, too :)

(And I think it's better than a lot of WordPress SEO modules, so maybe another pro for choosing pw)

Share this post


Link to post
Share on other sites

Thanks for the module Nico! Could you update the GitHub readme to either have instructions like this or link to this page? I mention it just for those folks that might download the module but not know about this thread.  

Share this post


Link to post
Share on other sites

Just working on some more options (like using parent values, smart values, excluding templates, special permissions, ...). After that I will update all of the descriptions :)

  • Like 1

Share this post


Link to post
Share on other sites

New update: 0.3.0

Added options:

- exclude Templates

- Google Analytics

- smart values

- use parents values if empty

  • Like 3

Share this post


Link to post
Share on other sites

Just digging through some of my own bits and I noticed that somewhere someone said that for facebook and twitter, it helps if the image is square. Is it worth adding a size() to this?

Share this post


Link to post
Share on other sites

Well I think facebook changed it. They are supporting all formats now I think. 

But if you want to you can add an image field with cropped images and add it to image automatically via "smart image" field

Share this post


Link to post
Share on other sites

Hi Nico

Thanks for the module. As we need here multilingual SEO as for good practice we can't mix i.e. Thai, Chinese, Russian, English letters - The much better way is therfore to have all those textfields made by textlanguage fields and not only text fields. Would this be feasible or would we need to create a multilingual version of the module?

Beside the stuff you mentioned already above here are some more fields you should add:

MSN Verification
Yahoo Verification
Web of Trust (wot) Verification
Google Crawler Verification

Like Google Analytics add Piwik Analytics too.

For the Title it would be great to have a prefix and a suffix for the Title which could be recurring if empty. This way you can create great Broser titles from each page without loosing a constant part of the title - either in front or in the back.

Title prefix

Title suffix

-----------

Have a look here:
http:// and https://)

  Piwik ID Tracking id of your website in your piwik   Piwik Download & Click Domain

Specifies which domains are internal domains:

  • single domain (eg. “example.com”)
  • subdomain (eg. “.example.com”)

For more informations visit:

  Piwik Cookie Domain Name

Specifies the domain name for the tracking cookie:

  • single domain (eg. “example.com”)
  • subdomain (eg. “.example.com”)

For more informations visit:

  Piwik DoNotTrack Opt Out users with Mozilla's DoNotTrack browser setting enabled
Social Constant Description Default Google+ Direct Connect

Your Google+ Profile Page ID

see https://developers.google.com/+/plugins/badge/

PageTitle Constant Description Default Apply tmpl-sitetitle to absolute <title>

There is a prefix/suffix for your pagetitle defined in your root template settings.

If you use the SEO-Absolute-Pagetitle settings you can disable this suffix/prefix here.

disabled Apply tmpl-sitetitle to prefix/suffix

There is a prefix/suffix for your pagetitle defined in your root template settings.

If you use the SEO-Pagetitle-Suffix/Prefix settings you can disable this suffix/prefix here.

enabled Sitetitle glue Glue between Pagetitle (from Page) and Sitetitle (from template) : Sitetitle glue spacer (before) Add spacer before glue string disabled Sitetitle glue spacer (after) Add spacer after glue string enabled Sitetitle position

Position of Sitetitle (from template) Possible options:

Sitetitle-Pagetitle (eg. Example Company: About us) Pagetitle-Sitle (eg. About us: Example Company)

Sitetitle-Pagetitle (0) Sitetitle Overwrite the template sitetitle with a custom one  

Sitemap Constant Description Default Enable Enables output (if set on root-pid of tree) and indexing for the whole subtree enabled Page limit Limit pages on sitemap-xml-pages 10000 Limit to current language

Limit output of the sitemap to the current language. This will enable multi-language-domain sitemaps. eg:

  • www.example.com (FE-Language is english) will output only english pages
  • www.example.de (FE-Language is german) will output only german pages

This option was ported from the extension configuration and will replace this configuration.

disabled Default change frequency Default change frequency for sitemap cache (will be cached!)   Page priority

Default page priority if the page have no own priority set

Page priority will be calculated by:

( [page priority] – [priority modificator] ) * ( 1/[page depth] * [page multiplier] )

1 Page priority depth multiplier Page depth multiplier, see formula in page priority 1 Page priority depth modificator Page depth modificator, see formula in page priority 1

-----

If now this gets combined with a cron job (scheduler task) than you are all set for your SEO needs.
 

Scheduler Tasks Scheduler Task Description Frequency MetaSEO Cleanup This task cleans up old database entries in the tx_metaseo_sitemap table. One run per day MetaSEO sitemap.txt builder

This task builds a real sitemap.txt file in the upload directory.

  • Directory: uploads/tx_metaseo/sitemap_txt/
  • Sitemap: sitemap-r{ROOTPID}.txt.gz

If language domain support is active:

  • Sitemap: sitemap-r{ROOTPID}-l{LANG}.txt.gz

{ROOTPID} is the Page-UID from the root pages in your TYPO3 installations.

{LANG} is the language id (only active if language domains are active).

Hint: These files are already gziped.

One run per day MetaSEO sitemap.xml builder

This task builds a real sitemap.xml files in the upload directory.

  • Directory: uploads/tx_metaseo/sitemap_xml/
  • Sitemap-Index: index-r{ROOTPID}.xml.gz
  • Sitemap-Page: sitemap-r{ROOTPID}-p{PAGE}.xml.gz

If language domain support is active:

  • Sitemap-Index: index-r{ROOTPID}-l{LANG}.xml.gz
  • Sitemap-Page: sitemap-r{ROOTPID}-l{LANG}-p{PAGE}.xml.gz

{ROOTPID} is the Page-UID from the root pages in your TYPO3 installations.

{PAGE} is the current page of the sitemap.

{LANG} is the language id (only active if language domains are active).

The index will refer to all page sitemaps so you only have to reference to the sitemap index.

Hint: These files are already gziped.

But most important is that it contains the ability to do multilingual SEO - which means depending on your language you can display the same or different or additional values in your text fields.

Thanks

Andi

Share this post


Link to post
Share on other sites

:-) Hi Martin

well if you wanna play in the top CMS leauge than better adjust to the encyclopedia ;-) - and get one new Processwire customer after the other converting TYPO3 Enterprise Level Sites to Processwire. The market shares of TYPO3 in Europe - especially Germany, Netherlands, Austria, Switzerland are great and very highprized. But with only WordPress Like seo features you won't get them at all.

No joke - If you understand SEO the right way and we are doing it here since years,aha than you really should use all that stuff the right way. To beat wordPress might be enough what is in there right now but this is just the beginning of what could be achieve with an enterprise SEO feature.

Perhaps you meant the way the data got clutterd in the post - so perhaps have a look to the link I have posted - It shows very clear what values are necessary. We use that tool (actually the predecessor of it called tq_seo) since many years with great success.

now we try to convince more and more customers to use Processwire instead of TYPO3 and WordPress (which is already crab by the way as they should have kept it as a blogging plattform for what it had been developed originally.



I

Share this post


Link to post
Share on other sites

Thanks for that great module Nico. I won't have to add a SEO tab by hand anymore ;-)

Share this post


Link to post
Share on other sites

@andi: thanks for the response! I took a look on the typo3 site and it looks like a good place for inspiration. I'll probably adapt some of the options there. But first I'm going to clean the current version and try to get multi language integrated (already tried it but it didn't work. So I have to try again :) )

  • Like 2

Share this post


Link to post
Share on other sites

Perhaps you meant the way the data got clutterd in the post - so perhaps have a look to the link I have posted 

yep referring to that. :-) But thanks for the great list I did have an overview of the page you linked to.

Lisandi, when you want a module that controls it all you're left with a tool build on assumptions. Nico has build a great tool especially for the smaller websites. We're in a business sending 100.000+ newsletters a week. We have 4 big news portals and multitude of articles are published everyday, you have to automate SEO (read custom build functions). No ready to use tool could be used here, many things can't be controlled in a reasonable way with inputfields and you can't have one tool to do the job. 

  • Like 1

Share this post


Link to post
Share on other sites

Was going to mention this earlier but it slipped my mind, so: Nico, what's your take on the storage method this module uses (saving all content to module config, i.e. the data column of related Modules table entry) and the obvious limitations it causes?

Based on some quick testing, using suggested description length, this module should be able to store data for roughly 300 pages -- though actual number depends a lot on the stored data itself. I was just wondering if it would make sense to reconsider the storage method, offer an alternative method for large sites, mention this somewhere.. and/or perhaps make the module aware of how much "quota" it still has?

I'm asking 'cause this seemed like an interesting choice for some of our sites, but it's not that rare for those to have hundreds or even thousands of pages.. so if the client ever gets too enthusiastic, there's going to be a problem ;)

Also: you might want to add garbage collection for removed pages. That's going to limit the scope of aforementioned scalability issue a bit.

  • Like 6

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 Robin S
      Repeater Images
      Adds options to modify Repeater fields to make them convenient for "page-per-image" usage. Using a page-per-image approach allows for additional fields to be associated with each image, to record things such as photographer, date, license, links, etc.
      When Repeater Images is enabled for a Repeater field the module changes the appearance of the Repeater inputfield to be similar (but not identical) to an Images field. The collapsed view shows a thumbnail for each Repeater item, and items can be expanded for field editing.
      Screencast

      Installation
      Install the Repeater Images module.
      Setup
      Create an image field to use in the Repeater field. Recommended settings for the image field are "Maximum files allowed" set to 1 and "Formatted value" set to "Single item (null if empty)". Create a Repeater field. Add the image field to the Repeater. If you want additional fields in the Repeater create and add these also. Repeater Images configuration
      Tick the "Activate Repeater Images for this Repeater field" checkbox. In the "Image field within Repeater" dropdown select the single image field. You must save the Repeater field settings to see any newly added Image fields in the dropdown. Adjust the image thumbnail height if you want (unlike the core Images field there is no slider to change thumbnail height within Page Edit). Note: the depth option for Repeater fields is not compatible with the Repeater Images module.
      Image uploads feature
      There is a checkbox to activate image uploads. This feature allows users to quickly and easily add images to the Repeater Images field by uploading them to an adjacent "upload" field.
      To use this feature you must add the image field selected in the Repeater Images config to the template of the page containing the Repeater Images field - immediately above or below the Repeater Images field would be a good position.
      It's recommended to set the label for this field in template context to "Upload images" or similar, and set the visibility of the field to "Closed" so that it takes up less room when it's not being used. Note that when you drag images to a closed Images field it will automatically open. You don't need to worry about the "Maximum files allowed" setting because the Repeater Images module overrides this for the upload field.
      New Repeater items will be created from the images uploaded to the upload field when the page is saved. The user can add descriptions and tags to the images while they are still in the upload field and these will be retained in the Repeater items. Images are automatically deleted from the upload field when the page is saved.
      Tips
      The "Use accordion mode?" option in the Repeater field settings is useful for keeping the inputfield compact, with only one image item open for editing at a time. The "Repeater item labels" setting determines what is shown in the thumbnail overlay on hover. Example for an image field named "image": {image.basename} ({image.width}x{image.height})  
      https://github.com/Toutouwai/RepeaterImages
      https://modules.processwire.com/modules/repeater-images/
    • By EyeDentify
      Hello There Guys.

      I am in the process of getting into making my first modules for PW and i had a question for you PHP and PW gurus in here.

      I was wondering how i could use an external library, lets say TwitterOAuth in my PW module.
      Link to library
      https://twitteroauth.com/

      Would the code below be correct or how would i go about this:
      <?PHP namespace ProcessWire; /* load the TwitterOAuth library from my Module folder */ require "twitteroauth/autoload.php"; use Abraham\TwitterOAuth\TwitterOAuth; class EyeTwitter extends WireData,TwitterOAuth implements Module { /* vars */ protected $twConnection; /* extend parent TwitterOAuth contructor $connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $access_token, $access_token_secret); */ public function myTwitterConnection ($consumer_key, $consumer_secret, $access_token, $access_token_secret) { /* save the connection for use later */ $this->twConnection = TwitterOAuth::__construct($consumer_key, $consumer_secret, $access_token, $access_token_secret); } } ?> Am i on the right trail here or i am barking up the wrong tree?
      I don´t need a complete solution, i just wonder if i am including the external library the right way.
      If not, then give me a few hint´s and i will figure it out.

      Thanks a bunch.

      /EyeDentify
    • By dimitrios
      Hello,
      this module can publish content of a Processwire page on a Facebook page, triggered by saving the Processwire page.
      To set it up, configure the module with a Facebook app ID, secret and a Page ID. Following is additional configuration on Facebook for developers:
      Minimum Required Facebook App configuration:
      on Settings -> Basics, provide the App Domains, provide the Site URL, on Settings -> Advanced, set the API version (has been tested up to v3.3), add Product: Facebook Login, on Facebook Login -> Settings, set Client OAuth Login: Yes, set Web OAuth Login: Yes, set Enforce HTTPS: Yes, add "http://www.example.com/processwire/page/" to field Valid OAuth Redirect URIs. This module is configurable as follows:
      Templates: posts can take place only for pages with the defined templates. On/Off switch: specify a checkbox field that will not allow the post if checked. Specify a message and/or an image for the post.
      Usage
      edit the desired PW page and save; it will post right after the initial Facebook log in and permission granting. After that, an access token is kept.
       
      Download
      PW module directory: http://modules.processwire.com/modules/auto-fb-post/ Github: https://github.com/kastrind/AutoFbPost   Note: Facebook SDK for PHP is utilized.


    • By kongondo
      FieldtypeRuntimeMarkup and InputfieldRuntimeMarkup
       
      Modules Directory: http://modules.processwire.com/modules/fieldtype-runtime-markup/
      GitHub: https://github.com/kongondo/FieldtypeRuntimeMarkup
      As of 11 May 2019 ProcessWire versions earlier than 3.x are not supported
      This module allows for custom markup to be dynamically (PHP) generated and output within a page's edit screen (in Admin).
       
      The value for the fieldtype is generated at runtime. No data is saved in the database. The accompanying InputfieldRuntimeMarkup is only used to render/display the markup in the page edit screen.
       
      The field's value is accessible from the ProcessWire API in the frontend like any other field, i.e. it has access to $page and $pages.
       
      The module was commissioned/sponsored by @Valan. Although there's certainly other ways to achieve what this module does, it offers a dynamic and flexible alternative to generating your own markup in a page's edit screen whilst also allowing access to that markup in the frontend. Thanks Valan!
       
      Warning/Consideration
      Although access to ProcessWire's Fields' admin pages is only available to Superusers, this Fieldtype will evaluate and run the custom PHP Code entered and saved in the field's settings (Details tab). Utmost care should therefore be taken in making sure your code does not perform any CRUD operations!! (unless of course that's intentional) The value for this fieldtype is generated at runtime and thus no data is stored in the database. This means that you cannot directly query a RuntimeMarkup field from $pages->find(). Usage and API
       
      Backend
      Enter your custom PHP snippet in the Details tab of your field (it is RECOMMENDED though that you use wireRenderFile() instead. See example below). Your code can be as simple or as complicated as you want as long as in the end you return a value that is not an array or an object or anything other than a string/integer.
       
      FieldtypeRuntimeMarkup has access to $page (the current page being edited/viewed) and $pages. 
       
      A very simple example.
      return 'Hello'; Simple example.
      return $page->title; Simple example with markup.
      return '<h2>' . $page->title . '</h2>'; Another simple example with markup.
      $out = '<h1>hello '; $out .= $page->title; $out .= '</h1>'; return $out; A more advanced example.
      $p = $pages->get('/about-us/')->child('sort=random'); return '<p>' . $p->title . '</p>'; An even more complex example.
      $str =''; if($page->name == 'about-us') { $p = $page->children->last(); $str = "<h2><a href='{$p->url}'>{$p->title}</a></h2>"; } else { $str = "<h2><a href='{$page->url}'>{$page->title}</a></h2>"; } return $str; Rather than type your code directly in the Details tab of the field, it is highly recommended that you placed all your code in an external file and call that file using the core wireRenderFile() method. Taking this approach means you will be able to edit your code in your favourite text editor. It also means you will be able to type more text without having to scroll. Editing the file is also easier than editing the field. To use this approach, simply do:
      return wireRenderFile('name-of-file');// file will be in /site/templates/ If using ProcessWire 3.x, you will need to use namespace as follows:
      return ProcessWire\wireRenderFile('name-of-file'); How to access the value of RuntimeMarkup in the frontend (our field is called 'runtime_markup')
       
      Access the field on the current page (just like any other field)
      echo $page->runtime_markup; Access the field on another page
      echo $pages->get('/about-us/')->runtime_markup; Screenshots
       
      Backend
       

       

       
      Frontend
       

×
×
  • Create New...