What does it do?

Clickstorm SEO enables important on-page features for search engine optimization (SEO) and expands the page settings and extbase models e.g. with a preview for google search results.

Features

• Advanced page settings

  • Preview for search results on Google (SERP)
  • Focus Keyword
  • Structured Data (JSON-LD)

• Easily extend any database record you like with this SEO properties (news, events etc.)
• On-page evaluation of different SEO aspects (focus keyword, alt attributes, heading order etc.) and records (pages, news etc.)
• href="lang" support for extensions
• allow all languages for the x-default attribute
• Define fallback images for Open Graph and Twitter Cards
• Backend module in AngularJS to edit the properties directly
• Another backend module to fill empty alternative text of images

Screenshots

Here you can take a look at the advanced page configurations.

Evaluate the On-page SEO of the current page you see in the backend. Try to reach 100/100.

The backend module gives you an overview and the option to change page properties directly.

Extend e.g. the news with SEO properties. So in the detail view, they are automatically shown.

Evaluate this records.

For example, check that the hierarchical order of headings is correct.

Add alternative text to your images.

Add Structured Data (JSON-LD) to pages and records incl. check for the current URL or markup.

Page Properties

FAQ

Do I have to insert open graph and twitter cards properties always? The title, description and an image should be available on every page. The title is default given by the page title. You can set the description in the SEO tab. A default image for sharing can be set by the open graph image field in the Social Media tab.

Page properties in TYPO3 v9

If you use TYPO3 v8 and want to update to TYPO3 v9 or higher, please use cs_seo version 4, to migrate the page properties from cs_seo to core, e.g 'tx_csseo_title' to 'seo_title'.

From older versions

Please take a look at our ChangeLog.

Properties

Page configurations

In this section we provide default settings for maximum characters of the meta data which were recommended. The recommendation is the result of a research by ourself. So if you don't agree with them, you can override them here.

Evaluation

File configurations

Properties

Language configurations

I get an error when I edit a page. What should I do?

Please include the TypoScript from the extension in your root ts.

There is no domain displayed in the google preview. What should I do?

Please add a Site Configuration for your root page.

I can't find a robots meta tag with index,follow. Is this a bug?

Not at all. index,follow is the default setting. So if no robot tag is specified, the crawler has no restrictions for indexing. More information you'll get by Google.

.htaccess disallow frontend access. There are no evaluation results. What should I do?

Give your server access to the frontend. Include the following line in your .htaccess file and replace the x with the IP from the server.

Order allow,deny
Allow from xxx.xxx.xxx.xxx

You could also use the domain instead of the IP.

Allow from .mydomian.com

In my setup I need specific options to handle the evaluation request. How can I solve this?

All requests from cs_seo get a specific request header "X-CS-SEO". So you can specify your own handles, e.g. in your .htacces file.

RewriteCond %{REQUEST_URI} ^/en [NC]
RewriteCond %{HTTP:X-CS-SEO} !^1$
RewriteRule ^(.*)$ https://en.example.org/$1 [L,R=301]

Every browser title has a pipe symbol | at the end. How can I remove this?

Usually we display after this symbol the title of your whole site. You can set the title in your TypoScript Template record or via TypoScript

plugin.tx_csseo.sitetitle = my site title

You can also change or remove the symbol via TypoScript, see also TSREF

config.pageTitleSeparator =

Main Topics

# user TSconfig
page.mod.web_layout.tx_csseo.disable = 0

# page TSconfig
mod.web_layout.tx_csseo.disable = 0

TypoScript Settings Reference

Properties

plugin.tx_csseo.social.

1. Add a Yaml Config File

Add the following yaml content to a file EXT:myext/Configuration/CsSeo/config.yaml.

records:

   # new index and table name of the model
   tx_myext_domain_model_mymod:

      # if the get parameter is set in the URL the cs_seo properties will be shown
      enable: 'GP:tx_myext_pi1|mymod'

      # if the model already has fields like title etc. define them as fallback
      fallback:

         # cs_seo title field fallback = mymod title field
         title: title

         # cs_seo description field fallback = mymod description field
         # you can use double slashes for multiple fallback options, e.g. 'teaser // abstract'
         # in this case the first field with content will be used
         # also more fields possible within curly brackets, e.g. description: {teaser} - {company}
         description: description

      # enable evaluation for mymod
      evaluation:

         # additional params to initialize the detail view, the pipe will be replaced by the uid
         getParams: >-
            &tx_myext_pi1[controller]=MyController&tx_myext_pi1[action]=MyAction&tx_myext_pi1[mymod]=|

         # detail pid for the current records, only if set the table will be available
         detailPid: 100

You have the possibility to merge multiple config files via imports.

If you need another detail pid, for example for different storage pids, you can use the PSR-14 event \Clickstorm\CsSeo\Event\ModifyEvaluationPidEvent. Furthermore you can also use environment variables for different pids in different environments like staging or production.

detailPid: '%env(TYPO3__TX_NEWS__PID_DETAIL)%'

You may take also a look at the dotenv-connector.

2. Register the config file

Register the config file in your ext_localconf.php.

// Copy the current file
$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['cs_seo']['yamlConfigFile'] = 'EXT:myext/Configuration/CsSeo/config.yaml';

Clear the system cache and done. A new tab is in the backend visible called SEO.

3. Update the database

You need to update the database in install tool afterwards. We will automatically insert the following SQL.

CREATE TABLE tx_myext_domain_model_mymod (
	tx_csseo int(11) DEFAULT '0' NOT NULL
);

1. Create a new evaluator

<?php
namespace Vendor\ExtensionName\Evaluation;

use Clickstorm\CsSeo\Evaluation\AbstractEvaluator;

class MyEvaluator extends AbstractEvaluator
{

	public function evaluate() {
		$state = self::STATE_RED;

		$count = $this->domDocument->getElementsByTagName('h1')->length;

		if($count > 0 && $count < 2) {
			$state =  self::STATE_GREEN;
		}

		return [
			'count' => $count,
			'state' => $state
		];
	}

}

The class must extend the AbstractEvaluator class. You get the current domDocument with $this->domDocument. You must return an arry that contains at least the key state. This is important for the final percentage calculation.

2. Register the evaluator

Add the following configurition in your ext_localconf.php.

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['cs_seo']['evaluators']['My'] =
	\Vendor\ExtensionName\Evaluation\MyEvaluator::class;

The key is important. In the results the partial with the path Results\My will be called for the output.

3. Create a partial and add the partialRootPaths

module.tx_csseo.view.partialRootPaths.10 = EXT:my_ext/Resources/Private/Partials

In the partial folder create a folder called Results. In this folder insert your partial file My.html.

<html xmlns="http://www.w3.org/1999/xhtml" lang="en"
      xmlns:f="http://typo3.org/ns/fluid/ViewHelpers">
<body>
<f:section name="Main">
	<li class="cs-icon csseo-icon-state-{result.state}">
		<b><f:translate key="evaluation.my" extensionName="my_extension" /></b> <f:translate key="evaluation.my.{result.state}" arguments="{0: result.count}" extensionName="my_extension" />.
	</li>
</f:section>
</body>

4. Add the evaluator in the extension manager settings

Add the evaluator in the extension manager to the available evaluators, e.g. H1,H2,My. The key equals the key in the array where you registered the evaulator.

Some considerations

• More hints while typing the title or description (like min characters, words etc.)

Properties

Basic configurations