[TASK] Update the List Module section and its screenshots (#211)

* [TASK] Update the List Module section and its screenshots releases: main, 13.4 * Apply suggestions from code review Co-authored-by: Stefan Frömken <[email protected]> * Update Documentation/ListModule/UsingEffectively/Index.rst * [TASK] Update the List Module Mass edit section and its screenshots releases: main, 13.4 * Update Documentation/ListModule/UsingEffectively/Index.rst Co-authored-by: Stefan Frömken <[email protected]> * [TASK] Change "Clipboard" into "Copy and paste" The clipboard is not required for simple copy&paste anymore releases: main, 13.4 * [TASK] Update Clipboard documentation releases: main, 13.4 * [TASK] Update Clipboard documentation releases: main, 13.4 * Apply suggestions from code review Co-authored-by: Stefan Frömken <[email protected]> * Update Documentation/ListModule/CopyPaste/Index.rst * [TASK] Changes after code review releases: main, 13.4 --------- Co-authored-by: Stefan Frömken <[email protected]> Co-authored-by: Stefan Frömken <[email protected]>
TYPO3-Documentation · Jan 22, 2025 · 86aaf9f · 86aaf9f
1 parent 7f2817a
commit 86aaf9f
Show file tree

Hide file tree

Showing 62 changed files with 238 additions and 247 deletions.
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/ContextMenu.png b/Documentation/Images/AutomaticScreenshots/ListModule/ContextMenu.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/ContextMenu.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/ContextMenu.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/EditSelection.png b/Documentation/Images/AutomaticScreenshots/ListModule/EditSelection.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/EditSelection.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/EditSelection.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
diff --git a/...tion/Images/AutomaticScreenshots/ListModule/MassEdit/MassMultipleFields.rst.txt b/...tion/Images/AutomaticScreenshots/ListModule/MassEdit/MassMultipleFields.rst.txt
diff --git a/...ges/AutomaticScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.png b/...ges/AutomaticScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.png
diff --git a/...AutomaticScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.rst.txt b/...AutomaticScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/SelectiveEditing.png b/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/SelectiveEditing.png
diff --git a/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/SelectiveEditing.rst.txt b/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/SelectiveEditing.rst.txt
diff --git a/...mentation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsButton.png b/...mentation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsButton.png
diff --git a/...ation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsButton.rst.txt b/...ation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsButton.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsModal.png b/Documentation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsModal.png
diff --git a/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsModal.rst.txt b/...tation/Images/AutomaticScreenshots/ListModule/MassEdit/ShowColumnsModal.rst.txt
diff --git a/...mentation/Images/AutomaticScreenshots/ListModule/MovedContentEmptyClipboard.png b/...mentation/Images/AutomaticScreenshots/ListModule/MovedContentEmptyClipboard.png
diff --git a/...ation/Images/AutomaticScreenshots/ListModule/MovedContentEmptyClipboard.rst.txt b/...ation/Images/AutomaticScreenshots/ListModule/MovedContentEmptyClipboard.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/PasteClipboardContent.png b/Documentation/Images/AutomaticScreenshots/ListModule/PasteClipboardContent.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/PasteClipboardContent.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/PasteClipboardContent.rst.txt
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/SimpleClipboard.png b/Documentation/Images/AutomaticScreenshots/ListModule/SimpleClipboard.png
diff --git a/Documentation/Images/AutomaticScreenshots/ListModule/SimpleClipboard.rst.txt b/Documentation/Images/AutomaticScreenshots/ListModule/SimpleClipboard.rst.txt
diff --git a/Documentation/Images/ManualScreenshots/ListModule/ActionIcons.png b/Documentation/Images/ManualScreenshots/ListModule/ActionIcons.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/Clipboard/ChooseClipboard.png b/Documentation/Images/ManualScreenshots/ListModule/Clipboard/ChooseClipboard.png
diff --git a/...tation/Images/ManualScreenshots/ListModule/Clipboard/ClipboardMultipleItems.png b/...tation/Images/ManualScreenshots/ListModule/Clipboard/ClipboardMultipleItems.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/Clipboard/PasteClipboard.png b/Documentation/Images/ManualScreenshots/ListModule/Clipboard/PasteClipboard.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/CopyOfRecord.png b/Documentation/Images/ManualScreenshots/ListModule/CopyOfRecord.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/CopyRecord.png b/Documentation/Images/ManualScreenshots/ListModule/CopyRecord.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/ListModule.png b/Documentation/Images/ManualScreenshots/ListModule/ListModule.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/MassEdit/MassEditingEnabled.png b/Documentation/Images/ManualScreenshots/ListModule/MassEdit/MassEditingEnabled.png
diff --git a/...Images/ManualScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.png b/...Images/ManualScreenshots/ListModule/MassEdit/RecordListWithAdditionalFields.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/MassEdit/SelectiveEditing.png b/Documentation/Images/ManualScreenshots/ListModule/MassEdit/SelectiveEditing.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/MassEdit/ShowColumnsButton.png b/Documentation/Images/ManualScreenshots/ListModule/MassEdit/ShowColumnsButton.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/MassEdit/ShowColumnsModal.png b/Documentation/Images/ManualScreenshots/ListModule/MassEdit/ShowColumnsModal.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/PasteRecord.png b/Documentation/Images/ManualScreenshots/ListModule/PasteRecord.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/RecordOnPageError.png b/Documentation/Images/ManualScreenshots/ListModule/RecordOnPageError.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/RecordUnique.png b/Documentation/Images/ManualScreenshots/ListModule/RecordUnique.png
diff --git a/Documentation/Images/ManualScreenshots/ListModule/SearchRecord.png b/Documentation/Images/ManualScreenshots/ListModule/SearchRecord.png
diff --git a/Documentation/ListModule/AdvancedClipboard/Index.rst b/Documentation/ListModule/AdvancedClipboard/Index.rst
@@ -1,48 +1,53 @@
-.. include:: /Includes.rst.txt
-.. index:: Clipboard; Advanced
-.. _advanced_clipboard_usage:
-.. _the-numeric-clipboard-pads-managing-many-elements:
+:navigation-title: Clipboard
 
-========================
-Advanced clipboard usage
-========================
+..  include:: /Includes.rst.txt
+..  index:: Clipboard; Advanced
+..  _clipboard:
+..  _advanced_clipboard_usage:
+..  _the-numeric-clipboard-pads-managing-many-elements:
 
-Select a page, in the :guilabel:`List` view. If not activated, click on
-:guilabel:`Show Clipboard` (1). Select
-:guilabel:`"Clipboard #1 (multi-selection mode)"` in the clipboard panel on the
-bottom of the page. You can now check all records (3) or check just the ones
-you want to work on. Each record now has a checkbox.
+============================================================
+Using the clipboard to copy or move multiple records at once
+============================================================
 
-.. include:: /Images/AutomaticScreenshots/ListModule/ActivateClipboardPad.rst.txt
+If the clipboard is not yet enabled, display it via the "View" drop down in the
+header of the "List" module. Then choose one of the clipboards, for example
+"Clipboard #1".
+
+..  figure:: /Images/ManualScreenshots/ListModule/Clipboard/ChooseClipboard.png
+    :alt: The clipboard can be shown by "Show clipbaord" entry in the "View" drop down
+
+    Choose "Clipboard #1" to activate the multi-selection mode
 
 As soon as one or more records are checked, new buttons will appear at the top of the list:
 
-#. :guilabel:`Edit` all selected items at once
+#.  :guilabel:`Edit` all selected items at once
 
-#. :guilabel:`Transfer to Clipboard` all selected items at once
+#.  :guilabel:`Transfer to Clipboard` all selected items at once
 
-#. :guilabel:`Remove from Clipboard` all selected items at once
+#.  :guilabel:`Remove from Clipboard` all selected items at once
 
-#. :guilabel:`Delete` all selected items at once
+#.  :guilabel:`Delete` all selected items at once
 
 Now check several boxes and click the :guilabel:`Transfer to Clipboard` button.
 Your clipboard should look like this:
 
-.. include:: /Images/AutomaticScreenshots/ListModule/ClipboardWithMultipleItems.rst.txt
+..  figure:: /Images/ManualScreenshots/ListModule/Clipboard/ClipboardMultipleItems.png
+    :alt: TYPO3 backend clipboard with several items
+
+    You can transfer multiple items of different types from different pages
 
-The button :guilabel:`Move Elements`is selected by default. Select the button
+The button :guilabel:`Move Elements` is selected by default. Select the button
 :guilabel:`Copy Elements` instead. The selected elements will now be copied
 and the current page will remain unchanged.
 
-Move to another page and click the "Paste into" icon:
-
-.. include:: /Images/AutomaticScreenshots/ListModule/PasteClipboardContent.rst.txt
-
-A warning appears to confirm the operation:
+Move to another page and click the "Paste in clipboard content" button:
 
-.. include:: /Images/AutomaticScreenshots/ListModule/ClipboardWarning.rst.txt
+..  figure:: /Images/ManualScreenshots/ListModule/Clipboard/PasteClipboard.png
+    :alt: Button "Paste in clipboard content"
 
-After confirmation, you can see that the two elements have been moved
-to the top of the list and that the clipboard pane is empty:
+    The text on the button is the same no matter weather you move or copy items
 
-.. include:: /Images/AutomaticScreenshots/ListModule/MovedContentEmptyClipboard.rst.txt
+A confirmation dialog appears. If you click ok, the chosen records are moved or
+copied, depending on the mode selected in the Clipboard on the bottom of the
+List module.
diff --git a/Documentation/ListModule/Clipboard/Index.rst b/Documentation/ListModule/Clipboard/Index.rst
diff --git a/Documentation/ListModule/CopyPaste/Index.rst b/Documentation/ListModule/CopyPaste/Index.rst
@@ -0,0 +1,102 @@
+:navigation-title: Copy and paste
+
+..  include:: /Includes.rst.txt
+..  _list-copy-paste:
+
+==============================
+Copy and paste database record
+==============================
+
+You can copy and paste records in the :guilabel:`List` module using the context
+menu and then choose "copy" (or cut if you want to move the record instead).
+
+..  tip::
+    If you want to copy or move several database records at once, use the
+    :ref:`clipboard <clipboard>`.
+
+..  contents:: Table of content
+
+..  _list-copy-paste-howto:
+
+How to copy and paste via list module
+=====================================
+
+Open the context menu by clicking the three dots button or the icon to the
+left of the record. Copy or cut the database record.
+
+..  figure:: /Images/ManualScreenshots/ListModule/CopyRecord.png
+    :alt: The context menu contains options copy and cut amongst others
+
+    Copy or cut a record using the context menu.
+
+To paste the copied record you have several options:
+
+..  figure:: /Images/ManualScreenshots/ListModule/PasteRecord.png
+    :alt: Location of the paste buttons in the TYPO3 List module: At the top of the module and in the context menu.
+
+    \(1) inserts the record at the end of the other records, with the context menu (2) you can choose the location
+
+..  _list-copy-paste-trouble:
+
+Trouble shooting during copy and paste
+======================================
+
+If you see any error messages not listed here, note the date and time, error
+message and what you have been doing. Send the information to your site
+administrator.
+
+..  _list-copy-paste-copy-1:
+
+Why is the header appended with (copy 1)?
+-----------------------------------------
+
+..  figure:: /Images/ManualScreenshots/ListModule/CopyOfRecord.png
+    :alt: A copied content element with (copy 1) appended to its header
+
+    The pasted database record is changed to "Mercury (copy 1)"
+
+By default the title of the pasted record is post fixed with "(copy x)" and the
+new record is marked as hidden and not displayed in the frontend.
+
+This default behaviour of titles being prefixed can make working with copy and
+paste tedious and advanced editors often prefer that the integrator of the site
+turns of this behaviour. They can use the setting
+:ref:`disablePrependAtCopy <t3tsref:confval-tcemain-disableprependatcopy>` to
+disable this.
+
+..  _list-copy-paste-record-on-page:
+
+Attempt to insert record on a page that can't store record type
+---------------------------------------------------------------
+
+Some record types, for example frontend user records or category records may
+only be created in pages of type "folder". If you try to insert such a record
+on a plain page, an error message will be displayed:
+
+..  figure:: /Images/ManualScreenshots/ListModule/RecordOnPageError.png
+    :alt: TYPO3 Backend Error: Attempt to insert record "fe_groups:3" on a page (8) that can't store record type
+
+    Result of trying to copy a frontend user group into a plain page
+
+The record was not pasted in this case. Use the page tree to switch to a folder,
+for example the folder "Frontend Users" and click the "Paste in clipboard
+content" there.
+
+..  _list-copy-paste-unique:
+
+The value of the field "username" has been changed as it is required to be unique
+---------------------------------------------------------------------------------
+
+Some fields need to be unique across the complete TYPO3 installation, for example
+a user name or identifier.
+
+If you try to copy & paste such a record, the affected fields are automatically
+renamed by appending a number.
+
+..  figure:: /Images/ManualScreenshots/ListModule/RecordUnique.png
+    :alt: TYPO3 Backend Warning: The value of the field "username" has been changed from "galileo" to "galileo0" as it is required to be unique
+
+    Fields that have to be unique are automatically alterered on paste
+
+The record has been pasted but renamed. Edit the new record and replace the
+field with a unique value.
diff --git a/Documentation/ListModule/Index.rst b/Documentation/ListModule/Index.rst
@@ -18,20 +18,17 @@ Records
 
         The list view displays a list of records stored on the current page, grouped by type.
 
-    ..  card:: :ref:`The Clipboard<clipboard>`
+    ..  card:: :ref:`Copy and paste <list-copy-paste>`
 
-        Every time a record is copied in the TYPO3, it appears in the clipboard
-        found at the bottom of the list module screen.
+        You can copy and paste records using the context menu and then choose
+        "copy" (or cut if you want to move the record instead).
 
-        Find out how you can move and copy content in the backend.
-
-    ..  card:: :ref:`Advanced Clipboard Usage<advanced_clipboard_usage>`
+    ..  card:: :ref:`Clipboard usage <advanced_clipboard_usage>`
 
         Find out how to make get the most out of the clipboard with an overview of some
         its extra features.
 
-
-    ..  card:: :ref:`Mass Editing<mass-editing>`
+    ..  card:: :ref:`Mass Editing <mass-editing>`
 
         The List module makes it possible to display the content of several
         fields at once and gives you the ability edit several records with one action.
@@ -42,6 +39,6 @@ Records
     :hidden:
 
     UsingEffectively/Index
-    Clipboard/Index
+    CopyPaste/Index
     AdvancedClipboard/Index
     MassEditing/Index