Jump to content

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
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?

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
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)

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.  

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?

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

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

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

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
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
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
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 monollonom
      (once again I was surprised to see a work of mine pop up in the newsletter, this time without even listing the module on PW modules website 😅. Thx @teppo !)
      Github: https://github.com/romaincazier/FieldtypeQRCode
      Modules directory: https://processwire.com/modules/fieldtype-qrcode/
      This is a simple module I made so a client could quickly grab a QR Code of the page's url in the admin.
      There's not much to it for now, but if need be you can output anything using a hook:
      $wire->addHookAfter("FieldtypeQRCode::getQRText", function($event) { $event->return = "Your custom text"; }) You can also output the QR code on your front-end by calling the field:
      echo $page->qr_code_field; The module uses the PHP library QR Code Generator by Kazuhiko Arase. When looking for a way to generate a QR Code in PW I came across @ryan's integration in his TFA module. I'm not very familiar with fieldtype/inputfield module development so I blindly followed @bernhard (great) tutorial and his BaseFieldtypeRuntime. At some point I'll take a deeper look to make a module on my own.
      Some ideas for improvements :
      add the ability to choose what to ouput : page's url / editUrl / file(s) / image(s) / ... allow to output multiple QR codes ?
    • By Chris Bennett
      https://github.com/chrisbennett-Bene/AdminThemeTweaker
      Inspired by @bernhard's excellent work on the new customisable LESS CSS getting rolled into the core soon, I thought I would offer up the module for beta testing, if it is of interest to anyone.

      It takes a different approach to admin styling, basically using the Cascade part of CSS to over-ride default UiKit values.
      Values are stored in ModuleConfig Module creates a separate AdminThemeTweaker Folder at root, so it can link to AdminThemeTweaker.php as CSS AdminThemeTweaker.php reads the module values, constructs the CSS variables then includes the CSS framework Can be switched on and off with a click. Uninstall removes everything, thanks to bernhard's wonderful remove dir & contents function.
      It won't touch your core. It won't care if stuff is upgraded. You won't need to compile anything and you don't need to touch CSS unless you want to.

      It won't do much at all apart from read some values from your module config, work out the right CSS variables to use (auto contrast based on selected backgrounds) and throw it on your screen.
      You can configure a lot of stuff, leave it as it comes (dark and curvy), change two main colors (background and content background) or delve deep to configure custom margins, height of mastheads, and all manner of silly stuff I never use.

      Have been developing it for somewhere around 2 years now. It has been (and will continue to be) constantly tweaked over that time, as I click on something and find something else to do.
      That said, it is pretty solid and has been in constant use as my sole Admin styling option for all of those 2 years.

      If nothing else, it would be great if it can provide any assistance to @bernhard or other contributor's who may be looking to solve some of the quirkier UiKit behavior.
      Has (in my opinion) more robust and predictable handling of hidden Inputfields, data-colwidths and showIf wrappers.
      I am very keen to help out with that stuff in any way I can, though LESS (and any css frameworks/tools basically) are not my go.
      I love CSS variables and banging-rocks-together, no-dependency CSS you can write with notepad.



       

    • By opalepatrick
      I see old posts saying that repeaters are not the way to go in Custom Process Modules. If that is the case, when using forms (as I am trying to do) how would one tackle things like repeat contact fields where there can be multiple requirements for contact details with different parameters? (Like point of contact, director, etc) or even telephone numbers that have different uses?
      Just for background I am creating a process module that allows me to create types of financial applications in the admin area (no need to publish any of this, pure admin) that require a lot of personal or company information.
      Maybe I am thinking about this incorrectly?
    • By HMCB
      I ran across a reference to IftRunner module. The post was 6 years ago. I cant find it in available modules. Has it been pulled?
    • By tcnet
      PageViewStatistic for ProcessWire is a module to log page visits of the CMS. The records including some basic information like IP-address, browser, operating system, requested page and originate page. Please note that this module doesn't claim to be the best or most accurate.
      Advantages
      One of the biggest advantage is that this module doesn't require any external service like Google Analytics or similar. You don't have to modify your templates either. There is also no Javascript or image required.
      Disadvantages
      There is only one disadvantage. This module doesn't record visits if the browser loads the page from its browser cache. To prevent the browser from loading the page from its cache, add the following meta tags to the header of your page:
      <meta http-equiv="Cache-Control" content="no-cache, no-store, must-revalidate" /> <meta http-equiv="Pragma" content="no-cache" /> <meta http-equiv="Expires" content="0" /> How to use
      The records can be accessed via the Setup-menu of the CMS backend. The first dropdown control changes the view mode.

      Detailed records
      View mode "Detailed records" shows all visits of the selected day individually with IP-address, browser, operating system, requested page and originate page. Click the update button to see new added records.

      Cached visitor records
      View modes other than "Detailed records" are cached visitor counts which will be collected on a daily basis from the detailed records. This procedure ensures a faster display even with a large number of data records. Another advantage is that the detailed records can be deleted while the cache remains. The cache can be updated manually or automatically in a specified time period. Multiple visits from the same IP address on the same day are counted as a single visitor.

      Upgrade from older versions
      Cached visitor counts is new in version 1.0.8. If you just upgraded from an older version you might expire a delay or even an error 500 if you display cached visitor counts. The reason for this is that the cache has to be created from the records. This can take longer if your database contains many records. Sometimes it might hit the maximally execution time. Don't worry about that and keep reloading the page until the cache is completely created.
      Special Feature
      PageViewStatistic for ProcessWire can record the time a visitor viewed the page. This feature is deactivated by default. To activate open the module configuration page and activate "Record view time". If activated you will find a new column "S." in the records which means the time of view in seconds. With every page request, a Javascript code is inserted directly after the <body> tag. Every time the visitor switches to another tab or closes the tab, this script reports the number of seconds the tab was visible. The initial page request is recorded only as a hyphen (-).

      Settings
      You can access the module settings by clicking the Configuration button at the bottom of the records page. The settings page is also available in the menu: Modules->Configure->ProcessPageViewStat.
      IP2Location
      This module uses the IP2Location database from: http://www.ip2location.com. This database is required to obtain the country from the IP address. IP2Location updates this database at the begin of every month. The settings of ProcessPageViewStat offers the ability to automatically download the database monthly. Please note, that automatically download will not work if your webspace doesn't allow allow_url_fopen.
      Dragscroll
      This module uses DragScroll. A JavaScript available from: http://github.com/asvd/dragscroll. Dragscroll adds the ability in view mode "Day" to drag the records horizontally with the mouse pointer.
      parseUserAgentStringClass
      This module uses the PHP class parseUserAgentStringClass available from: http://www.toms-world.org/blog/parseuseragentstring/. This class is required to filter out the browser type and operating system from the server request.
×
×
  • Create New...