Skip to content

Commit 9551a54

Browse files
committed
[TASK] Improve Introduction Package page
References: #546 Releases: main, 13.4, 12.4
1 parent 2656f62 commit 9551a54

File tree

8 files changed

+117
-80
lines changed

8 files changed

+117
-80
lines changed

Documentation/Extensions/InstallingExtensions.rst

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
.. include:: /Includes.rst.txt
1+
.. include:: /Includes.rst.txt
22

3-
.. _installing-extensions:
3+
.. _installing-extensions:
44

55
=====================
66
Installing extensions
@@ -10,7 +10,7 @@ Both system extensions and third-party extensions are managed using Composer. Co
1010
the installation of the extension and also installs any dependencies that may be
1111
required. Composer is also used to uninstall extensions.
1212

13-
.. _install-extension-with-composer:
13+
.. _install-extension-with-composer:
1414

1515
Find the Composer package name for an extension
1616
-----------------------------------------------
@@ -37,53 +37,58 @@ Composer package name
3737
:composer:`friendsoftypo3/extension-builder`
3838

3939

40+
.. _installing-extensions-require:
41+
4042
Use :bash:`composer require` to install the extension
4143
-----------------------------------------------------
4244

43-
.. code-block:: bash
44-
:caption: /var/www/site/$
45+
.. code-block:: bash
46+
:caption: /var/www/site/$
4547
46-
composer require <packagename>
48+
ddev composer require <packagename>
4749
4850
To install the news extension:
4951

52+
.. code-block:: bash
53+
:caption: /var/www/site/$
5054
51-
.. code-block:: bash
52-
:caption: /var/www/site/$
53-
54-
composer require georgringer/news
55+
ddev composer require georgringer/news
5556
5657
This will add the extension requirement to the installations :file:`composer.json`
5758
and install the extension.
5859

5960
Whilst the extension is installed and activated automatically, it still needs to be set up before it can be used:
6061

62+
.. _installing-extensions-setup:
63+
6164
Setup the extension
6265
-------------------
6366

64-
.. code-block:: bash
65-
:caption: /var/www/site/$
67+
.. code-block:: bash
68+
:caption: /var/www/site/$
6669
67-
./vendor/bin/typo3 extension:setup
70+
ddev typo3 extension:setup
6871
6972
The extension setup command takes care of executing additional installation procedures, such as database migrations and
7073
clearing caches if necessary. The extension setup command is not specific to a single extension but instead looks at the overall
7174
state and executes all necessary steps.
7275

76+
.. _uninstalling-extensions:
77+
7378
Uninstalling extensions
7479
=======================
7580

7681
The composer command `remove` uninstalls an extension.
7782

78-
.. code-block:: bash
79-
:caption: /var/www/site/$
83+
.. code-block:: bash
84+
:caption: /var/www/site/$
8085
81-
composer remove georgringer/news
86+
ddev composer remove georgringer/news
8287
8388
The updated :file:`composer.lock` file needs to be committed to the version
8489
control system.
8590

86-
.. _install_local_extensions_using_composer:
91+
.. _install_local_extensions_using_composer:
8792

8893
Installing local extensions
8994
===========================
@@ -97,8 +102,8 @@ Once this directory exists, update the installations `composer.json` and add thi
97102
as a new repository:
98103

99104

100-
.. code-block:: bash
101-
:caption: /var/www/site/composer.json
105+
.. code-block:: bash
106+
:caption: /var/www/site/composer.json
102107
103108
{
104109
"repositories": [
@@ -112,21 +117,22 @@ as a new repository:
112117
Then run `composer require` to the install the local extension `my-local-extension` with vendor `vendor`:
113118

114119

115-
.. code-block:: bash
116-
:caption: /var/www/site/$
120+
.. code-block:: bash
121+
:caption: /var/www/site/$
117122
118-
composer require vendor/my-local-extension:@dev
123+
ddev composer require vendor/my-local-extension:@dev
119124
120125
By executing this command, Composer locates `vendor/my-local-extension` and then symlinks
121126
it to `typo3conf/ext/my-local-extension` once `composer install` is executed.
122127
The setup from above defines that the extension is to be placed by composer into the folder `:file:packages/my-local-extension`
123128
if it has not been already there.
124129

130+
.. _installing-extensions-additional:
125131

126132
Additional information
127133
======================
128134

129-
.. _find-out-extension-key:
135+
.. _find-out-extension-key:
130136

131137
Find out the extension key for an extension
132138
-------------------------------------------

Documentation/FirstProject/CreateSitePackage.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1+
:navigation-title: Site package
12
.. include:: /Includes.rst.txt
23

34
.. _creating-a-site-package:
45

5-
=======================
6-
Creating a site package
7-
=======================
6+
======================================================
7+
Site package - extend or provide a theme for your site
8+
======================================================
89

910
The next step is to create a site package. In TYPO3, a site package is a
1011
structured package that organizes the layout, design, and essential

Documentation/FirstProject/Index.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,13 @@ First project setup
2323
.. card-footer:: :ref:`Set up a prebuild site <introductionpackage_index>`
2424
:button-style: btn btn-secondary stretched-link
2525

26+
.. card:: :ref:`Site package - extend or provide a theme for your site <creating-a-site-package>`
27+
28+
Next steps after setting up your first project.
29+
30+
.. card-footer:: :ref:`Creating a site package <creating-a-site-package>`
31+
:button-style: btn btn-secondary stretched-link
32+
2633
.. card:: :ref:`Root page <create-root-page>`
2734

2835
Learn how to create the first page, the so called root page.
@@ -46,19 +53,12 @@ First project setup
4653
.. card-footer:: :ref:`Manage settings <settings>`
4754
:button-style: btn btn-secondary stretched-link
4855

49-
.. card:: :ref:`Creating a site package <creating-a-site-package>`
50-
51-
Next steps after setting up your first project.
52-
53-
.. card-footer:: :ref:`Creating a site package <creating-a-site-package>`
54-
:button-style: btn btn-secondary stretched-link
55-
5656
.. toctree::
5757
:hidden:
5858
:titlesonly:
5959

6060
IntroductionPackage/Index
61+
CreateSitePackage
6162
CreateRootPage
6263
SiteManagement/Index
6364
Settings
64-
CreateSitePackage
Lines changed: 76 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. include:: /Includes.rst.txt
22

3-
.. _introductionpackage_index:
3+
.. _introductionpackage-index:
44

55
====================
66
Introduction Package
@@ -10,6 +10,13 @@ If you are using TYPO3 for the first time you may want to
1010
see a working example of the CMS before you start work on
1111
your own project.
1212

13+
.. contents::
14+
15+
.. _introductionpackage-about:
16+
17+
About the Introduction Package
18+
==============================
19+
1320
The Official Introduction Package :composer:`typo3/cms-introduction`
1421
showcases many of
1522
TYPO3's capabilities and gives you the ability to try them first hand.
@@ -21,6 +28,18 @@ It also features examples of the different kinds page content that you
2128
typically see on a website, such as paragraphs of text, images, tables
2229
and navigation menus.
2330

31+
.. _installing-introduction-package-prerequisites:
32+
33+
Prerequisites
34+
=============
35+
36+
* You should have a fresh TYPO3 installation, Composer-based and using DDEV
37+
as described here: :ref:`Installing TYPO3 with DDEV <t3start:installation-ddev-tutorial>`.
38+
* You should know about basic TYPO3 concepts such as
39+
:ref:`Backend <t3start:backend>` and :ref:`Frontend <t3start:frontend>`.
40+
* You need very basic knowledge about `DDEV <https://ddev.readthedocs.io/en/stable/>`__
41+
and `Composer <https://getcomposer.org/>`__.
42+
2443
.. _installing-introduction-package-with-composer:
2544
.. _installing-distributions-wit-composer:
2645

@@ -29,65 +48,82 @@ Installing the Introduction Package
2948

3049
To install the Introduction Package run the following command:
3150

32-
.. tabs::
33-
34-
.. group-tab:: bash
35-
36-
.. code-block:: bash
37-
38-
composer require typo3/cms-introduction
39-
40-
.. group-tab:: powershell
41-
42-
.. code-block:: powershell
43-
44-
composer require typo3/cms-introduction
51+
.. code-block:: bash
4552
46-
.. group-tab:: ddev
47-
48-
.. code-block:: bash
49-
50-
ddev composer require typo3/cms-introduction
53+
ddev composer require typo3/cms-introduction
5154
5255
Then run:
5356

54-
.. tabs::
57+
.. code-block:: bash
5558
56-
.. group-tab:: bash
59+
ddev typo3 extension:setup
5760
58-
.. code-block:: bash
61+
This will set up the extension ready for immediate use.
5962

60-
vendor/bin/typo3 extension:setup
63+
.. _install-intro-first-steps:
6164

62-
.. group-tab:: powershell
65+
First steps with the Introduction Package
66+
=========================================
6367

64-
.. code-block:: powershell
68+
The "Introduction Package" creates a number of pre-built pages within the
69+
page tree. The top level page is named "Congratulations".
6570

66-
vendor/bin/typo3 extension:setup
71+
The following DDEV command tells you how to open the
72+
:ref:`Frontend <t3start:frontend>`:
6773

68-
.. group-tab:: ddev
74+
.. code-block:: bash
6975
70-
.. code-block:: bash
76+
ddev describe
7177
72-
ddev typo3 extension:setup
78+
In section "All URLs" choose the first suggested URL and open it in a browser
79+
of your choice. This could be for example: `https://my-first-project.ddev.site`
7380

74-
This will set up the extension ready for immediate use.
81+
.. figure:: /Images/AutomaticScreenshots/Frontend/IntroductionPackageHome.png
82+
:class: with-shadow
83+
:alt: Screenshot of the front page of a TYPO3 project with introduction package installed
7584

76-
.. _install-intro-first-steps:
85+
Frontend of the TYPO3 Introduction Package
7786

78-
First steps with the Introduction Package
79-
=========================================
87+
Open the backend of the site by adding `/typo3` to this URL, for example
88+
`https://my-first-project.ddev.site/typo3` (This URL is configurable, if you
89+
followed this guide it should however not have been changed yet:
90+
:ref:`Backend entry point <t3coreapi:backend-entry-point>`).
91+
92+
.. figure:: /Images/AutomaticScreenshots/Frontend/IntroductionPackageHome.png
93+
:class: with-shadow
94+
:alt: Screenshot of the backend of a TYPO3 project with introduction package installed
8095

81-
The "Introduction Package" creates a number of pre-built pages within the page tree. The top level page is named "Congratulations".
96+
Backend of the TYPO3 Introduction Package
8297

83-
.. rst-class:: bignums-xxl
98+
You can look and click around, try to change the content of the page etc.
99+
The :ref:`Editors Guide <t3editors:start>` explains how to change the content
100+
as an editor.
84101

85-
#. Click on "Congratulations" in the page tree.
102+
.. _install-intro-next-steps:
86103

104+
Next steps
105+
==========
87106

88-
#. View the page in the frontend:
107+
You can use this installation to improve your understanding of some of the
108+
concepts of TYPO3:
89109

90-
Click on the :guilabel:`"View webpage"` icon (with an eye) to view the page
91-
in the frontend.
110+
* Compare the directory structure that was generated and compare it with
111+
chapter :ref:`TYPO3 concepts: Project structure <t3start:project-structure>`.
112+
* The introduction package you just installed is a TYPO3 extension.
113+
The extension key is `introduction` and the Composer name is
114+
:composer:`typo3/cms-introduction` you can find its source code in
115+
directory :path:`vendor/typo3/cms-introduction` and have a look a the
116+
code, especially the :file:`vendor/typo3/cms-introduction/composer.json`
117+
Compare it with chapter :ref:`TYPO3 concepts: Extensions <t3start:concepts-extensions>`.
118+
* The introduction package depends on the third party extension
119+
"Bootstrap Package" with extension key `bootstrap_package` and Composer name
120+
:composer:`bk2k/bootstrap-package`. You can finde its code at
121+
:path:`vendor/bk2k/bootstrap-package`. This is a very complex example of
122+
what a generic site package that can be extended for specific sites looks
123+
like.
124+
* The introduction package only contained some data that was already loaded
125+
into your TYPO3 installation if the frontend worked. It is not needed
126+
anymore and can be uninstalled. See :ref:`uninstalling-extensions`.
92127

93-
.. include:: /Images/AutomaticScreenshots/Frontend/IntroductionPackageHome.rst.txt
128+
Once you are ready for your first project start by
129+
:ref:`Creating a site package <t3start:creating-a-site-package>`.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/Frontend/IntroductionPackageHome.rst.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.
44.3 KB
Loading
168 KB
Loading

0 commit comments

Comments
 (0)