Skip to content

Commit

Permalink
Overhaul "Using the list module" (#141)
Browse files Browse the repository at this point in the history
Releases: main, 12.4
  • Loading branch information
sarahmccarthy123 committed Nov 28, 2023
1 parent 10e289c commit 6c73a1c
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 27 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Expand Up @@ -3,4 +3,4 @@
.. figure:: /Images/AutomaticScreenshots/ListModule/ListModule.png
:class: with-shadow

A typical view from the List module
A typical view of the List module
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Expand Up @@ -3,4 +3,4 @@
.. figure:: /Images/AutomaticScreenshots/ListModule/ListModuleContentArea.png
:class: with-shadow

The "List" module content area with its actions icons
The "List" module content area with action icons
40 changes: 15 additions & 25 deletions Documentation/ListModule/UsingEffectively/Index.rst
Expand Up @@ -5,13 +5,11 @@
Introduction
============

The :guilabel:`Web > List` module allows you to browse through
each page or folder within your site and view all of the records that
are stored within it. The :guilabel:`List` module also gives you the ability to
create and manage records that don't have a dedicated module.
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.

Sub pages, content elements and news stories are examples of the different
kinds of records that can be stored on any given page.
Records stored on pages include sub pages, content elements and news articles.

=====================
Using the list module
Expand All @@ -23,56 +21,48 @@ Select the :guilabel:`Web > List` module and browse to the
.. include:: /Images/AutomaticScreenshots/ListModule/ListModule.rst.txt

The list view displays a list of records stored on the
current page, grouped by type. The name which appears for each record
depends on which field is used as label. For "pages", the field is
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".

The list view offers several different action icons in the **Docheader**:
The list view has action icons in the **Docheader** including:

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

2. **View** the current page (in the frontend)

3. **Edit** the current page

4. **Search** in the current page
4. **Search** the current page

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

6. **Refresh** the List view

7. **Bookmark** this view

8. **Copy URL** to this view
8. **Copy URL** of this view

9. Access **contextual help** (removed with version 12.0)

.. todo: update screenshot
In the **Content Area**, action icons are also available:
Action icons are also available in the **Content Area**:

.. include:: /Images/AutomaticScreenshots/ListModule/ListModuleContentArea.rst.txt


#. Create a **new page record**

#. Action icons for the record. What icons appear here depends on the record
#. 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 will have the next three icons, respectively
icon is displayed. All records have the three icons
"Edit", "Hide/unhide" (i.e. visible in the frontend or not) and "Delete".

The ellipsis icon (three consecutive dots) expands the icon list to show
additional action icons (typically for accessing information, moving around, etc.)
additional action icons (typically used for accessing information, moving around, etc.)

Lastly, the cut and paste icons.
There are also cut and paste icons.

.. todo: the "Extended view" option does not exist anymore
If you wish to have the list of icons expanded all the time, you can check the
:guilabel:`Extended view` box at the very bottom of the view.

Also make sure that the :guilabel:`Show clipboard` box is checked, as we
Now, make sure that the :guilabel:`Show clipboard` box is checked, as we
will explore this next.

If you plan to manage a multilingual web site, you will want to
check the :guilabel:`Localization view` checkbox.

0 comments on commit 6c73a1c

Please sign in to comment.