[TASK] Documentation update for version 4.0

in2code-de · Jun 5, 2021 · 1bc6959 · 1bc6959
1 parent f20bdbe
commit 1bc6959
Show file tree

Hide file tree

Showing 8 changed files with 44 additions and 20 deletions.
diff --git a/Documentation/Images/documentation_installation_senderconfiguration.png b/Documentation/Images/documentation_installation_senderconfiguration.png
diff --git a/Documentation/Images/documentation_installation_settings.png b/Documentation/Images/documentation_installation_settings.png
diff --git a/Documentation/Images/documentation_installation_siteconfiguration.png b/Documentation/Images/documentation_installation_siteconfiguration.png
diff --git a/Documentation/Images/documentation_newnewsletter_step2.png b/Documentation/Images/documentation_newnewsletter_step2.png
diff --git a/Documentation/Images/documentation_newnewsletter_step3.png b/Documentation/Images/documentation_newnewsletter_step3.png
diff --git a/Documentation/Index.md b/Documentation/Index.md
@@ -1,6 +1,8 @@
 <img align="left" src="../Resources/Public/Icons/lux.svg" width="50" />
 
-# Luxletter - Email marketing in TYPO3. Send newsletters the easy way.
+# Luxletter - Email marketing in TYPO3
+
+Send newsletters the easy way
 
 ## Documentation start
 

diff --git a/Documentation/Installation/Index.md b/Documentation/Installation/Index.md
@@ -1,6 +1,8 @@
 <img align="left" src="../../Resources/Public/Icons/lux.svg" width="50" />
 
-# Luxletter - Email marketing in TYPO3. Send newsletters the easy way.
+# Luxletter - Email marketing in TYPO3
+
+Send newsletters the easy way
 
 ## Installation
 
@@ -11,27 +13,46 @@ composer require "in2code/luxletter"
 ```
 
 Note: Installation without composer could work but is not supported. 
-TYPO3 9.5 is required. The free extension lux can be also installed for more analysis but is not 
+TYPO3 10.4 is required. The free extension lux can be also installed for more analysis but is not 
 neccessary.
 
 
 ### Basic settings in extension configuration
 
-| Field                         | Default value                 | Description                                                                             |
-| ----------------------------- | ----------------------------- | --------------------------------------------------------------------------------------- |
-| Webserver domain              | https://www.domain.org        | Domain for the rendering of the newsletter in frontend. Normally your current domain.   |
-| Unsubscribe PID               | 6                             | Where is your unsubscribe plugin located on your website?                               |
-| Rewrite links in newsletter   | 1                             | Do you want to track if a receiver opens a link? Then you have to check this option.    |
-| Add typenum                   | 1562349004                    | Default typenum if content of your website should be rendered in an email view.         |
-| Show receiver action          | 1                             | Disable the link to the receiver action if you don't need it.                           |
-| Sender email address          | [email protected]     | Define a sender email address for your newsletters.                                     |
-| Sender name                   | Sender name                   | Define a sender name for your newsletters.                                              |
-| Reply email address           | [email protected]        | Real email address of a person that should receive answers to this newsletter email.    |
-| Sender name                   | Sender name                   | Name of the sender for your newsletter (mostly the same as fromName).                   |
+| Field                         | Default value                 | Description                                                                                                                                                                                 |
+| ----------------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Rewrite links in newsletter   | 1                             | Rewrite links in newsletter: Absolute links in your newsletters can be rewritten automatically, to track all link clicks. If you disable this feature, clicks are not tracked.              |
+| Add typenum                   | 1562349004                    | Add typenum: Everytime you parse a html for a new newsletter, this type will be added (can be used in fluidStyledMailContent). This will work only for PID in origin, not for absolute URL. |
+| Show receiver action          | 1                             | Show receiver action: Show link to receiver view in newsletter module. This view is maybe disturbing if you don't use extension lux in addition.                                            |
 
 <img src="../Images/documentation_installation_settings.png" width="800" alt="extension settings" />
 
 
+### Site configuration
+
+You can define one unsubscribe pid per site configuration. This is only relevant if you are using the unsubscribe
+plugin of luxletter.
+
+**Attention** Be aware to use a full domain name in base (Entry point) settings of your site configuration. Good: `https://www.domain.org/` - Bad: `/`
+
+<img src="../Images/documentation_installation_siteconfiguration.png" width="800" alt="Site configuration" />
+
+
+### Sender configuration
+
+| Field          | Description                                                                                                                                                                                 |
+| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Title          | Your internal title for this sender configuration                                                                                                                                           |
+| Sender email   | Sender email address for newsletter email                                                                                                                                                   |
+| Sender name    | Sender name for newsletter email                                                                                                                                                            |
+| Reply to email | Email address when a receiver wants to send an answer to the newsletter                                                                                                                     |
+| Reply to name  | Name when a receiver wants to send an answer to the newsletter                                                                                                                              |
+| Site           | This defines your domain/site and is needed for the unsubscribe plugin and for building absolute URI                                                                                        |
+
+<img src="../Images/documentation_installation_senderconfiguration.png" width="800" alt="Sender configuration" />
+
+
+
 ### TypoScript
 
 Basicly there are two different TypoScripts that should be included in static templates in your root template
@@ -74,7 +95,7 @@ Don't forget to add the page identifier to the main extension settings (see abov
 * In addition you can add a message that should appear if a user just unsubscribed.
 
 **Note** Unsubscribing is only possible if a hash is added to the link call. 
-See `{luxletter:mail.getUnsubscribeUrl(newsletter:newsletter,user:user)}` in the newsletter layout 
+See `{luxletter:mail.getUnsubscribeUrl(newsletter:newsletter,user:user,site:site)}` in the newsletter layout 
 on EXT:lux/Resources/Private/Templates/Mail/NewsletterContainer.html
 
 

diff --git a/readme.md b/readme.md
@@ -19,14 +19,15 @@ it.
 ### The upside
 
 * A useful and nice **dashboard** shows you the relevant information in the backend
-* Modern newsletter extension for TYPO3 9
+* Modern newsletter extension for TYPO3 10
 * Tracking of clicks via **PSR-15 interface** in TYPO3
 * Sending mails in queue via **symfony command controller**
 * Records for **fe_groups** (and there related fe_users) are used to send mails to
 * An **unsubscribe plugin** is already included
 * A **teaser content element** helps you to create newsletters out of default content elements in TYPO3
 * Every website can be used as prototype for your newsletter
 * A **third party mailserver** can be used for newsletters
+* Since 4.0 multiple sender configuration can be saved
 
 ### The downside
 
@@ -81,17 +82,16 @@ See the full [documentation](Documentation/Index.md) (installation, configuratio
 
 ## Technical requirements
 
-* TYPO3 9 or 10 LTS is the basic CMS for this newsletter tool.
+* TYPO3 10 LTS is the basic CMS for this newsletter tool.
 * EXT:lux is **not needed** to run luxletter but both extensions can work together to show more relevant information.
 * This extension needs to be **installed with composer** (classic installation could work but is not supported and tested).
-* fe_users records are used to send emails to while fe_groups is used to select a group of them
+* fe_users in fe_groups is used to send newsletter emails to.
 
 
 ## Sponsored features (please get in contact to us if you want to sponsor a new feature)
 
 * Import of fe_users from tt_address (to migrate easier from direct_mail to luxletter)
 * Editview of existing newsletters (reparse function?)
-* Move global newsletter configuration to records to use different settings per newsletter
 
 
 ## Installation with composer
@@ -105,13 +105,14 @@ composer require "in2code/luxletter"
 
 ### Upgrade to 4.x
 
-Multiple sender can now be defined in records, in addition it's not needed to define a domain in extension configuration
+Multiple senders can now be defined in records, in addition it's not needed to define a domain in extension configuration
 any more. We now look into site configuration. But that change needs you to adjust some stuff.
 
 Breaking changes in detail and what you have to do step by step after you have updated the extension:
 
 * Add one (ore more) record(s) with sender information on any sysfolder
 * Update your site configuration with an unsubscribe pid (so you could use different unsubscribe plugins now)
+* Take care that your base (Entry point) settings in site configuration is not just `/` but a full domain prefix like `https://www.domain.org/`
 * Create new newsletter records with the new sender configuration. **Note:** Old newsletters won't be queued any more because a sender configuration is missing
 * Update your HTML template files (compare your files with `EXT:luxletter/Resources/Private/Templates/Mail/NewsletterContainer.html`)
   * If you are using the viewhelper `luxletter:mail.getUnsubscribeUrl` now another argument must be passed: `site` - example: `{luxletter:mail.getUnsubscribeUrl(newsletter:newsletter,user:user,site:site)}`