[Backport 12.4] [TASK] Write information on List module for Developer…

…s and Integrators (#569) * [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 * Update Documentation/Concepts/Backend/ListModule/Index.rst * Apply suggestions from code review Co-authored-by: Sandra Erbel <[email protected]> --------- Co-authored-by: lina.wolf <[email protected]> Co-authored-by: Lina Wolf <[email protected]> Co-authored-by: Sandra Erbel <[email protected]>
TYPO3-Documentation · Nov 17, 2024 · a98369a · a98369a
1 parent 469f9c8
commit a98369a
Show file tree

Hide file tree

Showing 41 changed files with 76 additions and 334 deletions.
diff --git a/Documentation/Concepts/Backend/ListModule/AdvancedClipboard/Index.rst b/Documentation/Concepts/Backend/ListModule/AdvancedClipboard/Index.rst
diff --git a/Documentation/Concepts/Backend/ListModule/Clipboard/Index.rst b/Documentation/Concepts/Backend/ListModule/Clipboard/Index.rst
diff --git a/Documentation/Concepts/Backend/ListModule/Index.rst b/Documentation/Concepts/Backend/ListModule/Index.rst
@@ -6,25 +6,84 @@
 The list module
 ===============
 
-The list module is a useful tool that allows you to browse through
-each page or folder within your site and view all of the records that
-are stored within it. The List Module also gives you the ability to
-create and manage records that don't have a dedicated Module.
+Almost all data stored in the database is represented as a
+:ref:`Database record <t3coreapi:database-records>` in the TYPO3 backend.
 
-Sub pages, content elements and news stories are examples of the different
-kinds of records that can be stored on any given page.
+The respective backend module called :guilabel:`Web > List` module can be 
+used to view, edit, search and export database records.
 
-For example, a typical page would consist of several content elements that
-contain text and images. By using the list module, you can see every content element
-stored on that page, even if its set to hidden.
+How to use the List module effectively for managing database records is
+described in-depth in
+:ref:`Editors Guide, Using the list module <t3editors:using-the-list-module-effectively>`.
 
+For example there is a :ref:`Mass editing mode <t3editors:selective-editing>` and
+a :ref:`clipboard <t3editors:clipboard>`.
 
-.. toctree::
-   :maxdepth: 5
-   :titlesonly:
-   :glob:
+.. _list-module-tca:
 
-   UsingEffectively/Index
-   Clipboard/Index
-   AdvancedClipboard/Index
-   MassEditing/Index
+Display of database records in the List module
+==============================================
+
+How a database record type is displayed in the list module is determined by
+:ref:`tca` and can be further configured by TSconfig. While TCA is always loaded
+globally Tsconfig can be included on a per-site or per-page level.
+
+..  todo: Link tsconfig once article exists in concepts.
+
+Here are some examples of what you might want to change in the list module:
+
+.. _list-module-mod-hideTables:
+
+Hide tables in the List module
+------------------------------
+
+The TSconfig properties in section :ref:`web_list <t3tsconfig:pageweblist>`
+can be used to influence display and functionality of the List module.
+
+For example you can hide the records of certain tables visible in the List module with:
+
+..  code-block:: typoscript
+    :caption: EXT:site_package/Configuration/page.tsconfig
+
+    mod.web_list {
+        hideTables := addToList(tx_my_table,tx_my_table2)
+    }
+
+We use the :ref:`operator ":=" <t3tsref:typoscript-syntax-syntax-value-modification>` to add tables to a list that we want to hide.
+
+.. _list-module-disableHideAtCopy:
+
+Disable hide and prepend at copy
+--------------------------------
+
+By default copied database records are inserted hidden and with `(copy X)`
+appended to their label. You can disable this default behaviour by
+setting :ref:`disablePrependAtCopy <t3tsconfig:pagetcemaintables-disableprependatcopy>`
+and :ref:`disableHideAtCopy <t3tsconfig:pagetcemaintables-disablehideatcopy>` for
+the affected table belonging to the record to true like so:
+
+..  code-block:: typoscript
+    :caption: EXT:site_package/Configuration/page.tsconfig
+
+    TCEMAIN.table.tx_my_table {
+       disablePrependAtCopy = 1
+       disableHideAtCopy = 1
+    }
+
+.. _list-module-TCAdefaults:
+
+Define defaults for certain fields
+----------------------------------
+
+You can override the :confval:`default (TCA reference) <t3tca:input-default>`
+set globally in the :ref:`tca` by setting a custom default value in TSconfig
+:ref:`TCAdefaults <t3tsconfig:pageTsTcaDefaults>`:
+
+..  code-block:: typoscript
+    :caption: EXT:site_package/Configuration/page.tsconfig
+
+    # Do not hide newly created pages by default
+    TCAdefaults.pages.hidden = 0
+
+    # Set the author of a news to "Anonymous"
+    TCAdefaults.tx_news_domain_model_news.author = Anonymous
diff --git a/Documentation/Concepts/Backend/ListModule/MassEditing/Index.rst b/Documentation/Concepts/Backend/ListModule/MassEditing/Index.rst
diff --git a/Documentation/Concepts/Backend/ListModule/UsingEffectively/Index.rst b/Documentation/Concepts/Backend/ListModule/UsingEffectively/Index.rst
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.png b/Documentation/Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ClipboardWarning.png b/Documentation/Images/AutomaticScreenshots/ListModule/ClipboardWarning.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ClipboardWarning.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/ClipboardWarning.rst.txt
diff --git a/...mentation/Images/AutomaticScreenshots/ListModule/ClipboardWithMultipleItems.png b/...mentation/Images/AutomaticScreenshots/ListModule/ClipboardWithMultipleItems.png
diff --git a/...ation/Images/AutomaticScreenshots/ListModule/ClipboardWithMultipleItems.rst.txt b/...ation/Images/AutomaticScreenshots/ListModule/ClipboardWithMultipleItems.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/CopyToClipboard.png b/Documentation/Images/AutomaticScreenshots/ListModule/CopyToClipboard.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/CopyToClipboard.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/CopyToClipboard.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ListModule.png b/Documentation/Images/AutomaticScreenshots/ListModule/ListModule.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ListModule.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/ListModule.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ListModuleContentArea.png b/Documentation/Images/AutomaticScreenshots/ListModule/ListModuleContentArea.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ListModuleContentArea.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/ListModuleContentArea.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeader.png b/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeader.png
diff --git a/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeader.rst.txt b/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeader.rst.txt
diff --git a/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeaderButton.png b/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeaderButton.png
diff --git a/...on/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeaderButton.rst.txt b/...on/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditHeaderButton.rst.txt
diff --git a/...mages/AutomaticScreenshots/ListModule/MassEdit/MassEditMultipleFieldsButton.png b/...mages/AutomaticScreenshots/ListModule/MassEdit/MassEditMultipleFieldsButton.png
diff --git a/...s/AutomaticScreenshots/ListModule/MassEdit/MassEditMultipleFieldsButton.rst.txt b/...s/AutomaticScreenshots/ListModule/MassEdit/MassEditMultipleFieldsButton.rst.txt
diff --git a/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditingEnabled.png b/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditingEnabled.png
diff --git a/...tion/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditingEnabled.rst.txt b/...tion/Images/AutomaticScreenshots/ListModule/MassEdit/MassEditingEnabled.rst.txt
diff --git a/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassMultipleFields.png b/...entation/Images/AutomaticScreenshots/ListModule/MassEdit/MassMultipleFields.png