Skip to content

Commit e871282

Browse files
[TASK] Update Filelist section (#578)
Releases: main, 13.4, 12.4 Co-authored-by: lina.wolf <[email protected]>
1 parent e81dba4 commit e871282

File tree

7 files changed

+66
-61
lines changed

7 files changed

+66
-61
lines changed
Lines changed: 66 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,93 @@
11
.. include:: /Includes.rst.txt
2-
.. index::
3-
Modules; Filelist
4-
Filelist
52
.. _file-module:
63

74
===================
85
The Filelist module
96
===================
107

11-
The **FILE > Filelist** module is where you can manage
12-
all the media associated with your TYPO3 web site.
8+
The :guilabel:`File > Filelist` module is where you can manage
9+
all the :ref:`media and downloads <media>` associated with your TYPO3 web site.
1310

14-
.. index::
15-
Files; Management
16-
Directories; fileadmin
17-
.. _managing-files:
11+
The Editors Guide describes how to
12+
:ref:`manage media in the TYPO3 backend <t3editors:managing-files-in-typo>`.
1813

19-
Managing files in the TYPO3 CMS
20-
===============================
14+
Do not store :ref:`assets <assets>` needed for your theme here. Store these in
15+
the folder :path:`Resources/Public` of your :ref:`site package <creating-a-site-package>`
16+
or another :ref:`extension <create-own-extension>`.
17+
leuchtfeuer/secure-downloads
2118

22-
Files including documents and images are managed in the
23-
Filelist module. Similar to the **WEB > List** module,
24-
it displays a navigation tree, which corresponds to the file
25-
structure on the server, and a list of all files for the
26-
selected directory.
19+
.. _file-module-fileadmin:
2720

28-
.. include:: /Images/AutomaticScreenshots/FilelistModule/FilelistModule.rst.txt
21+
Fileadmin - the default file storage
22+
====================================
2923

30-
For admin users, the folder displayed by default is called
31-
"fileadmin/ (auto-generated)" and corresponds to the
32-
:file:`fileadmin/` folder located under the document root
33-
folder on your web server.
24+
By default all media managed via the Filelist module is stored in the folder
25+
:path:`public/fileadmin`.
3426

35-
Using these files inside content elements to display them
36-
or link to them in your web site is covered in the
37-
:ref:`Editors Tutorial <t3editors:images>`.
27+
This folder is publicly accessible and it is possible for attackers to access
28+
any file herein when they have or guess the correct path.
3829

39-
.. note::
30+
Third party extensions like :composer:`leuchtfeuer/secure-downloads` can help
31+
you if downloads should only be available to logged-in frontend users.
4032

41-
There are extensions which make it possible to connect to remote
42-
storage pools (like a WebDAV server or an Amazon S3 account) and work
43-
with the files as if they were on the TYPO3 CMS server.
33+
.. _file-module-storages:
4434

35+
File storages
36+
=============
4537

46-
.. index:: pair: Files; Clipboard
38+
It is possible to configure additional file storages, including private and
39+
read only ones. This topic is beyond the scope of this guide. It is explained in
40+
TYPO3 Explained, chapter :ref:`File storages <t3coreapi:fal-administration-storages>`.
4741

48-
.. _file-module-clipboard:
42+
.. _file-module-fal:
4943

50-
Clipboard
51-
---------
44+
File abstraction layer (FAL)
45+
============================
5246

53-
There's a clipboard just like in the *List* module.
47+
All media and download files managed in the Filelist module are managed via
48+
an abstraction layer. You can find the documentation of this layer in TYPO3
49+
Explained, chapter :ref:`File abstraction layer (FAL) <t3coreapi:fal_introduction>`.
5450

55-
.. include:: /Images/AutomaticScreenshots/FilelistModule/FileClipboard.rst.txt
51+
On uploading, each file get a unique identifier assigned to
52+
it. This identifier is used to link to files and also to attach meta data to
53+
them.
5654

57-
Using the action icons, files can be renamed or replaced
58-
(just hover over the icons and you will get a help text).
55+
This allows your editors to rename and move files without breaking the frontend.
56+
It also allows to test weather a file is still being used on deletion and to
57+
automatically delete unused media if desired.
5958

59+
However you can only use the full power of the FAL if you do not link directly
60+
to files but only use the API to access them:
6061

61-
.. index:: Files; Upload
62-
.. _uploading-files:
62+
In Fluid link files using the
63+
:ref:`Image ViewHelper <f:image> <t3viewhelper:typo3-fluid-image>` with property
64+
:typo3:viewhelper-argument:`image <t3viewhelper:typo3-cms-fluid-viewhelpers-imageviewhelper-image>`
65+
for images and the :ref:`Link.file ViewHelper <f:link.file> <t3viewhelper:typo3-fluid-link-file>`
66+
for download links.
6367

64-
Uploading new files
65-
-------------------
68+
In TypoScript the :ref:`typolink function with the file property <t3tsref:typolink-handler-file>`
69+
can be used to link downloads.
6670

67-
You can upload files to a given folder by using the context menu
68-
or to the current directory by using the action icon in the docheader.
71+
For usage in PHP there is an API: :ref:`Working with files, folders and file
72+
references <t3coreapi:fal-using-fal-examples-file-folder>`
6973

70-
.. include:: /Images/AutomaticScreenshots/FilelistModule/FileUpload.rst.txt
74+
.. note::
75+
Never link to a file in the fileadmin from CSS or or JavaScript. Such files
76+
like logos, icons, background images etc. should be stored as
77+
:ref:`Assets in extensions and site packages <assets>`.
78+
79+
.. _file-module-meta-data:
80+
81+
File meta data
82+
==============
83+
84+
A number of meta data fields for media uploaded in the Filelist module is
85+
available out-of-the-box. Additional meta data fields are available if the
86+
system extension :composer:`typo3/cms-filemetadata` is installed.
87+
88+
For accessibility reasons images should always have an alt text defined.
89+
Editors can input an alt text either in the file metadata in the Filelist module
90+
or override it in the file relation when they use an image in a content element.
91+
92+
By using the :ref:`Image ViewHelper <f:image> <t3viewhelper:typo3-fluid-image>`
93+
the alt text is automatically output unless you override it with property 'alt'.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/FilelistModule/FileClipboard.rst.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/FilelistModule/FileUpload.rst.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/FilelistModule/FilelistModule.rst.txt

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)