From c95d51db87cbe14601fa432a1311d24526130a99 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Sat, 27 Jul 2024 13:11:46 +0200 Subject: [PATCH] [TASK] Replace outdated syntax (#246) * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * Revert "[TASK] Replace outdated syntax (#245)" This reverts commit c4c277ff0f4bcd90b1652e7cf6ce50c73b7276a6. * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax * [TASK] Replace outdated syntax --- Documentation/Home/ConfiguringTYPO3.rst | 175 ++++------ .../Home/CreatingManagingContent.rst | 143 +++----- Documentation/Home/ExtensionManuals.rst | 104 ++---- Documentation/Home/OverviewInclude.rst.txt | 243 ------------- Documentation/Home/References.rst | 173 ++++------ Documentation/Home/SystemExtensions.rst | 324 +++++++++++------- Documentation/Home/Templating.rst | 67 ++-- Documentation/Home/UpgradingTYPO3.rst | 203 ++++------- Documentation/Home/_OverviewInclude.rst.txt | 154 +++++++++ Documentation/Index.rst | 34 +- 10 files changed, 685 insertions(+), 935 deletions(-) delete mode 100644 Documentation/Home/OverviewInclude.rst.txt create mode 100644 Documentation/Home/_OverviewInclude.rst.txt diff --git a/Documentation/Home/ConfiguringTYPO3.rst b/Documentation/Home/ConfiguringTYPO3.rst index e61397f..6a34e90 100644 --- a/Documentation/Home/ConfiguringTYPO3.rst +++ b/Documentation/Home/ConfiguringTYPO3.rst @@ -1,152 +1,101 @@ -.. include:: /Includes.rst.txt - -.. _configuringTYPO3: +.. include:: /Includes.rst.txt +.. _configuringTYPO3: ================= Configuring TYPO3 ================= +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Configuration Overview ` - - .. container:: card-body - - The configuration overview gives an overview of the various - configuration options available. It contains a description of the main - system configuration options. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`TypoScript in 45 Minutes ` - - .. container:: card-body - - The tutorial "TypoScript in 45 Minutes" introduces TYPO3's - configuration language "TypoScript". - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Site Handling ` - - .. container:: card-body - - The site configuration defines how TYPO3 handles domains, languages and error handling. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - + .. card:: :ref:`Configuration Overview ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + The configuration overview gives an overview of the various + configuration options available. It contains a description of the main + system configuration options. - .. container:: card px-0 h-100 + .. card-footer:: + :button-styles: secondary - .. rst-class:: card-header h3 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rubric:: :ref:`SEO ` - .. container:: card-body + .. card:: :ref:`TypoScript in 45 Minutes ` - The SEO module allows users to configure SEO related options like meta data or titles. + The tutorial "TypoScript in 45 Minutes" introduces TYPO3's + configuration language "TypoScript". - .. container:: card-footer pb-0 + .. card-footer:: + :button-styles: secondary - .. rst-class:: horizbuttons-striking-m - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card:: :ref:`Site Handling ` - .. container:: card px-0 h-100 + The site configuration defines how TYPO3 handles domains, languages and error handling. - .. rst-class:: card-header h3 + .. card-footer:: + :button-styles: secondary - .. rubric:: :ref:`Security ` + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-body - Security is an important aspect for any website. The TYPO3 security - guidelines contain information for installing, maintaining and using - TYPO3 securely. + .. card:: :ref:`SEO ` - .. container:: card-footer pb-0 + The SEO module allows users to configure SEO related options like meta data or titles. - .. rst-class:: horizbuttons-striking-m + .. card-footer:: + :button-styles: secondary - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card:: :ref:`Security ` - .. container:: card px-0 h-100 + Security is an important aspect for any website. The TYPO3 security + guidelines contain information for installing, maintaining and using + TYPO3 securely. - .. rst-class:: card-header h3 + .. card-footer:: + :button-styles: secondary - .. rubric:: :ref:`RTE ` + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-body - The heart of any content management system is its editor. TYPO3 uses ckeditor - to provide a rich and configurable editing environment. + .. card:: :ref:`RTE ` - .. container:: card-footer pb-0 + The heart of any content management system is its editor. TYPO3 uses ckeditor + to provide a rich and configurable editing environment. - .. rst-class:: horizbuttons-striking-m + .. card-footer:: + :button-styles: secondary - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` -.. toctree:: - :hidden: +.. toctree:: + :hidden: - Configuration Overview - Site Handling - SEO - Security - RTE's + Configuration Overview + Site Handling + SEO + Security + RTE's diff --git a/Documentation/Home/CreatingManagingContent.rst b/Documentation/Home/CreatingManagingContent.rst index b267cd5..fcdb966 100644 --- a/Documentation/Home/CreatingManagingContent.rst +++ b/Documentation/Home/CreatingManagingContent.rst @@ -2,121 +2,82 @@ .. _creatingmanagingcontent: - =========================== Creating & Managing Content =========================== +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Pages ` - - .. container:: card-body - - The Page Management Guide introduces TYPO3's Page Tree and explains how pages are created and managed. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Content ` - - .. container:: card-body - - The Content Creation Guide shows how page content is created in the form of Content Elements. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :doc:`Localizing Pages & Content ` - - .. container:: card-body - - The Localization Guide covers everything needed to add additional languages to a TYPO3 site, and how to translate content and pages. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m + .. card:: :ref:`Pages ` - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + The Page Management Guide introduces TYPO3's Page Tree and explains + how pages are created and managed. - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card-footer:: + :button-styles: secondary - .. container:: card px-0 h-100 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rst-class:: card-header h3 + .. card:: :ref:`Content ` - .. rubric:: :doc:`Forms ` + The Content Creation Guide shows how page content is created in the + form of Content Elements. - .. container:: card-body + .. card-footer:: + :button-styles: secondary - The Form Framework allows non-technical as well technical users to create and extend complex web forms - directly from TYPO3's backend. + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-footer pb-0 + .. card:: :doc:`Localizing Pages & Content ` - .. rst-class:: horizbuttons-striking-m + The Localization Guide covers everything needed to add additional + languages to a TYPO3 site, and how to translate content and pages. - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + .. card-footer:: + :button-styles: secondary - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. container:: card px-0 h-100 + .. card:: :doc:`Forms ` - .. rst-class:: card-header h3 + The Form Framework allows non-technical as well technical users to + create and extend complex web forms directly from TYPO3's backend. - .. rubric:: :ref:`Deep Linking ` + .. card-footer:: + :button-styles: secondary - .. container:: card-body + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - Deep linking allows users to share links to specific pages, content elements and modules from within TYPO3’s backend. + .. card:: :ref:`Deep Linking ` - .. container:: card-footer pb-0 + Deep linking allows users to share links to specific pages, content + elements and modules from within TYPO3’s backend. - .. rst-class:: horizbuttons-striking-m + .. card-footer:: + :button-styles: secondary - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` -.. toctree:: - :hidden: +.. toctree:: + :hidden: - Pages - Content - Localization - Forms - Deep Linking + Pages + Content + Localization + Forms + Deep Linking diff --git a/Documentation/Home/ExtensionManuals.rst b/Documentation/Home/ExtensionManuals.rst index eec3d58..0b80254 100644 --- a/Documentation/Home/ExtensionManuals.rst +++ b/Documentation/Home/ExtensionManuals.rst @@ -4,96 +4,66 @@ Developing & Using Extensions ============================= +.. _extensions-development: + Extension Development ===================== -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header - - .. rubric:: Getting started with extension development - - .. container:: card-body +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 - * :ref:`Introduction to extensions in TYPO3 - ` + .. card:: Getting started with extension development - * Extension :ref:`t3coreapi:extension-files-locations` + * :ref:`Introduction to extensions in TYPO3 + ` - * :ref:`t3coreapi:extension-naming` and :ref:`t3coreapi:cgl` + * Extension :ref:`t3coreapi:extension-files-locations` + * :ref:`t3coreapi:extension-naming` and :ref:`t3coreapi:cgl` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - .. container:: card px-0 h-100 + .. card:: TYPO3 Explained - API Quicklinks - .. rst-class:: card-header + * :ref:`QueryBuilder ` based on Doctrine + * :ref:`t3coreapi:DependencyInjection` + * :ref:`t3coreapi:request-handling` - .. rubric:: TYPO3 Explained - API Quicklinks - - .. container:: card-body - - * :ref:`QueryBuilder ` based on Doctrine - * :ref:`t3coreapi:DependencyInjection` - * :ref:`t3coreapi:request-handling` +.. _extension-manuals: Extension Manuals ================= -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header - - .. rubric:: System Extensions - - .. container:: card-body - - Here you can find documentation of system extensions and third-party extensions, - if available. - - System extensions are shipped with the TYPO3 core. A list of all available - system extension documentation is found in the - :ref:`system extensions section `. - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header - - .. rubric:: Third-party extensions - - .. container:: card-body - - Third-party extensions are available through the - TYPO3 Extension Repository (TER) or via composer. +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 - Go to the `TYPO3 Extension Repository (TER) `__ to search - for documentation of third-party extensions. + .. card:: System Extensions - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + Here you can find documentation of system extensions and third-party extensions, + if available. - .. container:: card px-0 h-100 + System extensions are shipped with the TYPO3 core. A list of all available + system extension documentation is found in the + :ref:`system extensions section `. - .. rst-class:: card-header + .. card:: Third-party extensions - .. rubric:: Document an extension + Third-party extensions are available through the + TYPO3 Extension Repository (TER) or via composer. - .. container:: card-body + Go to the `TYPO3 Extension Repository (TER) `__ to search + for documentation of third-party extensions. - Documentation is an essential part of an extension. - Learn :ref:`how to document ` an extension - and :ref:`publish the documentation ` on docs.typo3.org. + .. card:: Document an extension + Documentation is an essential part of an extension. + Learn :ref:`how to document ` an extension + and :ref:`publish the documentation ` on docs.typo3.org. .. toctree:: diff --git a/Documentation/Home/OverviewInclude.rst.txt b/Documentation/Home/OverviewInclude.rst.txt deleted file mode 100644 index 8cb66ee..0000000 --- a/Documentation/Home/OverviewInclude.rst.txt +++ /dev/null @@ -1,243 +0,0 @@ - -__________ - -.. _start-getting-started: - -Getting Started with TYPO3 -========================== - -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Getting Started ` - - .. container:: card-body - - * :ref:`TYPO3 Concepts ` introduces some of TYPO3s - core concepts. - - * :ref:`System Requirements ` for the - host operating system including its web server and database. - - * :ref:`Installation Guide ` details - the entire installation process. - - * :ref:`Setup Guide ` guides you through the next steps - post installation. - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Creating & Managing Content ` - - .. container:: card-body - - * :ref:`Editors Tutorial ` explains the creation and management of pages and content. - - * :ref:`Form System Extension ` is a powerful - tool that gives backend users the ability to create web forms. - - * :ref:`Localization Guide ` covers everything needed to add additional languages to a - TYPO3 site, and how to translate content and pages. - - - .. _start-theme: - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Templating & Sitepackages ` - - .. container:: card-body - - * :ref:`Fluid is TYPO3’s templating engine. ` - Fluid acts as the glue between your static HTML templates and the content you create in TYPO3’s backend. - - * :ref:`Sitepackages ` allow you to bundle your Fluid templates and other site assets into a single, reusable extension. - - .. _start-configuration: - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Configuring TYPO3 ` - - .. container:: card-body - - The :ref:`configuration overview ` - in :ref:`TYPO3 Explained ` - gives an overview of the various configuration options available. - It contains a description of the main system configuration options. - - * :ref:`Site Handling and Configuration ` shows you how - to setup domains, languages, human-readable URLs and error pages. - - * :ref:`Backend User Management ` explains how you - setup backend users and grant them specific access to your installation of - TYPO3. - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Upgrading TYPO3 ` - - .. container:: card-body - - * :ref:`Minor Upgrades ` contains information on how to upgrade to a newer minor version of TYPO3. - - * :ref:`Major Upgrades ` details how to upgrade to a newer major release of TYPO3. 11.5 to 12.4 for example. - - * :ref:`Upgrading Extensions ` details how to upgrade extensions using Composer. - - * :ref:`Migrate A TYPO3 Installation To Composer ` Information on how to migrate a legacy installation of TYPO3 to a Composer based installation. - - .. _start-extdev: - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Developing & Using Extensions ` - - .. container:: card-body - - Getting started with extension development: - - * :ref:`Introduction to extensions in TYPO3 - ` - - * Extension :ref:`t3coreapi:extension-files-locations` - - * :ref:`t3coreapi:extension-naming` and :ref:`t3coreapi:cgl` - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`References ` - - .. container:: card-body - - * :ref:`TYPO3 Explained ` contains detailed information - about concepts and APIs for core and extension developers. - - * The `Core changelog `__ - lists all relevant changes for each TYPO3 version since 7. - - * The :ref:`references section ` lists all available reference manuals. - - - .. _start-localization: - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: How to create translations - - .. container:: card-body - - *Internationalization* | *Translation* | *Multiple Languages* - - * :ref:`Localization Guide ` - - * :ref:`Supported languages ` - - * :ref:`Manage backend languages ` - - * :ref:`Working with languages as an editor ` - - * :ref:`t3coreapi:internationalization` in "TYPO3 Explained" - -__________ - -Contributing -============ - -.. _start-coredev: - -.. container:: row m-0 p-0 - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: Contribute to the core - - .. container:: card-body - - The "Core contribution guide" contains information for creating core - patches: - - * :ref:`Create a patch ` - - * :ref:`Commit message rules ` - - * :ref:`Setup an installation with DDEV ` - - - But contributions aren't just about writing patches. Contributions happen - in numerous other ways, including - - * :ref:`Writing issues ` - - * :ref:`Review patches ` - - - - .. _start-contribute-docs: - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: Contribute to official documentation - - .. container:: card-body - - You are welcome to click on the "Edit on GitHub" button on any page to propose - a change in the official documentation whenever you see something that you - think can be improved. - - * The blog post `Start Improving Docs Now to Grow TYPO3 - `__ gives a - good introduction to documentation contribution. - - * :ref:`h2document:docs-contribute` explains the workflow for contributing. - - * The documentation is edited in text files using reStructuredText syntax. Use - the :ref:`h2document:rest-cheat-sheet` to lookup most commonly used directives. - - * General conventions can be found in :ref:`h2document:conventions` - - * :ref:`h2document:docs-official-how-you-can-help` lists some general tasks to - get you started. diff --git a/Documentation/Home/References.rst b/Documentation/Home/References.rst index ec18602..ea9985c 100644 --- a/Documentation/Home/References.rst +++ b/Documentation/Home/References.rst @@ -7,146 +7,101 @@ Reference Manuals ================= -.. container:: row m-0 p-0 +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card:: :ref:`t3coreapi:start` - .. container:: card px-0 h-100 + TYPO3 Explained contains detailed information about concepts and + APIs for core and extension developers. - .. rst-class:: card-header + .. card-footer:: + :button-styles: secondary - .. rubric:: :ref:`t3coreapi:start` + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-body - TYPO3 Explained contains detailed information about concepts and - APIs for core and extension developers. + .. card:: :doc:`Changelog ` - .. container:: card-footer pb-0 + The changelog lists all relevant changes for each TYPO3 version since version 7. - .. rst-class:: horizbuttons-striking-m + .. card-footer:: + :button-styles: secondary - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + :doc:`13-dev ` + :doc:`v12 ` + :doc:`v11 ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - .. container:: card px-0 h-100 + .. card:: :ref:`t3tca:start` - .. rst-class:: card-header + Reference for the Table Configuration Array (TCA). TCA can be + used to extend the definition of database tables. - .. rubric:: :doc:`Changelog ` + .. card-footer:: + :button-styles: secondary - .. container:: card-body + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - The changelog lists all relevant changes for each TYPO3 version since version 7. - .. container:: card-footer pb-0 + .. card:: :ref:`t3tsconfig:start` - .. rst-class:: horizbuttons-striking-m + Reference to Page TSconfig and User TSconfig. This is used + to configure the backend. - - `13-dev `__ - - `v12 `__ - - `v11 `__ + .. card-footer:: + :button-styles: secondary - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card px-0 h-100 - .. rst-class:: card-header + .. card:: :ref:`t3tsref:start` - .. rubric:: :ref:`t3tca:start` + TypoScript is a configuration language that is specific to + TYPO3. This is used to configure the frontend. - .. container:: card-body + .. card-footer:: + :button-styles: secondary - Reference for the Table Configuration Array (TCA). TCA can be - used to extend the definition of database tables. + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-footer pb-0 + .. card:: :ref:`t3viewhelper:start` - .. rst-class:: horizbuttons-striking-m + A complete reference of all available Fluid ViewHelper within + TYPO3. - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + .. card-footer:: + :button-styles: secondary - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card px-0 h-100 - .. rst-class:: card-header +.. tip:: - .. rubric:: :ref:`t3tsconfig:start` + Did you know, you can click on the version selector which is located right under the title. This + enables you to read the manual for a different version. The versions of the manual correspond to + the TYPO3 version. - .. container:: card-body - Reference to Page TSconfig and User TSconfig. This is used - to configure the backend. +.. toctree:: + :hidden: - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header - - .. rubric:: :ref:`t3tsref:start` - - .. container:: card-body - - TypoScript is a configuration language that is specific to - TYPO3. This is used to configure the frontend. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header - - .. rubric:: :ref:`t3viewhelper:start` - - .. container:: card-body - - A complete reference of all available Fluid ViewHelper within - TYPO3. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - -.. tip:: - - Did you know, you can click on the version selector which is located right under the title. This - enables you to read the manual for a different version. The versions of the manual correspond to - the TYPO3 version. - - -.. toctree:: - :hidden: - - TYPO3 Explained - Changelog - TCA - TSconfig - TypoScript - Fluid ViewHelpers + TYPO3 Explained + Changelog + TCA + TSconfig + TypoScript + Fluid ViewHelpers diff --git a/Documentation/Home/SystemExtensions.rst b/Documentation/Home/SystemExtensions.rst index 5c25af7..0260c27 100644 --- a/Documentation/Home/SystemExtensions.rst +++ b/Documentation/Home/SystemExtensions.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _System-Extensions: +.. _System-Extensions: ================= System Extensions @@ -21,25 +21,25 @@ own documentation; the functionality is documented in .. toctree:: :hidden: - adminpanel - dashboard - felogin + aditor + workminpanel + dashboard + felogin fluid_styled_content - form - impexp - indexed_search - linkvalidator - lowlevel - reactions - recycler - redirects - reports - rte_ckeditor - scheduler - seo - sys_note - t3editor - workspaces + form + impexp + indexed_search + linkvalidator + lowlevel + reactions + recycler + redirects + reports + rte_ckeditor + scheduler + seo + sys_note + t3edspaces Documentation of system extensions in current Core version ========================================================== @@ -57,188 +57,262 @@ part of the Core and extracted at some point in time. :columns: 1 :columns-md: 2 :gap: 4 - :class: pb-4 :card-height: 100 - .. card:: `Admin Panel `__ + .. card:: :doc:`Admin Panel ` - The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, - Preview...). + The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, + Preview...). - Composer: :composer:`typo3/cms-adminpanel` + Composer name: :composer:`typo3/cms-adminpanel` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + .. card-footer:: + :button-styles: secondary - .. card:: `Dashboard `__ + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - A Dashboard for the TYPO3 backend. + .. card:: :doc:`Dashboard ` - Composer: :composer:`typo3/cms-dashboard` + A Dashboard for the TYPO3 backend. - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Composer name: :composer:`typo3/cms-dashboard` - .. card:: `Frontend Login `__ + .. card-footer:: + :button-styles: secondary - Frontend login based on frontend users and user groups + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - Composer: :composer:`typo3/cms-felogin` + .. card:: :doc:`Frontend Login ` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Frontend login based on frontend users and user groups - .. card:: `Fluid Styled Content `_ + Composer name: :composer:`typo3/cms-felogin` - Content Elements based on Fluid. + .. card-footer:: + :button-styles: secondary - Composer: :composer:`typo3/cms-fluid-styled-content` + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. card-footer:: `13-dev `__ `12.4 `_ `11.5 `_ - :button-style: btn btn-secondary - .. card:: `Form framework `__ + .. card:: :doc:`Fluid Styled Content ` - Form Library, Plugin and Editor. + Content Elements based on Fluid. - Composer: :composer:`typo3/cms-form` + Composer name: :composer:`typo3/cms-fluid-styled-content` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + .. card-footer:: + :button-styles: secondary - .. card:: `Indexed Search `__ + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - Indexed Search Engine for TYPO3 pages, PDF-files, Word-files, HTML and text files. Provides a backend module - for statistics of the indexer and a frontend plugin. + .. card:: :doc:`Form framework ` - Composer: :composer:`typo3/cms-indexed-search` + Form Library, Plugin and Editor. - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Composer name: :composer:`typo3/cms-form` - .. card:: `Import / Export `__ + .. card-footer:: + :button-styles: secondary - Import and Export of records from TYPO3 in a custom serialized format (.T3D) for data exchange with other - TYPO3 systems. + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - Composer: :composer:`typo3/cms-impexp` + .. card:: :doc:`Indexed Search ` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Indexed Search Engine for TYPO3 pages, PDF-files, Word-files, HTML and text files. Provides a backend module + for statistics of the indexer and a frontend plugin. - .. card:: `Link Validator `__ + Composer name: :composer:`typo3/cms-indexed-search` - The Link Validator checks the links in your website for validity. + .. card-footer:: + :button-styles: secondary - Composer: :composer:`typo3/cms-linkvalidator` + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + .. card:: :doc:`Import / Export ` - .. card:: `Lowlevel `__ + Import and Export of records from TYPO3 in a custom serialized format (.T3D) for data exchange with other + TYPO3 systems. - Enables the 'Config' and 'DB Check' modules for technical analysis of the system. This includes raw - database search, checking relations, counting pages and records etc. + Composer name: :composer:`typo3/cms-impexp` - Composer: :composer:`typo3/cms-lowlevel` + .. card-footer:: + :button-styles: secondary - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. card:: `Reactions `__ + .. card:: :doc:`Link Validator ` - This extension handles incoming webhooks to TYPO3. + The Link Validator checks the links in your website for validity. - Composer: :composer:`typo3/cms-reactions` + Composer name: :composer:`typo3/cms-linkvalidator` - .. card-footer:: `13-dev `__ `12.4 `__ - :button-style: btn btn-secondary + .. card-footer:: + :button-styles: secondary - .. card:: `Recycler `__ + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - The recycler offers the possibility to restore deleted records or remove them from the database permanently. + .. card:: :doc:`Lowlevel ` - Composer: :composer:`typo3/cms-recycler` + Enables the 'Config' and 'DB Check' modules for technical analysis of the system. This includes raw + database search, checking relations, counting pages and records etc. - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Composer name: :composer:`typo3/cms-lowlevel` - .. card:: `Redirects `__ + .. card-footer:: + :button-styles: secondary - Create manual redirects, list existing redirects and automatically create\nredirects on slug changes. + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - Composer: :composer:`typo3/cms-redirects` + .. card:: :doc:`Reactions ` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + This extension handles incoming webhooks to TYPO3. - .. card:: `Reports `__ + Composer name: :composer:`typo3/cms-reactions` - This extension shows status reports and installed services in the - :guilabel:`System > Reports` backend module. + .. card-footer:: + :button-styles: secondary - Composer: :composer:`typo3/cms-reports` + :doc:`13-dev ` + :doc:`12.4 ` - .. card-footer:: `13-dev `__ `12.4 `__ - :button-style: btn btn-secondary + .. card:: :doc:`Recycler ` - .. card:: `CKEditor `__ + The recycler offers the possibility to restore deleted records or remove them from the database permanently. - Integration of CKEditor as a Rich Text Editor for the TYPO3 backend. + Composer name: :composer:`typo3/cms-recycler` - Composer: :composer:`typo3/cms-rte-ckeditor` + .. card-footer:: + :button-styles: secondary - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. card:: `Scheduler `_ + .. card:: :doc:`Redirects ` - The TYPO3 Scheduler lets you register tasks to happen at a specific time. + Create manual redirects, list existing redirects and automatically create\nredirects on slug changes. - Composer: :composer:`typo3/cms-scheduler` + Composer name: :composer:`typo3/cms-redirects` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + .. card-footer:: + :button-styles: secondary - .. card:: `SEO `_ + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - SEO features including specific fields for SEO purposes, rendering of HTML meta tags and sitemaps. + .. card:: :doc:`Reports ` - Composer: :composer:`typo3/cms-seo` + This extension shows status reports and installed services in the + :guilabel:`System > Reports` backend module. - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + Composer name: :composer:`typo3/cms-reports` - .. card:: `System Notes `_ + .. card-footer:: + :button-styles: secondary - The internal notes are a useful feature for adding context and notes to pages. - It provides a way for users to document important information related to specific pages. + :doc:`13-dev ` + :doc:`12.4 ` - Composer: :composer:`typo3/cms-sys-note` + .. card:: :doc:`CKEditor ` - .. card-footer:: `13-dev `__ `12.4 `__ - :button-style: btn btn-secondary + Integration of CKEditor as a Rich Text Editor for the TYPO3 backend. - .. card:: `T3Editor `__ + Composer name: :composer:`typo3/cms-rte-ckeditor` - This system extension provides a backend editor with syntax highlighting. + .. card-footer:: + :button-styles: secondary - Composer: :composer:`typo3/cms-t3editor` + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - This system extension was merged into EXT:backend with TYPO3 v13.0. + .. card:: :doc:`Scheduler `_ - .. card-footer:: `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + The TYPO3 Scheduler lets you register tasks to happen at a specific time. - .. card:: `Workspaces and Versioning `__ + Composer name: :composer:`typo3/cms-scheduler` - Adds workspaces functionality with custom stages to TYPO3. + .. card-footer:: + :button-styles: secondary - Composer: :composer:`typo3/cms-workspaces` + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` - .. card-footer:: `13-dev `__ `12.4 `__ `11.5 `__ - :button-style: btn btn-secondary + .. card:: :doc:`SEO ` + SEO features including specific fields for SEO purposes, rendering of HTML meta tags and sitemaps. + + Composer name: :composer:`typo3/cms-seo` + + .. card-footer:: + :button-styles: secondary + + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` + + .. card:: :doc:`System Notes ` + + The internal notes are a useful feature for adding context and notes to pages. + It provides a way for users to document important information related to specific pages. + + Composer name: :composer:`typo3/cms-sys-note` + + .. card-footer:: + :button-styles: secondary + + :doc:`13-dev ` + :doc:`12.4 ` + + .. card:: :doc:`T3Editor ` + + This system extension provides a backend editor with syntax highlighting. + + Composer name: :composer:`typo3/cms-t3editor` + + This system extension was merged into EXT:backend with TYPO3 v13.0. + + .. card-footer:: + :button-styles: secondary + + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` + + .. card:: :doc:`Workspaces and Versioning ` + + Adds workspaces functionality with custom stages to TYPO3. + + Composer name: :composer:`typo3/cms-workspaces` + + .. card-footer:: + :button-styles: secondary + + :doc:`13-dev ` + :doc:`12.4 ` + :doc:`11.5 ` + +.. _System-Extensions-outdated: Documentation of system extensions abandoned from current Core version ====================================================================== @@ -264,7 +338,7 @@ Documentation of system extensions abandoned from current Core version - :Manual: `func `_ :Composer: :composer:`friendsoftypo3/cms-func` - :Comment: Was removed from Core in 9.0, see `Changelog `__ + :Comment: Was removed from Core in 9.0, see `Changelog ` - :Manual: `Openid `_ :Composer: :composer:`friendsoftypo3/openid` @@ -280,7 +354,7 @@ Documentation of system extensions abandoned from current Core version - :Manual: `Salted user password hashes `_ :Composer: :composer:`typo3/cms-saltedpasswords` - :Comment: Merged into main Core extension since TYPO3 >=7.4. See `Core API `_ + :Comment: Merged into main Core extension since TYPO3 >=7.4. See :ref:`Core API ` - :Manual: `System Actions `_ :Composer: :composer:`typo3/cms-sys-action` diff --git a/Documentation/Home/Templating.rst b/Documentation/Home/Templating.rst index 24581c7..202a448 100644 --- a/Documentation/Home/Templating.rst +++ b/Documentation/Home/Templating.rst @@ -7,54 +7,39 @@ Templating ========== +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 -.. container:: row m-0 p-0 + .. card:: :ref:`The Fluid Templating Engine ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + Fluid is TYPO3’s templating engine. Fluid acts as the glue between your static HTML templates and the + content you create in TYPO3’s backend. A typical Fluid template will contain HTML that defines the + structure of your page and Fluid tags that call various types of dynamic content. - .. container:: card px-0 h-100 + .. card-footer:: + :button-styles: secondary - .. rst-class:: card-header h3 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rubric:: :ref:`The Fluid Templating Engine ` + .. card:: :ref:`Sitepackages ` - .. container:: card-body + Sitepackages allow you to bundle your Fluid templates and other site + assets into a single, reusable extension that can be installed with a single click. - Fluid is TYPO3’s templating engine. Fluid acts as the glue between your static HTML templates and the - content you create in TYPO3’s backend. A typical Fluid template will contain HTML that defines the - structure of your page and Fluid tags that call various types of dynamic content. + .. card-footer:: + :button-styles: secondary - .. container:: card-footer pb-0 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rst-class:: horizbuttons-striking-m +.. toctree:: + :hidden: - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: :ref:`Sitepackages ` - - .. container:: card-body - - Sitepackages allow you to bundle your Fluid templates and other site - assets into a single, reusable extension that can be installed with a single click. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - -.. toctree:: - :hidden: - - Templating With Fluid - Sitepackages + Templating With Fluid + Sitepackages diff --git a/Documentation/Home/UpgradingTYPO3.rst b/Documentation/Home/UpgradingTYPO3.rst index 79cd799..4ee1a67 100644 --- a/Documentation/Home/UpgradingTYPO3.rst +++ b/Documentation/Home/UpgradingTYPO3.rst @@ -6,164 +6,109 @@ Upgrading TYPO3 =============== -.. container:: row m-0 p-0 +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card:: :ref:`Minor upgrades ` - .. container:: card px-0 h-100 + Minor updates (for example 12.4.1 to 12.4.2) + contain bugfixes and/or security updates. + This chapter details how updates are installed and highlights what tasks need to + be carried out before and after the core is updated. - .. rst-class:: card-header h3 + .. card-footer:: + :button-styles: secondary - .. rubric:: `Minor upgrades `__ + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. container:: card-body + .. card:: :ref:`Major upgrades ` - Minor updates (for example 12.4.1 to 12.4.2) - contain bugfixes and/or security updates. - This chapter details how updates are installed and highlights what tasks need to - be carried out before and after the core is updated. + Major updates (for example 11.5 to 12.4) can contain new features + and breaking changes as well as bugfixes. + This chapter details how updates are installed and highlights what tasks need to + be carried out before and after the core is updated. - .. container:: card-footer pb-0 + .. card-footer:: + :button-styles: secondary - .. rst-class:: horizbuttons-striking-m + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + .. card:: :ref:`Upgrading extensions ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + Just like TYPO3's core, extensions also need to be regularly updated. + This chapter details how to upgrade extensions using Composer. - .. container:: card px-0 h-100 + .. card-footer:: + :button-styles: secondary - .. rst-class:: card-header h3 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rubric:: `Major upgrades `__ + .. card:: :ref:`Third-party tools ` - .. container:: card-body + Tools and resources developed by the community that can assist with + common upgrade and maintenance tasks. - Major updates (for example 11.5 to 12.4) can contain new features - and breaking changes as well as bugfixes. - This chapter details how updates are installed and highlights what tasks need to - be carried out before and after the core is updated. + .. card-footer:: + :button-styles: secondary - .. container:: card-footer pb-0 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rst-class:: horizbuttons-striking-m - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + .. card:: :ref:`Legacy upgrade guide ` - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + Using TYPO3 without Composer? This chapter details how to upgrade + TYPO3 manually. - .. container:: card px-0 h-100 + .. card-footer:: + :button-styles: secondary - .. rst-class:: card-header h3 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rubric:: `Upgrading extensions `__ + .. card:: :ref:`Migrate a TYPO3 installation to Composer ` - .. container:: card-body + Information on how to migrate a legacy installation of TYPO3 to a + Composer-based installation. - Just like TYPO3's core, extensions also need to be regularly updated. - This chapter details how to upgrade extensions using Composer. + .. card-footer:: + :button-styles: secondary - .. container:: card-footer pb-0 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rst-class:: horizbuttons-striking-m + .. card:: :ref:`Migrate content ` - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ + This chapter details how pages and content can be exported and then + imported into another installation of TYPO3. - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 + .. card-footer:: + :button-styles: secondary - .. container:: card px-0 h-100 + :ref:`13-dev ` + :ref:`12.4 ` + :ref:`11.5 ` - .. rst-class:: card-header h3 - .. rubric:: `Third-party tools `__ +.. toctree:: + :hidden: - .. container:: card-body - - Tools and resources developed by the community that can assist with common upgrade and maintenance tasks. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Legacy upgrade guide `__ - - .. container:: card-body - - Using TYPO3 without Composer? This chapter details how to upgrade TYPO3 manually. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Migrate a TYPO3 installation to Composer `__ - - .. container:: card-body - - Information on how to migrate a legacy installation of TYPO3 to a Composer-based installation. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Migrate content `__ - - .. container:: card-body - - This chapter details how pages and content can be exported and then imported into another installation of TYPO3. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `13-dev `__ - - `12.4 `__ - - `11.5 `__ - - -.. toctree:: - :hidden: - - Minor upgrades - Major upgrades - Upgrading extensions - Third-party tools - Legacy upgrade - Migrate to Composer - Migrate content + Minor upgrades + Major upgrades + Upgrading extensions + Third-party tools + Legacy upgrade + Migrate to Composer + Migrate content diff --git a/Documentation/Home/_OverviewInclude.rst.txt b/Documentation/Home/_OverviewInclude.rst.txt new file mode 100644 index 0000000..1fa6561 --- /dev/null +++ b/Documentation/Home/_OverviewInclude.rst.txt @@ -0,0 +1,154 @@ + +.. _start-getting-started: + +Getting Started with TYPO3 +========================== + +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 + + .. card:: :ref:`Getting Started ` + + * :ref:`TYPO3 Concepts ` introduces some of TYPO3s + core concepts. + + * :ref:`System Requirements ` for the + host operating system including its web server and database. + + * :ref:`Installation Guide ` details + the entire installation process. + + * :ref:`Setup Guide ` guides you through the next steps + post installation. + + .. card:: :ref:`Creating & Managing Content ` + + * :ref:`Editors Tutorial ` explains the creation and management of pages and content. + + * :ref:`Form System Extension ` is a powerful + tool that gives backend users the ability to create web forms. + + * :ref:`Localization Guide ` covers everything needed to add additional languages to a + TYPO3 site, and how to translate content and pages. + + + .. card:: :ref:`Templating & Sitepackages ` + + * :ref:`Fluid is TYPO3’s templating engine. ` + Fluid acts as the glue between your static HTML templates and the content you create in TYPO3’s backend. + + * :ref:`Sitepackages ` allow you to bundle your Fluid templates and other site assets into a single, reusable extension. + + .. card:: :ref:`Configuring TYPO3 ` + + The :ref:`configuration overview ` + in :ref:`TYPO3 Explained ` + gives an overview of the various configuration options available. + It contains a description of the main system configuration options. + + * :ref:`Site Handling and Configuration ` shows you how + to setup domains, languages, human-readable URLs and error pages. + + * :ref:`Backend User Management ` explains how you + setup backend users and grant them specific access to your installation of + TYPO3. + + .. card:: :ref:`Upgrading TYPO3 ` + + * :ref:`Minor Upgrades ` contains information on how to upgrade to a newer minor version of TYPO3. + + * :ref:`Major Upgrades ` details how to upgrade to a newer major release of TYPO3. 11.5 to 12.4 for example. + + * :ref:`Upgrading Extensions ` details how to upgrade extensions using Composer. + + * :ref:`Migrate A TYPO3 Installation To Composer ` Information on how to migrate a legacy installation of TYPO3 to a Composer based installation. + + .. card:: :ref:`Developing & Using Extensions ` + + Getting started with extension development: + + * :ref:`Introduction to extensions in TYPO3 + ` + + * Extension :ref:`t3coreapi:extension-files-locations` + + * :ref:`t3coreapi:extension-naming` and :ref:`t3coreapi:cgl` + + + .. card:: :ref:`References ` + + * :ref:`TYPO3 Explained ` contains detailed information + about concepts and APIs for core and extension developers. + + * The `Core changelog `__ + lists all relevant changes for each TYPO3 version since 7. + + * The :ref:`references section ` lists all available reference manuals. + + .. card:: How to create translations + + *Internationalization* | *Translation* | *Multiple Languages* + + * :ref:`Localization Guide ` + + * :ref:`Supported languages ` + + * :ref:`Manage backend languages ` + + * :ref:`Working with languages as an editor ` + + * :ref:`t3coreapi:internationalization` in "TYPO3 Explained" + + +.. _start-Contributing: + +Contributing +============ + +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 + + .. card:: Contribute to the core + + The "Core contribution guide" contains information for creating core + patches: + + * :ref:`Create a patch ` + + * :ref:`Commit message rules ` + + * :ref:`Setup an installation with DDEV ` + + + But contributions aren't just about writing patches. Contributions happen + in numerous other ways, including + + * :ref:`Writing issues ` + + * :ref:`Review patches ` + + .. card:: Contribute to official documentation + + You are welcome to click on the "Edit on GitHub" button on any page to propose + a change in the official documentation whenever you see something that you + think can be improved. + + * The blog post `Start Improving Docs Now to Grow TYPO3 + `__ gives a + good introduction to documentation contribution. + + * :ref:`h2document:docs-contribute` explains the workflow for contributing. + + * The documentation is edited in text files using reStructuredText syntax. Use + the :ref:`h2document:rest-cheat-sheet` to lookup most commonly used directives. + + * General conventions can be found in :ref:`h2document:conventions` + + * :ref:`h2document:docs-official-how-you-can-help` lists some general tasks to + get you started. diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 97f2ba8..4a48029 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -14,23 +14,23 @@ PHP. .. rst-class:: horizbuttons-primary-m -* :ref:`getting-started` -* :ref:`references` -* :ref:`extensions` - -.. include:: Home/OverviewInclude.rst.txt - -.. toctree:: - :hidden: - - Home/GettingStarted - Home/CreatingManagingContent - Home/Templating - Home/ConfiguringTYPO3 - Home/UpgradingTYPO3 - Home/ExtensionManuals - Home/References - Home/Contribute +* :ref:`getting-started` +* :ref:`references` +* :ref:`extensions` + +.. include:: Home/_OverviewInclude.rst.txt + +.. toctree:: + :hidden: + + Home/GettingStarted + Home/CreatingManagingContent + Home/Templating + Home/ConfiguringTYPO3 + Home/UpgradingTYPO3 + Home/ExtensionManuals + Home/References + Home/Contribute Support is available via StackOverflow and Slack. Visit the `help page