Skip to content

Commit f4eff4e

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

File tree

8 files changed

+211
-2
lines changed

8 files changed

+211
-2
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/PageModule/Index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Within the Page module there can be one or more areas (also called columns)
2323
in which content can be added. The columns to be displayed in the backend
2424
are defined via page TSconfig in a so-called backend layout, sometimes also
2525
called page layout. The site package tutorial describes how page layouts
26-
can be configured and used: :ref:`Page layouts with page
27-
TSconfig <t3sitepackage:content-mapping-backend-layout>`.
26+
can be configured and used: :doc:`Page layouts with page
27+
TSconfig <t3sitepackage:ContentMapping/Index#define-the-backend-layouts>`.
2828

2929
The topic is also covered in-depth in the TSconfig Reference,
3030
chapter :ref:`Backend layouts <t3tsconfig:backend-layouts>`.

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
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+
Redirects
22+
PageTSconfig
23+
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/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: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
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 your TypoScript configuration.
10+
11+
TypoScript is managed via database records, called "TypoScript
12+
records". This module can
13+
be used to manage TypoScript records. Its usage is described in
14+
TypoScript Reference, chapter
15+
:ref:`TypoScript backend module <t3tsref:typoscript-syntax-typoscript-templates-structure>`.
16+
17+
The TypoScript module consists of the following submodules. You can switch them
18+
in the docheader:
19+
20+
.. figure:: /Images/ManualScreenshots/Modules/TypoScript.png
21+
:alt: Screenshot of the TypoScript module in the backend demonstrating the location of the submodule switch, a drop down in the document header
22+
23+
Switch between the TypoScript submodules in
24+
25+
.. contents::
26+
27+
.. _site-management-typoscript-overview:
28+
29+
TypoScript Overview
30+
===================
31+
32+
Global overview of all pages with active TypoScript definitions (TypoScript
33+
records and site sets). Useful if you have more then one site or more then one
34+
TypoScript record in one site.
35+
36+
.. _site-management-typoscript-constant-editor:
37+
38+
Constant Editor
39+
===============
40+
41+
TypoScript constants are
42+
used to define values once and reuse them across TypoScript definitions.
43+
44+
This editor can be used to edit Constants that have been defined in Extensions
45+
with a special kind of comments. They are not widely supported anymore.
46+
47+
.. _site-management-typoscript-record-editor:
48+
49+
Edit TypoScript record
50+
======================
51+
52+
Can be used to edit TypoScript records.
53+
54+
Its usage is described in the TypoScript reference,
55+
chapter :ref:`Submodule "Edit TypoScript Record" <t3tsref:typoscript_module_edit>`.
56+
57+
.. _site-management-typoscript-active:
58+
59+
Active TypoScript
60+
=================
61+
62+
This module can be used to debug the active TypoScript. During loading and
63+
pre compiling TypoScript configuration can override or unset definitions made in
64+
another file.
65+
66+
How exactly this happens depends on things like loading order.
67+
68+
For example if the TypoScript in your site package configures:
69+
70+
.. code-block:: typoscript
71+
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript
72+
73+
page.20 = TEXT
74+
page.20.value = Apple
75+
76+
And the TypoScript of another extensions configures:
77+
78+
.. code-block:: typoscript
79+
:caption: EXT:some_extension/Configuration/TypoScript/setup.typoscript
80+
81+
page.20 = TEXT
82+
page.20.value = Banana
83+
84+
It depends on how these includes are loaded weather the `page.20.value` ends up
85+
being set to "Banana" or "Apple".
86+
87+
The module can also be used to simulate what happens if certain
88+
:ref:`TypoScript Conditions <t3tsref:typoscript-syntax-implementing-custom-conditions>`
89+
are being met or how site settings / TypoScript constants are replaced.
90+
91+
Chapter :ref:`Debug the TypoScript in the backend module "Active
92+
TypoScript" <typoscript-active-debug>` demonstrates the usage of this module in
93+
a concrete example.
94+
95+
.. _site-management-typoscript-included:
96+
97+
Included TypoScript
98+
===================
99+
100+
This submodule is helpful in debugging in which order TypoScript files were
101+
included and :ref:`@import <t3tsref:typoscript-syntax-import>` statements were
102+
resolved.
103+
104+
This module is also described in the TypoScript reference, chapter
105+
: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)