From e4f6383ba866d0c3d311f867dc8b6230ff6e5e4d Mon Sep 17 00:00:00 2001 From: "lina.wolf" Date: Sun, 24 Nov 2024 08:38:24 +0100 Subject: [PATCH] [TASK] Update introduction Releases: main, 13.4, 12.4 --- Documentation/Introduction/Index.rst | 87 +++++++++++++--------------- 1 file changed, 40 insertions(+), 47 deletions(-) diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index 9fe24508..f79b2622 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -1,71 +1,64 @@ +:navigation-title: Introduction .. include:: /Includes.rst.txt +.. _typoscript-syntax-typoscript-templates: +.. _typoscript-syntax-typoscript-templates-usage: +.. _introduction: -.. _about: -.. _introduction: +============================ +Introduction into TypoScript +============================ -============ -Introduction -============ +TypoScript is a configuration language used to configure both the frontend +output and the backend of a a TYPO3 web site. -This document serves as a manual for TypoScript and TSconfig, two -essential configuration tools in TYPO3. - -.. _typoscript-syntax-typoscript-templates: - -TypoScript -========== - -TypoScript is a configuration language used to define the frontend rendering -in TYPO3. It is not a programming language but a means of configuring the +TypoScript is not a programming language but a means of configuring the website. -Key sections to explore: - -* :ref:`TypoScript Syntax ` for an introduction to the syntax. -* :ref:`TypoScript Reference ` for details on data types, object types, functions, and conditions. -* :ref:`guide` for configuring frontend behavior using TypoScript. -* :ref:`using-and-setting` for extending and setting TypoScript properties. +.. contents:: -.. _typoscript-syntax-typoscript-templates-usage: +.. _introduction-frontend-typoscript: -Templating in TYPO3 +Frontend TypoScript =================== -Frontend rendering in TYPO3 can use several methods, each requiring some TypoScript configuration: +Frontend TypoScript is mainly used to configure which data should be send to the +Fluid templates. -**Best Practice:** +It can also be used to define settings send to Extbase plugins, metadata for +a whole page etc. -- **Fluid Templates**: Use the `Fluid `__ engine with TypoScript's :ref:`cobj-fluidtemplate` to integrate external HTML templates with Fluid variables. - * See :ref:`t3sitepackage:start` for creating site packages and custom themes. - * See :ref:`t3coreapi:adding-your-own-content-elements` to create custom content elements with TypoScript and Fluid. +In the beginning of TYPO3, TypoScript was used as templating language. In modern +project it is not common to do that anymore. -**Other Methods:** +For an introduction see +`Getting started: A quick introduction into TypoScript `_. -- External templating engines via extensions. -- Custom PHP code for advanced use cases. -- TypoScript content objects for fully configurable rendering. - -**Outdated Method:** +.. _about-tsconfig: -- **HTML Templates** using markers and subparts (:ref:`cobj-template`) are no longer recommended. +Backend TypoScript / TSconfig +============================= -.. _about-tsconfig: +Backend TypoScript, also called TSconfig, can be used to configure the output +of certain forms etc in the TYPO3 backend. -TSconfig -======== +.. _about-page-tsconfig: -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. +Page TSconfig +------------- -**Key Concepts:** +Page TSconfig can be made available globally, on a per site or per page level. -- **Page TSconfig**: Configures backend behavior on a per-page basis. -- **User TSconfig**: Configures options for specific users or groups. +For the possibilities see the +`Page TSconfig Reference `_. -TSconfig is primarily for integrators to control what backend users see and interact with, including: +.. _about-user-tsconfig: -- Configuring backend options and views. -- Customizing the Admin Panel in the frontend, which is tightly linked to backend user roles. +User TSconfig +------------- -For details on syntax, refer to :ref:`TYPO3 Explained `. Remember, properties from the :ref:`TypoScript Reference ` cannot be used in TSconfig and vice versa. +User TSconfig can be made available globally for certain user groups or certain +users. It cannot be set for just one site or page. It can however override +:ref:`about-page-tsconfig`. -This document provides the foundational concepts and serves as a reference for both TypoScript and TSconfig, empowering developers and integrators to customize TYPO3 effectively. +For the possibilities see the +`User TSconfig reference `_.