Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Overhaul Introduction (#562)
Browse files Browse the repository at this point in the history
Releases:main

Co-authored-by: Sarah McCarthy <[email protected]>
  • Loading branch information
github-actions[bot] and sarahmccarthy123 authored Nov 4, 2024
1 parent f334f8f commit 95fe155
Showing 1 changed file with 35 additions and 32 deletions.
67 changes: 35 additions & 32 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,20 @@ Introduction
About this document
===================

This document describes TSconfig and its options: A TypoScript a-like configuration
syntax to configure details of the backend for backend users based on a user, group and page level.
This document describes TSconfig and its options. Tsconfig is a TypoScript-like configuration
syntax which is used to configure parts of the backend based on user, group and page.

This document can be seen as detail below the main :ref:`TYPO3 Explained <t3coreapi:start>` documentation.
It is too huge to be integrated into TYPO3 Explained directly.
This document can be seen as detail below the main :ref:`TYPO3 Explained <t3coreapi:start>`
documentation as this section is too big to be included there.

First parts of this document explain the concepts of TSconfig, the different places it can be
found in the system, how it can be diagnosed, and goes a bit into the PHP API if developers
need to access data from TSconfig.
The rest of the document is a reference: A document to look-up and find properties on a daily basis.
The first parts of this document explain concepts related to TSconfig, where it
can be found in the system, how it can be debugged, and how developers
can access data from TSconfig via the the PHP API.

This document is especially important for integrators who want to make life as easy as possible
The rest of the document can be used as a reference for looking up properties as
you need them.

This document is especially important for integrators wanting to make life as easy as possible
for their dear backend users.

.. index:: ! TSconfig
Expand All @@ -30,35 +32,36 @@ for their dear backend users.
About TSconfig
==============

TSconfig is used in TYPO3 to configure and customize the backend on a page and
a user or group basis. The syntax to do this is based on `TypoScript` that is also
used to configure frontend output of the web site.
TSconfig is used in TYPO3 to configure and customize the backend on a page, user
or group basis. Its syntax is based on the `TypoScript` that is
used to configure the frontend output of the web site.

The whole point of TSconfig is that it allows configuration of backend details
by integrators, without asking developers for writing PHP code. Thus, some areas
of TSconfig are rather powerful and offer vast possibilities of customizing the TYPO3 backend.
The whole point of TSconfig is that integrators can configure parts of the backend
without having to ask developers to write PHP code. This means that some areas
of TSconfig are very powerful and provide a lot of different ways of customizing the
TYPO3 backend.

TSconfig is divided into configuration for pages ("Page TSconfig") and configuration
for users and groups ("User TSconfig"). Each variant is further detailed in this document.
for users and groups ("User TSconfig"). Each type is further explained in this document.

The general "dotted notation" of `TypoScript` is re-used for Page TSconfig and
User TSconfig, it is possible to reference values, use conditions, and so on.
For a general look at the syntax, please read the according section of
The general "dotted notation" used in `TypoScript` is also used in Page TSconfig and
User TSconfig. It is possible to reference values, use conditions, and so on.
For a general look at the syntax, please read the relevant section in
:ref:`TYPO3 Explained <t3tsref:typoscript-syntax>`.

Other than the basic syntax, TSconfig and frontend TypoScript have nothing in common.
Properties outlined in the :ref:`TypoScript Reference <t3tsref:start>` can never be
used in TSconfig and vice versa. Frontend TypoScript and TSconfig are different
things: TypoScript is used to steer the rendering of the frontend web site, TSconfig
Other than basic syntax, TSconfig and frontend TypoScript have nothing in common.
Properties in the :ref:`TypoScript Reference <t3tsref:start>` cannot be
used in TSconfig and vice versa. TypoScript and TSconfig are two different
things: TypoScript is used to configure rendering of the frontend web site, TSconfig
is used to configure what is displayed to a logged in backend user.

While this might be confusing in the first place, it becomes clear as soon as integrators
start using TSconfig and looking at the available options: It is all about setting values
to configure if a backend users sees or does not see this-and-that, give a user additional
editing options, or removing them. As a last note to complete this picture: TSconfig is
also used to configure the "Admin panel" in the frontend. While this might look funny in the
first place, thinking about that makes clear on why admin panel configuration options are
bound to TSconfig and not to frontend TypoScript: The admin panel is basically a view to parts
of the backend that is shown in the frontend, it is entirely bound to backend users. So, the
admin panel is a backend thing, even if displayed in frontend, it is for backend users. This
While this might sound confusing at first, as soon as integrators
start using TSconfig and looking at the available options it is clear: it is all about setting values
to configure what a backend user does or does not see, give them additional
editing options, or removing them. And as a final point, TSconfig is
also used to configure the "Admin panel" in the frontend. While this might seem strange at
first, thinking about it makes it clear why admin panel configuration options are
bound to TSconfig and not to frontend TypoScript. The admin panel is basically a
frontend view of parts of the backend - it is entirely bound to the backend user. So the
admin panel is a backend thing. Even if it is displayed in the frontend it is meant for backend users. This
is why the admin panel is configured via TSconfig.

0 comments on commit 95fe155

Please sign in to comment.