Skip to content

Commit

Permalink
[TASK] Update the List Module section and its screenshots
Browse files Browse the repository at this point in the history
releases: main, 13.4
  • Loading branch information
linawolf committed Jan 13, 2025
1 parent 8aced89 commit 90d6c3c
Show file tree
Hide file tree
Showing 8 changed files with 58 additions and 44 deletions.
Binary file not shown.

This file was deleted.

Binary file not shown.

This file was deleted.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
90 changes: 58 additions & 32 deletions Documentation/ListModule/UsingEffectively/Index.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
.. include:: /Includes.rst.txt
.. _using-the-list-module-effectively:
.. include:: /Includes.rst.txt
.. _using-the-list-module-effectively:

=====================
Using the list module
Expand All @@ -9,56 +9,82 @@ The :guilabel:`Web > List` module allows you to browse through pages and folders
in your site and view the records that
are stored there. You can also create and edit records.

Records stored on pages include sub pages, content elements and news articles.
Select the :guilabel:`Web > List` module and choose a page or folder.

Select the :guilabel:`Web > List` module and browse to the
"Congratulations" page. You should see the following:
.. contents:: Table of Contents

.. include:: /Images/AutomaticScreenshots/ListModule/ListModule.rst.txt
.. _list-module-header:

The List module header
======================

.. figure:: /Images/ManualScreenshots/ListModule/ListModule.png
:alt: Screenshots of the List module in the TYPO3 backend, demonstrating the locations of the buttons mentioned bellow

See bellow about the meaning of the labeled buttons

The list view displays a list of records stored on the
current page, grouped by type. The name which appears on a record
depends on which field is used for the label. For "pages", the field is
"Pagetitle".
current page, grouped by type. The List module is commonly used for records
that have no dedicated backend module, for example website users and groups.

The list view has action icons in the **module header** including:

#. **Create new record** (a wizard appears to let you choose which type)

#. **Edit page properties** of the current page

#. **Clear the cache** of the current page

The list view has action icons in the **Docheader** including:
#. **Refresh** the List view

1. **Create** a new record (a wizard appears to let you choose which type)
#. **Create internal note**

2. **View** the current page (in the frontend)
#. **View** Show or hide search or `The clipboard <https://docs.typo3.org/permalink/t3editors:clipboard>`_

3. **Edit** the current page
#. **Share** Copy an URL to this page or bookmark it for quick access

4. **Search** the current page
.. tip::
Use the **Create new record** button if you want to create a record of
a type that does not yet have items on the current page.

5. **Clear the cache** of the current page
.. _list-module-record-type:

6. **Refresh** the List view
Editing a record of a certain type
==================================

7. **Bookmark** this view
If there are already database records stored on the current page, each record
type features its own action buttons for available actions:

8. **Copy URL** of this view
.. figure:: /Images/ManualScreenshots/ListModule/ActionIcons.png
:alt: Example of the action icons available for record type "Website Usergroup"

9. Access **contextual help** (removed with version 12.0)
In this example the first button can be used to edit the user group, the second
button to hide or unhide it, the third button to delete it. The button with the
three dots offers additional options.

.. todo: update screenshot
.. tip::
You can also edit a database record by clicking on its title.

Action icons are also available in the **Content Area**:
.. _list-module-record-search:

.. include:: /Images/AutomaticScreenshots/ListModule/ListModuleContentArea.rst.txt
Finding a record in a long list
===============================

If there are a large number of records you can use the search box to search for
a record containing a certain word.

#. Create a **new page record**
.. figure:: /Images/ManualScreenshots/ListModule/SearchRecord.png
:alt: Screenshot of the List module with the search box visible

#. Action icons for the record. Which icons appear here depends on the record
type selected. If the record is viewable in the frontend (as "pages" are), a "View"
icon is displayed. All records have the three icons
"Edit", "Hide/unhide" (i.e. visible in the frontend or not) and "Delete".
To make the search box visible, Select "Show Search" from the "View" dropdown.

The ellipsis icon (three consecutive dots) expands the icon list to show
additional action icons (typically used for accessing information, moving around, etc.)
It is also possible to include subpages of the current page by choosing the
number of levels (for performance reasons) in which to search.

There are also cut and paste icons.
If you do not know on which page the record could be found you can also
use the `Backend search <https://docs.typo3.org/permalink/t3editors:backend-search>`_.

Now, make sure that the :guilabel:`Show clipboard` box is checked, as we
will explore this next.
The search can be opened by selecting the magnifying glass in the top right
corner of the toolbar or by pressing the :kbd:`Cmd + K`
keystroke on macOS or the :kbd:`Ctrl K` keystroke on Windows and Linux
systems.

0 comments on commit 90d6c3c

Please sign in to comment.