Skip to content

Commit ccca49e

Browse files
linawolfgithub-actions[bot]
authored andcommitted
[TASK] Write information on List module for Developers and Integrators
How to use the list module for editing is described in the editors tutorial. Releases: main, 13.4, 12.4
1 parent 469f9c8 commit ccca49e

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+78
-334
lines changed

Documentation/Concepts/Backend/ListModule/AdvancedClipboard/Index.rst

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

Documentation/Concepts/Backend/ListModule/Clipboard/Index.rst

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

Documentation/Concepts/Backend/ListModule/Index.rst

Lines changed: 78 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,86 @@
66
The list module
77
===============
88

9-
The list module is a useful tool that allows you to browse through
10-
each page or folder within your site and view all of the records that
11-
are stored within it. The List Module also gives you the ability to
12-
create and manage records that don't have a dedicated Module.
9+
Almost all data stored in the database is represented as a
10+
:ref:`Database record <t3coreapi:database-records>` in the TYPO3 backend.
1311

14-
Sub pages, content elements and news stories are examples of the different
15-
kinds of records that can be stored on any given page.
12+
The :guilabel:`Web > List` module can be used to view, edit, search and
13+
export database records.
1614

17-
For example, a typical page would consist of several content elements that
18-
contain text and images. By using the list module, you can see every content element
19-
stored on that page, even if its set to hidden.
15+
How to use the List module effectively for managing database records is
16+
described in-depth in
17+
:ref:`Editors Guide, Using the list module <t3editors:using-the-list-module-effectively>`.
2018

19+
For example there is a :ref:`Mass editing mode <t3editors:selective-editing>` and
20+
a :ref:`The clipboard <t3editors:clipboard>`.
2121

22-
.. toctree::
23-
:maxdepth: 5
24-
:titlesonly:
25-
:glob:
22+
.. _list-module-tca:
2623

27-
UsingEffectively/Index
28-
Clipboard/Index
29-
AdvancedClipboard/Index
30-
MassEditing/Index
24+
Display of database records in the list-module
25+
==============================================
26+
27+
How a database record type is displayed int the list module is determined by
28+
:ref:`tca` and can be further configured by TSconfig. While TCA is always loaded
29+
globally Tsconfig can be included on a per-site or per-page level.
30+
31+
.. todo: Link tsconfig once article exists in concepts.
32+
33+
Here are some examples of what you might want to change in the list module:
34+
35+
.. _list-module-mod-hideTables:
36+
37+
Hide tables in the List module
38+
------------------------------
39+
40+
The TSconfig properties in section :ref:`web_list <t3tsconfig:pageweblist>`
41+
can be used to influence display and functionality of the List module.
42+
43+
For example you can hide the records of certain tables:
44+
45+
.. code-block:: typoscript
46+
:caption: EXT:site_package/Configuration/page.tsconfig
47+
48+
mod.web_list {
49+
hideTables := addToList(tx_my_table,tx_my_table2)
50+
}
51+
52+
We use the :ref:`Value modifications with ":="
53+
syntax <t3tsref:typoscript-syntax-syntax-value-modification>` to preserve values
54+
that where set by another extension.
55+
56+
.. _list-module-disableHideAtCopy:
57+
58+
Disable hide and prepend at copy
59+
--------------------------------
60+
61+
By default copied database records are inserted hidden and with `(copy X)`
62+
appended to their label. You can disable this default behaviour by
63+
setting :ref:`disablePrependAtCopy <t3tsconfig:pagetcemaintables-disableprependatcopy>`
64+
and :ref:`disableHideAtCopy <t3tsconfig:pagetcemaintables-disablehideatcopy>` for
65+
the affected table belonging to the record:
66+
67+
.. code-block:: typoscript
68+
:caption: EXT:site_package/Configuration/page.tsconfig
69+
70+
TCEMAIN.table.tx_my_table {
71+
disablePrependAtCopy = 1
72+
disableHideAtCopy = 1
73+
}
74+
75+
.. _list-module-TCAdefaults:
76+
77+
Define defaults for certain fields
78+
----------------------------------
79+
80+
You can override the :confval:`default (TCA reference) <t3tca:input-default>`
81+
set globally in :ref:`tca` by setting a custom default value in TSconfig
82+
:ref:`TCAdefaults <t3tsconfig:pageTsTcaDefaults>`:
83+
84+
.. code-block:: typoscript
85+
:caption: EXT:site_package/Configuration/page.tsconfig
86+
87+
# Do not hide newly created pages by default
88+
TCAdefaults.pages.hidden = 0
89+
90+
# Set the author of a news to "Anonymous"
91+
TCAdefaults.tx_news_domain_model_news.author = Anonymous

Documentation/Concepts/Backend/ListModule/MassEditing/Index.rst

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

Documentation/Concepts/Backend/ListModule/UsingEffectively/Index.rst

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

Documentation/Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.rst.txt

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

Documentation/Images/AutomaticScreenshots/ListModule/ClipboardWarning.rst.txt

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

0 commit comments

Comments
 (0)