Skip to content

Commit

Permalink
[DOCS] Streamline installation chapters of system extension manuals
Browse files Browse the repository at this point in the history
The content of the installation chapter of the various system
extension differs, some don't have an installation chapter. This
is now streamlined: now every installation chapter has the
Composer-based installation and the legacy installation described
in the same way.

Resolves: #103308
Releases: main, 12.4
Change-Id: I7750ab3139e468a16c48e22a8e5659947713872a
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/83290
Tested-by: Lina Wolf <112@linawolf.de>
Reviewed-by: Chris Müller <typo3@krue.ml>
Tested-by: Chris Müller <typo3@krue.ml>
Tested-by: core-ci <typo3@b13.com>
Reviewed-by: Lina Wolf <112@linawolf.de>
  • Loading branch information
brotkrueml authored and linawolf committed Mar 7, 2024
1 parent 36f24c3 commit f781d5d
Show file tree
Hide file tree
Showing 39 changed files with 636 additions and 222 deletions.
4 changes: 2 additions & 2 deletions typo3/sysext/adminpanel/Documentation/Installation/Index.rst
Expand Up @@ -24,7 +24,7 @@ This should either give you no result or something similar to:

.. code-block:: none
typo3/cms-adminpanel v12.4.1
typo3/cms-adminpanel v12.4.11
If it is not installed yet, use the ``composer require`` command to install
the extension:
Expand All @@ -45,7 +45,7 @@ not be activated yet. Activate it as follows:
module.
#. Click the :guilabel:`Activate` icon for the Admin Panel extension.

.. figure:: ../Images/InstallActivate.png
.. figure:: /Images/InstallActivate.png
:class: with-border
:alt: Extension manager showing Admin Panel extension

Expand Down
36 changes: 19 additions & 17 deletions typo3/sysext/dashboard/Documentation/Installation/Index.rst
Expand Up @@ -9,40 +9,42 @@ Installation

Target group: **Administrators**

This extension is part of the TYPO3 core.
This extension is part of the TYPO3 Core, but not installed by default.

Installation with composer
.. contents:: Table of contents
:local:

Installation with Composer
==========================

Check whether you are already using the extension with::
Check whether you are already using the extension with:

composer show | grep dashboard
.. code-block:: bash
This should either give you no result or something similar to:::
composer show | grep dashboard
typo3/cms-dashboard v10.4.0 Dashboard for TYPO3.
This should either give you no result or something similar to:

If it is not yet installed, use the ``composer require`` command to install the extension::
.. code-block:: none
composer require typo3/cms-dashboard ^10.4
typo3/cms-dashboard v12.4.11
The given version depends on the version of the TYPO3 core you are using.
If it is not installed yet, use the ``composer require`` command to install
the extension:

Now head over to the extension manager and activate the extension.
.. code-block:: bash
.. figure:: ../Images/em.png
:class: with-shadow
:alt: Extension manager with filtered dashboard extension
composer require typo3/cms-dashboard
Extension manager with filtered dashboard extension
The given version depends on the version of the TYPO3 Core you are using.

Installation without composer
Installation without Composer
=============================

In an installation without composer, the extension is already shipped. You just have to activate it.
In an installation without Composer, the extension is already shipped. You just have to activate it.
Head over to the extension manager and activate the extension.

.. figure:: ../Images/em.png
.. figure:: /Images/em.png
:class: with-shadow
:alt: Extension manager with filtered dashboard extension

Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions typo3/sysext/felogin/Documentation/Index.rst
Expand Up @@ -40,6 +40,7 @@ in to the TYPO3 frontend.
:titlesonly:

Introduction/Index
Installation/Index
UsersManual/Index
LoginMechanism/Index
Configuration/Index
Expand Down
57 changes: 57 additions & 0 deletions typo3/sysext/felogin/Documentation/Installation/Index.rst
@@ -0,0 +1,57 @@
.. include:: /Includes.rst.txt

.. _installation:

============
Installation
============

This extension is part of the TYPO3 Core, but not installed by default.

.. contents:: Table of contents
:local:

Installation with Composer
==========================

Check whether you are already using the extension with:

.. code-block:: bash
composer show | grep felogin
This should either give you no result or something similar to:

.. code-block:: none
typo3/cms-felogin v12.4.11
If it is not installed yet, use the ``composer require`` command to install
the extension:

.. code-block:: bash
composer require typo3/cms-felogin
The given version depends on the version of the TYPO3 Core you are using.

Installation without Composer
=============================

In an installation without Composer, the extension is already shipped but might
not be activated yet. Activate it as follows:

#. In the backend, navigate to the :guilabel:`Admin Tools > Extensions`
module.
#. Click the :guilabel:`Activate` icon for the Frontend Login extension.

.. figure:: /Images/InstallActivate.png
:class: with-border
:alt: Extension manager showing Frontend Login extension

Extension manager showing Frontend Login extension

Next steps
==========

:ref:`Configure the Frontend Login <configuration>`.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Expand Up @@ -6,76 +6,54 @@
Installation
============

.. _installation_composer:

With Composer
=============

If your :ref:`TYPO3 installation <t3start:install>` is using Composer,
install the extension `fluid_styled_content` by:

.. code-block:: bash
composer require typo3/cms-fluid-styled-content
This extension is part of the TYPO3 Core.

If you are not working with the latest version of TYPO3
you will need to add a version constraint:
.. contents:: Table of contents
:local:

.. code-block:: bash
.. _installation_composer:

composer require typo3/cms-fluid-styled-content:"^10.4"
Installation with Composer
==========================

Installing the extension prior to TYPO3 11.4
--------------------------------------------
Check whether you are already using the extension with:

Before TYPO3 11.4 it was still necessary to manually activate extensions
installed via Composer using the :guilabel:`Extensions` module.
.. code-block:: bash
If you are using TYPO3 with Composer and are using a version of TYPO3 that is
older than 11.4, you will need to activate the extension:
composer show | grep fluid-styled-content
- Access :guilabel:`Admin Tools > Extensions > Installed Extensions`
- Search for `fluid_styled_content` (note the underscores)
- Activate the extension by selecting the :guilabel:`Activate` button in the
column labeled :guilabel:`A/D`
This should either give you no result or something similar to:

.. _installation_legacy:
.. code-block:: none
Without Composer
================
typo3/cms-fluid-styled-content v12.4.11
If you are working with a
:ref:`legacy installation <t3start:legacyinstallation>` of TYPO3, this
extension will already be part of the installation due to the fact that
"classic" `.tar` & `.zip` packages come bundled with all system extensions.
If it is not installed yet, use the ``composer require`` command to install
the extension:

However, whilst the extension is already downloaded, it might not be activated.
.. code-block:: bash
To activate the extension `fluid_styled_content`, navigate to
:guilabel:`Admin Tools > Extensions > Installed Extensions` and
search for `fluid_styled_content` (note the underscores). If the extension
is not active, activate it by selecting
the :guilabel:`Activate` button in the column labeled :guilabel:`A/D`.
composer require typo3/cms-fluid-styled-content
.. figure:: /Images/ManualScreenshots/Installation/ActivateExtension.png
:alt: Activate the extension by clicking the Activate button.
The given version depends on the version of the TYPO3 Core you are using.

Activate the extension by clicking the :guilabel:`Activate` button.
.. _installation_legacy:

System Maintainer rights are required to activate the extension.
Installation without Composer
=============================

.. _upgrading:
In an installation without Composer, the extension is already shipped but might
not be activated yet. Activate it as follows:

Upgrade
=======
#. In the backend, navigate to the :guilabel:`Admin Tools > Extensions`
module.
#. Click the :guilabel:`Activate` icon for the Fluid Styled Content extension.

If you upgrade your TYPO3 CMS installation from one major version to another
(for example 10.4 to 11.5), it is advised to run the
:ref:`Upgrade Wizard <t3install:postupgradetasks>`.
It guides you through the necessary steps to upgrade your database records.
.. figure:: /Images/ManualScreenshots/Installation/ActivateExtension.png
:class: with-border
:alt: Extension manager showing Fluid Styled Content extension

Open the tool at :guilabel:`Admin Tools > Upgrade > Upgrade Wizard` and run all
suggested steps.
Extension manager showing Fluid Styled Content extension

Next step
=========
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions typo3/sysext/form/Documentation/Index.rst
Expand Up @@ -40,6 +40,7 @@ integrators and developers alike to create all kinds of forms.
:titlesonly:

Introduction/Index
Installation/Index
QuickStartForEditors/Index
QuickStartForIntegrators/Index
D/Index
Expand Down
52 changes: 52 additions & 0 deletions typo3/sysext/form/Documentation/Installation/Index.rst
@@ -0,0 +1,52 @@
.. include:: /Includes.rst.txt

.. _installation:

============
Installation
============

This extension is part of the TYPO3 Core, but not installed by default.

.. contents:: Table of contents
:local:

Installation with Composer
==========================

Check whether you are already using the extension with:

.. code-block:: bash
composer show | grep form
This should either give you no result or something similar to:

.. code-block:: none
typo3/cms-form v12.4.11
If it is not installed yet, use the ``composer require`` command to install
the extension:

.. code-block:: bash
composer require typo3/cms-form
The given version depends on the version of the TYPO3 Core you are using.

Installation without Composer
=============================

In an installation without Composer, the extension is already shipped but might
not be activated yet. Activate it as follows:

#. In the backend, navigate to the :guilabel:`Admin Tools > Extensions`
module.
#. Click the :guilabel:`Activate` icon for the Form extension.

.. figure:: /Images/InstallActivate.png
:class: with-border
:alt: Extension manager showing Form extension

Extension manager showing Form extension
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
61 changes: 29 additions & 32 deletions typo3/sysext/impexp/Documentation/Installation/Index.rst
Expand Up @@ -6,54 +6,51 @@
Installation
============

This extension is part of the TYPO3 Core, but not installed by default.

.. contents:: Table of contents
:local:

.. _installation_composer:

With Composer
=============
Installation with Composer
==========================

If your TYPO3 installation is using Composer, install the import/export
extension by:
Check whether you are already using the extension with:

.. code-block:: bash
.. code-block:: bash
composer require typo3/cms-impexp
composer show | grep impexp
If you are using Composer and not working with the latest version of TYPO3
you will need to add a version constraint:
This should either give you no result or something similar to:

.. code-block:: bash
.. code-block:: none
composer require typo3/cms-impexp:"^10.4"
typo3/cms-impexp v12.4.11
Installing the extension prior to version 11.4
----------------------------------------------
If it is not installed yet, use the ``composer require`` command to install
the extension:

Before TYPO3 11.4 it was still necessary to manually activate extensions
installed via Composer using the Extension Manager.
.. code-block:: bash
If you are using TYPO3 with Composer and are using a version of TYPO3 that is
older than 11.4, you will need to activate the extension:
composer require typo3/cms-impexp
- Access :guilabel:`Admin Tools > Extension Manager > Installed Extensions`
- Search for `impexp`
- Activate the extension by selecting the :guilabel:`Activate` button in the
column labeled :guilabel:`A/D`
The given version depends on the version of the TYPO3 Core you are using.

.. _installation_legacy:

Without Composer
================
Installation without Composer
=============================

If you are working with an installation of TYPO3 that doesn't use Composer, this
extension will already be part of the installation due to the fact that
"classic" `.tar` & `.zip` packages come bundled with all system extensions.
In an installation without Composer, the extension is already shipped but might
not be activated yet. Activate it as follows:

However, whilst the extension is already downloaded, it is likely that the
extension is not activated.
#. In the backend, navigate to the :guilabel:`Admin Tools > Extensions`
module.
#. Click the :guilabel:`Activate` icon for the Import / Export extension.

To activate the import/export tool, navigate to
:guilabel:`Admin Tools > Extension Manager > Installed Extensions` and
search for "impexp". If the extension is not active, activate it by selecting
the :guilabel:`Activate` button in the column labeled :guilabel:`A/D`.
.. figure:: /Images/ManualScreenshots/InstallActivate.png
:class: with-border
:alt: Extension manager showing Import / Export extension

Admin rights are required to activate the extension.
Extension manager showing Import / Export extension
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f781d5d

Please sign in to comment.