Jump to content

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


Recommended Posts

@mike: 

Thanks for adding it. I'll take a look.

@ceberlin:

Select a custom field with a fallback to title?

You can use multiple smart titles. So the first one will be used if filled (https://github.com/NicoKnoll/MarkupSEO/blob/master/MarkupSEO.module#L182-L187). If not the second one is used and so on. "Smart title" will be used in case you leave the "Title" field in the SEO tab empty.

post-140-0-92619200-1422108590_thumb.png

Canonical

Yes it's $page->httpUrl by default (https://github.com/NicoKnoll/MarkupSEO/blob/master/MarkupSEO.module#L233). But you're right. I should add a comment.

URL Segments

I'm not sure either how to handle them. But as they are not "real" pages I guess this module isn't able to handle them anyway (you can't add SEO fields to non existing pages...)

link rel="alternate" hreflang

I'll add an option to include this :)

  • Like 1
Link to post
Share on other sites

Hi Nico,

Thanks for this module! Love it much :)

I think I may have found a conflicting issue when this module is installed along side with ProcessBackup (DB Backup module). There is an error when you try to view the Database Backup detail and I believe it may be caused by the following line:

$editedPage = wire('pages')->get($this->config->input->get->id);

The SEO module kicks in when trying to view the database backup page because there is a querystring id in the url.

setup/db-backups/info/?id=0:dev.cc26012015-01.sql

The fix is pretty simple:

    public function ready() {
      // backend hooks
      if(@$this->page->process == 'ProcessPageEdit') {
        $editedPage = wire('pages')->get($this->config->input->get->id);

        if(in_array($editedPage->template->name, $this->includeTemplates)) {
          $this->addHookAfter("ProcessPageEdit::buildFormContent", $this, 'hookCustomizeSeoTab');
        }
      }

      // frontend hooks
      if($this->page->template != 'admin' && in_array($this->page->template->name, $this->includeTemplates)) {
        $this->addHookProperty("Page::seo", $this, 'hookFrontendPage');
        $this->addHookProperty("Config::seo", $this, 'hookFrontendConfig');
      }
    }

Check the ProcessEditPage first before look for the edited page object. But anyway, I thought I let you know :) Thanks much again!

  • Like 3
Link to post
Share on other sites

Hi Nico,

>Canonical

>Yes it's $page->httpUrl

I see a potential double content problem here:

A page can exist in http and in https mode. Especially after a https page was called (admin area, or a form in the frontend for example) a user stays in https mode until a next page which is set as http-only was opened.

Do you agree that a double content issue is possible?

If so, my idea would be using this checking order:

1. is the whole site https only (the brand new setting option in the latest dev) ->https

2. fallback: is there a strict setting in the URL part of the template for https? ->https

3. fallback: use the common way to display a website ->http

What Do you think?

Link to post
Share on other sites

If so, my idea would be using this checking order:

1. is the whole site https only (the brand new setting option in the latest dev) ->https

2. fallback: is there a strict setting in the URL part of the template for https? ->https

3. fallback: use the common way to display a website ->http

I would support such a process, as google is suggesting webmasters to use https. I don't know for sure about the state of improved rankings from https, but as it's a possible factor, it should be taken care of as best as possible.

Link to post
Share on other sites

URL Segments

I'm not sure either how to handle them. But as they are not "real" pages I guess this module isn't able to handle them anyway (you can't add SEO fields to non existing pages...)

Personally I'm not using the SEO module, I set it up in my _init.php, and when using URL Segments I add it in my templates.

Correct me if I'm wrong, but using URLSegments you actually have to edit the template, since it's not an actual page and doesn't have a title and/or meta_descriptions can't you create some default fall-back when URL Segments are used?

Then in the template itself:

SeoModule->fallback_string(__('%1$s is part of %2$s and contains %3$s subpages'),$URLSegment1, $page->parent->title, count($page->children));

or as matter as fact any default outcome when a $page->name/$page->core.title doesn't exist at all...?

BTW above "code" is just fiction, but I guess you know where I'm going...

Now we're at it, URL Segments aren't included in the current sitmap xml module either, which is not ideal on a SEO point of view.

Link to post
Share on other sites

@makari: You now have to define which templates should get a SEO-tab in the module's settings :)

I did it. But no SEO-tab anywere... :mellow:

I guess, some of the old versions data is left in the database - but how can I find that - and where?

Link to post
Share on other sites

Version 0.7.0:

Hey, I added the https option you asked for:

post-140-0-95031700-1422794809_thumb.png

$config->https will be set to true in runtime I guess if the template is set to use https, too. So all of the fallbacks should be covered.

And I added the fix by @peterfoeng.

  • Like 1
Link to post
Share on other sites

I'm not getting an SEO tab appear on my publish/edit pages. I'm also not seeing any seo_xxxx fields in my fields list. So I thought I should maybe uninstall and reinstall, but when I try to uninstall I get:

Recoverable Fatal Error: Argument 1 passed to Fields::___delete() must implement interface Saveable, null given (line 265 of /wire/core/Fields.php) 
This error message was shown because you are logged in as a Superuser. Error has been logged.

And yes, I have specified templates to get the tab in the module's settings.

Link to post
Share on other sites

Thanks for this module.

I use smart fields and got a little bit trouble using the description field. Because I chose fields which include html tags. Even if if I check "Strip Tags" in the field settings for seo_description. I guess that this setting doesn't take effect if the field was left blank. This results in:

<meta name="og:description" content="<h2>KF Interactive GmbH</h2>
	
	<p>
	D-04107 Leipzig</p>
	
	<p>Tel.: +<br />
	Fax: +<br />
	Mail: <a href=" mailto:info@kf-interactive.com"="">
<p><strong>Konzeption und Gestaltung der Website:</strong><br>
	<a href=""></a> & KF Interactive</p>
">
	

.. and breaks the layout.

I changed line 206:

-             $pageData['description'] = $page->get(implode('|', $configData['descriptionSmart']));
+             $pageData['description'] = strip_tags($page->get(implode('|', $configData['descriptionSmart']))); 

.. and everything works  :)

Maybe you could include this litte fix in a later version?

  • Like 4
Link to post
Share on other sites

Regarding the HTTPS option:

$pageData['canonical'] = preg_replace('%^http%Uis', 'https', $page->httpUrl);

should be

$pageData['canonical'] = preg_replace('%^https?%i', 'https', $page->httpUrl);

This way the regex will capture all of the protocol string regardless of whether it is http or https at this stage. In my case I got a httpss in the resulting links from the first one as it matched the http, when the input was https.

Tried a few other regexes (e.g. https?, etc.) as well which logically should've worked, but preg_replace in its true self proved to be inconsistent.

Scratch that - read over the U modifier.

Fix returns https for both http and https as input, so covers both eventualities in the context of where it's called in the codebase.

  • Like 1
Link to post
Share on other sites

Had to add a character counter with limiting functionality for one of my projects. Take a look and let me know what you think for now https://github.com/pjguk/MarkupSEO

No guarantees given - this was "hacked" straight into a production environment which already utilises the module and therefore uninstalling and reinstalling was not an option for the time being.

Particulars that are most likely not working as expected for now (Couldn't reliably test yet):

  • Default character limits are not set on install
  • Default character limits do not set should the limit field be empty when the page is saved
  • Hard character limits do not apply to pages unless the fields are being edited and the page subsequently saved (requirement for my project, may not be the behaviour everybody wants/needs)

So still some teething problems with the config on that part, but works well enough for me for the time being.

The modifications allow the following:

post-1687-0-78764400-1423414963_thumb.pn

Counter added to the title and description fields in the SEO tab. Counting down from the limit to 0 - and beyond to show how many characters you are over.

post-1687-0-54384900-1423414472_thumb.pn

Config options in the module settings to set the character limits for title and description as well as toggling hard limits. Hard limits disable the ability to enter more than the limit number of characters. Useful if multiple authors work with the SEO tabs and you want to ensure nobody goes over the limits.

post-1687-0-89385900-1423414964_thumb.pn

With hard limiting disabled the character counter simply goes into the negative and ignores the limit for the actual input and render.

post-1687-0-36572600-1423414966_thumb.pn

With hard limiting enabled the input cuts off at 0 characters left.

  • Like 1
Link to post
Share on other sites

@pjg: Hey, I implemented the counter you suggested. It's a little bit different from your version but it has the same settings :)

Very nice implementation. Works a charm.

  • Like 1
Link to post
Share on other sites

@tyssen: if you can't delete it go to fields and delete all of the (remaining) seo fields manually. Then go to the modules code and delete the whole ___delete() function. Then uninstall the module and delete the .module file. Then download the most recent version (0.8.1), install it and let me now if it works better afterwards :)

Link to post
Share on other sites

This module cause a conflict with pages on the front end that use the id variable.

"../json_pages/?id=234|434"  will crash processwire. 

this seems to be the caused by: LINE: 92.

$editedPage = wire('pages')->get($this->config->input->get->id)

I think checking that you are in the backend before running the above query might solve the issue.

btw, great plugin. 

  • Like 1
Link to post
Share on other sites

All good now, thanks. And very nice module, previewing feature especially.

Just one small request: it would be useful to have a way to override the Title Format on certain pages, e.g. the home page. For most pages I'll want to have Page Name – Site Name, but on the home page I'll want to have Site Name – Site Description, but with title format enabled I get Site Name – Site Description – Site Name.

  • Like 1
Link to post
Share on other sites

Thanks for adding strip_tags for smart fields  :)

I got a little bit of trouble regarding the new piwik including. Still after re-saving the module settings I get the following error:

Notice: Undefined index: piwikAnalyticsUrl in /.../public/site/modules/MarkupSEO/MarkupSEO.module on line 311

On line 311 you need to check first if this array key exists because in the database there is just an entry for "piwikAnalytics":"" initially. As a quick fix I added ,"piwikAnalyticsUrl":"" manually.

Changing line 311 to

if (array_key_exists('piwikAnalyticsUrl', $configData) && $configData['piwikAnalyticsUrl']) 

or  check if piwikAnalytics is not empty

if (!empty($configData['piwikAnalytics']) && $configData['piwikAnalyticsUrl'])

should solve this issue.

Link to post
Share on other sites

You corrected the names and therefore an empty entry will be saved. That's on line 767  ;) So you don't have to extend the if condition I suggested (on line 311) because you know that there is always an entry with this key.  ;) Thanks for the quick fix.

(I've been waiting for the strip_tags fix to be able to reset my deployment script because your module is included as a git submodule and I didn't want to change this. So I was quite sure to use the latest master version.)

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 FireWire
      Hello community!

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

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

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

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

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

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

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

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

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

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

    • By 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?
×
×
  • Create New...