Skip to content

Commit 344ad08

Browse files
committed
[TASK] Improve "Create a root page" chapter (#721)
* [TASK] Improve "Create a root page" chapter releases: main, 13.4 * Apply suggestions from code review Co-authored-by: Mathias Bolt Lesniak <git@mabolek.dev> * Update Documentation/FirstProject/CreateRootPage.rst Co-authored-by: Mathias Bolt Lesniak <git@mabolek.dev> --------- Co-authored-by: Mathias Bolt Lesniak <git@mabolek.dev> (cherry picked from commit 80a1ebe)
1 parent c101e3e commit 344ad08

File tree

9 files changed

+90
-33
lines changed

9 files changed

+90
-33
lines changed
Lines changed: 90 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
:navigation-title: Root page
22
.. include:: /Includes.rst.txt
33

4-
.. index:: site, domain configuration, languages
4+
.. index:: site, domain configuration, languages
55

6-
.. _create-root-page:
6+
.. _create-root-page:
77

88
=========================
99
How to create a root page
@@ -14,56 +14,113 @@ It serves as the top-level page in the page tree and is essential for
1414
configuring the site and making it available to users. In this tutorial,
1515
you will learn how to create a root page in TYPO3 v13.
1616

17-
.. note::
17+
.. admonition:: Prerequisites
18+
1819
* You have TYPO3 :ref:`installed <t3start:installation-ddev-tutorial>`
1920
and can log into the backend.
2021
* You have access to the Page module and permission to create pages.
21-
* You are familiar with the basic layout of the TYPO3 backend.
22+
* You are familiar with the basic layout of the TYPO3
23+
`Backend <https://docs.typo3.org/permalink/t3start:backend>`_.
24+
25+
.. contents:: Steps to create a root package
26+
27+
.. _create-root-page-new-page:
28+
29+
Create a new page on root level
30+
===============================
31+
32+
Once you log into the TYPO3 backend, locate the :guilabel:`Web > Page` module on the left-hand
33+
side of the screen. Click on the Page module to open the page tree.
34+
35+
.. figure:: /Images/ManualScreenshots/CreateRootPage/CreateNewPage.png
36+
:alt: The "Page" module in the TYPO3 backend with a context menu to create a new page
37+
38+
* In the page tree, right-click on the "root level" or the top node of the page
39+
tree (if no pages exist yet, this will likely be labeled as "site" or similar).
40+
A context menu will appear.
41+
42+
* From the context menu, select "New". This will open a form for creating a new
43+
page.
44+
45+
.. _create-root-page-configure:
46+
47+
Configure the newly created page
48+
================================
49+
50+
Now, you need to configure the new page:
51+
52+
* In the form that appears, give your new page a name.
53+
This will be the label of your root page in the page tree.
54+
55+
* Under the :guilabel:`Behavior` tab, look for the checkbox called
56+
"Use as Root Page". Ensure this is checked.
57+
58+
.. figure:: /Images/ManualScreenshots/CreateRootPage/SetRootPage.png
59+
:alt: Page properties, tab "Behaviour", highlighting the "Use as root page"
60+
61+
.. _create-root-page-save:
62+
63+
Save the page
64+
=============
65+
66+
Once you have filled in the necessary information and selected the
67+
"Use as Root Page" option, click the "Save" button at the top of the
68+
form. Your new root page will now appear in the page tree on the left.
69+
The page is only visible in the Backend at this point
70+
71+
.. figure:: /Images/ManualScreenshots/CreateRootPage/PageCreated.png
72+
:alt: Backend module "Page" with a newly created but still disabled root page
2273

23-
.. rst-class:: bignums-xxl
24-
#. Access the Page module
74+
The root page is disabled, therefore it is marked with the red icon.
75+
You can enable it in the context menu.
2576

26-
Once you log into the TYPO3 backend, locate the :guilabel:`Web > Page` module on the left-hand
27-
side of the screen. Click on the Page module to open the page tree.
77+
.. _create-root-page-site:
2878

29-
.. figure:: /Images/ManualScreenshots/CreateRootPage/PageModule.png
79+
Configure the site
80+
==================
3081

31-
#. Create a new root page
82+
All sites must have a `site configuration <https://docs.typo3.org/permalink/t3start:site-management>`_.
83+
If you have created a new page in the root of the page tree, the site configuration has been
84+
created automatically and you can edit it:
3285

33-
* In the page tree, right-click on the "root level" or the top node of the page
34-
tree (if no pages exist yet, this will likely be labeled as "site" or similar).
35-
A context menu will appear.
86+
.. figure:: /Images/ManualScreenshots/CreateRootPage/AutogeneratedSiteConfig.png
87+
:alt: The auto-generated site of a new root page viewed in the "Sites" module
3688

37-
* From the context menu, select "New". This will open a form for creating a new
38-
page.
89+
You can find the auto-generated site configuration for your root page in the module :guilabel:`Site Management > Sites`
3990

40-
.. figure:: /Images/ManualScreenshots/CreateRootPage/CreateNewPage.png
91+
.. _create-root-page-site-package:
4192

42-
* Alternatively, you can select a new page from the menu above the
43-
page tree using drag & drop and place it in the page tree.
93+
Create a site package for the theme
94+
===================================
4495

45-
.. figure:: /Images/ManualScreenshots/CreateRootPage/PageMenu.png
96+
The site needs a theme, also known as a "site package" in the TYPO3 world. Learn more about
97+
`creating a site package <https://docs.typo3.org/permalink/t3start:creating-a-site-package>`_.
4698

99+
.. admonition:: Trouble shooting
47100

48-
#. Set the page type to root
101+
TYPO3 does not come with a default theme. You will have to install
102+
or create a site package. If your site does not have a theme configured,
103+
you will see a message like the the one below when trying to display
104+
the page in the frontend:
49105

50-
Now, you need to configure the new page:
106+
.. figure:: /Images/ManualScreenshots/CreateRootPage/NoTypoScriptFound.png
107+
:alt: Error message: No TypoScript record found!
51108

52-
* In the form that appears, give your new page a name.
53-
This will be the label of your root page in the page tree.
109+
Error message when no site package is installed or configured
54110

55-
* Under the :guilabel:`Behaviour` tab, look for the checkbox called
56-
"Use as Root Page". Ensure this is checked.
111+
* `How to create a site package <https://docs.typo3.org/permalink/t3start:how-to-create-a-site-package>`_
112+
* `Troubleshooting "No TypoScript found!" <https://docs.typo3.org/permalink/t3tsref:guide-troubleshooting>`_
113+
* The `Introduction Package <https://docs.typo3.org/permalink/t3start:introductionpackage-index>`_
114+
includes a ready-to-use theme and example content.
57115

58-
.. figure:: /Images/ManualScreenshots/CreateRootPage/SetRootPage.png
116+
.. _create-root-page-enable:
59117

60-
#. Save the page
118+
Enable the page when you are ready
119+
==================================
61120

62-
Once you have filled in the necessary information and selected the
63-
"Use as Root Page" option, click the "Save" button at the top of the
64-
form. Your new root page will now appear in the page tree on the left.
121+
:guilabel:`Enable` the page as newly created pages are hidden by default.
65122

66-
.. note::
67-
By default, a newly created page is disabled. You need to enable it to
68-
make the page publicly visible.
123+
.. figure:: /Images/ManualScreenshots/CreateRootPage/EnablePage.png
124+
:alt: A disabled root page and its context menu
69125

126+
Right click on the newly created page and chose `Enable` from the context menu. The red icon should disappear.
23.3 KB
Loading
-16.8 KB
Loading
45.7 KB
Loading
6.23 KB
Loading
24.5 KB
Loading
-10.9 KB
Binary file not shown.
Binary file not shown.
5.48 KB
Loading

0 commit comments

Comments
 (0)