Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Documentation/Assets/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ symlinked into :path:`public/_assets/<some hash>`.

Read more about assets in :ref:`Getting started, assets <t3start:assets>`.

.. contents::

.. _theme-example:

The example theme
Expand Down Expand Up @@ -66,8 +68,8 @@ In a later step, you can use `npm <https://www.npmjs.com/>`__ (Node Package
Manager) to manage your JavaScript and CSS dependencies locally. We also
recommend using a JavaScript bundler like `Vite <https://vite.dev/>`__.

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`
Expand Down
2 changes: 2 additions & 0 deletions Documentation/ContentMapping/AddContent.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ now look like this:

.. include:: /Images/AutomaticScreenshots/ContentMappingPreviewPage.rst.txt

.. contents::

.. _cm-preview-page:

Preview page
Expand Down
2 changes: 2 additions & 0 deletions Documentation/ContentMapping/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions Documentation/ContentMapping/SubpageLayout.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ variable :html:`{sidebarContent}`.
You can compare your result to the example in our site extension:
`TwoColumns.html <https://github.com/TYPO3-Documentation/TYPO3CMS-Tutorial-SitePackage-Code/blob/main/Resources/Private/Templates/Page/TwoColumns.html>`_.

.. contents::

.. _cm-switch_backend_layout:

Expand Down
7 changes: 7 additions & 0 deletions Documentation/CreatePages/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 <t3sitepackage:content-mapping-backend-layout>`.

.. _typo3-backend-site:

Site configuration
Expand Down
1 change: 1 addition & 0 deletions Documentation/ExtensionConfiguration/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
Extension Configuration
=======================

.. contents::

.. _extension-configuration-composer:

Expand Down
2 changes: 2 additions & 0 deletions Documentation/ExtensionInstallation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ followed these steps:

:ref:`Installing TYPO3 with DDEV <t3start:installation-ddev-tutorial>`

.. contents::

.. _extension-installation_with_composer:

Install the site package you just created
Expand Down
2 changes: 2 additions & 0 deletions Documentation/FluidTemplates/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
20 changes: 10 additions & 10 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <t3sitepackage:minimal-design>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Extension Installation <t3sitepackage: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 <t3sitepackage:extension-installation>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Assets <assets-theme>`

Assets usually include CSS files, JavaScript and images / icons used
Expand Down Expand Up @@ -123,14 +131,6 @@ A working copy of the site package extension can be retrieved from the
.. card-footer:: :ref:`Discover the composer configurations <t3sitepackage:extension-configuration>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Extension Installation <t3sitepackage: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 <t3sitepackage:extension-installation>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Summary <t3sitepackage:summary>`

In this chapter we sum up the steps that we did after we have gone
Expand All @@ -144,18 +144,18 @@ 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
TypoScript/Index
MainMenuCreation/Index
SiteSets/Index
ExtensionConfiguration/Index
ExtensionInstallation/Index
Introduction/Index
Summary/Index

.. toctree::
Expand Down
2 changes: 2 additions & 0 deletions Documentation/Introduction/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ theme and functionality of a site.
For further reading see also:
:ref:`TYPO3 explained: Introduction into using site packages <t3coreapi:site-package-introduction>`.

.. contents::

.. _introduction-quickly:

How to get started quickly
Expand Down
2 changes: 2 additions & 0 deletions Documentation/MainMenuCreation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ A data processor (see :ref:`dataProcessing <t3tsref: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`
Expand Down
6 changes: 6 additions & 0 deletions Documentation/MinimalExample/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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 <t3sitepackage:extension-installation>`.

.. _minimal-extension-siteset:

Create a basic site set
Expand Down
4 changes: 3 additions & 1 deletion Documentation/SiteSets/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions Documentation/Summary/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down
2 changes: 2 additions & 0 deletions Documentation/TypoScript/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ by purpose.
Familiarize yourself with the TypoScript `@import` syntax first:
:ref:`TYPO3 Explained, @import syntax <t3tsref:typoscript-syntax-includes>`.

.. contents::

.. _typoscript-import:

Import the TypoScript from a different location
Expand Down