Skip to content

Commit

Permalink
[TASK] Update Page creation with site package
Browse files Browse the repository at this point in the history
Releases: main, 13.4
  • Loading branch information
linawolf committed Dec 12, 2024
1 parent 4d67f63 commit b489f12
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 38 deletions.
36 changes: 16 additions & 20 deletions Documentation/CreatePages/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,28 @@ 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.

The site package you build in chapter
`Generate a site package <https://docs.typo3.org/permalink/t3sitepackage:minimal-design>`_
creates a folder called :path:`Initialisation`. This folder contains an example
page tree with some dummy content in file
:file:`packages/my_site_package/Initialisation/data.xml`,
and an example site configuration in file
:file:`packages/my_site_package/Initialisation/Site/main/config.yaml`. Folder
:path:`packages/my_site_package/Initialisation/data.xml.files` contains
some example images to demonstrate using certain content elements.

.. contents::

.. _load-example-data:

Load the example data automatically
===================================

We have a created a small extension that loads the example data into your
installation. We suggest you work with this data while you are following this
tutorial.

Install extension :composer:`t3docs/site-package-data` to load the example
data required in this tutorial. It works similarly to the Introduction package,
:composer:`typo3/cms-introduction`.
After installing the site package you downloaded from https://get.typo3.org/sitepackage
run the following command:

.. code-block:: bash
ddev composer req t3docs/site-package-data
ddev typo3 extension:setup
Loading the data might take a few seconds. If you do not see the new pages try
Expand All @@ -38,9 +42,9 @@ 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>`.
This only works for site packages of type "Site Package Tutorial". The ones
based on the Bootstrap Package or Fluid Styled Content do not contain example
data.

.. _typo3-backend-site:

Expand All @@ -52,15 +56,7 @@ been created for you.

The site configuration is stored in a file called
:file:`config/sites/main/config.yaml`. You can edit this file in the
backend module :guilabel:`Site Management > Sites`.

When the :guilabel:`Sites` module is loaded, a warning will be displayed, which will disappear when our package site is created during this tutorial.

.. figure:: SiteSetDependencieWarning.png
:class: with-shadow
:alt: Screenshot of the backend module "Site" with a warning related to missing site set

Once this package has been created, the screen will look like this:
backend module :guilabel:`Site Management > Sites`:

.. figure:: SiteConfiguration.png
:alt: Screenshot of the backend module "Site Management"
Expand Down
Binary file not shown.
28 changes: 10 additions & 18 deletions Documentation/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,36 +36,28 @@ https://github.com/TYPO3-Documentation/site_package
.. card-footer:: :ref:`See the prerequisites <t3sitepackage:prerequisites>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Create initial pages <t3sitepackage:typo3-backend-create-initial-pages>`

Here we use :composer:`t3docs/site-package-data` to create a basic site
configuration and some pages in the TYPO3 backend with some example
content records.

.. card-footer:: :ref:`Create some dummy content <t3sitepackage:typo3-backend-create-initial-pages>`
:button-style: btn btn-secondary stretched-link
.. card:: :ref:`Generate a site package <t3sitepackage:minimal-design>`

.. card:: :ref:`Minimal site package <t3sitepackage:minimal-design>`
Generate a site package using the official Site Package Builder and
install it.

Create a minimal site package that outputs "Hello World".

.. card-footer:: :ref:`Create a minimal site package <t3sitepackage:minimal-design>`
.. card-footer:: :ref:`Generate a site package <t3sitepackage:minimal-design>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Extension Installation <t3sitepackage:extension-installation>`
.. card:: :ref:`Create initial pages <t3sitepackage:typo3-backend-create-initial-pages>`

In this section we go through the process of installing the site
package extension with composer.
Here we use the initialization data provided by your site package
to create some initial pages including dummy content.

.. card-footer:: :ref:`Add your site package with composer <t3sitepackage:extension-installation>`
.. card-footer:: :ref:`Create some dummy content <t3sitepackage:typo3-backend-create-initial-pages>`
:button-style: btn btn-secondary stretched-link

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

Assets usually include CSS files, JavaScript and images / icons used
for design purposes.

.. card-footer:: :ref:`Copy the assets into your site package <assets-theme>`
.. card-footer:: :ref:`Understand using assets into your site package <assets-theme>`
:button-style: btn btn-secondary stretched-link

.. card:: :ref:`Fluid Template <t3sitepackage:fluid-templates>`
Expand Down Expand Up @@ -131,8 +123,8 @@ https://github.com/TYPO3-Documentation/site_package
:hidden:

Prerequisites/Index
CreatePages/Index
MinimalExample/Index
CreatePages/Index
Assets/Index
FluidTemplates/Index
ContentMapping/Index
Expand Down

0 comments on commit b489f12

Please sign in to comment.