Skip to content

Commit 992531d

Browse files
[TASK] Update introduction (#1448)
Releases: main, 13.4, 12.4 Co-authored-by: lina.wolf <[email protected]>
1 parent 8aae6e2 commit 992531d

File tree

1 file changed

+40
-47
lines changed

1 file changed

+40
-47
lines changed
Lines changed: 40 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,71 +1,64 @@
1+
:navigation-title: Introduction
12
.. include:: /Includes.rst.txt
3+
.. _typoscript-syntax-typoscript-templates:
4+
.. _typoscript-syntax-typoscript-templates-usage:
5+
.. _introduction:
26

3-
.. _about:
4-
.. _introduction:
7+
============================
8+
Introduction into TypoScript
9+
============================
510

6-
============
7-
Introduction
8-
============
11+
TypoScript is a configuration language used to configure both the frontend
12+
output and the backend of a a TYPO3 web site.
913

10-
This document serves as a manual for TypoScript and TSconfig, two
11-
essential configuration tools in TYPO3.
12-
13-
.. _typoscript-syntax-typoscript-templates:
14-
15-
TypoScript
16-
==========
17-
18-
TypoScript is a configuration language used to define the frontend rendering
19-
in TYPO3. It is not a programming language but a means of configuring the
14+
TypoScript is not a programming language but a means of configuring the
2015
website.
2116

22-
Key sections to explore:
23-
24-
* :ref:`TypoScript Syntax <typoscript-syntax>` for an introduction to the syntax.
25-
* :ref:`TypoScript Reference <data-types>` for details on data types, object types, functions, and conditions.
26-
* :ref:`guide` for configuring frontend behavior using TypoScript.
27-
* :ref:`using-and-setting` for extending and setting TypoScript properties.
17+
.. contents::
2818

29-
.. _typoscript-syntax-typoscript-templates-usage:
19+
.. _introduction-frontend-typoscript:
3020

31-
Templating in TYPO3
21+
Frontend TypoScript
3222
===================
3323

34-
Frontend rendering in TYPO3 can use several methods, each requiring some TypoScript configuration:
24+
Frontend TypoScript is mainly used to configure which data should be send to the
25+
Fluid templates.
3526

36-
**Best Practice:**
27+
It can also be used to define settings send to Extbase plugins, metadata for
28+
a whole page etc.
3729

38-
- **Fluid Templates**: Use the `Fluid <https://typo3.org/fluid>`__ engine with TypoScript's :ref:`cobj-fluidtemplate` to integrate external HTML templates with Fluid variables.
39-
* See :ref:`t3sitepackage:start` for creating site packages and custom themes.
40-
* See :ref:`t3coreapi:adding-your-own-content-elements` to create custom content elements with TypoScript and Fluid.
30+
In the beginning of TYPO3, TypoScript was used as templating language. In modern
31+
project it is not common to do that anymore.
4132

42-
**Other Methods:**
33+
For an introduction see
34+
`Getting started: A quick introduction into TypoScript <https://docs.typo3.org/permalink/t3tsref:guide>`_.
4335

44-
- External templating engines via extensions.
45-
- Custom PHP code for advanced use cases.
46-
- TypoScript content objects for fully configurable rendering.
47-
48-
**Outdated Method:**
36+
.. _about-tsconfig:
4937

50-
- **HTML Templates** using markers and subparts (:ref:`cobj-template`) are no longer recommended.
38+
Backend TypoScript / TSconfig
39+
=============================
5140

52-
.. _about-tsconfig:
41+
Backend TypoScript, also called TSconfig, can be used to configure the output
42+
of certain forms etc in the TYPO3 backend.
5343

54-
TSconfig
55-
========
44+
.. _about-page-tsconfig:
5645

57-
TSconfig customizes the TYPO3 backend for pages, users, and groups without requiring PHP code. It is a TypoScript-like syntax, used for backend configuration, distinct from TypoScript, which configures the frontend.
46+
Page TSconfig
47+
-------------
5848

59-
**Key Concepts:**
49+
Page TSconfig can be made available globally, on a per site or per page level.
6050

61-
- **Page TSconfig**: Configures backend behavior on a per-page basis.
62-
- **User TSconfig**: Configures options for specific users or groups.
51+
For the possibilities see the
52+
`Page TSconfig Reference <https://docs.typo3.org/permalink/t3tsref:pagetoplevelobjects>`_.
6353

64-
TSconfig is primarily for integrators to control what backend users see and interact with, including:
54+
.. _about-user-tsconfig:
6555

66-
- Configuring backend options and views.
67-
- Customizing the Admin Panel in the frontend, which is tightly linked to backend user roles.
56+
User TSconfig
57+
-------------
6858

69-
For details on syntax, refer to :ref:`TYPO3 Explained <t3tsref:typoscript-syntax>`. Remember, properties from the :ref:`TypoScript Reference <t3tsref:start>` cannot be used in TSconfig and vice versa.
59+
User TSconfig can be made available globally for certain user groups or certain
60+
users. It cannot be set for just one site or page. It can however override
61+
:ref:`about-page-tsconfig`.
7062

71-
This document provides the foundational concepts and serves as a reference for both TypoScript and TSconfig, empowering developers and integrators to customize TYPO3 effectively.
63+
For the possibilities see the
64+
`User TSconfig reference <https://docs.typo3.org/permalink/t3tsref:usertoplevelobjects>`_.

0 commit comments

Comments
 (0)