Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TASK] Add links on "text" TCA type page #804

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 44 additions & 36 deletions Documentation/ColumnsConfig/Type/Text/Index.rst
Original file line number Diff line number Diff line change
@@ -1,46 +1,52 @@
.. include:: /Includes.rst.txt
.. include:: /Includes.rst.txt

.. _columns-text:
.. _columns-text:

================
Text areas & RTE
================

.. contents:: Table of contents:
:local:
:depth: 1
.. contents:: Table of contents:
:local:
:depth: 1

.. _columns-text-introduction:
.. _columns-text-introduction:

Introduction
============

The type='text' is for multi line text input, in the database :file:`ext_tables.sql` files it is typically
set to a :code:`TEXT` column type. In the Backend, it is rendered in various shapes: It can be rendered as
a simple :code:`<textarea>`, as a Rich Text Editor, as a code block with syntax highlighting, and others.

The following renderTypes are available:

* :ref:`default <columns-text-renderType-default>`: A simple text area
or a rich text field is rendered if no renderType is specified.
* :ref:`belayoutwizard <columns-text-renderType-belayoutwizard>`: The backend layout
wizard is displayed in order to edit records of table :code:`backend_layout` in the backend.
* :ref:`t3editor <columns-text-renderType-t3editor>`: The
:code:`renderType = 't3editor'`triggers a code highlighter if extension
`t3editor` is loaded, otherwise falls back to "default" renderType.
* :ref:`textTable <columns-text-renderType-textTable>`: The
:code:`renderType = 'textTable'` triggers a view to manage frontend table
display in the backend. It is used for the "Table" tt\_content content element.
The `text` type is for multi-line text input, in the database
:file:`ext_tables.sql` files it is typically set to a :sql:`TEXT` column type.
In the backend, it is rendered in various shapes: It can be rendered as a simple
:html:`<textarea>`, as a :ref:`rich text editor (RTE) <t3coreapi:rte>`, as a
code block with syntax highlighting, and others.

The following :php:`renderTypes` are available:

* :ref:`default <columns-text-renderType-default>`: A simple text area
or a rich text field is rendered, if no renderType is specified.
* :ref:`belayoutwizard <columns-text-renderType-belayoutwizard>`: The backend
layout wizard is displayed in order to edit records of table
:sql:`backend_layout` in the backend.
* :ref:`t3editor <columns-text-renderType-t3editor>`: The
:php:`renderType = 't3editor'` triggers a code highlighter, if extension
:doc:`t3editor <ext_t3editor:Index>` is loaded, otherwise falls back to
the "default" renderType.
* :ref:`textTable <columns-text-renderType-textTable>`: The
:php:`renderType = 'textTable'` triggers a view to manage frontend table
display in the backend. It is used for the "table" :sql:`tt_content` content
element.


Simple text area
================

A simple text area or a rich text field is rendered if no renderType is specified.
A simple text area or a rich text field is rendered, if no renderType is
specified.

.. include:: /Images/Rst/Text4.rst.txt

See :ref:`render type "default" <columns-text-renderType-default>`
See :ref:`render type "default" <columns-text-renderType-default>`
on how to configure such an editor.

.. include:: /CodeSnippets/Text4.rst.txt
Expand All @@ -50,36 +56,38 @@ Rich text editor field

.. include:: /Images/Rst/Rte1.rst.txt

See :ref:`property "enableRichtext" <columns-text-properties-enableRichtex>`
See :ref:`property "enableRichtext" <columns-text-properties-enableRichtext>`
on how to configure such an editor.

.. include:: /CodeSnippets/Rte1.rst.txt
.. include:: /CodeSnippets/Rte1.rst.txt


Code highlight editor
=====================

.. todo: include screenshot
See :ref:`t3editor <columns-text-renderType-t3editor>` on how to configure such an editor.
See :ref:`t3editor <columns-text-renderType-t3editor>` on how to configure such
an editor.

.. code-block:: php
// ...
'type' => 'text',
'renderType' => 't3editor',
// ...
[
// ...
'type' => 'text',
'renderType' => 't3editor',
// ...
]
Backend layout editor
=====================

The backend layout wizard is displayed in order to edit records of table
:code:`backend_layout` in the backend.
The backend layout wizard is displayed in order to edit records of table
:sql:`backend_layout` in the backend.

.. include:: /Images/Rst/Text20.rst.txt

See :ref:`render type belayoutwizard <columns-text-renderType-belayoutwizard>`
See :ref:`render type belayoutwizard <columns-text-renderType-belayoutwizard>`
on how to configure such an editor.

.. include:: /CodeSnippets/Text20.rst.txt
Expand All @@ -90,7 +98,7 @@ Text field with renderType textTable

.. include:: /Images/Rst/Text17.rst.txt

See :ref:`render type textTable <columns-text-renderType-textTable>`
See :ref:`render type textTable <columns-text-renderType-textTable>`
on how to configure such an editor.

.. include:: /CodeSnippets/Text17.rst.txt
Expand Down
2 changes: 1 addition & 1 deletion Documentation/Settings.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ ext_core = https://docs.typo3.org/c/typo3/cms-core/main/en-us/
# ext_rte_ckeditor = https://docs.typo3.org/c/typo3/cms-rte-ckeditor/main/en-us/
# ext_scheduler = https://docs.typo3.org/c/typo3/cms-scheduler/main/en-us/
# ext_seo = https://docs.typo3.org/c/typo3/cms-seo/main/en-us/
# ext_t3editor = https://docs.typo3.org/c/typo3/cms-t3editor/main/en-us/
ext_t3editor = https://docs.typo3.org/c/typo3/cms-t3editor/main/en-us/
ext_workspaces = https://docs.typo3.org/c/typo3/cms-workspaces/main/en-us/

[extlinks]
Expand Down
Loading