[TASK] Finish powermail integration

studiomitte · Aug 24, 2023 · dec0cff · dec0cff
1 parent e6e4afc
commit dec0cff
Show file tree

Hide file tree

Showing 10 changed files with 80 additions and 14 deletions.
diff --git a/Configuration/PageTsConfig/powermail.typoscript b/Configuration/PageTsConfig/powermail.typoscript
@@ -1,4 +1,4 @@
 # Add FriendlyCaptcha field to Powermail
 tx_powermail.flexForm.type.addFieldOptions {
-    friendlycaptcha = FriendlyCaptcha
-}
+  friendlycaptcha = FriendlyCaptcha
+}
diff --git a/Configuration/TCA/Overrides/sys_template.php b/Configuration/TCA/Overrides/sys_template.php
@@ -3,7 +3,7 @@
 if (\TYPO3\CMS\Core\Utility\ExtensionManagementUtility::isLoaded('powermail')) {
     \TYPO3\CMS\Core\Utility\ExtensionManagementUtility::addStaticFile(
         'friendlycaptcha_official',
-        'Configuration/TypoScript/Powermail/setup.typoscript',
+        'Configuration/TypoScript/Powermail',
         'Friendly Captcha - EXT:powermail'
     );
 }
diff --git a/Configuration/TypoScript/Powermail/setup.typoscript b/Configuration/TypoScript/Powermail/setup.typoscript
@@ -1,14 +1,16 @@
 plugin.tx_powermail {
-    view {
-        partialRootPaths {
-            0 = EXT:powermail/Resources/Private/Partials/
-            10 = EXT:friendlycaptcha_official/Resources/Private/Powermail/Partials
-        }
+  view {
+    partialRootPaths {
+      981818 = EXT:friendlycaptcha_official/Resources/Private/Powermail/Partials
     }
+  }
 
-    settings.setup.validators {
-        1 {
-            class = StudioMitte\FriendlyCaptcha\FieldValidator\PowermailValidator
-        }
+  settings.setup.validators {
+    981818 {
+      class = StudioMitte\FriendlyCaptcha\FieldValidator\PowermailValidator
+      config {
+
+      }
     }
+  }
 }
diff --git a/Documentation/.DS_Store b/Documentation/.DS_Store
diff --git a/Documentation/Images/.DS_Store b/Documentation/Images/.DS_Store
diff --git a/Documentation/Images/integration/powermail-field.png b/Documentation/Images/integration/powermail-field.png
diff --git a/Documentation/Images/integration/powermail-page-tsconfig.png b/Documentation/Images/integration/powermail-page-tsconfig.png
diff --git a/Documentation/Images/integration/powermail-result.png b/Documentation/Images/integration/powermail-result.png
diff --git a/Documentation/Images/integration/powermail-typoscript.png b/Documentation/Images/integration/powermail-typoscript.png
diff --git a/Documentation/Using/Powermail.rst b/Documentation/Using/Powermail.rst
@@ -7,5 +7,69 @@
 EXT:powermail
 =============
 
-..  note::
-    To be done
+Friendly Captcha can be used in EXT:powermail by following these steps:
+
+Setup
+-----
+
+TypoScript and Page TsConfig need to be extended.
+
+Add TypoScript
+~~~~~~~~~~~~~~
+
+Either import the TypoScript manually in your site package or add the following line to your TypoScript template:
+
+..  code-block:: typoscript
+
+    @import 'EXT:friendlycaptcha_official/Configuration/TypoScript/Powermail/setup.typoscript'
+
+or select the TypoScript in your TypoScript record
+
+..  figure:: /Images/integration/powermail-typoscript.png
+    :class: with-shadow
+    :alt: Add TypoScript
+    :width: 450px
+
+    Add TypoScript
+
+Add Page TsConfig
+~~~~~~~~~~~~~~~~~
+
+Either import the TsConfig manually in your site package or add the following line to your TsConfig files :
+
+..  code-block:: typoscript
+
+    @import 'EXT:friendlycaptcha_official/Configuration/PageTsConfig/powermail.typoscript'
+
+or select the TypoScript in your TypoScript record
+
+..  figure:: /Images/integration/powermail-page-tsconfig.png
+    :class: with-shadow
+    :alt: Add Page TsConfig
+    :width: 450px
+
+    Add Page TsConfig
+
+Usage
+-----
+
+It is now possible to select Friendly Captcha as a field type in a powermail field record
+
+..  figure:: /Images/integration/powermail-field.png
+    :class: with-shadow
+    :alt: Add Friendly Captcha to your form
+    :width: 450px
+
+    Add Friendly Captcha to your form
+
+Result
+------
+
+The result should look like this:
+
+..  figure:: /Images/integration/powermail-result.png
+    :class: with-shadow
+    :alt: Result
+    :width: 450px
+
+    Result