Skip to content

Commit 46c7f79

Browse files
github-actions[bot]linawolf
github-actions[bot]
and
linawolf
authored
[TASK] Update Site management section (#579)
Releases: main, 13.4, 12.4 Co-authored-by: lina.wolf <[email protected]>
1 parent e871282 commit 46c7f79

File tree

8 files changed

+243
-0
lines changed

8 files changed

+243
-0
lines changed

‎Documentation/Concepts/Backend/Index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ see when browsing the site.
2727
PageModule/Index
2828
ListModule/Index
2929
FileModule/Index
30+
SiteManagement/Index
3031
InfoModule/Index
3132
AdminTools/Index
3233
SystemModules/Index

‎Documentation/Concepts/Backend/SiteManagement/Index.rst‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:navigation-title: Site Management
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-modules:
4+
5+
=======================
6+
Site Management modules
7+
=======================
8+
9+
The modules in this group manage and configure a site in your installation.
10+
11+
It is possible to manage more then one web site within one TYPO3 installation.
12+
In the beginning you will probably only have one site in your installation.
13+
14+
The following modules are available in a full TYPO3 installation:
15+
16+
.. toctree::
17+
:glob:
18+
:titlesonly:
19+
20+
Sites
21+
Settings
22+
Redirects
23+
PageTSconfig
24+
TypoScript

‎Documentation/Concepts/Backend/SiteManagement/PageTSconfig.rst‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
:navigation-title: Page TSconfig
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-page-tsconfig:
4+
5+
======================================
6+
Page TSconfig module (Site management)
7+
======================================
8+
9+
This module works in a similar way like the
10+
:ref:`TypoScript module <site-management-typoscript>`.
11+
12+
Page TSconfig and TypoScript both use the same syntax and are loaded in a similar
13+
fashion.
14+
15+
.. _site-management-page-tsconfig-overview:
16+
17+
Pages containing page TSconfig
18+
==============================
19+
20+
Until TYPO3 version 13 page TSconfig was either added globally via a file
21+
called :file:`EXT:my_extension/Configuration/page.tsconfig` or inserted or
22+
included in the record of a page in the page properties. Doing so is still
23+
possible for backward compatibility reasons.
24+
25+
If you included the Page TSconfig via a site set or globally it
26+
not displayed in the overview submodule.
27+
28+
This does not mean it is not being loaded.
29+
30+
.. _site-management-page-tsconfig-active:
31+
32+
Active page TSconfig
33+
====================
34+
35+
This module works much like :ref:`site-management-typoscript-active`.
36+
37+
.. _site-management-page-tsconfig-included:
38+
39+
Included page TSconfig
40+
======================
41+
42+
This module works much like :ref:`site-management-typoscript-included`, however
43+
the sources from which TSconfig is being loaded are different.
44+
45+
In this Guide we assume that you load page TSconfig via the the site set of your
46+
site package. The TSconfig Reference gives you an overview of all possible
47+
strategies to set page TSconfig:
48+
:ref:`Setting page TSconfig <t3tsconfig:setting-page-tsconfig>`.
49+
50+
And to make confusion perfect there is also user TSconfig, which is loaded on a
51+
per user basis: :ref:`Setting user TSconfig <t3tsconfig:setting-user-tsconfig>`
52+
and can override page TSconfig:
53+
:ref:`Overriding page TSconfig in user TSconfig <t3tsconfig:pageoverridingpagetsconfigwithusertsconfig>`
54+
55+
These topics are beyond the scope of this Guide however.

‎Documentation/Concepts/Backend/SiteManagement/Redirects.rst‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
:navigation-title: Redirects
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-redirects:
4+
5+
==================================
6+
Redirects module (Site management)
7+
==================================
8+
9+
This backend module is only available if the optional system extension
10+
:composer:`typo3/cms-redirects` is installed.
11+
12+
The the Redirects system extension has a dedicated manual in which the
13+
:doc:`Usage <typo3/cms-redirects:Usage/Index#usage>` of this module is
14+
described.

‎Documentation/Concepts/Backend/SiteManagement/Settings.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:navigation-title: Settings
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-settings:
4+
5+
=================================
6+
Settings module (Site management)
7+
=================================
8+
9+
.. note::
10+
Content will follow, for now see TYPO3 explained,
11+
:ref:`Site settings <t3coreapi:sitehandling-settings>`.

‎Documentation/Concepts/Backend/SiteManagement/Sites.rst‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
:navigation-title: Site
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-site-configuration:
4+
5+
=========================
6+
Site configuration module
7+
=========================
8+
9+
.. note::
10+
Content will follow, for now see TYPO3 explained,
11+
:ref:`Creating a new site configuration <t3coreapi:sitehandling-create-new>`.

‎Documentation/Concepts/Backend/SiteManagement/TypoScript.rst‎

Lines changed: 127 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,127 @@
1+
:navigation-title: TypoScript
2+
.. include:: /Includes.rst.txt
3+
.. _site-management-typoscript:
4+
5+
===================================
6+
TypoScript module (Site management)
7+
===================================
8+
9+
The TypoScript backend module can be used to debug the TypoScript configuration
10+
that you provided via your site as described in
11+
:ref:`"Hello world" example in TypoScript <t3start:typoscript-hello-world>`
12+
or via your site set as described in the Site Package Tutorial, chapter
13+
:ref:`The TypoScript-only version <t3sitepackage:make-typoscript-available>`.
14+
15+
Before TYPO3 v13 TypoScript was managed via database records, called "TypoScript
16+
records". It is still possible doing this and you will see it in older examples
17+
or installations that have been updated and not refactored. This module can
18+
also be used to manage TypoScript records. Its usage is described in
19+
TypoScript Reference, chapter
20+
:ref:`TypoScript backend module <t3tsref:typoscript-syntax-typoscript-templates-structure>`.
21+
22+
In the context of this guide we concentrate on the new way of providing TypoScript
23+
via the site only.
24+
25+
The TypoScript module consists of the following submodules. You can switch them
26+
in the docheader:
27+
28+
.. figure:: /Images/ManualScreenshots/Modules/TypoScript.png
29+
:alt: Screenshot of the TypoScript module in the backend demonstrating the location of the submodule switch, a drop down in the document header
30+
31+
Switch between the TypoScript submodules in
32+
33+
.. contents::
34+
35+
.. _site-management-typoscript-overview:
36+
37+
TypoScript Overview
38+
===================
39+
40+
Global overview of all pages with active TypoScript definitions (TypoScript
41+
records and site sets). Useful if you have more then one site or more then one
42+
TypoScript record in one site.
43+
44+
.. _site-management-typoscript-constant-editor:
45+
46+
Constant Editor
47+
===============
48+
49+
Before site settings were introduced with TYPO3 13, TypoScript constants where
50+
used to define values once and reuse them across TypoScript definitions.
51+
52+
Constants can still be used for backward compatibility reasons but the
53+
Constant Editor is not available if you are using site sets. Other
54+
then site settings, TypoScript constants are only available within TypoScript.
55+
56+
It is therefore recommended to always use site settings.
57+
58+
.. _site-management-typoscript-record-editor:
59+
60+
Edit TypoScript record
61+
======================
62+
63+
Only available if TypoScript records are being used. Can be used to edit those
64+
records. As we manage TypoScript within the site in this Guide it is out of
65+
scope of this Guide. Its usage is described in the TypoScript reference,
66+
chapter :ref:`Submodule "Edit TypoScript Record" <t3tsref:typoscript_module_edit>`.
67+
68+
.. _site-management-typoscript-active:
69+
70+
Active TypoScript
71+
=================
72+
73+
This module can be used to debug the active TypoScript. During loading and
74+
pre compiling TypoScript configuration can override or unset definitions made in
75+
another file.
76+
77+
How exactly this happens depends on things like dependencies between the used
78+
site sets.
79+
80+
For example if a site set in your site package configures:
81+
82+
.. code-block:: typoscript
83+
:caption: EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript
84+
85+
page.20 = TEXT
86+
page.20.value = Apple
87+
88+
And the set of another extensions configures:
89+
90+
.. code-block:: typoscript
91+
:caption: EXT:some_extension/Configuration/Sets/BananaSet/setup.typoscript
92+
93+
page.20 = TEXT
94+
page.20.value = Banana
95+
96+
It depends on how these sets are loaded weather the `page.20.value` ends up
97+
being set to "Banana" or "Apple".
98+
99+
If the site set of our site package **depends** on the Banana set, the
100+
SitePackage set **overrides** the Banana set and the Active TypoScript submodule
101+
will show you the value "Apple" while it never mentions Banana.
102+
103+
This module therefore shows you the compiled version of the TypoScript.
104+
105+
The module can also be used to simulate what happens if certain
106+
:ref:`TypoScript Conditions <t3tsref:typoscript-syntax-implementing-custom-conditions>`
107+
are being met or how site settings / TypoScript constants are replaced.
108+
109+
Chapter :ref:`Debug the TypoScript in the backend module "Active
110+
TypoScript" <typoscript-active-debug>` demonstrates the usage of this module in
111+
a concrete example.
112+
113+
.. _site-management-typoscript-included:
114+
115+
Included TypoScript
116+
===================
117+
118+
This submodule is helpful in debugging in which order TypoScript files were
119+
included and :ref:`@import <t3tsref:typoscript-syntax-import>` statements were
120+
resolved.
121+
122+
If the "Banana" from the example in :ref:`site-management-typoscript-active`
123+
was overridden, you can use this module to find out where it might have been
124+
overridden.
125+
126+
This module is also described in the TypoScript reference, chapter
127+
:ref:`Submodule "Included TypoScript" <t3tsref:typoscript-syntax-typoscript-templates-structure-analyzer>`.

‎Documentation/Images/ManualScreenshots/Modules/TypoScript.png‎

31.9 KB
Loading

0 commit comments

Comments
 (0)