Skip to content

Commit 4e2b5e8

Browse files
glmvclinawolf
andcommitted
Fix typos, grammar and improve wording ("Installation" & "First project setup" chapters) (#683)
* Update Index.rst ("Maintaining TYPO3") fix grammar, typos and "here" links * Update CreateRootPage.rst * Update Index.rst * Update CreateRootPage.rst * Update Settings.rst * Update CreateRootPage.rst * Update CreateSitePackage.rst * Update CreateRootPage.rst Correct indentation * Apply suggestions from code review --------- Co-authored-by: Lina Wolf <48202465+linawolf@users.noreply.github.com> (cherry picked from commit 8d54921)
1 parent ebb0df6 commit 4e2b5e8

File tree

4 files changed

+67
-65
lines changed

4 files changed

+67
-65
lines changed

Documentation/FirstProject/CreateRootPage.rst

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,10 @@ you will learn how to create a root page in TYPO3 v13.
6060
#. Save the page
6161

6262
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 form.
64-
Your new root page will now appear in the page tree on the left.
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.
65+
66+
.. note::
67+
By default, a newly created page is disabled. You need to enable it to
68+
make the page publicly visible.
69+

Documentation/FirstProject/CreateSitePackage.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ To create a site package, you have two main options:
2323
the detailed instructions in the
2424
:ref:`TYPO3 site package tutorial <t3sitepackage:start>`.
2525

26-
* Using the `Sitepackage-Builder <https://get.typo3.org/sitepackage/new//>`__:
27-
If you are looking for a faster start, the Sitepackage-Builder is a
28-
handy tool. You can choose whether your site package should be based on
26+
* Using the `Site Package Builder <https://get.typo3.org/sitepackage/new//>`__:
27+
If you are looking for a faster start, TYPO3's official Site Package Builder
28+
is a handy tool. You can choose whether your site package should be based on
2929
the `Bootstrap Package <https://www.bootstrap-package.com/>`__ or
3030
:ref:`fluid_styled_content <typo3/cms-fluid-styled-content:introduction>`.
3131

@@ -46,16 +46,16 @@ To create a site package, you have two main options:
4646

4747
.. _pros-and-cons-of-sitepackage-builder:
4848

49-
Pros and cons of using the Sitepackage-Builder
50-
==============================================
49+
Pros and cons of using the Site Package Builder
50+
===============================================
5151

5252
Pros:
5353

54-
* The Sitepackage-Builder is particularly useful for beginners or projects
54+
* The Site Package Builder is particularly useful for beginners or projects
5555
that need a quick start.
5656

5757
Cons:
5858

59-
* A large number of unnecessary, mostly empty files are being generated.
60-
* Depending on your prior knowledge you use code that you might not fully
61-
understand.
59+
* A large number of unnecessary, mostly empty files are generated.
60+
* Depending on your prior knowledge, you may use code that you
61+
do not fully understand.

Documentation/FirstProject/Settings.rst

Lines changed: 24 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,10 @@ parts of it.
1616
Global settings
1717
===============
1818

19-
Global settings can be made in the modules in section :guilabel:`Admin Tools`,
20-
which changes file :file:`config/system/settings.php` or be overridden manually
21-
in file :file:`config/system/additional.php`. Avoid making manual changes to
22-
the first file as it is auto-managed.
19+
Global settings can be made in the modules under the :guilabel:`Admin Tools` section,
20+
which updates the :file:`config/system/settings.php` file. Alternatively, settings can
21+
be overridden manually in the :file:`config/system/additional.php` file. Avoid making
22+
manual changes to the first file mentioned, as it is auto-managed.
2323

2424
.. todo: Also explain Configuration Presets and Feature Toggles here?
2525
@@ -28,16 +28,16 @@ the first file as it is auto-managed.
2828
Global extension settings
2929
-------------------------
3030

31-
Global settings to installed extensions, including some that are part of a
32-
default installation can be made in submodule
33-
:guilabel:`Admin Tools > Settings > Extension Configuration`.
31+
Global settings for installed extensions, including some that are part of a
32+
default installation, can be made in the
33+
:guilabel:`Admin Tools > Settings > Extension Configuration` submodule.
3434

3535
.. figure:: /Images/ManualScreenshots/AdminTools/ExtensionConfiguration.png
3636
:alt: Screenshot demonstration the location of the Extension Configuration in module "Settings"
3737

3838
You can find the global Extension Configuration in module Settings
3939

40-
After opening the submodule you can make your changes and hit save:
40+
After opening the submodule, you can make your changes and hit "Save":
4141

4242

4343
.. figure:: /Images/ManualScreenshots/AdminTools/ExtensionConfigurationDetail.png
@@ -46,25 +46,23 @@ After opening the submodule you can make your changes and hit save:
4646
Make changes and hit "Save".
4747

4848
.. note::
49-
File :file:`config/system/settings.php` has to be writable. If you keep it
50-
under version control make sure to commit and push your changes.
49+
The :file:`config/system/settings.php` file has to be writable. If you keep
50+
it under version control, make sure to commit and push your changes.
5151

5252
.. _settings_site:
5353

5454
Site handling
5555
=============
5656

57-
One TYPO3 installation may contain more then one site. Even if you have only one
58-
site in your installation important settings can be made here.
59-
60-
Important settings can be made in the site configuration. Read more about
61-
them in chapter :ref:`siteconfiguration`.
57+
One TYPO3 installation can contain more then one site. Even if you only have one
58+
site in your installation, important settings can be made in the Site Configuration.
59+
Read more about this in the chapter: :ref:`siteconfiguration`.
6260

6361
Site configurations are stored in a file called
64-
:file:`config/sites/my-site/config.yaml` and can be edited from module
65-
:guilabel:`Site Management > Sites`. Each site must have a unique key, called
66-
the "Site Identifier". For demonstration purposes we use "my-site" here. The
67-
Site Identifier is also used in the path to save the configuration.
62+
:file:`config/sites/my-site/config.yaml` and can be edited from the
63+
:guilabel:`Site Management > Sites` module. Each site must have a unique key, called
64+
the "Site Identifier". For demonstration purposes, we use "my-site" here. The
65+
Site Identifier is also used as the path for saving the configuration file.
6866

6967
.. figure:: /Images/ManualScreenshots/SiteManagement/SiteIdentifier.png
7068
:alt: Screenshot demonstration field "Site Identifier" in a site configuration
@@ -97,18 +95,18 @@ Page wide frontend definitions: TypoScript
9795
This module was renamed. With TYPO3 v12 it was moved from
9896
:guilabel:`Web > Template` to :guilabel:`Site Management > TypoScript`.
9997

100-
TypoScript is a scripting language that can and will most likely be used to
101-
influence the output of your pages. TypoScript can be managed in a TypoScript
102-
record that you find in module :guilabel:`Site Management > TypoScript`.
98+
TypoScript is a configuration language used to configure both the frontend
99+
output and the backend of a TYPO3 web site. TypoScript can be managed in a TypoScript
100+
record, which can be found in the :guilabel:`Site Management > TypoScript` module.
103101

104102
.. figure:: /Images/ManualScreenshots/SiteManagement/TypoScriptModule.png
105103
:ref: Screenshot demonstrating the TypoScript overview module
106104

107105
Edit the TypoScript record by clicking on the name of the record in the overview module
108106

109-
TypoScript affects the page it is defined on and all subpages. In most cases
110-
TypoScript is only defined on the root page of a site. In that case the
111-
settings made here affect the whole page.
107+
TypoScript affects the page on which it is defined, and any subpages. In most cases,
108+
TypoScript is only defined on the root page of a site. In this case. the
109+
settings made here affect the entire page.
112110

113111
You can also navigate between the different submodules by using the submodule menu:
114112

@@ -126,6 +124,6 @@ See also the complete :ref:`TypoScript Reference <t3tsref:start>`.
126124
Page wide backend settings: Page TSconfig
127125
=========================================
128126

129-
Read more about this in :ref:`Setting page TSconfig <t3tsref:setting-page-tsconfig>`.
127+
Read more about this topic in :ref:`Setting page TSconfig <t3tsref:setting-page-tsconfig>`.
130128

131129
.. todo: Add screenshots, mention the module etc?

Documentation/Installation/Updates/Index.rst

Lines changed: 27 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ When and why should we perform TYPO3 updates?
1717
With the newest version of TYPO3 you receive free bugfixes and free security patches
1818
for at least three years from the time of the first LTS minor (for example v13.1) release.
1919

20-
In TYPO3 however, we follow a specific cycle which usually takes 1.5 years long. Every
21-
1 and a half year a new TYPO3 version occurs. You can follow the cycle `here <https://typo3.org/cms/roadmap>`__.
20+
In TYPO3 however, we follow a specific `cycle <https://typo3.org/cms/roadmap>`__ which usually takes 1.5 years long. Every
21+
1 and a half year a new TYPO3 version occurs.
2222

2323
We explain the different parts in the `roadmap <https://typo3.org/cms/roadmap>`__ now.
2424
When you follow the roadmap you see dark red strokes. They represent the **sprint releases**.
@@ -39,7 +39,7 @@ we summarize how a TYPO3 user should act with respect to TYPO3 updates:
3939

4040
* When a new major LTS version is released, users **should** focus on updating to this version as soon as possible.
4141
* When a new minor version is released, users **must** update to the new minor version, since the previous minor version is **not** supported any more.
42-
* When a new patch level version is released, users should always update to the new version, because it contains important bugfixes and security fixes (if announced). Here you find the `security advisories <https://typo3.org/help/security-advisories>`__.
42+
* When a new patch level version is released, users **should** always update to the new version, because it contains **important** bugfixes and security fixes (if announced). Here you find the `security advisories <https://typo3.org/help/security-advisories>`__.
4343

4444
Additionally, users should take care of updated extensions on a regular schedule
4545
in order to use the most recent versions.
@@ -57,17 +57,17 @@ Major, minor and patch level updates
5757
In TYPO3 you can update your TYPO3 version. There exist three different types
5858
of updates:
5959

60-
#. Major updates: from for example 12.4.23 to 13.0.0
61-
#. Minor updates: from for example 13.0 to 13.1
62-
#. Patch and bugfix level updates (often security updates): from for example 13.4.0 to 13.4.1
60+
#. Major updates: for example, from 12.4.23 to 13.0.0
61+
#. Minor updates: for example, from 13.0 to 13.1
62+
#. Patch and bugfix level updates (often security updates): for example, from 13.4.0 to 13.4.1
6363

6464

6565
.. _getting-started-major-typo3-updates:
6666

6767
Major updates
6868
-------------
6969

70-
In major updates you will definitely have breaking changes and incompatible API
70+
In major updates you will definitely have **breaking changes** and incompatible API
7171
changes.
7272
A breaking change can cause your system to break. You need to find a replacement
7373
for any usage that was removed or changed. For example in version 13.0 was a
@@ -89,11 +89,11 @@ Minor updates
8989

9090
Minor changes - `11.*.2`: For example 11.5 has new functionalities compared to
9191
11.4. The version 11.5 is compatible with 11. So within a version like major
92-
11 the steps do not lead to breaking changes. For example in version 13.3
92+
11, the steps do not lead to breaking changes. For example in version 13.3
9393
compared to version 13.2 a new
9494
:ref:`Feature: #101252 - Introduce ErrorHandler for 403 errors with redirect option <changelog:feature-101252-1715447531>`
9595
was introduced.
96-
When performing minor updates you often have to clear the cache, run the Upgrade wizard and to run a database compare.
96+
When performing minor updates, you often have to clear the cache, run the Upgrade wizard, and run a database compare.
9797
Usually minor and patch changes are also referred to as **non-breaking** changes.
9898

9999
.. _getting-started-patchlevel-typo3-updates:
@@ -102,21 +102,21 @@ Patchlevel updates
102102
------------------
103103

104104
Patchlevel changes - `11.5.*`: The version 11.5.2 indicates a backwards-compatible bugfix or patch release.
105-
It can be for example a security update. Clear the cache and check if website is working as expected. For further
106-
information we refer to the :ref:`Patch/Bugfix update guide<t3coreapi:minor>`.
105+
It can be for example a security update. Clear the cache and check if the website is working as expected. For
106+
further information we refer to the :ref:`Patch/Bugfix update guide<t3coreapi:minor>`.
107107

108108
.. _getting-started-extension-updates:
109109

110110
Extension updates
111111
=================
112112

113-
In a TYPO3 instance you have usually third party extensions installed. When you update your TYPO3 version you
114-
have to update the third party extensions too. In the **TYPO3 Extension Repository (TER)** you can enter the name of
115-
that extension and get information about supported TYPO3 versions. You find the TER `here <https://extensions.typo3.org/>`__.
113+
In a TYPO3 instance you have usually third party extensions installed. When you update your TYPO3 version, you
114+
have to update the third-party extensions too. In the **`TYPO3 Extension Repository (TER) <https://extensions.typo3.org/>`__**
115+
you can enter the name of that extension and get information about supported TYPO3 versions.
116116
Some extension authors prefer to only publish their extensions on `packagist <https://packagist.org/packages/typo3/>`__.
117117
When the extension does not exist for the current TYPO3 version you can create an
118118
issue or search for an alternative extension offering the same functionality.
119-
For example the `gridelements extension<https://extensions.typo3.org/extension/gridelements>`__
119+
For example, the `gridelements extension<https://extensions.typo3.org/extension/gridelements>`__
120120
was replaced by the `container extension<https://extensions.typo3.org/extension/container>`__, both
121121
having equal functionalities.
122122

@@ -129,30 +129,29 @@ Deprecations
129129

130130
In TYPO3, deprecations indicate that a specific functionality will be removed in the next TYPO3 version. For further
131131
information we refer to the :ref:`article about deprecation <t3coreapi:deprecation>`. For example the
132-
:ref:`deprecation: #105171 - INCLUDE_TYPOSCRIPT TypoScript syntax <changelog:deprecation-105171-1727785626>`- notice is
133-
a deprecation notice telling you that in TYPO3 v14 you can't use the TypoScript syntax :typoscript:`INCLUDE_TYPOSCRIPT`
134-
to include TypoScript files anymore.
132+
:ref:`deprecation: #105171 - INCLUDE_TYPOSCRIPT TypoScript syntax <changelog:deprecation-105171-1727785626>` - a deprecation
133+
notice telling you that in TYPO3 v14 you can't use the TypoScript syntax :typoscript:`INCLUDE_TYPOSCRIPT` to include TypoScript files anymore.
135134

136135
.. _getting-started-little-helpers:
137136

138137
Little Helpers: Rector and Fractor
139138
==================================
140139

141-
In general you can use extensions like `rector <https://github.com/sabbelasichon/typo3-rector/blob/main/README.md>`__
142-
or `fractor <https://github.com/andreaswolf/fractor>`__ to find and replace deprecations. To reach this you have to
143-
fill out a configuration file (in rector file :file:`rector.php`, in fractor file :file:`fractor.php`) that defines
144-
the scope in which you want to perform deprecation replacements. For both extension is valid, only the rules that
145-
exist can find the respective deprecation. Here is an overview about the
146-
`existing rector rules <https://github.com/sabbelasichon/typo3-rector/blob/main/docs/all_rectors_overview.md>`__.
147-
When a rule is missing you can't find the deprecation. Check `here <https://getrector.com/find-rule>`__ if your desired
148-
rector rule exists already. If you feel able to create your own rector or fractor rule and want to share it with the TYPO3
149-
community, everyone using these tools would be happy to benefit from your efforts.
140+
In general you can use extensions like `Rector <https://github.com/sabbelasichon/typo3-rector>`__
141+
or `Fractor <https://github.com/andreaswolf/fractor>`__ to find and replace deprecations. To reach this, you have to
142+
fill out a configuration file (in Rector :file:`rector.php`, in Fractor :file:`fractor.php`) that defines
143+
the scope in which you want to **perform deprecation replacements**. For both extensions, only the rules that
144+
exist can find the respective deprecation. For instance, check the
145+
`overview of existing rules for Rector <https://github.com/sabbelasichon/typo3-rector/blob/main/docs/all_rectors_overview.md>`__
146+
or `search for your desired Rector rule <https://getrector.com/find-rule>`__ if it already exists. When a rule is missing, you can't
147+
find the deprecation using the extension. If you feel able to create your own Rector or Fractor rule and want to share
148+
it with the TYPO3 community, everyone using these tools would be happy to benefit from your efforts.
150149

151150
.. _getting-started-language-updates:
152151

153152
Language updates
154153
================
155154

156-
After a TYPO3 update you have to update your translations. We refer to the article
155+
After a TYPO3 update, you have to update your translations. We refer to the article
157156
:ref:`Update backend translations <t3coreapi:update_backend_translation>`. You have to update the language packs that
158157
you are using after each TYPO3 update.

0 commit comments

Comments
 (0)