Merge branch 'main' into feature/remove-legacy-installation-extension

Author: linawolf

Documentation/Concepts/Cache/Index.rst

@@ -0,0 +1,58 @@
+:navigation-title: Cache
+..  include:: /Includes.rst.txt
+
+..  _cache:
+
+=====
+Cache
+=====
+
+.. _what-is-caching:
+
+What is caching in TYPO3?
+=========================
+
+Caching is a process TYPO3 uses to temporarily store content and data to help
+your website load faster and perform efficiently. Instead of regenerating
+every page or content piece each time a visitor loads it, TYPO3 saves a
+"cached" version. This way, the system can quickly serve this saved content,
+reducing the load on the server and speeding up the response time for users.
+
+.. _how-to-clear-cache:
+
+How to clear caches in TYPO3?
+=============================
+
+When you update content or make configuration changes, TYPO3 sometimes needs a
+cache refresh to reflect these updates on the live site.
+Here are the main ways to clear caches in TYPO3 13:
+
+*   Clearing Cache in the backend:
+
+    *   In the Backend, look for the Clear cache icon, which resembles a
+        lightning bolt. You can find this in the top toolbar.
+
+        .. figure:: /Images/ManualScreenshots/ClearCache/Toolbar.png
+
+    *   For deeper cache management, you can use the Install Tool:
+        In :guilabel:`Admin Tools > Maintenance` you can find the option to
+        clear all caches. This will refresh everything, including caches
+        that aren't typically cleared through the backend toolbar.backend
+
+*   Clearing caches via Command Line
+
+    For advanced users or developers, caches can also be cleared from
+    the command line:
+
+    ..  code-block:: bash
+
+        ddev typo3 cache:flush
+
+.. _when-to-clear-cache:
+
+When should you clear caches?
+=============================
+
+*   If new content, images or text doesn't show up right away.
+*   When adjusting templates, extensions or system settings.
+*   While working on custom code, plugins or during site updates.

Documentation/Concepts/Index.rst

@@ -57,6 +57,22 @@ TYPO3 Concepts
         ..  card-footer:: :ref:`Extensions <concepts-extensions>`
             :button-style: btn btn-secondary stretched-link
 
+    ..  card:: Cache
+
+        The TYPO3 cache temporarily stores website data to improve loading
+        speed and reduce server load by delivering saved versions
+        of content to visitors.
+
+        ..  card-footer:: :ref:`Cache <cache>`
+            :button-style: btn btn-secondary stretched-link
+
+    ..  card:: Project Structure
+
+        This chapter describes the structure of a TYPO3 project.
+
+        ..  card-footer:: :ref:`Project Structure <project-structure>`
+            :button-style: btn btn-secondary stretched-link
+
 ..  toctree::
     :caption: Topics
     :glob:

Documentation/Concepts/ProjectStructure/Index.rst

@@ -0,0 +1,150 @@
+:navigation-title: Project Structure
+..  include:: /Includes.rst.txt
+
+..  _project-structure:
+
+=================
+Project structure
+=================
+
+The following introduction refers to a Composer-based installation.
+
+..  directory-tree::
+    :level: 2
+    :show-file-icons: true
+
+
+    *   config
+
+        *   sites
+        *   system
+
+    *   packages
+
+    *   public/
+
+        *   _assets/
+        *   fileadmin/
+        *   typo3/
+        *   typo3temp/
+
+            *   assets/
+
+    *   var/
+
+        *   cache/
+        *   labels/
+        *   log
+
+    *   vendor
+    *   composer.json
+    *   composer.lock
+
+.. _files-and-directories:
+
+Files and directories on project level
+======================================
+
+The :file:`composer.json` contains the requirements for the TYPO3 installation and
+the :file:`composer.lock` contains information about the concrete installed versions
+of each package. For further information see
+:ref:`here <t3coreapi:files-composer-json>`.
+
+.. _directory-config:
+
+:file:`config/`
+~~~~~~~~~~~~~~
+This directory contains installation-wide configuration.
+
+.. _directory-config-sites:
+
+:file:`config/sites/`
+~~~~~~~~~~~~~~~~~~~~~
+
+The folder :file:`config/sites/` contains subfolders for each site.
+
+The following files are processed:
+
+*   :file:`config.yaml` for the :ref:`site configuration <t3coreapi:sitehandling>`
+*   :file:`settings.yaml` for the :ref:`site settings <t3coreapi:sitehandling-settings>`
+
+.. _directory-config-system:
+
+:file:`config/system/`
+~~~~~~~~~~~~~~~~~~~~~~
+
+The folder :file:`config/system/` contains the installation-wide
+
+*   :file:`settings.php`: :ref:`Configuration <t3coreapi:typo3ConfVars-localConfiguration>` written
+    by the :guilabel:`Admin Tools > Settings` backend module
+*   :file:`additional.php`: :ref:`Manually created file <t3coreapi:typo3ConfVars-additionalConfiguration>`
+    which can override settings from :file:`settings.php` file
+
+.. _directory-packages:
+
+:file:`packages/`
+-----------------
+
+.. todo: Link sitepackage
+
+Each website running on TYPO3 should have a site package - a specialized an
+:ref:`extension <t3start:extensions_index>` that contains all the templates,
+styles, images and other assets required for the theme.
+
+The sitepackage is typically stored locally and then linked inte the :file:`vendor`
+folder via a symlink. Many projects also require custom extensions,
+which can also be stored in this location.
+
+.. _directory-public:
+
+:file:`public/`
+---------------
+
+This folder contains all files that are publicly available. Your webserver's
+web root **must** point here.
+
+This folder contains the main entry script :file:`index.php` created by Composer
+and might contain publicly available files like a :file:`robots.txt` and
+files needed for the server configuration like a :file:`.htaccess`.
+
+.. _directory-public-fileadmin:
+
+:file:`public/fileadmin/`
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This is a directory in which editors store files. Typically images,
+PDFs or video files appear in this directory and/or its subdirectories.
+
+.. _directory-public-typo3:
+
+:file:`public/typo3/`
+~~~~~~~~~~~~~~~~~~~~~
+
+This directory contains the two PHP files for accessing the TYPO3
+backend (:file:`typo3/index.php`) and install tool (:file:`typo3/install.php`).
+
+.. _directory-var:
+
+:file:`var/`
+------------
+
+Directory for temporary files that contains private files (e.g.
+cache and logs files) and should not be publicly available.
+
+.. _directory-var-log:
+
+:file:`var/log/`
+~~~~~~~~~~~~~~~~
+
+This directory contains log files like the
+TYPO3 log, the deprecations log and logs generated by extensions.
+
+.. _directory-vendor:
+
+:file:`vendor/`
+---------------
+
+In this directory all extensions (system, third-party and custom) are installed
+as Composer packages.
+
+For more information see :ref:`here <t3coreapi:directory-structure>`.

Documentation/Concepts/TypoScript/Index.rst

@@ -10,11 +10,13 @@ A minimal page created by pure TypoScript
 TypoScript is the basic configuration language used to configure the frontend
 output of a page in TYPO3.
 
-You can find detailed information about
-:ref:`TypoScript <t3coreapi:typoscript-syntax-syntax>` and its syntax in
-the reference "TYPO3 Explained".
+Learn more about TypoScript in
+:ref:`Getting started: A quick introduction into TypoScript <t3tsref:guide>` in
+the :ref:`TypoScript Reference <t3tsref:start>`.
 
-The semantics of TypoScript settings are listed in the
+You can find detailed information about the
+:ref:`TypoScript Syntax<t3tsref:typoscript-syntax>` and a listing of all objects
+and with their properties and functions in the
 :ref:`TypoScript Reference <t3tsref:start>`.
 
 ..  _typoscript-hello-world:
@@ -37,11 +39,11 @@ containing your :ref:`site configuration <site-configuration>`.
     :linenos:
 
 #.  Is a comment. See the Syntax of comments in TypoScript:
-    :ref:`Comments <t3coreapi:typoscript-syntax-syntax-comment-blocks>`.
+    :ref:`Comments <t3tsref:typoscript-syntax-syntax-comment-blocks>`.
 #.  Assigns a top level object of type :ref:`PAGE <t3tsref:object-type-page>`
     to a variable called `page`.
 #.  The `page` gets more options in this block. See the
-    :ref:`Blocks in the TypoScript syntax <t3coreapi:typoscript-syntax-syntax-curly-brackets>`.
+    :ref:`Blocks in the TypoScript syntax <t3tsref:typoscript-syntax-syntax-curly-brackets>`.
 #.  Another comment.
 #.  Assigns a content object (also called "cObject") of type
     :ref:`TEXT <t3tsref:cobj-text>` to
@@ -114,7 +116,7 @@ Wrap "Hello, world." in p-tags
 
 4.  As we now have several options for :ref:`TEXT <t3tsref:cobj-text>` object
     with path `page.10`, we switch to the
-    :ref:`block syntax <t3coreapi:typoscript-syntax-syntax-curly-brackets>` here.
+    :ref:`block syntax <t3tsref:typoscript-syntax-syntax-curly-brackets>` here.
 5.  Assign the text to the :confval:`value <t3tsref:text-value>` property of
     the TEXT object.
 6.  We use the :confval:`stdWrap <t3tsref:text-stdwrap>` property of the TEXT
@@ -153,7 +155,7 @@ Display the title of the current page on top
     :confval:`index number 5 <t3tsref:page-array>` of `page`. As the index is
     smaller than the index 10 of the TEXT object containing the text
     "Hello World", it is displayed before the other object.
-4.  Uses the :ref:`block syntax <t3coreapi:typoscript-syntax-syntax-curly-brackets>`
+4.  Uses the :ref:`block syntax <t3tsref:typoscript-syntax-syntax-curly-brackets>`
     to apply properties to the TEXT object.
 5.  Uses the stdWrap property :confval:`field <t3tsref:stdwrap-field>` to fetch
     the field `title` from the :ref:`database record <t3coreapi:database-records>`
@@ -168,5 +170,3 @@ Display the title of the current page on top
 
     ..  literalinclude:: _page-title_reverse.typoscript
         :caption: config/sites/main/setup.typoscript
-
-.. todo: Add more basic TypoScript examples

Documentation/Extensions/CreateOwnExtension.rst

@@ -0,0 +1,72 @@
+.. include:: /Includes.rst.txt
+
+.. _create-own-extension:
+
+=========================
+Create your own extension
+=========================
+
+In TYPO3, extensions allow you to expand the system’s functionality by
+adding new features and customizing behavior according to your project's needs.
+
+Prerequisites
+=============
+
+*   A working :ref:`TYPO3 installation <t3start:installation-ddev-tutorial>`
+    using Composer.
+*   Familiarity with Composer
+*   Basic knowledge of PHP and TYPO3 development concepts
+*   CLI access to your TYPO3 instance
+
+.. _why-create-extension:
+
+Why create an extension?
+========================
+
+Creating an extension allows you to:
+
+*   Add custom features and modules to TYPO3
+*   Share functionality across multiple TYPO3 instances
+
+
+.. _how-to-create-extension:
+
+How to start developing an extension
+====================================
+
+Developing an extension involves several steps, from setting up the extension
+structure to implementing your custom functionality.
+To guide you through this process, TYPO3 provides a detailed tutorial on
+extension development.
+
+Please refer to this :ref:`link <t3coreapi:extension-tutorials>` for
+comprehensive, step-by-step instructions on how to create an extension.
+
+
+.. _basic-steps:
+
+Basic steps to create an extension
+==================================
+
+*   Define the purpose of your extension.
+
+    Determine what specific functionality or feature you want to add to TYPO3
+
+*   Create the extension skeleton
+
+    Set up the basic structure for your extension.
+
+*   Implement the desired features
+
+    Add the necessary PHP classes, TypoScript configuration and templates
+    that will bring your extension's functionality to life.
+
+*   Register the extension in TYPO3
+
+    Register your extension so TYPO3 can recognize it. This includes adding it
+    to your instance's configuration.
+
+*   Test and refine
+
+    Test your extension to ensure it works as expected and make any needed
+    adjustments.