diff --git a/Documentation/Home/ConfiguringTYPO3.rst b/Documentation/Home/ConfiguringTYPO3.rst deleted file mode 100644 index ffa6146..0000000 --- a/Documentation/Home/ConfiguringTYPO3.rst +++ /dev/null @@ -1,101 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _configuringTYPO3: - -================= -Configuring TYPO3 -================= - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :ref:`Configuration Overview ` - - The configuration overview gives an overview of the various - configuration options available. It contains a description of the main - system configuration options. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`TypoScript in 45 Minutes ` - - The tutorial "TypoScript in 45 Minutes" introduces TYPO3's - configuration language "TypoScript". - - .. card-footer:: - :button-styles: secondary - - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`Site Handling ` - - The site configuration defines how TYPO3 handles domains, languages and error handling. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`SEO ` - - The SEO module allows users to configure SEO related options like meta data or titles. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`Security ` - - Security is an important aspect for any website. The TYPO3 security - guidelines contain information for installing, maintaining and using - TYPO3 securely. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`RTE ` - - The heart of any content management system is its editor. TYPO3 uses ckeditor - to provide a rich and configurable editing environment. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - -.. toctree:: - :hidden: - - Configuration Overview - Site Handling - SEO - Security - RTE's diff --git a/Documentation/Home/Contribute.rst b/Documentation/Home/Contribute.rst deleted file mode 100644 index ffb72e9..0000000 --- a/Documentation/Home/Contribute.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _contribute: - -========== -Contribute -========== - -.. toctree:: - - Contribute to Core - Contribute to Documentation - Contribute to typo3.org website - Coding Guidelines - Writing and Language Guide - Content and Marketing Guide diff --git a/Documentation/Home/CreatingManagingContent.rst b/Documentation/Home/CreatingManagingContent.rst deleted file mode 100644 index a702550..0000000 --- a/Documentation/Home/CreatingManagingContent.rst +++ /dev/null @@ -1,83 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _creatingmanagingcontent: - -=========================== -Creating & Managing Content -=========================== - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :ref:`Pages ` - - The Page Management Guide introduces TYPO3's Page Tree and explains - how pages are created and managed. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Content ` - - The Content Creation Guide shows how page content is created in the - form of Content Elements. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :doc:`Localizing Pages & Content ` - - The Localization Guide covers everything needed to add additional - languages to a TYPO3 site, and how to translate content and pages. - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Forms ` - - The Form Framework allows non-technical as well technical users to - create and extend complex web forms directly from TYPO3's backend. - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :ref:`Deep Linking ` - - Deep linking allows users to share links to specific pages, content - elements and modules from within TYPO3’s backend. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - -.. toctree:: - :hidden: - - Pages - Content - Localization - Forms - Deep Linking diff --git a/Documentation/Home/ExtensionManuals.rst b/Documentation/Home/ExtensionManuals.rst deleted file mode 100644 index dd223cc..0000000 --- a/Documentation/Home/ExtensionManuals.rst +++ /dev/null @@ -1,75 +0,0 @@ -.. _extensions: - -============================= -Developing & Using Extensions -============================= - -.. _extensions-development: - -Extension Development -===================== - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: 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:: TYPO3 Explained - API Quicklinks - - * :ref:`QueryBuilder ` based on Doctrine - * :ref:`t3coreapi:DependencyInjection` - * :ref:`t3coreapi:request-handling` - -.. _extension-manuals: - -Extension Manuals -================= - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: System Extensions - - 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 `. - - .. card:: Third-party extensions - - Third-party extensions are available through the - TYPO3 Extension Repository (TER) or via composer. - - Go to the `TYPO3 Extension Repository (TER) `__ to search - for documentation of third-party extensions. - - .. 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:: - :hidden: - - Extension Development Basics - SystemExtensions - Third-party extensions - Document an extension diff --git a/Documentation/Home/GettingStarted.rst b/Documentation/Home/GettingStarted.rst deleted file mode 100644 index 1f79034..0000000 --- a/Documentation/Home/GettingStarted.rst +++ /dev/null @@ -1,205 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _getting-started: - -=============== -Getting Started -=============== - - -.. 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:: `Concepts `__ - - .. container:: card-body - - Written for new users, this chapter introduces some of TYPO3s core concepts including the backend, TYPO3s administration interface. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `System Requirements `__ - - .. container:: card-body - - System requirements for the host operation system, including its web server and database and how they should be configured prior to installation. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Installation `__ - - .. container:: card-body - - The installation chapter provides detailed instructions about how to install TYPO3, it also contains information about how to deploy TYPO3 to a production environment. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Setup `__ - - .. container:: card-body - - Setup aims to guide you through the next steps post installation. Such as adding domains, setting up additional users and configuring languages. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Troubleshooting `__ - - .. container:: card-body - - Troubleshoot common issues that can occur during installation. The Troubleshooting chapter covers both TYPO3 CMS and the host environment including the web server, database and PHP. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Managing Backend Users `__ - - .. container:: card-body - - Learn how to create users and configure their backend privileges. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Working With Extensions `__ - - .. container:: card-body - - Discover how third-party extensions are installed and managed using Composer. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `The Introduction Package `__ - - .. container:: card-body - - The Introduction Package is a great place to start if you are looking to test drive TYPO3 and see a prebuilt site that contains - a range of example page templates and content. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - .. container:: col-md-6 pl-0 pr-3 py-3 m-0 - - .. container:: card px-0 h-100 - - .. rst-class:: card-header h3 - - .. rubric:: `Next Steps `__ - - .. container:: card-body - - Next Steps provides an overview of tasks that can be carried out once TYPO3 is installed, such as creating templates and adding content. - - .. container:: card-footer pb-0 - - .. rst-class:: horizbuttons-striking-m - - - `14-dev `__ - - `13.4 `__ - - `12.4 `__ - - - .. toctree:: - :hidden: - - TYPO3 Concepts - System Requirements - Installation - Setup - Troubleshooting - Managing Backend Users - Working With Extensions - Introduction Package - Next Steps diff --git a/Documentation/Home/Images/version-link.png b/Documentation/Home/Images/version-link.png deleted file mode 100644 index 43dd1cf..0000000 Binary files a/Documentation/Home/Images/version-link.png and /dev/null differ diff --git a/Documentation/Home/Overview.rst b/Documentation/Home/Overview.rst index 5418500..42ebdec 100644 --- a/Documentation/Home/Overview.rst +++ b/Documentation/Home/Overview.rst @@ -1,3 +1,4 @@ +:orphan: .. include:: /Includes.rst.txt .. _resources: @@ -6,4 +7,4 @@ Official documentation resources ================================ -.. include:: /mainMenu.rst.txt +.. include:: /_mainMenu.rst.txt diff --git a/Documentation/Home/References.rst b/Documentation/Home/References.rst deleted file mode 100644 index 3929e38..0000000 --- a/Documentation/Home/References.rst +++ /dev/null @@ -1,107 +0,0 @@ - -.. include:: /Includes.rst.txt - -.. _references: - -================= -Reference Manuals -================= - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :ref:`t3coreapi:start` - - TYPO3 Explained contains detailed information about concepts and - APIs for core and extension developers. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :doc:`Changelog ` - - The changelog lists all relevant changes for each TYPO3 version since version 7. - - .. card-footer:: - :button-styles: secondary - - :doc:`13-dev ` - :doc:`v12 ` - :doc:`v11 ` - - - .. card:: :ref:`t3tca:start` - - Reference for the Table Configuration Array (TCA). TCA can be - used to extend the definition of database tables. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`t3tsconfig:start` - - Reference to Page TSconfig and User TSconfig. This is used - to configure the backend. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`t3tsref:start` - - TypoScript is a configuration language that is specific to - TYPO3. This is used to configure the frontend. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`t3viewhelper:start` - - A complete reference of all available Fluid ViewHelper within - TYPO3. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - -.. 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 diff --git a/Documentation/Home/SystemExtensions.rst b/Documentation/Home/SystemExtensions.rst deleted file mode 100644 index 9aad30a..0000000 --- a/Documentation/Home/SystemExtensions.rst +++ /dev/null @@ -1,365 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _System-Extensions: - -================= -System Extensions -================= - -Documentation of extensions managed within the Core repository directly -and maintained by the Core Team and Core contributors are called -*system extensions*. If working with the full Core package, these -extensions can be found in :file:`typo3/sysext` directory. - -Some of these extensions provide documentation, too. These are -listed here. - -EXT:core, EXT:backend and other system extensions do not have their -own documentation; the functionality is documented in -:ref:`TYPO3 Explained `. - -.. toctree:: - :hidden: - - adminpanel - dashboard - felogin - fluid_styled_content - form - impexp - indexed_search - linkvalidator - lowlevel - reactions - recycler - redirects - reports - rte_ckeditor - scheduler - seo - sys_note - t3editor - workspaces - -Documentation of system extensions in current Core version -========================================================== - -The list of extensions developed directly in the Core repository -changes from time to time: Some extensions are merged into others, -some are integrated, others abandoned from Core and maintained at -a different place. - -The list below is kept in sync with the current development version -of the Core, the table further below lists extensions that were -part of the Core and extracted at some point in time. - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :doc:`Admin Panel ` - - The TYPO3 admin panel provides a panel with additional functionality in the frontend (Debugging, Caching, - Preview...). - - Composer name: :composer:`typo3/cms-adminpanel` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Dashboard ` - - A Dashboard for the TYPO3 backend. - - Composer name: :composer:`typo3/cms-dashboard` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Frontend Login ` - - Frontend login based on frontend users and user groups - - Composer name: :composer:`typo3/cms-felogin` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - - .. card:: :doc:`Fluid Styled Content ` - - Content Elements based on Fluid. - - Composer name: :composer:`typo3/cms-fluid-styled-content` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Form framework ` - - Form Library, Plugin and Editor. - - Composer name: :composer:`typo3/cms-form` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Indexed Search ` - - 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. - - Composer name: :composer:`typo3/cms-indexed-search` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Import / Export ` - - Import and Export of records from TYPO3 in a custom serialized format (.T3D) for data exchange with other - TYPO3 systems. - - Composer name: :composer:`typo3/cms-impexp` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Link Validator ` - - The Link Validator checks the links in your website for validity. - - Composer name: :composer:`typo3/cms-linkvalidator` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Lowlevel ` - - 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-lowlevel` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Reactions ` - - This extension handles incoming webhooks to TYPO3. - - Composer name: :composer:`typo3/cms-reactions` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - - .. card:: :doc:`Recycler ` - - The recycler offers the possibility to restore deleted records or remove them from the database permanently. - - Composer name: :composer:`typo3/cms-recycler` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Redirects ` - - Create manual redirects, list existing redirects and automatically create\nredirects on slug changes. - - Composer name: :composer:`typo3/cms-redirects` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Reports ` - - This extension shows status reports and installed services in the - :guilabel:`System > Reports` backend module. - - Composer name: :composer:`typo3/cms-reports` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - - .. card:: :doc:`CKEditor ` - - Integration of CKEditor as a Rich Text Editor for the TYPO3 backend. - - Composer name: :composer:`typo3/cms-rte-ckeditor` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. card:: :doc:`Scheduler ` - - The TYPO3 Scheduler lets you register tasks to happen at a specific time. - - Composer name: :composer:`typo3/cms-scheduler` - - .. card-footer:: - :button-styles: secondary - - :doc:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. 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:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. 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:`14-dev ` - :doc:`13.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:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - - .. 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:`14-dev ` - :doc:`13.4 ` - :doc:`12.4 ` - -.. _System-Extensions-outdated: - -Documentation of system extensions abandoned from current Core version -====================================================================== - -.. t3-field-list-table:: - :header-rows: 1 - - - :Manual: Manual - :Composer: Composer name - :Comment: Comment - - - :Manual: `ADOdb `_ - :Composer: :composer:`friendsoftypo3/adodb` - :Comment: Included until TYPO3 <= 7.6 - - - :Manual: `CSS Styled Content `_ - :Composer: :composer:`typo3/cms-css-styled-content` - :Comment: Included until TYPO3 <= 8.7 - - - :Manual: `Database abstraction layer `_ - :Composer: :composer:`friendsoftypo3/dbal` - :Comment: Included until TYPO3 <= 7.6 - - - :Manual: `func `_ - :Composer: :composer:`friendsoftypo3/cms-func` - :Comment: Was removed from Core in 9.0, see `Changelog ` - - - :Manual: `Openid `_ - :Composer: :composer:`friendsoftypo3/openid` - :Comment: Included until TYPO3 <= 6.2 - - - :Manual: `RSA authentication `_ - :Composer: :composer:`typo3/cms-rsaauth` - :Comment: Included until TYPO3 <= 9.5 - - - :Manual: `htmlarea RTE `_ - :Composer: :composer:`friendsoftypo3/rtehtmlarea` - :Comment: Included until TYPO3 <= 7.6 - - - :Manual: `Salted user password hashes `_ - :Composer: :composer:`typo3/cms-saltedpasswords` - :Comment: Merged into main Core extension since TYPO3 >=7.4. See :ref:`Core API ` - - - :Manual: `System Actions `_ - :Composer: :composer:`typo3/cms-sys-action` - :Comment: Included until TYPO3 <= 9.5 - - - :Manual: `Taskcenter `_ - :Composer: :composer:`typo3/cms-taskcenter` - :Comment: Included until TYPO3 <= 9.5 diff --git a/Documentation/Home/Templating.rst b/Documentation/Home/Templating.rst deleted file mode 100644 index 9c8e148..0000000 --- a/Documentation/Home/Templating.rst +++ /dev/null @@ -1,45 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _templating: - - -========== -Templating -========== - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :ref:`The Fluid Templating Engine ` - - 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 - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Sitepackages ` - - 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. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - -.. toctree:: - :hidden: - - Templating With Fluid - Sitepackages diff --git a/Documentation/Home/UpgradingTYPO3.rst b/Documentation/Home/UpgradingTYPO3.rst deleted file mode 100644 index ff4c4d5..0000000 --- a/Documentation/Home/UpgradingTYPO3.rst +++ /dev/null @@ -1,114 +0,0 @@ -.. include:: /Includes.rst.txt - -.. _upgrading-typo3: - -=============== -Upgrading TYPO3 -=============== - -.. card-grid:: - :columns: 1 - :columns-md: 2 - :gap: 4 - :card-height: 100 - - .. card:: :ref:`Minor upgrades ` - - Minor updates (for example 13.4.1 to 13.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. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Major upgrades ` - - Major updates (for example 12.4 to 13.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 - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Upgrading extensions ` - - 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 - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Third-party tools ` - - Tools and resources developed by the community that can assist with - common upgrade and maintenance tasks. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - - .. card:: :ref:`Legacy upgrade guide ` - - Using TYPO3 without Composer? This chapter details how to upgrade - TYPO3 manually. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Migrate a TYPO3 installation to Composer ` - - Information on how to migrate a legacy installation of TYPO3 to a - Composer-based installation. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - .. card:: :ref:`Migrate content ` - - This chapter details how pages and content can be exported and then - imported into another installation of TYPO3. - - .. card-footer:: - :button-styles: secondary - - :ref:`14-dev ` - :ref:`13.4 ` - :ref:`12.4 ` - - -.. toctree:: - :hidden: - - 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 deleted file mode 100644 index 24c21f6..0000000 --- a/Documentation/Home/_OverviewInclude.rst.txt +++ /dev/null @@ -1,153 +0,0 @@ - -.. _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 e2833c2..4b9a7f9 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,9 +1,18 @@ .. include:: /Includes.rst.txt -.. _start: +.. _start-Contributing: +.. _upgrading-typo3: +.. _templating: +.. _System-Extensions: +.. _getting-started: +.. _extensions: +.. _configuringTYPO3: +.. _creatingmanagingcontent: +.. _contribute: .. _examples: .. _guides: .. _tutorials: +.. _start: =========================================== Welcome to the official TYPO3 Documentation @@ -12,30 +21,71 @@ Welcome to the official TYPO3 Documentation TYPO3 CMS is an Open Source Enterprise Content Management System powered by PHP. -.. rst-class:: horizbuttons-primary-m -* :ref:`getting-started` -* :ref:`references` -* :ref:`extensions` +.. card-grid:: + :columns: 1 + :columns-md: 2 + :gap: 4 + :card-height: 100 + + .. card:: Getting started guide + + This guide introduces some of the core concepts of TYPO3, guides you + through installation, helps you to set up your first small project with + a custom template and gives you information on trou + + .. card-footer:: :ref:`Get started with TYPO3 ` + :button-style: btn btn-secondary stretched-link + + .. card:: Site package tutorial + + This tutorial describes step by step how to come from your first + site package or theme in TYPO3 from the scratch. + + .. card-footer:: :ref:`Build your own site package ` + :button-style: btn btn-secondary stretched-link + + .. card:: Editors guide + + Learn about how to log into the TYPO3 backend, how to work with the + page tree, how to create and manage content, how to work with translations + and other useful tricks for editors. + + .. card-footer:: :ref:`Add content to a TYPO3 page ` + :button-style: btn btn-secondary stretched-link + + .. card:: Download TYPO3 -.. include:: Home/_OverviewInclude.rst.txt + For information about the different versions of TYPO3 and its system + requirements, visit https://get.typo3.org -.. toctree:: - :hidden: + You can also download the the sources from there. We suggest to + :ref:`Install TYPO3 using Composer `, however. - Home/GettingStarted - Home/CreatingManagingContent - Home/Templating - Home/ConfiguringTYPO3 - Home/UpgradingTYPO3 - Home/ExtensionManuals - Home/References - Home/Contribute - Home/Overview + .. card-footer:: `Download TYPO3 `__ + :button-style: btn btn-secondary stretched-link +.. _references: -Support is available via StackOverflow and Slack. Visit the `help page -`__ for more information. +References +========== -For information about the different versions of TYPO3 and its system -requirements, visit https://get.typo3.org. +:ref:`TYPO3 explained ` + The main document for advanced developers and integrators, describes + the API, coding guidelines, configuration options and security + guidelines. Introduces extension development to enhance TYPO3. +:doc:`TYPO3 Core changelog ` + Learn what is new in TYPO3 and how to migrate away from deprecated + functionality. +:ref:`Fluid ViewHelper reference ` + Complete reference of all Fluid ViewHelper provided by TYPO3. Used + to improve your templates. +:ref:`TypoScript reference ` + Complete reference of TypoScript settings and configuration options. + Useful to improve the frontend output of your site. +:ref:`TSconfig rference ` + Configuration options to customize the TYPO3 backend. +:ref:`TCA reference ` + The complete reference of the Table Configuration Array (TCA) which + is used to map between raw database tables and their representation + as database records in the TYPO3 backend and in Extbase. diff --git a/Documentation/mainMenu.rst.txt b/Documentation/_mainMenu.rst.txt similarity index 100% rename from Documentation/mainMenu.rst.txt rename to Documentation/_mainMenu.rst.txt diff --git a/Documentation/mainMenu.json.rst b/Documentation/mainMenu.json.rst index 26bae1c..c7d42ee 100644 --- a/Documentation/mainMenu.json.rst +++ b/Documentation/mainMenu.json.rst @@ -3,4 +3,4 @@ .. main-menu-json:: - .. include:: /mainMenu.rst.txt + .. include:: /_mainMenu.rst.txt