Skip to content

Commit 47a64ba

Browse files
[DOCS] Overhaul generate a site package (#365)
Releases: main, Backport: 13.4
1 parent ed2e294 commit 47a64ba

File tree

1 file changed

+42
-42
lines changed

1 file changed

+42
-42
lines changed

Documentation/MinimalExample/Index.rst

Lines changed: 42 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,11 @@
88
Generate a site package
99
=======================
1010

11-
A site package is a custom TYPO3 extension which contains configuration,
12-
templates, assets, etc that are used for the site it belongs to.
11+
A site package is a TYPO3 extension that you can customize to contain the configuration,
12+
templates, assets, etc, for your site. It therefore acts as a kind of main "theme" for
13+
your site.
1314

14-
So first we generate a minimal extension.
15+
So we start by generating a basic extension.
1516

1617
.. contents::
1718

@@ -21,31 +22,31 @@ So first we generate a minimal extension.
2122
Generate and download a site package
2223
====================================
2324

24-
You can download a site package by using the official Site Package Builder at
25+
You can download a site package using the official Site Package Builder at
2526
https://get.typo3.org/sitepackage or by using curl.
2627

27-
You have the choice of three site packages types:
28+
You can choose between three site packages types:
2829

29-
* Bootstrap Package: This site package comes with a ready to use theme
30+
* Bootstrap Package: This site package comes with a ready-to-use theme
3031
* Fluid Styled Content: A minimal site package where you can build your own
3132
custom theme.
32-
* Site Package Tutorial: Contains all files that are used as examples in
33+
* Site Package Tutorial: Contains all the files that are used as examples in
3334
this tutorial.
3435

35-
To follow this tutorial, chose "Site Package Tutorial" as type of the site package.
36+
To follow this tutorial, choose the "Site Package Tutorial".
3637

37-
Download and unzip the zip file, place the result in folder
38-
`packages/my_site_package`, and :ref:`install it <extension-installation>`.
38+
Download and unzip the file into the
39+
`packages/my_site_package` folder and :ref:`install it <extension-installation>`.
3940

4041
.. _extension-installation:
4142

4243
Extension installation
4344
======================
4445

45-
This tutorial assumes that your TYPO3 instance is a brand new installation,
46+
This tutorial assumes that your TYPO3 instance is a brand new installation
4647
without any themes, templates, pages or content.
4748

48-
We assume that you are working on your local machine using DDEV and that you
49+
We assume that you are working on your local machine using DDEV and that you have
4950
followed these steps:
5051

5152
:ref:`Installing TYPO3 with DDEV <t3start:installation-ddev-tutorial>`
@@ -55,13 +56,13 @@ followed these steps:
5556
Install the site package you just created
5657
-----------------------------------------
5758

58-
If you used the Site Package Builder, file :file:`packages/my_site_package/README.md`
59+
If you have used the Site Package Builder, the :file:`packages/my_site_package/README.md` file
5960
contains instructions on how to install your site package.
6061

61-
Move / unzip your extension folder :path:`my_site_package/` into the :path:`packages/`
62+
Move / unzip your :path:`my_site_package/` extension folder into the :path:`packages/`
6263
folder. Then *require* the extension via Composer using the
63-
package name defined in the site package extension's :file:`composer.json` now located
64-
at :file:`packages/my_site_package/`
64+
package name defined in the site package extension's :file:`composer.json` (now located
65+
at :file:`packages/my_site_package/`)
6566

6667
.. code-block:: json
6768
:caption: packages/my-site-package/composer.json
@@ -70,7 +71,7 @@ at :file:`packages/my_site_package/`
7071
"name": "my-vendor/my-site-package"
7172
}
7273
73-
require it by:
74+
*require* it with:
7475

7576
.. code-block:: bash
7677
:caption: Execute in directory page_root
@@ -130,16 +131,16 @@ Your project should now have the following structure:
130131

131132
.. _minimal-extension-siteset:
132133

133-
Look at the a basic site set
134+
A look at the basic site set
134135
============================
135136

136137
.. versionadded:: 13.1
137138
:ref:`Site sets <t3coreapi:site-sets>` have been introduced.
138139

139-
The site package build by Site Package Builder comes with a ready to use
140+
The site package built by Site Package Builder comes with a ready-to-use
140141
site set in folder :path:`packages/my_site_package/Configuration/Sets/SitePackage/`.
141142

142-
The set itself is defined within this folder in the file :file:`config.yaml`:
143+
The set itself is defined in the :file:`config.yaml` file inside this folder:
143144

144145
.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/config.yaml
145146
:caption: packages/my-site-package/Configuration/Sets/SitePackage/config.yaml
@@ -148,23 +149,22 @@ The set itself is defined within this folder in the file :file:`config.yaml`:
148149
You will learn more about site sets in chapter
149150
:ref:`site_set`.
150151

151-
You can find the complete reference in TYPO3 explained:
152+
The TYPO3 Explained complete reference is here:
152153
:ref:`Site sets <t3coreapi:site-sets>`.
153154

154155
During installation of your site package a page tree with example content was
155-
created, and should already have a site configuration in folder
156-
:path:`config/sites/main`.
156+
created. The site configuration folder is :path:`config/sites/main`.
157157

158-
When you look at the site configuration in module :guilabel:`Site Management > Sites`
159-
it should already contain the set "My Site package". Other sets, for example
160-
if you want to use :composer:`typo3/cms-form` can be added here.
158+
If you look at the site configuration in module :guilabel:`Site Management > Sites`
159+
it should already contain the "My Site package" set. Other sets can be added here,
160+
for example :composer:`typo3/cms-form`.
161161

162162
.. figure:: AddSiteSet.png
163163
:alt: Screenshot demonstrating adding the "My Site package" to the site main
164164

165165
Use module :guilabel:`Site Management > Sites` to add the "Example: My Site package"
166166

167-
If you made no changes, the site configuration should look like this:
167+
If you haven't made any changes, the site configuration should look like this:
168168

169169
.. literalinclude:: /CodeSnippets/my_site_package/Initialisation/Site/main/config.yaml
170170
:caption: config/sites/main/config.yaml
@@ -178,33 +178,33 @@ The site set as TypoScript Provider
178178
.. versionadded:: 13.1
179179
A site set can be used as :ref:`TypoScript provider <t3coreapi:site-sets-typoscript>`.
180180

181-
TYPO3 uses TypoScript as configuration language. The TypoScript is used to
182-
configure the templates, which are created with the templating language Fluid.
181+
TYPO3 uses TypoScript as a configuration language. TypoScript is used to
182+
configure templates created with the Fluid templating language.
183183

184184
A file called :path:`packages/my_site_package/Configuration/Sets/SitePackage/setup.typoscript`
185-
provides the TypoScript to your site. This file contains imports of files from
185+
provides the TypoScript for your site. This file contains imports of files from
186186
folder :path:`packages/my_site_package/Configuration/Sets/SitePackage/TypoScript`
187-
which contain the actual configuration.
187+
(which contain the actual configuration).
188188

189-
You can learn more about the TypoScript syntax used here in chapter
189+
Learn more about the TypoScript syntax used here in chapter
190190
:ref:`A minimal page created by pure TypoScript <t3start:typoscript>`
191-
of the "Getting Started Tutorial".
191+
in the "Getting Started Tutorial".
192192

193193
.. _minimal-extension-fluid:
194194

195195
The TYPO3 Fluid version
196196
=======================
197197

198198
File :path:`packages/my_site_package/Configuration/Sets/SitePackage/TypoScript/page.typoscript`
199-
Defines how the output of all pages of the site is rendered with Fluid templates:
199+
below defines the rendering of the site with Fluid templates:
200200

201201
.. literalinclude:: /CodeSnippets/my_site_package/Configuration/Sets/SitePackage/TypoScript/page.typoscript
202202
:caption: packages/my_site_package/Configuration/Sets/SitePackage/TypoScript/page.typoscript
203203
:emphasize-lines: 6
204204
:linenos:
205205

206-
Line 6 defines from what directory the Fluid Templates are loaded. Line 7 allows
207-
to override this part via settings.
206+
Line 6 sets the directory the Fluid Templates are loaded from. Line 7 sets a value
207+
from the site package settings.
208208

209209
Learn more about using Fluid Templates in chapter :ref:`fluid-templates`.
210210

@@ -213,24 +213,24 @@ Learn more about using Fluid Templates in chapter :ref:`fluid-templates`.
213213
Preview page
214214
============
215215

216-
Whenever we have made changes to the Fluid templates or TypoScript files, it is
217-
necessary to :guilabel:`Flush frontend caches` in the menu in the
218-
top bar before you can preview the page properly:
216+
Whenever you make changes to Fluid templates or TypoScript files,
217+
you need to :guilabel:`Flush frontend caches` in the menu in the
218+
top bar before previewing the page:
219219

220220
.. figure:: /Images/AutomaticScreenshots/FlushFrontendCaches.png
221221
:class: with-shadow
222222

223223
Flush the frontend cache after changing template files
224224

225-
You can then preview your page by clicking on the button :guilabel:`View webpage`
225+
You can then preview your page by clicking on the :guilabel:`View webpage` button
226226
in the page module.
227227

228228
.. _extension-configuration-composer:
229229

230230
Composer configuration :file:`composer.json`
231231
============================================
232232

233-
In step :ref:`Create a minimal TYPO3 extension <t3sitepackage:minimal-extension>`
233+
In :ref:`Create a minimal TYPO3 extension <t3sitepackage:minimal-extension>`
234234
a file called :file:`composer.json` was created for you:
235235

236236
.. literalinclude:: /CodeSnippets/my_site_package/composer.json
@@ -243,7 +243,7 @@ extension key in the extra section - :file:`my_site_package` (with an underscore
243243
The Composer "name" consists of a vendor name followed by a forward slash and the
244244
lowercase extension name with dashes.
245245

246-
When you reference files in your extension, the extension key is used, for
246+
When you reference files in your extension use your extension key, for
247247
example when setting your favicon in TypoScript:
248248

249249
.. code-block:: typoscript

0 commit comments

Comments
 (0)