Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix typos, grammar and improve wording ("Installation" & "First project setup" chapters) #683

Merged
merged 10 commits into from
Feb 23, 2025
10 changes: 8 additions & 2 deletions Documentation/FirstProject/CreateRootPage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,11 @@ you will learn how to create a root page in TYPO3 v13.
#. Save the page

Once you have filled in the necessary information and selected the
"Use as Root Page" option, click the Save button at the top of the form.
Your new root page will now appear in the page tree on the left.
"Use as Root Page" option, click the "Save" button at the top of the
form. Your new root page will now appear in the page tree on the left.

.. note::
By default, a newly created page is disabled. You need to enable it to
make the page publicly visible.

.. todo: Add screenshots, and explain the "disabled"/"page visibility" behavior and settings?
18 changes: 9 additions & 9 deletions Documentation/FirstProject/CreateSitePackage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ To create a site package, you have two main options:
the detailed instructions in the
:ref:`TYPO3 site package tutorial <t3sitepackage:start>`.

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

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

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

Pros and cons of using the Sitepackage-Builder
==============================================
Pros and cons of using the Site Package Builder
===============================================

Pros:

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

Cons:

* A large number of unnecessary, mostly empty files are being generated.
* Depending on your prior knowledge you use code that you might not fully
understand.
* A large number of unnecessary, mostly empty files are generated.
* Depending on your prior knowledge, you may use code that you
do not fully understand.
72 changes: 35 additions & 37 deletions Documentation/FirstProject/Settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ parts of it.
Global settings
===============

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

.. todo: Also explain Configuration Presets and Feature Toggles here?

Expand All @@ -28,16 +28,16 @@ the first file as it is auto-managed.
Global extension settings
-------------------------

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

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

You can find the global Extension Configuration in module Settings

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


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

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

.. _settings_site:

Site handling
=============

One TYPO3 installation may contain more then one site. Even if you have only one
site in your installation important settings can be made here.

Important settings can be made in the site configuration. Read more about
them in chapter :ref:`siteconfiguration`.
One TYPO3 installation can contain more then one site. Even if you only have one
site in your installation, important settings can be made in the Site Configuration.
Read more about this in the chapter: :ref:`siteconfiguration`.

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

.. figure:: /Images/ManualScreenshots/SiteManagement/SiteIdentifier.png
:alt: Screenshot demonstration field "Site Identifier" in a site configuration
Expand All @@ -79,23 +77,23 @@ Site settings
-------------

.. versionadded:: 13.3
Starting with TYPO3 v13.3 site settings can also be edited in the site
Starting with TYPO3 v13.3, site settings can also be edited in the site
settings editor.

You can edit site settings in the module :guilabel:`Site Management > Settings`.
Changes are written to file :file:`config/sites/my-site/settings.yaml`. If you
keep this file under version control you must commit and push the changes made
You can edit site settings in the :guilabel:`Site Management > Settings` module.
Changes are written to the :file:`config/sites/my-site/settings.yaml` file. If you
keep this file under version control, you must commit and push the changes made
to this file.

.. figure:: /Images/ManualScreenshots/SiteManagement/SiteSettingsOverview.png
:alt: Screenshot of the Site Settings Overview

You can find all sites in the settings module. If editable settings are available there is a button "Edit Settings"
You can find all sites in the "Settings" module. If editable settings are available, there is a button "Edit Settings"

You can find more information about this editor in
:ref:`TYPO3 Explained, Site settings editor <t3coreapi:site-settings-editor>`.

If site settings are available refer to the documentation of the extension
If site settings are available, refer to the documentation of the extension
offering them.

The following optional Core extensions offer site settings:
Expand All @@ -108,18 +106,18 @@ The following optional Core extensions offer site settings:
Used to offer a login for frontend users.
* :composer:`typo3/cms-indexed-search`:
:ref:`Settings of the site set "Indexed Search" <typo3/cms-indexed-search:site-set-settings>`.
Used to display a search box and offer basic indexing of a page without need
for a Solr core as would be required by :composer:`apache-solr-for-typo3/solr`.
Used to display a search box and offer basic indexing of a page without the need
for a Solr core, as would be required by :composer:`apache-solr-for-typo3/solr`.
* :composer:`typo3/cms-seo`:
:ref:`Site sets settings of EXT:seo <typo3/cms-seo:configuration-site-set-settings>`.
Used to improve meta tags, page titles and a provides a XML sitemap.
Used to improve meta tags and page titles, and provides an XML sitemap.

You can define custom site settings in your site package:
:ref:`TYPO3 Sitepackage Tutorial <t3sitepackage:start>`.

.. todo: link to the site settings page in the sitepackage tutorial once it is written.
.. todo: link to the site settings page in the sitepackage tutorial once it is written.

Find detailed information on the topic also in
For detailed information on this topic, see also
:ref:`TYPO3 Explained, Site settings <t3coreapi:sitehandling-settings>`.

.. _settings_typoscript:
Expand All @@ -131,18 +129,18 @@ Page wide frontend definitions: TypoScript
This module was renamed. With TYPO3 v12 it was moved from
:guilabel:`Web > Template` to :guilabel:`Site Management > TypoScript`.

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

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

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

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

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

Expand All @@ -160,6 +158,6 @@ See also the complete :ref:`TypoScript Reference <t3tsref:start>`.
Page wide backend settings: Page TSconfig
=========================================

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

.. todo: Add screenshots, mention the module etc?
2 changes: 1 addition & 1 deletion Documentation/FirstProject/SiteManagement/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ have one. You can learn how to create a site package in the

Enter the basic data and choose the site set

Since our set already depends on the set of fluid_styled_content, it is
Since our set already depends on the set of `fluid_styled_content`, it is
not necessary to choose that set here.

.. figure:: NewSitePageLanguage.png
Expand Down
55 changes: 27 additions & 28 deletions Documentation/Installation/Updates/Index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ When and why should we perform TYPO3 updates?
With the newest version of TYPO3 you receive free bugfixes and free security patches
for at least three years from the time of the first LTS minor (for example v13.1) release.

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

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

* When a new major LTS version is released, users **should** focus on updating to this version as soon as possible.
* 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.
* 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>`__.
* 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>`__.

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

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


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

Major updates
-------------

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

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

.. _getting-started-patchlevel-typo3-updates:
Expand All @@ -102,21 +102,21 @@ Patchlevel updates
------------------

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

.. _getting-started-extension-updates:

Extension updates
=================

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

Expand All @@ -129,30 +129,29 @@ Deprecations

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

.. _getting-started-little-helpers:

Little Helpers: Rector and Fractor
==================================

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

.. _getting-started-language-updates:

Language updates
================

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