11.. include :: /Includes.rst.txt
22
3- .. _ introductionpackage_index :
3+ .. _ introductionpackage-index :
44
55====================
66Introduction Package
@@ -10,6 +10,13 @@ If you are using TYPO3 for the first time you may want to
1010see a working example of the CMS before you start work on
1111your own project.
1212
13+ .. contents ::
14+
15+ .. _introductionpackage-about :
16+
17+ About the Introduction Package
18+ ==============================
19+
1320The Official Introduction Package :composer: `typo3/cms-introduction `
1421showcases many of
1522TYPO3'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
2128typically see on a website, such as paragraphs of text, images, tables
2229and 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
3049To 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 >`.
0 commit comments