Skip to content

Commit 51458a9

Browse files
[TASK] Improve directory structure chapters (#5732)
* [TASK] Improve directory structure chapters Explain how to detect Composer mode vs classic mode and link between the two Improve contents menus and headlines Releases: main, 13.4, 12.4 * [TASK] Improve directory structure chapters Explain how to detect Composer mode vs classic mode and link between the two Improve contents menus and headlines Releases: main, 13.4, 12.4 * Update Documentation/Administration/DirectoryStructure/ClassicInstallations.rst Co-authored-by: Stefan Frömken <123929835+sfroemkenjw@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Stefan Frömken <123929835+sfroemkenjw@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Stefan Frömken <123929835+sfroemkenjw@users.noreply.github.com> * Apply suggestions from code review --------- Co-authored-by: Stefan Frömken <123929835+sfroemkenjw@users.noreply.github.com>
1 parent d065460 commit 51458a9

File tree

6 files changed

+182
-124
lines changed

6 files changed

+182
-124
lines changed

Documentation/Administration/DirectoryStructure/ClassicInstallations.rst

Lines changed: 50 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -11,42 +11,51 @@
1111
Classic mode installations: Directory structure
1212
===============================================
1313

14-
The structure below describes the directory structure in a Classic
15-
TYPO3 installation without Composer. For the structure in a Composer-based installation
16-
see :ref:`Composer-based installations: Directory structure <directory-structure>`.
14+
The structure below describes the directory layout of a Classic TYPO3 installation
15+
(without Composer), sometimes also called a legacy installation.
16+
17+
.. figure:: /Images/ManualScreenshots/Backend/ClassicMode.png
18+
:alt: The TYPO3 backend Extension Manager in Classic Mode: Buttons "Upload Extension" and "Deactivate" for some extensions are visible
19+
20+
If the "Upload Extension" button is visible, TYPO3 is running in Classic mode.
21+
22+
.. contents:: Table of contents
23+
:depth: 1
24+
25+
.. seealso::
26+
27+
* `Composer mode: Directory structure <https://docs.typo3.org/permalink/t3coreapi:directory-structure-composer>`_
28+
for details on the structure in a Composer-based installation.
1729

1830
.. _classic-directory-project:
1931
.. _legacy-directory-project:
2032

21-
Files on project level
22-
======================
23-
24-
The project folder is usually at :file:`/path/to/your/webroot/` (web application root).
25-
It must contain the main entry script :file:`index.php`.
26-
It might contain a file for server configuration like :file:`.htaccess`.
33+
Files on the root level of a typical Classic mode project
34+
=========================================================
2735

28-
.. note::
36+
The project folder, usually at :path:`/path/to/your/webroot/`, must contain
37+
:file:`index.php`. It may also include server config files like :file:`.htaccess`.
2938

30-
Further files might be useful depending on the server or the purpose.
31-
It is for example common to place an authentication file in the web root for a search engine.
32-
Also different files for server configuration might be possible.
39+
Additional files that should be available at the root of you web site like
40+
:file:`robots.txt` can be placed here in single site installations.
3341

34-
Note that TYPO3 has the possibility to provide one or more virtual file(s) :file:`robots.txt`.
35-
This option can be found in the backend module 'Sites' in 'Site Management' and
36-
is especially advised when different domains shall be hosted in one TYPO3 installation.
37-
Like this it's possible to provide for each domain an individual :file:`robots.txt`.
42+
In multi-site installations you should use
43+
`Static routes <https://docs.typo3.org/permalink/t3coreapi:sitehandling-staticroutes>`_
44+
in the site configuration to provide individualized files for each site.
3845

46+
.. _legacy-directory-directory:
47+
.. _classic-directory-directory:
3948

40-
Directories in a typical project
41-
================================
49+
Directories in a typical Classic mode project
50+
=============================================
4251

43-
.. contents::
44-
:local:
52+
.. contents::
53+
:local:
4554

4655
.. _classic-directory-fileadmin:
4756
.. _legacy-directory-fileadmin:
4857

49-
:file:`fileadmin/`
58+
:path:`fileadmin/`
5059
------------------
5160

5261
This is a directory in which editors store files.
@@ -57,7 +66,7 @@ structure.
5766
.. _classic-directory-typo3:
5867
.. _legacy-directory-typo3:
5968

60-
:file:`typo3/`
69+
:path:`typo3/`
6170
--------------
6271

6372
Among others, this directory contains the PHP
@@ -70,25 +79,25 @@ file for accessing the install tool (:file:`public/typo3/install.php`).
7079
.. _classic-directory-typo3-sysext:
7180
.. _legacy-directory-typo3-sysext:
7281

73-
:file:`typo3/sysext/`
82+
:path:`typo3/sysext/`
7483
~~~~~~~~~~~~~~~~~~~~~
7584

7685
All system extensions, supplied by the TYPO3 Core, are stored here.
7786

7887
.. _classic-directory-typo3_source:
7988
.. _legacy-directory-typo3_source:
8089

81-
:file:`typo3_source/`
90+
:path:`typo3_src/`
8291
---------------------
8392

8493
It is a common practice in Classic mode installations to use symlinks to quickly
8594
change between TYPO3 Core versions. In many installations you will find a symlink or folder
86-
called :file:`typo3_source` that contains the folders :ref:`classic-directory-typo3`,
95+
called :path:`typo3_src` that contains the folders :ref:`classic-directory-typo3`,
8796
and :ref:`classic-directory-vendor` and the file :file:`index.php`. In this case,
88-
those directories and files only symlink to :file:`typo3_source`. This way
97+
those directories and files only symlink to :path:`typo3_src`. This way
8998
the Core can be updated quickly by changing the symlink.
9099

91-
Assuming your webroot is a directory called :file:`public` you could have
100+
Assuming your webroot is a directory called :path:`public` you could have
92101
the following symlink structure:
93102

94103
* typo3_src-12.0.0
@@ -111,7 +120,7 @@ the following symlink structure:
111120
.. _classic-directory-typo3conf:
112121
.. _legacy-directory-typo3conf:
113122

114-
:file:`typo3conf/`
123+
:path:`typo3conf/`
115124
------------------
116125

117126
This path can be retrieved from the Environment API, see
@@ -120,7 +129,7 @@ This path can be retrieved from the Environment API, see
120129
.. _classic-directory-typo3conf-autoload:
121130
.. _legacy-directory-typo3conf-autoload:
122131

123-
:file:`typo3conf/autoload/`
132+
:path:`typo3conf/autoload/`
124133
~~~~~~~~~~~~~~~~~~~~~~~~~~~
125134

126135
Contains :ref:`autoloading <autoload>` information.
@@ -130,7 +139,7 @@ The files are updated each time an extension is installed via the
130139
.. _classic-directory-typo3conf-ext:
131140
.. _legacy-directory-typo3conf-ext:
132141

133-
:file:`typo3conf/ext/`
142+
:path:`typo3conf/ext/`
134143
~~~~~~~~~~~~~~~~~~~~~~
135144

136145
Directory for third-party and custom TYPO3 extensions. Each subdirectory
@@ -144,7 +153,7 @@ for more information on how the extensions are structured.
144153
.. _classic-directory-typo3conf-l10n:
145154
.. _legacy-directory-typo3conf-l10n:
146155

147-
:file:`typo3conf/l10n/`
156+
:path:`typo3conf/l10n/`
148157
~~~~~~~~~~~~~~~~~~~~~~~
149158

150159
Directory for extension localizations. Contains all downloaded translation
@@ -156,19 +165,19 @@ This path can be retrieved from the Environment API, see
156165
.. _classic-directory-typo3conf-sites:
157166
.. _legacy-directory-typo3conf-sites:
158167

159-
:file:`typo3conf/sites/`
168+
:path:`typo3conf/sites/`
160169
~~~~~~~~~~~~~~~~~~~~~~~~
161170

162-
The folder :file:`typo3conf/sites/` contains subfolders, one for each site
171+
The folder :path:`typo3conf/sites/` contains subfolders, one for each site
163172
in the installation. See chapter :ref:`site-folder`.
164173

165174
.. _classic-directory-typo3conf-system:
166175
.. _legacy-directory-typo3conf-system:
167176

168-
:file:`typo3conf/system/`
177+
:path:`typo3conf/system/`
169178
~~~~~~~~~~~~~~~~~~~~~~~~~
170179

171-
The folder :file:`typo3conf/system/` contains the installation-wide
180+
The folder :path:`typo3conf/system/` contains the installation-wide
172181
:ref:`configuration files <configuration-files>`:
173182

174183
* :file:`settings.php`: :ref:`Configuration <typo3ConfVars-settings>` written
@@ -185,7 +194,7 @@ This path can be retrieved from the Environment API, see
185194
.. _classic-directory-typo3temp:
186195
.. _legacy-directory-typo3temp:
187196

188-
:file:`typo3temp/`
197+
:path:`typo3temp/`
189198
------------------
190199

191200
Directory for temporary files. It contains subdirectories (see below)
@@ -194,14 +203,14 @@ for temporary files of extensions and TYPO3 components.
194203
.. attention::
195204

196205
Although it is a most common understanding in the TYPO3 world that
197-
:file:`typo3temp/` can be removed at any time, it is considered
206+
:path:`typo3temp/` can be removed at any time, it is considered
198207
bad practice to remove the whole folder. Developers should selectively
199208
remove folders relevant to the changes made.
200209

201210
.. _classic-directory-typo3temp-assets:
202211
.. _legacy-directory-typo3temp-assets:
203212

204-
:file:`typo3temp/assets/`
213+
:path:`typo3temp/assets/`
205214
~~~~~~~~~~~~~~~~~~~~~~~~~
206215

207216
Directory for temporary files that should be publicly available
@@ -210,7 +219,7 @@ Directory for temporary files that should be publicly available
210219
.. _classic-directory-typo3temp-var:
211220
.. _legacy-directory-typo3temp-var:
212221

213-
:file:`typo3temp/var/`
222+
:path:`typo3temp/var/`
214223
~~~~~~~~~~~~~~~~~~~~~~
215224

216225
Directory for temporary files that should not be accessed through the web
@@ -219,7 +228,7 @@ Directory for temporary files that should not be accessed through the web
219228
.. _classic-directory-vendor:
220229
.. _legacy-directory-vendor:
221230

222-
:file:`vendor/`
231+
:path:`vendor/`
223232
~~~~~~~~~~~~~~~
224233

225234
This directory contains third-party packages that are required by the

Documentation/Administration/DirectoryStructure/FlagFiles.rst

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
1-
.. include:: /Includes.rst.txt
1+
:navigation-title: Flag files
22

3-
.. _flag-files:
3+
.. include:: /Includes.rst.txt
4+
.. _flag-files:
45

5-
==========
6-
Flag files
7-
==========
6+
===================================================
7+
Flag files (ENABLE_INSTALL_TOOL, LOCK_BACKEND, ...)
8+
===================================================
89

910
TYPO3 uses a set of special files known as flag files or indicator files to
1011
control and manage low-level configurations, behaviors, and security settings

0 commit comments

Comments
 (0)