-
Notifications
You must be signed in to change notification settings - Fork 172
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[TASK] Update Site management section (#568)
Releases: main, 13.4, 12.4
- Loading branch information
Showing
8 changed files
with
243 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
:navigation-title: Site Management | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-modules: | ||
|
||
======================= | ||
Site Management modules | ||
======================= | ||
|
||
The modules in this group manage and configure a site in your installation. | ||
|
||
It is possible to manage more then one web site within one TYPO3 installation. | ||
In the beginning you will probably only have one site in your installation. | ||
|
||
The following modules are available in a full TYPO3 installation: | ||
|
||
.. toctree:: | ||
:glob: | ||
:titlesonly: | ||
|
||
Sites | ||
Settings | ||
Redirects | ||
PageTSconfig | ||
TypoScript |
55 changes: 55 additions & 0 deletions
55
Documentation/Concepts/Backend/SiteManagement/PageTSconfig.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
:navigation-title: Page TSconfig | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-page-tsconfig: | ||
|
||
====================================== | ||
Page TSconfig module (Site management) | ||
====================================== | ||
|
||
This module works in a similar way like the | ||
:ref:`TypoScript module <site-management-typoscript>`. | ||
|
||
Page TSconfig and TypoScript both use the same syntax and are loaded in a similar | ||
fashion. | ||
|
||
.. _site-management-page-tsconfig-overview: | ||
|
||
Pages containing page TSconfig | ||
============================== | ||
|
||
Until TYPO3 version 13 page TSconfig was either added globally via a file | ||
called :file:`EXT:my_extension/Configuration/page.tsconfig` or inserted or | ||
included in the record of a page in the page properties. Doing so is still | ||
possible for backward compatibility reasons. | ||
|
||
If you included the Page TSconfig via a site set or globally it | ||
not displayed in the overview submodule. | ||
|
||
This does not mean it is not being loaded. | ||
|
||
.. _site-management-page-tsconfig-active: | ||
|
||
Active page TSconfig | ||
==================== | ||
|
||
This module works much like :ref:`site-management-typoscript-active`. | ||
|
||
.. _site-management-page-tsconfig-included: | ||
|
||
Included page TSconfig | ||
====================== | ||
|
||
This module works much like :ref:`site-management-typoscript-included`, however | ||
the sources from which TSconfig is being loaded are different. | ||
|
||
In this Guide we assume that you load page TSconfig via the the site set of your | ||
site package. The TSconfig Reference gives you an overview of all possible | ||
strategies to set page TSconfig: | ||
:ref:`Setting page TSconfig <t3tsconfig:setting-page-tsconfig>`. | ||
|
||
And to make confusion perfect there is also user TSconfig, which is loaded on a | ||
per user basis: :ref:`Setting user TSconfig <t3tsconfig:setting-user-tsconfig>` | ||
and can override page TSconfig: | ||
:ref:`Overriding page TSconfig in user TSconfig <t3tsconfig:pageoverridingpagetsconfigwithusertsconfig>` | ||
|
||
These topics are beyond the scope of this Guide however. |
14 changes: 14 additions & 0 deletions
14
Documentation/Concepts/Backend/SiteManagement/Redirects.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
:navigation-title: Redirects | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-redirects: | ||
|
||
================================== | ||
Redirects module (Site management) | ||
================================== | ||
|
||
This backend module is only available if the optional system extension | ||
:composer:`typo3/cms-redirects` is installed. | ||
|
||
The the Redirects system extension has a dedicated manual in which the | ||
:doc:`Usage <typo3/cms-redirects:Usage/Index#usage>` of this module is | ||
described. |
11 changes: 11 additions & 0 deletions
11
Documentation/Concepts/Backend/SiteManagement/Settings.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
:navigation-title: Settings | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-settings: | ||
|
||
================================= | ||
Settings module (Site management) | ||
================================= | ||
|
||
.. note:: | ||
Content will follow, for now see TYPO3 explained, | ||
:ref:`Site settings <t3coreapi:sitehandling-settings>`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
:navigation-title: Site | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-site-configuration: | ||
|
||
========================= | ||
Site configuration module | ||
========================= | ||
|
||
.. note:: | ||
Content will follow, for now see TYPO3 explained, | ||
:ref:`Creating a new site configuration <t3coreapi:sitehandling-create-new>`. |
127 changes: 127 additions & 0 deletions
127
Documentation/Concepts/Backend/SiteManagement/TypoScript.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
:navigation-title: TypoScript | ||
.. include:: /Includes.rst.txt | ||
.. _site-management-typoscript: | ||
|
||
=================================== | ||
TypoScript module (Site management) | ||
=================================== | ||
|
||
The TypoScript backend module can be used to debug the TypoScript configuration | ||
that you provided via your site as described in | ||
:ref:`"Hello world" example in TypoScript <t3start:typoscript-hello-world>` | ||
or via your site set as described in the Site Package Tutorial, chapter | ||
:ref:`The TypoScript-only version <t3sitepackage:make-typoscript-available>`. | ||
|
||
Before TYPO3 v13 TypoScript was managed via database records, called "TypoScript | ||
records". It is still possible doing this and you will see it in older examples | ||
or installations that have been updated and not refactored. This module can | ||
also be used to manage TypoScript records. Its usage is described in | ||
TypoScript Reference, chapter | ||
:ref:`TypoScript backend module <t3tsref:typoscript-syntax-typoscript-templates-structure>`. | ||
|
||
In the context of this guide we concentrate on the new way of providing TypoScript | ||
via the site only. | ||
|
||
The TypoScript module consists of the following submodules. You can switch them | ||
in the docheader: | ||
|
||
.. figure:: /Images/ManualScreenshots/Modules/TypoScript.png | ||
:alt: Screenshot of the TypoScript module in the backend demonstrating the location of the submodule switch, a drop down in the document header | ||
|
||
Switch between the TypoScript submodules in | ||
|
||
.. contents:: | ||
|
||
.. _site-management-typoscript-overview: | ||
|
||
TypoScript Overview | ||
=================== | ||
|
||
Global overview of all pages with active TypoScript definitions (TypoScript | ||
records and site sets). Useful if you have more then one site or more then one | ||
TypoScript record in one site. | ||
|
||
.. _site-management-typoscript-constant-editor: | ||
|
||
Constant Editor | ||
=============== | ||
|
||
Before site settings were introduced with TYPO3 13, TypoScript constants where | ||
used to define values once and reuse them across TypoScript definitions. | ||
|
||
Constants can still be used for backward compatibility reasons but the | ||
Constant Editor is not available if you are using site sets. Other | ||
then site settings, TypoScript constants are only available within TypoScript. | ||
|
||
It is therefore recommended to always use site settings. | ||
|
||
.. _site-management-typoscript-record-editor: | ||
|
||
Edit TypoScript record | ||
====================== | ||
|
||
Only available if TypoScript records are being used. Can be used to edit those | ||
records. As we manage TypoScript within the site in this Guide it is out of | ||
scope of this Guide. Its usage is described in the TypoScript reference, | ||
chapter :ref:`Submodule "Edit TypoScript Record" <t3tsref:typoscript_module_edit>`. | ||
|
||
.. _site-management-typoscript-active: | ||
|
||
Active TypoScript | ||
================= | ||
|
||
This module can be used to debug the active TypoScript. During loading and | ||
pre compiling TypoScript configuration can override or unset definitions made in | ||
another file. | ||
|
||
How exactly this happens depends on things like dependencies between the used | ||
site sets. | ||
|
||
For example if a site set in your site package configures: | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:site_package/Configuration/Sets/SitePackage/setup.typoscript | ||
page.20 = TEXT | ||
page.20.value = Apple | ||
And the set of another extensions configures: | ||
|
||
.. code-block:: typoscript | ||
:caption: EXT:some_extension/Configuration/Sets/BananaSet/setup.typoscript | ||
page.20 = TEXT | ||
page.20.value = Banana | ||
It depends on how these sets are loaded weather the `page.20.value` ends up | ||
being set to "Banana" or "Apple". | ||
|
||
If the site set of our site package **depends** on the Banana set, the | ||
SitePackage set **overrides** the Banana set and the Active TypoScript submodule | ||
will show you the value "Apple" while it never mentions Banana. | ||
|
||
This module therefore shows you the compiled version of the TypoScript. | ||
|
||
The module can also be used to simulate what happens if certain | ||
:ref:`TypoScript Conditions <t3tsref:typoscript-syntax-implementing-custom-conditions>` | ||
are being met or how site settings / TypoScript constants are replaced. | ||
|
||
Chapter :ref:`Debug the TypoScript in the backend module "Active | ||
TypoScript" <typoscript-active-debug>` demonstrates the usage of this module in | ||
a concrete example. | ||
|
||
.. _site-management-typoscript-included: | ||
|
||
Included TypoScript | ||
=================== | ||
|
||
This submodule is helpful in debugging in which order TypoScript files were | ||
included and :ref:`@import <t3tsref:typoscript-syntax-import>` statements were | ||
resolved. | ||
|
||
If the "Banana" from the example in :ref:`site-management-typoscript-active` | ||
was overridden, you can use this module to find out where it might have been | ||
overridden. | ||
|
||
This module is also described in the TypoScript reference, chapter | ||
:ref:`Submodule "Included TypoScript" <t3tsref:typoscript-syntax-typoscript-templates-structure-analyzer>`. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.