diff --git a/Documentation/Assets/Index.rst b/Documentation/Assets/Index.rst index c1aa1056..36d2f047 100644 --- a/Documentation/Assets/Index.rst +++ b/Documentation/Assets/Index.rst @@ -21,6 +21,8 @@ symlinked into :path:`public/_assets/`. Read more about assets in :ref:`Getting started, assets `. +.. contents:: + .. _theme-example: The example theme @@ -66,8 +68,8 @@ In a later step, you can use `npm `__ (Node Package Manager) to manage your JavaScript and CSS dependencies locally. We also recommend using a JavaScript bundler like `Vite `__. -If you decide to use a frontend bundler, make sure that the resulting asset -files are placed in a publicly available folder, like :path:`Resources/Public` +If you decide to use a frontend bundler, make sure that the resulting asset +files are placed in a publicly available folder, like :path:`Resources/Public` in your site package. There are also TYPO3 extensions like :composer:`praetorius/vite-asset-collector` diff --git a/Documentation/ContentMapping/AddContent.rst b/Documentation/ContentMapping/AddContent.rst index a3ba58a7..ec9de59b 100644 --- a/Documentation/ContentMapping/AddContent.rst +++ b/Documentation/ContentMapping/AddContent.rst @@ -27,6 +27,8 @@ now look like this: .. include:: /Images/AutomaticScreenshots/ContentMappingPreviewPage.rst.txt +.. contents:: + .. _cm-preview-page: Preview page diff --git a/Documentation/ContentMapping/Index.rst b/Documentation/ContentMapping/Index.rst index ae90af7a..5df495d3 100644 --- a/Documentation/ContentMapping/Index.rst +++ b/Documentation/ContentMapping/Index.rst @@ -14,6 +14,8 @@ with dummy content: .. literalinclude:: _codesnippets/_SectionMain.html :caption: Resources/Private/Templates/Pages/Default.html +.. contents:: + .. _content-mapping-site-set: Include the site sets of fluid-styled-content as dependency diff --git a/Documentation/ContentMapping/SubpageLayout.rst b/Documentation/ContentMapping/SubpageLayout.rst index 623bc0a6..0d39a57c 100644 --- a/Documentation/ContentMapping/SubpageLayout.rst +++ b/Documentation/ContentMapping/SubpageLayout.rst @@ -15,6 +15,7 @@ variable :html:`{sidebarContent}`. You can compare your result to the example in our site extension: `TwoColumns.html `_. +.. contents:: .. _cm-switch_backend_layout: diff --git a/Documentation/CreatePages/Index.rst b/Documentation/CreatePages/Index.rst index db2de99c..e401a96d 100644 --- a/Documentation/CreatePages/Index.rst +++ b/Documentation/CreatePages/Index.rst @@ -9,6 +9,8 @@ Create initial pages To follow this tutorial you need to have a few pages in your page tree and some content elements on those pages. You also need a basic site configuration. +.. contents:: + .. _load-example-data: Load the example data automatically @@ -35,6 +37,11 @@ reloading the backend. The page tree in the module :guilabel:`Web > Page` now contains a few example pages. +.. note:: + Ignore the "Unused elements detected" warning for now, it will disappear + once we have :ref:`Created a default page layout with page + TSconfig `. + .. _typo3-backend-site: Site configuration diff --git a/Documentation/ExtensionConfiguration/Index.rst b/Documentation/ExtensionConfiguration/Index.rst index 6ccf1008..9bfdcdf5 100644 --- a/Documentation/ExtensionConfiguration/Index.rst +++ b/Documentation/ExtensionConfiguration/Index.rst @@ -7,6 +7,7 @@ Extension Configuration ======================= +.. contents:: .. _extension-configuration-composer: diff --git a/Documentation/ExtensionInstallation/Index.rst b/Documentation/ExtensionInstallation/Index.rst index 838b876c..6a500dd3 100644 --- a/Documentation/ExtensionInstallation/Index.rst +++ b/Documentation/ExtensionInstallation/Index.rst @@ -14,6 +14,8 @@ followed these steps: :ref:`Installing TYPO3 with DDEV ` +.. contents:: + .. _extension-installation_with_composer: Install the site package you just created diff --git a/Documentation/FluidTemplates/Index.rst b/Documentation/FluidTemplates/Index.rst index 7f0aac2d..94888fee 100644 --- a/Documentation/FluidTemplates/Index.rst +++ b/Documentation/FluidTemplates/Index.rst @@ -22,6 +22,8 @@ This chapter is based on the following steps: After this tutorial you have created Fluid templates and split them into manageable pieces. +.. contents:: + .. _implement-templates-files: .. _the-page-layout-file: .. _create_template: diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 797a224e..2ff86c6e 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -56,6 +56,14 @@ A working copy of the site package extension can be retrieved from the .. card-footer:: :ref:`Create a minimal site package ` :button-style: btn btn-secondary stretched-link + .. card:: :ref:`Extension Installation ` + + In this section we go through the process of installing the site + package extension with composer. + + .. card-footer:: :ref:`Add your site package with composer ` + :button-style: btn btn-secondary stretched-link + .. card:: :ref:`Assets ` Assets usually include CSS files, JavaScript and images / icons used @@ -123,14 +131,6 @@ A working copy of the site package extension can be retrieved from the .. card-footer:: :ref:`Discover the composer configurations ` :button-style: btn btn-secondary stretched-link - .. card:: :ref:`Extension Installation ` - - In this section we go through the process of installing the site - package extension with composer. - - .. card-footer:: :ref:`Add your site package with composer ` - :button-style: btn btn-secondary stretched-link - .. card:: :ref:`Summary ` In this chapter we sum up the steps that we did after we have gone @@ -144,10 +144,10 @@ A working copy of the site package extension can be retrieved from the :titlesonly: :hidden: - Introduction/Index Prerequisites/Index CreatePages/Index MinimalExample/Index + ExtensionInstallation/Index Assets/Index FluidTemplates/Index ContentMapping/Index @@ -155,7 +155,7 @@ A working copy of the site package extension can be retrieved from the MainMenuCreation/Index SiteSets/Index ExtensionConfiguration/Index - ExtensionInstallation/Index + Introduction/Index Summary/Index .. toctree:: diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst index 80003beb..817600c2 100644 --- a/Documentation/Introduction/Index.rst +++ b/Documentation/Introduction/Index.rst @@ -14,6 +14,8 @@ theme and functionality of a site. For further reading see also: :ref:`TYPO3 explained: Introduction into using site packages `. +.. contents:: + .. _introduction-quickly: How to get started quickly diff --git a/Documentation/MainMenuCreation/Index.rst b/Documentation/MainMenuCreation/Index.rst index 0b21bd03..1074bafa 100644 --- a/Documentation/MainMenuCreation/Index.rst +++ b/Documentation/MainMenuCreation/Index.rst @@ -12,6 +12,8 @@ A data processor (see :ref:`dataProcessing `) can be used to provide the data for the menu to the template and a Fluid template partial do define the view of the menu. +.. contents:: + .. _add-menu-processor: Use the data processor `menu` diff --git a/Documentation/MinimalExample/Index.rst b/Documentation/MinimalExample/Index.rst index c4cca6cd..fd2fbbd9 100644 --- a/Documentation/MinimalExample/Index.rst +++ b/Documentation/MinimalExample/Index.rst @@ -12,6 +12,8 @@ templates, assets, etc that are used for the site it belongs to. So first we create a minimal extension. +.. contents:: + .. _minimal-extension: Create a minimal TYPO3 extension using b13/make @@ -80,6 +82,10 @@ After you have created your site package extension you can uninstall :composer:` ddev composer remove b13/make --dev +Before your brand new site package extension takes effect in your TYPO3 +installation, you have to install it. +See chapter :ref:`Extension installation `. + .. _minimal-extension-siteset: Create a basic site set diff --git a/Documentation/SiteSets/Index.rst b/Documentation/SiteSets/Index.rst index 287125e0..5bacc8af 100644 --- a/Documentation/SiteSets/Index.rst +++ b/Documentation/SiteSets/Index.rst @@ -16,10 +16,12 @@ our site package. In step :ref:`content-mapping-site-set` we added dependencies to our site set. +.. contents:: + .. _settings-definitions-yaml-constants: Setting definition ------------------- +================== Settings definitions are used to set values that can be used in the TypoScript setup through out the project. Before they were kept in the file diff --git a/Documentation/Summary/Index.rst b/Documentation/Summary/Index.rst index 03ff642f..332803e2 100644 --- a/Documentation/Summary/Index.rst +++ b/Documentation/Summary/Index.rst @@ -42,6 +42,7 @@ This all sounds very sophisticated and complicated, but keep in mind, the extension (as it stands at this point in time) contains approximately six files only, plus the HTML/CSS files. Only two files contain PHP code. +.. contents:: .. _next-steps: diff --git a/Documentation/TypoScript/Index.rst b/Documentation/TypoScript/Index.rst index b8523d6d..630e72ad 100644 --- a/Documentation/TypoScript/Index.rst +++ b/Documentation/TypoScript/Index.rst @@ -22,6 +22,8 @@ by purpose. Familiarize yourself with the TypoScript `@import` syntax first: :ref:`TYPO3 Explained, @import syntax `. +.. contents:: + .. _typoscript-import: Import the TypoScript from a different location