Skip to content

Commit 9ed78fd

Browse files
linawolfsbuerk
authored andcommitted
[DOCS] Document site sets of EXT:seo
This patch adds a description on how to utilize site sets from `EXT:seo` to the Configuration section. Resolves: #104600 Releases: main Change-Id: I79f206d08692ad905d29f2fe30d1b09993b99b82 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/85608 Tested-by: core-ci <[email protected]> Reviewed-by: Sandra Erbel <[email protected]> Tested-by: Garvin Hicking <[email protected]> Reviewed-by: Garvin Hicking <[email protected]> Tested-by: Stefan Bürk <[email protected]> Reviewed-by: Stefan Bürk <[email protected]> Tested-by: Sandra Erbel <[email protected]>
1 parent e292fad commit 9ed78fd

File tree

5 files changed

+71
-0
lines changed

5 files changed

+71
-0
lines changed

typo3/sysext/seo/Documentation/Configuration/Index.rst

+37
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,43 @@ Configuration
99

1010
Target group: **Developers, Integrators**
1111

12+
.. contents::
13+
:caption: Content on this page
14+
:depth: 1
15+
16+
.. toctree::
17+
:caption: Subpages
18+
:glob:
19+
20+
*
21+
22+
.. _configuration-site-sets:
23+
24+
Site sets
25+
=========
26+
27+
.. versionadded::13.3
28+
EXT:seo now offers a site set "SEO Sitemap" to include the TypoScript to
29+
output the XML sitemap.
30+
31+
Include the site set "SEO Sitemap" via the :ref:`site set in the site
32+
configuration <t3coreapi:site-sets>` or the custom
33+
:ref:`site package's site set <t3sitepackage:site_set>`.
34+
35+
.. figure:: /Images/SiteSet.png
36+
37+
Add the site set "SEO Sitemap"
38+
39+
This will change your site configuration file as follows:
40+
41+
.. literalinclude:: _site_config.diff
42+
:caption: config/sites/my-site/config.yaml (diff)
43+
44+
If your site has a custom :ref:`site package <t3sitepackage:start>`, you
45+
can also add the "SEO Sitemap" set as dependency in your site's configuration:
46+
47+
.. literalinclude:: _site_package_set.diff
48+
:caption: EXT:my_site_package/Configuration/Sets/MySite/config.yaml (diff)
1249

1350
TypoScript Settings
1451
===================
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
:navigation-title: Settings
2+
3+
.. include:: /Includes.rst.txt
4+
5+
.. _configuration-site-set-settings:
6+
7+
=============================
8+
Site sets settings of EXT:seo
9+
=============================
10+
11+
.. versionadded:: 13.3
12+
Site sets have been added, their settings supersede using TypoScript
13+
constants for settings.
14+
15+
The following settings are available via the :ref:`site set settings <configuration-site-sets>`:
16+
17+
.. typo3:site-set-settings:: PROJECT:/Configuration/Sets/Sitemap/settings.definitions.yaml
18+
:name: seo-settings
19+
:type:
20+
:Label: Settings of the site set of EXT:seo
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
base: 'https://example.com/'
2+
rootPageId: 1
3+
dependencies:
4+
- typo3/fluid-styled-content-css
5+
+ - typo3/seo-sitemap
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
name: my-vendor/my-site-package
2+
label: My Site Package Set
3+
settings:
4+
website:
5+
background:
6+
color: '#386492'
7+
dependencies:
8+
- typo3/fluid-styled-content-css
9+
+ - typo3/seo-sitemap
Loading

0 commit comments

Comments
 (0)