XML sitemap
typo3/cms-seo provides a ready to use XML sitemap that can be included via Site sets (recommended) or include in your TypoScript record.
Table of Contents
How to access your XML sitemap
You can access the sitemaps by visiting https://
.
You will first see the sitemap index. By default, there is one sitemap in the
index. This is the sitemap for pages.
Note
Each siteroot and language configured in the Site handling has its own XML sitemap depending on the entry point.
Example:
- Entry point
/
-https://
: for default languageexample. org/?type=1533906435 - Entry point
/fr/
-https://
: for Frenchexample. org/ fr/?type=1533906435 - Entry point
/it/
-https://
: for Italianexample. org/ it/?type=1533906435
How to setup routing for the XML sitemap
You can use the PageType decorator
to map page types to a fixed suffix. This allows you to expose the sitemap with a
readable URL, for example https://
.
Additionally, you can map the parameter sitemap
, so that the links to the
different sitemap types (pages
and additional ones, for example, from the
news extension) are also mapped.
Data providers for XML sitemaps
The rendering of sitemaps is based on data providers implementing :php:`TYPO3CMSSeoXmlSitemapXmlSitemapDataProviderInterface.
typo3/cms-seo ships with the following data providers for XML sitemaps:
For pages: PagesXmlSitemapDataProvider
The \TYPO3\
will generate a
sitemap of pages based on the detected site root. You can configure whether you
have additional conditions for selecting the pages.
Via setting seo.sitemap.pages.excludedDoktypes it is possible to exclude certain Types of pages.
Additionally, you may exclude page subtrees from the sitemap (for example internal pages). This can be configured using setting seo.sitemap.pages.excludePagesRecursive.
If your site still depend on TypoScript records instead of site sets, you can make these settings via TypoScript constants.
For special use cases you might want to override the default TypoScript provided by the set.
For database records: RecordsXmlSitemapDataProvider
If you have an extension installed and want a sitemap of those records, the
\TYPO3\
can be used. The
following example shows how to add a sitemap for news records:
plugin.tx_seo {
config {
xmlSitemap {
sitemaps {
myNewsSitemap {
provider = TYPO3\CMS\Seo\XmlSitemap\RecordsXmlSitemapDataProvider
config {
table = news_table
sortField = sorting
lastModifiedField = tstamp
changeFreqField = news_changefreq
priorityField = news_priority
additionalWhere = AND ({#no_index} = 0 OR {#no_follow} = 0)
pid = <page id('s) containing news records>
recursive = <number of subpage levels taken into account beyond the pid page. (default: 0)>
url {
pageId = <your detail page id>
fieldToParameterMap {
uid = tx_extension_pi1[news]
}
additionalGetParameters {
tx_extension_pi1.controller = News
tx_extension_pi1.action = detail
}
}
}
}
}
}
}
}
You can add multiple sitemaps and they will be added to the sitemap index automatically. Use different types to have multiple, independent sitemaps:
seo_googlenews < seo_sitemap
seo_googlenews.typeNum = 1571859552
seo_googlenews.10.sitemapType = googleNewsSitemap
plugin.tx_seo {
config {
xmlSitemap {
sitemaps {
news {
provider = GeorgRinger\News\Seo\NewsXmlSitemapDataProvider
config {
# ...
}
}
}
}
googleNewsSitemap {
sitemaps {
news {
provider = GeorgRinger\News\Seo\NewsXmlSitemapDataProvider
config {
googleNews = 1
# ...
template = GoogleNewsXmlSitemap.xml
}
}
}
}
}
}
Change frequency and priority
Change frequencies define how often each page is approximately updated and hence how often it should be revisited (for example: News in an archive are "never" updated, while your home page might get "weekly" updates).
Priority allows you to define how important the page is compared to other pages on your site. The priority is stated in a value from 0 to 1. Your most important pages can get an higher priority as other pages. This value does not affect how important your pages are compared to pages of other websites. All pages and records get a priority of 0.5 by default.
The settings can be defined in the TypoScript configuration of an XML sitemap by
mapping the properties to fields of the record by using the options
change
and priority
.
change
needs to point to a field containing string values
(see pages
TCA definition of field
sitemap_
), priority
needs to point to
a field with a decimal value between 0 and 1.
Note
Both the priority and the change frequency have no impact on your rankings. These options only give hints to search engines in which order and how often you would like a crawler to visit your pages.
Sitemap of records without sorting field
Sitemaps are paginated by default. To ensure that as few pages of the sitemap as possible are changed after the number of records is changed, the items in the sitemaps are ordered. By default, this is done using a sorting field. If you do not have such a field, make sure to configure this in your sitemap configuration and use a different field. An example you can use for sorting based on the uid field:
Create a custom XML sitemap provider
If you need more logic in your sitemap, you can also write your own
sitemap provider. You can do this by extending the
\TYPO3\
class or
implementing \TYPO3\
.
The main methods of interest are get
and get
.
The get
method is used in the sitemap index and has to
return the date of the last modified item in the sitemap.
The get
method has to return an array with the items for the
sitemap:
$this->items[] = [
'loc' => 'https://example.org/page1.html',
'lastMod' => '1536003609'
];
The loc
element is the URL of the page to be crawled by a search engine.
The last
element contains the date of the last update of the
specific item. This value is a UNIX timestamp. In addition, you can include
changefreq
and priority
as keys in the array to give
search engines a hint.
Use a customized sitemap XSL file
The XSL file used to create a layout for an XML sitemap can be configured at three levels:
-
For all sitemaps:
EXT:my_extension/Configuration/TypoScript/setup.typoscriptplugin.tx_seo.config { xslFile = EXT:my_extension/Resources/Public/CSS/mySite.xsl }
Copied! -
For all sitemaps of a certain sitemapType:
EXT:my_extension/Configuration/TypoScript/setup.typoscriptplugin.tx_seo.config.mySitemapType.sitemaps { xslFile = EXT:my_extension/Resources/Public/CSS/mySite.xsl }
Copied! -
For a specific sitemap:
EXT:my_extension/Configuration/TypoScript/setup.typoscriptplugin.tx_seo.config.xmlSitemap.sitemaps.myNewsSitemap.config { xslFile = EXT:my_extension/Resources/Public/CSS/mySite.xsl }
Copied!
The value is inherited until it is overwritten.
If no value is specified at all, EXT:
is used as default.