[TASK] Add clarification regarding honeypot and caching 83/56983/4
authorBjörn Jacob <bjoern.jacob@tritum.de>
Wed, 16 May 2018 17:30:01 +0000 (19:30 +0200)
committerRalf Zimmermann <ralf.zimmermann@tritum.de>
Thu, 17 May 2018 08:10:04 +0000 (10:10 +0200)
This patch adds some documentation regarding the automatic
inclusion of the honeypot and (static) site caching.

Resolves: #83212
Releases: master, 8.7
Change-Id: I9e7b56a8e515172f6a91274512db13488b41eacb
Reviewed-on: https://review.typo3.org/56983
Reviewed-by: Susanne Moog <susanne.moog@typo3.org>
Tested-by: Susanne Moog <susanne.moog@typo3.org>
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
Tested-by: Ralf Zimmermann <ralf.zimmermann@tritum.de>
typo3/sysext/form/Documentation/Config/proto/formElements/formElementTypes/Form/renderingOptions/honeypot/enable.rst
typo3/sysext/form/Documentation/FAQ/Index.rst

index d4cd077..e4c85fb 100644 (file)
@@ -52,4 +52,40 @@ renderingOptions.honeypot.enable
       ToDo
 
 :aspect:`Description`
-      Enable or disable the honeypot feature.
\ No newline at end of file
+      Enable or disable the honeypot feature.
+
+.. attention::
+
+   If you want to use a (static) site caching - for example EXT:staticfilecache -
+   you should disable the automatic inclusion of the honeypot.
+
+   Within your form definition:
+
+   .. code-block:: yaml
+
+      type: Form
+      identifier: fooForm
+      label: 'foo'
+      renderingOptions:
+        honeypot:
+          enable: false
+      renderables:
+        ...
+
+   Within your form setup:
+
+   .. code-block:: yaml
+
+      TYPO3:
+        CMS:
+          Form:
+            prototypes:
+              standard:
+                formElementsDefinition:
+                  Form:
+                    renderingOptions:
+                      honeypot:
+                        enable: false
+
+   See forge issue `#83212 <https://forge.typo3.org/issues/83212>` for more
+   information.
\ No newline at end of file
index 80b4ec6..983f159 100644 (file)
@@ -122,7 +122,7 @@ How do I localize the client side validations in the frontend?
 The displayed validation message is a browser specific text. The output is
 not generated by TYPO3 and therefore you cannot change it easily.
 Nevertheless, there is a JavaScript solution for changing the validation
-message. See `Stack Overflow <http://stackoverflow.com/questions/5272433/html5-form-required-attribute-set-custom-validation-message>`_
+message. See `Stack Overflow <http://stackoverflow.com/questions/5272433/html5-form-required-attribute-set-custom-validation-message>`
 for more information.
 
 
@@ -152,3 +152,12 @@ Is there some kind of export module for saved forms?
 Currently, there are no plans to implement such a feature. There are huge
 concerns regarding the data privacy when it comes to storing user data in
 your TYPO3 database permanently.
+
+.. _faq-honeypt-session:
+
+The honeypot does not work with static site caching. What can I do?
+===================================================================
+
+If you want to use a static site caching - for example using the staticfilecache extension -
+you should disable the automatic inclusion of the
+honeypot. Read more ':ref:`here<typo3.cms.form.prototypes.\<prototypeIdentifier>.formelementsdefinition.form.renderingoptions.honeypot.enable>`'.
\ No newline at end of file