SeoSuite

SEO Suite was introduced by Sterc as a MODX Extra that automatically redirects your 404 URLs to relevant pages on your website. 404 errors are a fairly common issue for anyone who’s transitioning from an old website to a new website. SEO Suite makes sure your visitors are redirected to a relevant page when they’re looking for an old URL.

SEO Suite v3.0

SEO Suite 2.0 combines the power of three extras, SEO Pro, SEO Tab and SEO Suite v1 into one powerful SEO extra. Not only have these three extra's been combined into one, but the codebase has gone through a large refactor and some great new features have been added. New SEO Suite 3.0 has been optimized to run on MODX3.

A custom panel dedicated to your focus keywords, meta title and description has been added, where you can view and switch between Google/Yandex previews or viewing the desktop or mobile preview. All search engine related properties have been gathered in a separate Search engine tab. A new tab "Social" has been added where you can manage the metadata used by Facebook and Twitter.

Migration

In order to migrate data from SEO Suite V1, SEO Tab or SEO Pro please run the migration during the SEO Suite update in the package installer.

Note: Please always backup your data before running any migrations and carefully check if the migration was finished succesfully.

Key features

• Preview Google/Yandex search results on desktop and mobile
• Manage search engine visibility (noindex, nofollow)
• Manage internal search engine behavior
• Manage your Google XML Sitemap(s)
• Manage social media previews for Facebook using the Open Graph protocol and Twitter Cards markup
• Manage 301 redirects
• Automatically generates 301 redirects when changing a resource URL
• When someone visits a non-existent page (404) on your website, the URL will be automatically added to SEO Suite so you can redirect it to an existing page.
• SEO Suite comes with a Dashboard widget, showing the 10 newest SEO Suite URL's
• It is possible to import a .csv file containing 404 URL's and then search for redirects inside only one (related) context. This comes in handy for multilingual websites.
• To get more specific redirect suggestions, you can exclude words from the matching system. Pay attention: when you add words to exclude after a .csv import, you might need to refresh the suggestions by clicking your right mouse button on the relevant 404 URL and choose 'Find suggestions'. After doing this, it will be refreshed.
• Block certain redirects from being saved by adding blocking key words to system settings.

Bulk import 404 URLs

Through simply uploading a single column .csv file containing your 404 URLs, SEO Suite will look for similar pages on your website and redirect them automatically. This matching process is based on the URL information after the last slash (example.com/this-information).

1. Gather your 404 URLs in a single column .csv file by exporting them or adding them manually. Make sure you’ve entered full URLs, including the domain. Example: https://modx.org instead of modx.org.
2. Import the .csv file into SEO Suite.
3. SEO Suite will look for similarities between your 404 URLs and the pages on your website (make sure the pages are published):
   • When there is one match, it will be automatically converted into a 301 redirect and stored in SEO Tab.
   • When there are several matches, you can choose the desired redirect manually (by choosing from suggestions).
   • When there are no matches, you can pick a redirect yourself (SEO Suite offers a search function so you can find a relevant redirect easily).

Plugin

The SEO Suite plugin handles all events where SEO Suite has to act upon. It also sets placeholders (when enabled) onLoadWebDocument so you can easily retrieve SEO metadata and include it in your code. You can read more about this in the SeoSuiteMeta section.

Snippets

SeoSuite comes with a few handy snippets for you to use.

SeoSuiteMeta

This snippet retrieves all metadata for you to include in the head of your web page. These placeholders are also available by default when the setting seosuite.placeholder_plugin_enabled is enabled. Then the snippet is called from a plugin which sets these placeholders for you. If you rather take control in your own hands, you can disable the plugin using the system setting and call the snippet yourself.

Here's an example of all available placeholders of the SeoSuiteMeta snippet when toPlaceholders is turned on.

<!-- Set by plugin. -->
[[!+ss_meta.meta_title]]
[[!+ss_meta.meta_description]]
[[!+ss_meta.robots]]
[[!+ss_meta.canonical]]
[[!+ss_meta.alternates]]
[[!+ss_meta.og_title]]
[[!+ss_meta.og_description]]
[[!+ss_meta.og_image]]
[[!+ss_meta.og_image_alt]]
[[!+ss_meta.og_type]]
[[!+ss_meta.twitter_site]]
[[!+ss_meta.twitter_title]]
[[!+ss_meta.twitter_description]]
[[!+ss_meta.twitter_image]]
[[!+ss_meta.twitter_image_alt]]
[[!+ss_meta.twitter_card]]

Or you can use the following placeholder to get all placeholders combined.

<!-- Set by plugin. -->
[[!+ss_meta]]

Properties

Property	Description	Default value
id	ID of the resource to retrieve meta for.	Current resource id.
tpl	Meta tag tpl.	tplMeta
tplSocial	Social Meta tag tpl.	tplMetaSocial
tplTitle	Title tag tpl.	tplMetaTitle
tplLink	Link tpl.	tplLink
tplAlternateWrapper	Alternate lang wrapper tpl.	tplAlternateWrapper
toPlaceholders	Set output to placeholders	false

SeoSuiteSitemap

Create sitemaps with the help of this snippet, by specifying a type, you can create different kinds of sitemaps:

• Page sitemap (default)
• Sitemap index containing child sitemaps, example structure:
  • Sitemap index: [[!SeoSuiteSitemap? &type=index]]
    • Page index: [[!SeoSuiteSitemap]]
    • Image index: [[!SeoSuiteSitemap? &type=images]]
• Sitemap containing images.

You have to manually create a resource within MODX, Template: (empty). go to the tab Settings and set Content Type: XML, Cachable and Rich Text should be ticked off. In the content field, use the following code:

[[!SeoSuiteSitemap]]
OR
[[!SeoSuiteSitemap? &type=`index`]]
OR
[[!SeoSuiteSitemap? &type=`images`]]

Property	Description	Default value
contexts	Specify one or more contextKey's, separated by a comma.	web
allowSymlinks	Set this to 1 if you want to include symlinks in your sitemap.	0
outerTpl	Refer to a chunk here to change the outer template, which contains rows of rowTpl's (see below).	sitemap/outertpl
rowTpl	Refer to a chunk here to change the rowTpl which is repeated for every resource which is included in the sitemap.	sitemap/rowtpl
type	Specify a sitemap type to generate a sitemap index page or an images sitemap. Possible values are: index/images.
indexOuterTpl	Refer to a chunk here to change the outer template, which contains rows of rowTpl's for the sitemap index.	sitemap/index/outertpl
indexRowTpl	Refer to a chunk here to change the rowTpl which is repeated for every sitemap which is included in the index sitemap.	sitemap/index/rowtpl
imagesOuterTpl	Refer to a chunk here to change the outer template, which contains rows of rowTpl's for the images sitemap.	sitemap/images/outertpl
imagesRowTpl	Refer to a chunk here to change the rowTpl which is repeated for every resource which is included in the images sitemap which can contain multiple images.	sitemap/images/rowtpl
imageTpl	Refer to a chunk here to change the imageTpl which is repeated for every image which is included for a resource.	sitemap/images/imagetpl
templates	Comma delimited list of template ID's to generate a template specific sitemap for. Exclude templates from a sitemap by prepending the template ID with an "-". For example: &templates=-1,2,3

Cronjobs

Inside the core/components/seosuite/elements/cronjobs/ directory you can find the SeoSuite cronjobs.

Redirect cleanup

Removes unresolved redirects which are older then 1 month and have been triggered just once.

Example usage:

php redirect-cleanup.php --till=2018-11-23 --triggered=2

File: redirect-cleanup.php

Property	Description	Default value
till	Till date for unresolved redirects to remove.	Current date - 1 month
triggered	Maximum amount of triggers for the unresolved redirects you want to remove.	1

Future features

• 301 redirect statistics: SEO Suite will feature a custom manager page containing 301 redirects statistics. A dashboard widget will be provided which shows the 10 redirects with the most hits.
• Automatically import 404's from Google Search Console.

Bugs and feature requests

We greatly value your feedback, feature requests and bug reports. Please issue them on Github.