Skip to content

Commit fdaac44

Browse files
github-actions[bot]linawolfAlagts
authored
[Backport 12.4] [TASK] Write information on Page module for Developers and Integrators (#571)
* [TASK] Write information on Page module for Developers and Integrators How to use the Page module for editing is described in the editors tutorial. Releases: main, 13.4, 12.4 * Update Documentation/Concepts/Backend/PageModule/Index.rst Co-authored-by: Sandra Erbel <[email protected]> * 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]>
1 parent a98369a commit fdaac44

File tree

9 files changed

+71
-60
lines changed

9 files changed

+71
-60
lines changed
Lines changed: 71 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1,72 +1,99 @@
1+
:navigation-title: Page module
12
.. include:: /Includes.rst.txt
23
.. _page-content:
34

4-
============
5-
Pages module
6-
============
5+
==============================
6+
"Page" backend module in TYPO3
7+
==============================
78

8-
Site content can be structured in many ways.
9+
The :guilabel:`Web > Page` module is used by the editors of the site to add
10+
and modify content elements on the page.
911

10-
A good place to start exploring different ways content
11-
can be arranged is the "Content Examples" section.
12+
The Editors Guide, chapter :ref:`Content Elements <t3editors:content-elements>`,
13+
covers practical topics on how to work with content.
1214

13-
.. rst-class:: bignums
15+
.. contents:: Topics related to the page module
1416

15-
1. Expand the page "Content Examples"
17+
.. _page-layout:
1618

17-
In the backend, click on the arrow next to the "Content Examples" title
18-
to open the subtree.
19+
Page layout / backend layout
20+
============================
1921

20-
.. include:: /Images/AutomaticScreenshots/PageTree/PageContent1.rst.txt
22+
Within the Page module there can be one or more areas (also called columns)
23+
in which content can be added. The columns to be displayed in the backend
24+
are defined via page TSconfig in a so-called backend layout, sometimes also
25+
called page layout. The site package tutorial describes how page layouts
26+
can be configured and used: :ref:`Page layouts with page
27+
TSconfig <t3sitepackage:content-mapping-backend-layout>`.
2128

22-
2. Next, do the same for the "Text" page, and then click on "Text in Columns"
29+
The topic is also covered in-depth in the TSconfig Reference,
30+
chapter :ref:`Backend layouts <t3tsconfig:backend-layouts>`.
2331

24-
3. Use the context menu to show the "Text in Columns" page in the frontend.
32+
.. _page-new-content:
2533

26-
Select :guilabel:`"Show"`
34+
The "New Page Content" wizard
35+
=============================
2736

28-
Let's now compare both views.
37+
.. figure:: /Images/ManualScreenshots/Backend/NewPageContentWizard.png
38+
:alt: Screenshot of a "New page content" wizard in a standard TYPO3 installation
2939

30-
**Frontend:**
40+
The "New page content" wizard
3141

32-
.. figure:: /Images/ManualScreenshots/Frontend/TextInColumnsFrontend.png
33-
:alt: Page content seen from the frontend
34-
:class: with-shadow
42+
When an editor adds a new content element to the page the "New Page Content"
43+
wizard is displayed. Available :ref:`content elements <page-content-elements>` and
44+
:ref:`plugins <page-plugins>` are ordered into groups.
3545

36-
Page content as seen in the frontend
46+
You can use the page TSconfig setting
47+
:ref:`mod.wizard.newContentElement.wizardItems <t3tsconfig:pagenewcontentelementwizard>`
48+
to hide or edit content elements displayed here. For example you can hide the
49+
"HTML" content element supplied by :composer:`typo3/cms-fluid-styled-content`:
3750

51+
.. code-block:: typoscript
52+
:caption: EXT:site_package/Configuration/page.tsconfig
3853
39-
**Backend:**
54+
mod.wizards.newContentElement.wizardItems {
55+
special.removeItems := addToList(html)
56+
}
4057
41-
For now we want to be in "Columns" mode. If that is not the case when you
42-
got to the Page module, please use the menu in the docheader to switch mode.
58+
.. _page-content-elements:
4359

44-
.. include:: /Images/AutomaticScreenshots/PageModule/TextInColumnsBackend.rst.txt
60+
Content elements
61+
================
4562

46-
The order of the content elements on the web page is the
47-
same as the order of the elements in the backend. The content elements
48-
are stored in columns, content that is in the right
49-
column in the backend is in the right column on your page, etc. Each
50-
content element on your page can be of a different type (like text or
51-
text & images) giving you a lot of flexibility.
63+
You can use the community extension :composer:`friendsoftypo3/content-blocks` to
64+
define additional content elements. Many third party extensions like
65+
:composer:`bk2k/bootstrap-package` offer pre-defined content elements or, like
66+
:composer:`georgringer/news` :ref:`plugins <page-plugins>`.
5267

53-
.. todo: Mention backend_layouts here?
68+
New content elements can also be created without relying on third party
69+
extensions. You need basic knowledge on :ref:`tca`, :ref:`typoscript`, and
70+
:ref:`templating with Fluid <fluid-templates>`. You have to use PHP for some
71+
basic configurations but need no in-depth knowledge of programming.
5472

55-
The Page module shows a preview of each content element, together
56-
with some action icons. Here is a quick overview:
73+
See :ref:`create a custom content element type <t3coreapi:adding-your-own-content-elements>`.
5774

58-
.. include:: /Images/AutomaticScreenshots/PageModule/ContentElementBackend.rst.txt
75+
.. _page-plugins:
5976

77+
Plugins
78+
=======
6079

61-
#. **Insert** a new content element above the current one
62-
#. An **icon** representing the type of content element
63-
(hovering over it will show its id)
64-
#. **Edit** the content element
65-
#. **Hide/show** the content element
66-
#. **Delete** content element
67-
#. A **preview** of the element's content (will vary depending on the type)
68-
#. **Insert** a new content element below the current one
80+
A plugin is a special kind of content element. It typically provides dynamic or
81+
interactive functionality. Many third party extensions offer ready to use
82+
plugins for a wide range of functionality. For example plugins to display news:
83+
:composer:`georgringer/news`, plugins to perform searches:
84+
:composer:`apache-solr-for-typo3/solr`, to display Open Street maps:
85+
:composer:`wsr/myleaflet`, event management with registration:
86+
:composer:`derhansen/sf-event-mgt-contentelements` and many more.
6987

88+
The chapter :ref:`how-to-find-extensions` covers searching for suitable extensions.
7089

71-
Modifying existing content or adding new content is covered in the
72-
:ref:`Editors Tutorial <t3editors:content-elements>`.
90+
Usually a PHP class called a "controller" manages
91+
the functionality and display of the plugin. To create a custom plugin you
92+
need some experience in PHP programming and dealing with databases etc.
93+
94+
.. note::
95+
In TYPO3 a plugin is a special type of content element that can be added to
96+
a page to provide complex functionality.
97+
98+
Other content management systems like wordpress use the word "plugin" to
99+
describe what we call an :ref:`extension <concepts-extensions>` in TYPO3.
Binary file not shown.

Documentation/Images/AutomaticScreenshots/PageModule/ContentElementBackend.rst.txt

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

Documentation/Images/AutomaticScreenshots/PageModule/TextInColumnsBackend.rst.txt

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

Documentation/Images/AutomaticScreenshots/PageTree/PageContent1.rst.txt

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

0 commit comments

Comments
 (0)