Skip to content

Commit

Permalink
Indexes F (#1185)
Browse files Browse the repository at this point in the history
* Indexes F

* Write: whether

* Add blank lines

* Add blank lines

* Add index entry: CSRF

Co-authored-by: Martin Bless <martin.bless@mbless.de>
  • Loading branch information
linawolf and marble committed Dec 18, 2020
1 parent b50ba58 commit 8a2a3f0
Show file tree
Hide file tree
Showing 12 changed files with 89 additions and 65 deletions.
22 changes: 11 additions & 11 deletions Documentation/ApiOverview/FeatureToggles/Index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
.. include:: /Includes.rst.txt



.. index::
Feature toggles
TYPO3_CONF_VARS; SYS features
.. _feature-toggles:

===============
Feature Toggles
Feature toggles
===============

TYPO3 provides an API class for creating so-called 'Feature Toggles'. Feature toggles provide an easy way to add
TYPO3 provides an API class for creating so-called 'feature toggles'. Feature toggles provide an easy way to add
new implementations of features next to their legacy version. By using a feature toggle, the integrator or site admin
can decide when to switch to the new feature.

Expand All @@ -22,7 +22,7 @@ Examples for features are:
- Disable obsolete functionality which might still be used, but slows down the system.
- Enable alternative PageNotFound handling for an installation.

Naming of Feature Toggles
Naming of feature toggles
=========================

Feature names should NEVER be named "enable" or have a negation, or contain versions or years.
Expand All @@ -46,7 +46,7 @@ Good examples:

.. _feature-toggles-api:

Using the API as Extension Author
Using the API as extension author
=================================

For extension authors, the API can be used for any custom feature provided by an extension.
Expand Down Expand Up @@ -79,7 +79,7 @@ extension name as the features are global switches which otherwise might lead to

.. _feature-toggles-core:

Core Feature Toggles
Core feature toggles
====================

Some examples for feature toggles in the TYPO3 Core:
Expand All @@ -91,7 +91,7 @@ Some examples for feature toggles in the TYPO3 Core:

.. _feature-toggles-enable:

Enable / Disable Feature Toggle
Enable / disable feature toggle
===============================

Features can be toggled in the *Settings* module via *Feature Toggles*:
Expand All @@ -108,10 +108,10 @@ Internally, the changes are written to :file:`LocalConfiguration.php`::
],
]

Feature Toggles in TypoScript
Feature toggles in TypoScript
===============================

To check wether a feature is enabled in TypoScript was introduced in v9.5 in :issue:`86881`
To check whether a feature is enabled in TypoScript was introduced in v9.5 in :issue:`86881`

Support for feature toggle check in the symfony expression language DefaultFunctionProvider is provided.
With the new function :typoscript:`feature()` the feature toggle can be checked.
Expand Down
11 changes: 7 additions & 4 deletions Documentation/ApiOverview/FileProcessing/Index.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
.. include:: /Includes.rst.txt

.. index:: File processors
.. _file_processing:

Custom File Processors
======================
Custom file processors
======================

For custom needs in terms of file processing, registration of custom file processors is available.


.. _file_processing-create:

Create a new processor class
----------------------------
============================

The file must implement the :php:`\TYPO3\CMS\Core\Resource\Processing\ProcessorInterface` and two required methods.

Expand All @@ -20,10 +22,11 @@ The file must implement the :php:`\TYPO3\CMS\Core\Resource\Processing\ProcessorI
:php:`processTask()`
Will then do whatever needs to be done to process the given file.


.. _file_processing-register:

Register the file processor
---------------------------
============================

To register a new processor, add the following code to :file:`ext_localconf.php`

Expand Down
27 changes: 15 additions & 12 deletions Documentation/ApiOverview/FlashMessages/Index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.. include:: /Includes.rst.txt



.. index:: Flash messages
.. _flash-messages:

==============
Flash Messages
Flash messages
==============

There exists a generic system to show users that an action
Expand Down Expand Up @@ -36,9 +34,10 @@ The different severity levels are described below:
and the like.


.. index:: Flash messages; API
.. _flash-messages-api:

Flash Messages API
Flash messages API
==================

Creating a flash message is achieved by simply instantiating an object
Expand All @@ -52,7 +51,7 @@ of class :php:`\TYPO3\CMS\Core\Messaging\FlashMessage`::
);


Flash Messages Severities
Flash messages severities
-------------------------

The severity is defined by using class constants provided by
Expand Down Expand Up @@ -100,7 +99,7 @@ to find the correct renderer for the current context.

.. _flash-messages-renderer:

Flash Messages Renderer
Flash messages renderer
=======================

The implementation of rendering FlashMessages in the core has been optimized.
Expand Down Expand Up @@ -139,9 +138,10 @@ Any third party extension should use the provided :php:`FlashMessageViewHelper`
->render($flashMessages);
.. index:: pair: Flash messages; Extbase
.. _flash-messages-extbase:

Flash Messages in Extbase
Flash messages in Extbase
=========================

In Extbase the standard way of issuing flash messages is to add them
Expand Down Expand Up @@ -176,16 +176,19 @@ Where to display the flash messages in an Extbase-based BE module is
as simple as moving the View Helper around.


.. index::
pair: Flash messages; JavaScript
Notification API
.. _flash-messages-javascript:

JavaScript-based Flash Messages (Notification API)
JavaScript-based flash messages (Notification API)
==================================================

.. important::
The Notification API is designed for TYPO3 Backend purposes only.
The notification API is designed for TYPO3 Backend purposes only.

The TYPO3 Core provides a JavaScript-based API to trigger flash messages ("Notifications") that appear on the upper
right corner of the TYPO3 backend. To use the Notification API, load the :js:`TYPO3/CMS/Backend/Notification` module and
right corner of the TYPO3 backend. To use the notification API, load the :js:`TYPO3/CMS/Backend/Notification` module and
use one of its methods:

* :js:`notice()`
Expand Down Expand Up @@ -242,7 +245,7 @@ Example:
Actions
-------

Since TYPO3 10.1 the Notification API may bind actions to a notification that execute certain tasks when invoked. Each
Since TYPO3 10.1 the notification API may bind actions to a notification that execute certain tasks when invoked. Each
action item is an object containing the fields :js:`label` and :js:`action`:

.. rst-class:: dl-parameters
Expand Down
45 changes: 30 additions & 15 deletions Documentation/ApiOverview/FlexForms/Index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. include:: /Includes.rst.txt

.. index:: Flexforms
.. _flexforms:

==============
=========
Flexforms
==============
=========

Flexforms can be used to store data within an XML structure inside a single DB
column.
Expand All @@ -27,7 +27,8 @@ over plugin features and what is to be rendered.
Using Flexforms you have all the features of TCA, so it is possible
to use input fields, select lists, show options conditionally and more.

Example Use Cases

Example use cases
=================

The `bootstrap_package <https://github.com/benjaminkott/bootstrap_package>`__
Expand All @@ -44,7 +45,7 @@ Some more extensions that utilize FlexForms are:
basic FlexForm, so it might be a good starting point to look at.


How it Works
How it works
============

#. In the extension, a configuration schema is defined and attached to
Expand All @@ -56,7 +57,8 @@ How it Works
#. The extension can read current configuration and act according to
the configuration.

Steps to Perform (Extension Developer)

Steps to perform (Extension developer)
======================================

.. rst-class:: bignums-xxl
Expand Down Expand Up @@ -152,7 +154,7 @@ Steps to Perform (Extension Developer)
from within a :ref:`Fluid template <read-flexforms-fluid>`.


More Examples
More examples
=============

The definition of the data types and parameters used complies to the
Expand All @@ -161,7 +163,10 @@ The definition of the data types and parameters used complies to the
The settings must be added within the :html:`<el>` element in the Flexform
configuration schema file.

Select Field

.. index:: Flexforms; Select field

Select field
------------

.. code-block:: xml
Expand Down Expand Up @@ -190,6 +195,7 @@ Select Field

* :ref:`t3tca:columns-select` in TCA reference.


.. _flexforms-itemsProcFunc:

Populate a `select` Field with a PHP Function (itemsProcFunc)
Expand Down Expand Up @@ -247,11 +253,10 @@ How this looks when configuring the plugin:
* :ref:`t3tca:columns-select-properties-itemsprocfunc` in TCA reference.




.. index:: Flexforms; Display conditions
.. _flexformDisplayCond:

Display Fields Conditionally (displayCond)
Display fields conditionally (displayCond)
------------------------------------------

Some settings may only make sense, depending on other settings.
Expand Down Expand Up @@ -280,6 +285,8 @@ in the TCA reference:

* :ref:`t3tca:columns-properties-displaycond` in TCA Reference


.. index:: Flexforms; switchableControllerActions
.. _flexformSwitchableControllerActions:

switchableControllerActions
Expand Down Expand Up @@ -311,10 +318,12 @@ can do that with:
This element is optional and must go inside the `<config>` element.


.. index:: pair: Flexforms; Extbase
.. _read-flexforms:
.. _read-flexforms-extbase:

How to Read Flexforms From an Extbase Controller Action
How to read flexforms from an Extbase controller action
-------------------------------------------------------

The settings can be read using :php:`$this->settings` in an
Expand All @@ -331,9 +340,11 @@ Extbase controller.
:php:`$this->settings`, the name of the setting must begin with
**settings** directly followed by a dot (`.`).


.. index:: pair: Flexforms; PHP
.. _read-flexforms-php:

How to Read and Write Flexforms From PHP
How to read and write flexforms from PHP
----------------------------------------

Some situation make it necessary to access Flexforms via PHP. The following APIs
Expand All @@ -355,9 +366,11 @@ method can be used:
$flexFormTools = new \TYPO3\CMS\Core\Configuration\FlexForm\FlexFormTools();
$flexFormString = $flexFormTools->flexArray2Xml($flexFormArray, true);
.. index:: pair: Flexforms; TypoScript
.. _read-flexforms-ts:

How to Access Flexforms From TypoScript
How to access flexforms From TypoScript
---------------------------------------

.. versionadded:: 8.4
Expand Down Expand Up @@ -390,9 +403,10 @@ The key `flexform` is followed by the field which holds the Flexform data (`pi_f
* :ref:`TypoScript: flexform <t3tsref:data-type-gettext-flexform>`


.. index:: pair: Flexforms; Fluid
.. _read-flexforms-fluid:

How to Access FlexForms From Fluid
How to access flexForms from fluid
----------------------------------

If you are using an Extbase controller, FlexForm settings can be read from within a Fluid template using
Expand Down Expand Up @@ -471,6 +485,7 @@ to the tab "Plugin" or whatever string you defined to replace this.
.. image:: Images/FlexformBackend.png
:class: with-shadow


Credits
=======

Expand Down
3 changes: 1 addition & 2 deletions Documentation/ApiOverview/Fluid/Index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
.. include:: /Includes.rst.txt

.. highlight:: xml

.. index:: ! Fluid
.. _fluid:

=====
Expand Down
6 changes: 4 additions & 2 deletions Documentation/ApiOverview/Fluid/Introduction.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
.. include:: /Includes.rst.txt

.. highlight:: xml

.. _fluid-introduction:

=====================
Expand Down Expand Up @@ -57,6 +55,9 @@ Object Accessors:
Conditions:
The conditions are supplied here by the if / then / else ViewHelpers.


.. index:: Fluid; Directory structure

Directory structure
===================

Expand Down Expand Up @@ -132,6 +133,7 @@ Templates can be used with or without a Layout.
Partials are a Fluid component. Partials can be used as reusable components from within
a template.


Example: Using Fluid to create a theme
======================================

Expand Down
4 changes: 2 additions & 2 deletions Documentation/ApiOverview/FormEngine/DataCompiling/Index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. include:: /Includes.rst.txt

.. index:: FormEngine; Data compiling
.. _FormEngine-DataCompiling:

==============
Data Compiling
Data compiling
==============

This is the first step of FormEngine. The data compiling creates an array containing all data
Expand Down
Loading

0 comments on commit 8a2a3f0

Please sign in to comment.