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

For better SEO try to place the Meta entries on top before the links/scripts of css and js!

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

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 Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
    • By Robin S
      This is a module I made as an experiment a while ago and never got around to releasing publicly. At the time it was prompted by discussions around using Repeater fields for "page builder" purposes, where the depth feature could possibly be used for elements that would be nested inside other elements. I thought it would be useful to enforce some depth rules and translate the depth data into a multi-dimensional array structure.
      I'm not using this module anywhere myself but maybe it's useful to somebody.
      Repeater Depth Helper
      This module does two things relating to Repeater fields that have the "Item depth" option enabled:
      It enforces some depth rules for Repeater fields on save. Those rules are:
      The first item must have a depth of zero. Each item depth must not be more than one greater than previous item depth. It provides a RepeaterPageArray::getDepthStructure helper method that returns a nested depth structure for a Repeater field value.
      Helper method
      The module adds a RepeaterPageArray::getDepthStructure method that returns a multi-dimensional array where the key is the page ID and the value is an array of nested "child" items, or null if there are no nested children.
      Example

      The module doesn't make any assumptions about how you might want to use the depth structure array, but here is a way you might use it to output a nested unordered list.
      // Output a nested unordered list from a depth structure array function outputNestedList($depth_structure, $repeater_items) { $out = "<ul>"; foreach($depth_structure as $page_id => $nested_children) { $out .= "<li>" . $repeater_items->get("id=$page_id")->title; // Go recursive if there are nested children if(is_array($nested_children)) $out .= outputNestedList($nested_children, $repeater_items); $out .= "</li>"; } $out .= "</ul>"; return $out; } $repeater_items = $page->my_repeater; $depth_structure = $repeater_items->getDepthStructure(); echo outputNestedList($depth_structure, $repeater_items);
       
      https://github.com/Toutouwai/RepeaterDepthHelper
      https://modules.processwire.com/modules/repeater-depth-helper/
    • By MoritzLost
      Cacheable Placeholders
      This module allows you to have pieces of dynamic content inside cached output. This aims to solve the common problem of having a mostly cacheable site, but with pieces of dynamic output here and there.  Consider this simple example, where you want to output a custom greeting to the current user:
      <h1>Good morning, <?= ucfirst($user->name) ?></h1> This snippet means you can't use the template cache (at least for logged-in users), because each user has a different name. Even if 99% of your output is static, you can only cache the pieces that you know won't include this personal greeting. A more common example would be CSRF tokens for HTML forms - those need to be unique by definition, so you can't cache the form wholesale.
      This module solves this problem by introducing cacheable placeholders - small placeholder tokens that get replaced during every request. The replacement is done inside a Page::render hook so it runs during every request, even if the response is served from the template cache. So you can use something like this:
      <h1>Good morning, {{{greeting}}}</h1> Replacement tokens are defined with a callback function that produces the appropriate output and added to the module through a simple hook:
      // site/ready.php wire()->addHookAfter('CachePlaceholders::getTokens', function (HookEvent $e) { $tokens = $e->return; $tokens['greeting'] = [ 'callback' => function (array $tokenData) { return ucfirst(wire('user')->name); } ]; $e->return = $tokens; }); Tokens can also include parameters that are parsed and passed to the callback function. There are more fully annotated examples and step-by-step instructions in the README on Github!
      Features
      A simple and fast token parser that calls the appropriate callback and runs automatically. Tokens may include multiple named or positional parameters, as well as multi-value parameters. A manual mode that allows you to replace tokens in custom pieces of cached content (useful if you're using the $cache API). Some built-in tokens for common use-cases: CSRF-Tokens, replacing values from superglobals and producing random hexadecimal strings. The token format is completely customizable, all delimiters can be changed to avoid collisions with existing tag parsers or template languages. Links
      Github Repository & documentation Module directory If you are interested in learning more, the README is very extensive, with more usage examples, code samples and usage instructions!
×
×
  • Create New...