|
| 1 | +:navigation-title: Introduction |
1 | 2 | .. include:: /Includes.rst.txt |
| 3 | +.. _typoscript-syntax-typoscript-templates: |
| 4 | +.. _typoscript-syntax-typoscript-templates-usage: |
| 5 | +.. _introduction: |
2 | 6 |
|
3 | | -.. _introduction: |
| 7 | +============================ |
| 8 | +Introduction into TypoScript |
| 9 | +============================ |
4 | 10 |
|
5 | | -============ |
6 | | -Introduction |
7 | | -============ |
| 11 | +TypoScript is a configuration language used to configure both the frontend |
| 12 | +output and the backend of a a TYPO3 web site. |
8 | 13 |
|
9 | | -This document serves as a manual for TypoScript and TSconfig, two |
10 | | -essential configuration tools in TYPO3. |
11 | | - |
12 | | -.. _typoscript-syntax-typoscript-templates: |
13 | | - |
14 | | -TypoScript |
15 | | -========== |
16 | | - |
17 | | -TypoScript is a configuration language used to define the frontend rendering |
18 | | -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 |
19 | 15 | website. |
20 | 16 |
|
21 | | -Key sections to explore: |
22 | | - |
23 | | -* :ref:`TypoScript Syntax <typoscript-syntax>` for an introduction to the syntax. |
24 | | -* :ref:`TypoScript Reference <data-types>` for details on data types, object types, functions, and conditions. |
25 | | -* :ref:`guide` for configuring frontend behavior using TypoScript. |
26 | | -* :ref:`using-and-setting` for extending and setting TypoScript properties. |
| 17 | +.. contents:: |
27 | 18 |
|
28 | | -.. _typoscript-syntax-typoscript-templates-usage: |
| 19 | +.. _introduction-frontend-typoscript: |
29 | 20 |
|
30 | | -Templating in TYPO3 |
| 21 | +Frontend TypoScript |
31 | 22 | =================== |
32 | 23 |
|
33 | | -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. |
34 | 26 |
|
35 | | -**Best Practice:** |
| 27 | +It can also be used to define settings send to Extbase plugins, metadata for |
| 28 | +a whole page etc. |
36 | 29 |
|
37 | | -- **Fluid Templates**: Use the `Fluid <https://typo3.org/fluid>`__ engine with TypoScript's :ref:`cobj-fluidtemplate` to integrate external HTML templates with Fluid variables. |
38 | | - * See :ref:`t3sitepackage:start` for creating site packages and custom themes. |
39 | | - * 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. |
40 | 32 |
|
41 | | -**Other Methods:** |
| 33 | +For an introduction see |
| 34 | +`Getting started: A quick introduction into TypoScript <https://docs.typo3.org/permalink/t3tsref:guide>`_. |
42 | 35 |
|
43 | | -- External templating engines via extensions. |
44 | | -- Custom PHP code for advanced use cases. |
45 | | -- TypoScript content objects for fully configurable rendering. |
46 | | - |
47 | | -**Outdated Method:** |
| 36 | +.. _about-tsconfig: |
48 | 37 |
|
49 | | -- **HTML Templates** using markers and subparts (:ref:`cobj-template`) are no longer recommended. |
| 38 | +Backend TypoScript / TSconfig |
| 39 | +============================= |
50 | 40 |
|
51 | | -.. _about-tsconfig: |
| 41 | +Backend TypoScript, also called TSconfig, can be used to configure the output |
| 42 | +of certain forms etc in the TYPO3 backend. |
52 | 43 |
|
53 | | -TSconfig |
54 | | -======== |
| 44 | +.. _about-page-tsconfig: |
55 | 45 |
|
56 | | -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 | +------------- |
57 | 48 |
|
58 | | -**Key Concepts:** |
| 49 | +Page TSconfig can be made available globally, on a per site or per page level. |
59 | 50 |
|
60 | | -- **Page TSconfig**: Configures backend behavior on a per-page basis. |
61 | | -- **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>`_. |
62 | 53 |
|
63 | | -TSconfig is primarily for integrators to control what backend users see and interact with, including: |
| 54 | +.. _about-user-tsconfig: |
64 | 55 |
|
65 | | -- Configuring backend options and views. |
66 | | -- Customizing the Admin Panel in the frontend, which is tightly linked to backend user roles. |
| 56 | +User TSconfig |
| 57 | +------------- |
67 | 58 |
|
68 | | -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`. |
69 | 62 |
|
70 | | -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