Refs #9905. Keyword 'render' in Report.

Documentation/Manual.rst

@@ -385,7 +385,9 @@ Extension Manager: QFQ Configuration
 +-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
 | flagProduction                    | yes                                                   | yes|no: used to differentiate production and development site.             |
 +-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
-| render                            | single                                                | both|single: used to differentiate production and development site.             |
+| render                            | single                                                | both|single: QFQ will show form and/or report. In most cases only one at a |
+|                                   |                                                       | time is needed. Options: 'single' (default) or 'both' (legacy). In mode    |
+|                                   |                                                       | 'single' prefer 'form' over 'report'.                                      |
 +-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
 | maxFileSize                       | 10M                                                   | If empty, take minimum of 'post_max_size' and 'upload_max_filesize'.       |
 +-----------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
@@ -769,7 +771,7 @@ backend for orientation.
 QFQ Keywords (Bodytext)
 ^^^^^^^^^^^^^^^^^^^^^^^
-**All of the named parameter are optional.**
+**All of these parameters are optional.**
  +-------------------+---------------------------------------------------------------------------------+
  | Name              | Explanation                                                                     |
@@ -793,6 +795,8 @@ QFQ Keywords (Bodytext)
  +-------------------+---------------------------------------------------------------------------------+
  | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
  +-------------------+---------------------------------------------------------------------------------+
+ | render            | Overwrites configuration_: render. See `report-render`_                         |
+ +-------------------+---------------------------------------------------------------------------------+
  | <level>.fbeg      | Start token for every field (=column)                                           |
  +-------------------+---------------------------------------------------------------------------------+
  | <level>.fend      | End token for every field (=column)                                             |
@@ -839,6 +843,33 @@ QFQ Keywords (Bodytext)
  |                   | | To retrieve the content: `{{<level>.line.content}}`. See `syntax-of-report`_  |
  +-------------------+---------------------------------------------------------------------------------+
+.. _`report-render`:
+
+Report: render
+--------------
+
+QFQ will render Report or Form in three situations:
+
+  #. Browser: The QFQ content is described by QFQ-Report syntax
+  #. Browser: The QFQ content is described by a QFQ-Form
+  #. API: The QFQ content is handled without Typo3. Typically a single tt-content record is specified in the request - only
+    that one is rendered by QFQ.
+
+Option 1 and 2 are distinguished by the SIP parameter `form`. If that one is given, in most cases only a Form
+should be shown.
+
++--------+--------------------------------------------------------------+
+| render | Use                                                          |
++========+==============================================================+
+| single | Display Form or Report, but not both at the same time. If    |
+|        | a SIP parameter 'form' is given, the form is shown.          |
++--------+--------------------------------------------------------------+
+| both   | Display Form and Report, both at the same time.              |
++--------+--------------------------------------------------------------+
+| api    | Only show Report when called via API (no Typo3).             |
++--------+--------------------------------------------------------------+
+
+
 .. _`qfq-database`:
 QFQ Database