diff --git a/Documentation/Developer/Index.md b/Documentation/Developer/Index.md index 2d3edc9e..52ba5ac3 100644 --- a/Documentation/Developer/Index.md +++ b/Documentation/Developer/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## How to develop with LUX diff --git a/Documentation/Images/screenshot_analysis_content_dark.png b/Documentation/Images/screenshot_analysis_content_dark.png new file mode 100644 index 00000000..c50ecb6f Binary files /dev/null and b/Documentation/Images/screenshot_analysis_content_dark.png differ diff --git a/Documentation/Index.md b/Documentation/Index.md index 1b206a4f..aa48a82b 100644 --- a/Documentation/Index.md +++ b/Documentation/Index.md @@ -1,8 +1,20 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Living User eXperience - LUX - the Marketing Automation tool for TYPO3 +LUX is an enterprise software solution that bridges the gap between your TYPO3 website and standalone marketing +automation tools. LUX tracks, identifies and analyzes your leads while providing visitors with an improved user +experience by showing relevant information at the right time. + +In addition, with **LUXenterprise** you can use this data even more effectively by nurturing leads, running A/B tests +and using URL shorteners. + +Or see interesting information of your visitors by extending data automatically via a GDPR-conform solution from +**WiredMinds** + +![LUX screenshot](Images/screenshot_analysis_content_dark.png "LUX") + ## [Privacy documentation](Privacy/Index.md) See some basic hints to respect visitors privacy and follow the rules of GDPR (General Data Protection Regulation) / DSGVO (Datenschutzgrundverordnung). diff --git a/Documentation/Marketing/Index.md b/Documentation/Marketing/Index.md index 73038eec..2a831991 100644 --- a/Documentation/Marketing/Index.md +++ b/Documentation/Marketing/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## Marketing documenation diff --git a/Documentation/Privacy/Commands.md b/Documentation/Privacy/Commands.md index da28753b..b53e9e0e 100644 --- a/Documentation/Privacy/Commands.md +++ b/Documentation/Privacy/Commands.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## User information diff --git a/Documentation/Privacy/DoNotTrack.md b/Documentation/Privacy/DoNotTrack.md index 490f9b82..57827ef2 100644 --- a/Documentation/Privacy/DoNotTrack.md +++ b/Documentation/Privacy/DoNotTrack.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## DoNotTrack Header diff --git a/Documentation/Privacy/FingerprintsAndLocalStorage.md b/Documentation/Privacy/FingerprintsAndLocalStorage.md index 00232061..dcdc132d 100644 --- a/Documentation/Privacy/FingerprintsAndLocalStorage.md +++ b/Documentation/Privacy/FingerprintsAndLocalStorage.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## Introduction diff --git a/Documentation/Privacy/Index.md b/Documentation/Privacy/Index.md index 27460e8e..9209477e 100644 --- a/Documentation/Privacy/Index.md +++ b/Documentation/Privacy/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") This part of the documentation gives you some information about privacy on websites in general. diff --git a/Documentation/Privacy/IpAddresses.md b/Documentation/Privacy/IpAddresses.md index 8c5177a3..52d7582f 100644 --- a/Documentation/Privacy/IpAddresses.md +++ b/Documentation/Privacy/IpAddresses.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## IP addresses diff --git a/Documentation/Privacy/OptInAndOptOut.md b/Documentation/Privacy/OptInAndOptOut.md index ae55e218..d441c741 100644 --- a/Documentation/Privacy/OptInAndOptOut.md +++ b/Documentation/Privacy/OptInAndOptOut.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## Tracking Opt-Out and Opt-In diff --git a/Documentation/Privacy/PrivacyPage.md b/Documentation/Privacy/PrivacyPage.md index 2f24d702..f2518bf7 100644 --- a/Documentation/Privacy/PrivacyPage.md +++ b/Documentation/Privacy/PrivacyPage.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Example part for your privacy page diff --git a/Documentation/Technical/API/Create.md b/Documentation/Technical/API/Create.md index 6eb0a703..6b24ad1d 100644 --- a/Documentation/Technical/API/Create.md +++ b/Documentation/Technical/API/Create.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Endpoint "create" to write new or update existing leads into database (writing access) diff --git a/Documentation/Technical/API/FindAllByAnyProperties.md b/Documentation/Technical/API/FindAllByAnyProperties.md index 0e91e4d7..6366b435 100644 --- a/Documentation/Technical/API/FindAllByAnyProperties.md +++ b/Documentation/Technical/API/FindAllByAnyProperties.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Endpoint "findAllByAnyProperties" for getting a list of visitors (reading access) diff --git a/Documentation/Technical/API/FindByProperty.md b/Documentation/Technical/API/FindByProperty.md index 5e51edda..6962078d 100644 --- a/Documentation/Technical/API/FindByProperty.md +++ b/Documentation/Technical/API/FindByProperty.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Endpoint "findByProperty" for getting a single visitor (reading access) diff --git a/Documentation/Technical/API/Index.md b/Documentation/Technical/API/Index.md index 76fab19f..cac1bd32 100644 --- a/Documentation/Technical/API/Index.md +++ b/Documentation/Technical/API/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # API and Interface from LUX (only in luxenterprise) diff --git a/Documentation/Technical/Analysis/Index.md b/Documentation/Technical/Analysis/Index.md index 1904f963..83c1ff06 100644 --- a/Documentation/Technical/Analysis/Index.md +++ b/Documentation/Technical/Analysis/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Tracking and Analysis @@ -68,7 +68,7 @@ plugin.tx_lux.settings { ``` Example page tracking request in browser console: - + @@ -77,7 +77,7 @@ Example page tracking request in browser console: #### Dashboard Now, if LUX is up and running, you should see information in the Analysis Backend Module in the dashboard view: - + The dashboard view should give you a quick overview about the latest activities and some useful information: * How many recurring/unique leads @@ -120,7 +120,7 @@ pages and assets for your leads. Clicking on an asset or a page will open a detail page to this item, where you can exactly see which lead was interested in this item. - + **Technical note:** Page visits will be automatically be tracked with LUX on normal TYPO3 pages. In some rare scenarios you may want to push an interaction (event) to LUX. This can be helpful if you want to track accordion opens, multistep @@ -161,7 +161,7 @@ reacting to your filter settings. Of course, you can also use the CSV download i Clicking on a lead will open a detail page to this lead. - + #### Link Listeners @@ -177,14 +177,14 @@ You can use the filter on the top for a perfect analysis in a timeframe or for a a Link Listener in the table you will see the latest leads in a preview. If you click on "Show details" then, you will see all leads that used the defined Link Listener. - + ##### How to change a link to a Link Listener Link? That's very simple. Just add a new Link listener with a link target. After that, go to your RTE and set a link to your new Listener. That's all. Now all clicks on this link are tracked now. - + #### Search @@ -198,7 +198,7 @@ You can use the filter on the top for a perfect analysis in a timeframe or for a a row in the table you will see the latest leads in a preview. If you click on "Show details" then, you will see all leads that used the search term. - + To **track searchterms**, there are basically two different ways: @@ -226,7 +226,7 @@ from LUX. This is a screenshot from default values: - + Available widgets: diff --git a/Documentation/Technical/Campaigns/AbTesting.md b/Documentation/Technical/Campaigns/AbTesting.md index dbe1ce52..020c68ee 100644 --- a/Documentation/Technical/Campaigns/AbTesting.md +++ b/Documentation/Technical/Campaigns/AbTesting.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") #### A/B testing @@ -26,7 +26,7 @@ After that you will see some more fields. Add a title, a description and two pag and select the current page, that you are editing. Add a title to page record 2 and also select page B. Read for your first test. - + | Field | Description | |------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -49,7 +49,7 @@ Read for your first test. Once you have activated A/B tests in page properties, you will see a result in pageoverview: - + ##### Backend module diff --git a/Documentation/Technical/Campaigns/Index.md b/Documentation/Technical/Campaigns/Index.md index 73f81d14..f2966508 100644 --- a/Documentation/Technical/Campaigns/Index.md +++ b/Documentation/Technical/Campaigns/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Marketing campaigns diff --git a/Documentation/Technical/Campaigns/UrlShortener.md b/Documentation/Technical/Campaigns/UrlShortener.md index 8d1d861e..b8e7de6d 100644 --- a/Documentation/Technical/Campaigns/UrlShortener.md +++ b/Documentation/Technical/Campaigns/UrlShortener.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") #### URL shorteners @@ -13,7 +13,7 @@ of short URL usage per lead. If you open the backend module campaigns you can switch to "URL shortener" by clicking the button on the top. A list view is shown. - + This view works basicly like every other view in Lux. You can filter your shorteners per searchterm, category or per timeframe. Diagrams are showing you "overall usage", "top shortener" and visits from "socialmedia". @@ -25,7 +25,7 @@ A click on an existing shortener will show you individual information about the If you click on the edit icon symbol, the edit view is opened. This view is similar to the view if you add a new shortener record. - + | Field | Description | |---------------|--------------------------------------------------------------------------------------| diff --git a/Documentation/Technical/Campaigns/UtmGenerator.md b/Documentation/Technical/Campaigns/UtmGenerator.md index 1e8383d1..d927710c 100644 --- a/Documentation/Technical/Campaigns/UtmGenerator.md +++ b/Documentation/Technical/Campaigns/UtmGenerator.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") #### UTM generator @@ -30,7 +30,7 @@ campaigns. If you open the backend module campaigns you can switch to "UTM Generator" by clicking the button on the top. Another list view is shown. - + This view works basicly like every other list view in Lux. You can filter your URI records by adding a searchterm. Every table row shows the campaign name and the first available URI. By clicking on the plus symbol, all available @@ -44,7 +44,7 @@ This view is similar to the view if you add a new shortener record. **Note:** You have to add records of type `Campaign (UTM)`, `Source (UTM)` and `Medium (UTM)` first with the list view module of TYPO3 to any folder page. Those records can be then selected in the edit view. - + | Field | Description | |-------------|----------------------------------------------| diff --git a/Documentation/Technical/Campaigns/Workflows.md b/Documentation/Technical/Campaigns/Workflows.md index 9558703e..bf4b80ac 100644 --- a/Documentation/Technical/Campaigns/Workflows.md +++ b/Documentation/Technical/Campaigns/Workflows.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") #### Workflows @@ -15,7 +15,7 @@ If you open the backend module workflows and you have not added any workflows ye you is to add a new workflow. If you have already added one or more workflows, you will see a list of your existing workflows. - + Existing workflows can be deleted or edited by clicking the buttons. If you edit an existing workflow or if you add a new workflow, you will see a form that is splitted into three @@ -24,7 +24,7 @@ different steps. ##### 1 Title Define a title and an internal description for your new workflow: - + After that you can choose next for step 2. @@ -37,7 +37,7 @@ should result in an action (see 3 Action). Choose a trigger and click on the **+** button. Now a new trigger configuration was added. Depending on the trigger that you have chosen, it's possible to add values to the trigger itself. In this example, we choose the *If a lead gets identified* trigger - no values to add here: - + Possible triggers by default are: * Lead properties: If a lead gets identified @@ -82,7 +82,7 @@ some variables in the bodytext. On the right there are general options. You can select of this action should only be executed once per lead or more often. Some actions are supporting also a delayed execution where you can specify a day and a time. - + Possible actions by default are: * Content manipulation: Open a popup (lightbox) with a content element diff --git a/Documentation/Technical/Categoryscorings/Index.md b/Documentation/Technical/Categoryscorings/Index.md index c31211fb..db79ec44 100644 --- a/Documentation/Technical/Categoryscorings/Index.md +++ b/Documentation/Technical/Categoryscorings/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Scoring and Categoryscoring @@ -28,7 +28,7 @@ ago. That means that you have to call a CommandController once a day (or night) The general scoring is visible on different views in Lux. Mostly beside the lead identification. The value in the grey badge reflects the general scoring. The value in the blue badge reflects the hottest category scoring: - + @@ -50,10 +50,10 @@ What can we do with the knowledge about leads and their category scoring? Lux is You can simply define some lux-categories in your TYPO3. A lux-category is just a sys_category record in TYPO3. Don't forget to check the checkbox "lux-category". - + After you added some lux-categories to your system, you can mark pages and files with that categories. - + ##### Calculation @@ -68,4 +68,4 @@ If you want to change the factors, you can do this in the Extension Manager in t Just open a lead detail-view. You will see all relevant information about category scorings to this lead. - + diff --git a/Documentation/Technical/Changelog/Index.md b/Documentation/Technical/Changelog/Index.md index cc2b60f3..9b382e0e 100644 --- a/Documentation/Technical/Changelog/Index.md +++ b/Documentation/Technical/Changelog/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Changelog and breaking changes @@ -9,6 +9,7 @@ | Version | Date | State | TYPO3 | Description | |------------|------------|----------|---------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 38.3.0 | 2024-01-16 | Task | `12.4 + 13.4` | Update documentation to be rendered on docs.typo3.org | | 38.2.0 | 2024-01-14 | Task | `12.4 + 13.4` | Small bugfix for command cleanup:deletedrecods, added first codeception test and framework, removed unneeded files, documentation update | | 38.1.0 | 2024-12-08 | Task | `12.4 + 13.4` | Fix identification of logged in frontendusers, update some LUXletter related stuff (if LUX + LUXletter is in use), code cleanup | | 38.0.1 | 2024-11-26 | Bugfix | `12.4 + 13.4` | Update TYPO3 dependencies in old ext_emconf file | @@ -325,7 +326,7 @@ Double check if you have cleared all caches after installing a new LUX version t | From former versions to 26.2.0 | Name of localStorage settings changed | Nothing to code, but maybe you have to adjust your privacy note: Local storage settings `luxTrackingOptOut` + `luxTrackingOptIn` were removed. A new name is given `luxTracking` | | From former versions to 23.0.0 | Signals are migrated to PSR-14 events | If you have extended LUX via slots (based in signals), you have to migrate your slots to eventlisteners - see [Events documentation](../Events/Index.md) for details | | From former versions to 21.0.0 | Small change: Marker names in email4link template changed | If you have overwritten the Email4Link template file, take care to use the "EMAIL4LINK_" prefix now for the 3 variables/markers (###TITLE### => ###EMAIL4LINK_TITLE###) | -| From former versions to 17.1.0 | Small change: Disable IP-API.com via Typoscript now | If you turned off connection to IP-API.com via extension manager settings, you have to do this now via TypoScript - see [documentation](../../../Documentation/Privacy/IpAddresses.md) | +| From former versions to 17.1.0 | Small change: Disable IP-API.com via Typoscript now | If you turned off connection to IP-API.com via extension manager settings, you have to do this now via TypoScript - see [documentation](../../Privacy/IpAddresses.md) | | From former versions to 8.x | Referrers are stored on a different place now | Call your TYPO3 upgrade wizard. There will be one more step that will copy values from _visitor.referrer to _pagevisit.referrer table. | | From former versions to 7.x | Cookie-Table was replaced with a Fingerprint-Table | Call your TYPO3 upgrade wizard. There will be one more step that will copy values from _idcookie to _fingerprint table. Note that CommandControllers are replaced by Symfony Commands! | | From former versions to 3.x | The visitor object can handle more cookies now | After updating use the update button in extension manager of if you have a lot of data stored, you can also use the LuxUpdateCommandController to prevent timeouts | diff --git a/Documentation/Technical/Commands/Index.md b/Documentation/Technical/Commands/Index.md index 8fa688b0..8acefbe9 100644 --- a/Documentation/Technical/Commands/Index.md +++ b/Documentation/Technical/Commands/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Symfony Commands (Scheduler Tasks) @@ -169,7 +169,7 @@ Example usage: ``` Example summary mail for sales with activities of identified and unknown leads of a given timeframe (e.g. the last day): - + #### Service Commands diff --git a/Documentation/Technical/Editors/Index.md b/Documentation/Technical/Editors/Index.md index 66b01b93..5852515a 100644 --- a/Documentation/Technical/Editors/Index.md +++ b/Documentation/Technical/Editors/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # Settings for editors diff --git a/Documentation/Technical/Events/Index.md b/Documentation/Technical/Events/Index.md index 0a0f00a9..3c673e6a 100644 --- a/Documentation/Technical/Events/Index.md +++ b/Documentation/Technical/Events/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Events (PSR-14) diff --git a/Documentation/Technical/FAQ/Index.md b/Documentation/Technical/FAQ/Index.md index f29b59f0..47bac550 100644 --- a/Documentation/Technical/FAQ/Index.md +++ b/Documentation/Technical/FAQ/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") # FAQ diff --git a/Documentation/Technical/Finisher/Index.md b/Documentation/Technical/Finisher/Index.md index 35979f6a..7041af39 100644 --- a/Documentation/Technical/Finisher/Index.md +++ b/Documentation/Technical/Finisher/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Finisher diff --git a/Documentation/Technical/Identification/Index.md b/Documentation/Technical/Identification/Index.md index 793f1a31..6cccca52 100644 --- a/Documentation/Technical/Identification/Index.md +++ b/Documentation/Technical/Identification/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Identification @@ -109,10 +109,10 @@ submit the form. Just go into the backend and check if the lead gets identified. **Note:** Password fields are ignored for this function Example powermail form in frontend: - + Example lead identification in dashboard: - + **Note:** Re-Initialization for forms, loaded via AJAX can also be done with a script like: @@ -272,10 +272,10 @@ Example form (added via content element html): ``` Form in frontend: - + Example lead identification in dashboard: - + **Note:** Re-Initialization for forms, loaded via AJAX can also be done with a script like: @@ -373,7 +373,7 @@ lib.lux.settings { ##### Example frontend output After that, you can change every link in the CK editor: - + | Field | Description | |----------------------|--------------------------------------------------------------------------------------------------------| @@ -382,7 +382,7 @@ After that, you can change every link in the CK editor: | Send asset via email | Try to send asset as attachment via email (only possible for allowed file extensions - see TypoScript) | All clicks in frontend will be caught now by JavaScript and opens a lightbox: - + ##### Hardcode an email4link in your template diff --git a/Documentation/Technical/Index.md b/Documentation/Technical/Index.md index 6aea185a..cfd492a8 100644 --- a/Documentation/Technical/Index.md +++ b/Documentation/Technical/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ## Technical documenation diff --git a/Documentation/Technical/Installation/Index.md b/Documentation/Technical/Installation/Index.md index 16ce4e3b..67b79cf4 100644 --- a/Documentation/Technical/Installation/Index.md +++ b/Documentation/Technical/Installation/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Installation @@ -37,14 +37,14 @@ install the package. Don't forget to activate (e.g. in the extension manager) th #### Extension Manager settings - + If you click on the settings symbol for extension lux, you can change some basic settings in lux extension. - - - - + + + + | Setting | Description | |-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| @@ -195,7 +195,7 @@ If you want to see in detail what kind of TypoScript will be included and how to lux is now up and running. If you go into the frontend of your webpage and open the browser console, you should see an asynchronical request to every page request. - + **Note:** Take care to be not logged in into your TYPO3-backend at the same time with the same browser or turn on tracking for BE-Users via TypoScript. diff --git a/Documentation/Technical/Leads/Companies.md b/Documentation/Technical/Leads/Companies.md index 95dea7ad..4d416e55 100644 --- a/Documentation/Technical/Leads/Companies.md +++ b/Documentation/Technical/Leads/Companies.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Backend Module Leads/Companies @@ -26,14 +26,14 @@ a company. #### Company Detection not yet enabled - + If you enter the page on your first time, there is a note, that a token is missing. Once you add a Wiredminds token, some TypoScript constants are set and company detection is activated. #### Enabled company detection - + Once you added a valid token, you are able to convert visitors to companies. @@ -79,7 +79,7 @@ token limit itself. #### Company Preview - + By selecting a line in the list view, you will see a company preview on the right side. Some basic information like Revenue, Size or Founding year is shown. @@ -93,7 +93,7 @@ The third box will show you the newest leads of the company. #### Company Detail View - + By clicking "Show company" a detail view will show up. There are similar information in this view as you may already know from the lead detail view. @@ -106,11 +106,11 @@ also related leads are deleted. #### Statistics - + By clicking the i-Icon in the navigation bar, a basic statistic is visible. - + In the third column you will have full control about how many requests are already sent to Wiredminds interface and how many requests are left. diff --git a/Documentation/Technical/Leads/Index.md b/Documentation/Technical/Leads/Index.md index fc56c2d2..c842fb6f 100644 --- a/Documentation/Technical/Leads/Index.md +++ b/Documentation/Technical/Leads/Index.md @@ -1,11 +1,11 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Backend Module Leads/Dashboard - + - + A dashboard helps to give you an overview about your lead activities on your website. diff --git a/Documentation/Technical/Leads/Leads.md b/Documentation/Technical/Leads/Leads.md index f192e0b1..71885d4e 100644 --- a/Documentation/Technical/Leads/Leads.md +++ b/Documentation/Technical/Leads/Leads.md @@ -1,12 +1,12 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Backend Module Leads/Leads Change the view to List module by clicking on "Leads". The backend module Leads show you all identified (and anonymous) leads. - + See all your leads in a listview on the left side. While - on the right side - you can see useful information (number of page visits and hottest leads). The left side itself is split into a filter area and the table-list-view @@ -60,7 +60,7 @@ change if you are using a special filter. If you click in a table row, a small lead preview will be loaded via AJAX. Both diagrams on the right side will be replaced with a preview box and a scoring box. - + * If you are using company detection via Wiredminds (see [Companies](Companies.md)), you can change the related company manually. @@ -84,7 +84,7 @@ The detail view will give you a couple of information of the chosen lead. The vi * Properties * Profiles - + ##### Lead information diff --git a/Documentation/Technical/Plugins/Index.md b/Documentation/Technical/Plugins/Index.md index be473ba2..c3224bcd 100644 --- a/Documentation/Technical/Plugins/Index.md +++ b/Documentation/Technical/Plugins/Index.md @@ -1,5 +1,5 @@ -![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") -![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") +![LUX](../../Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](../../Images/logo_claim_white.svg#gh-dark-mode-only "LUX") ### Plugins and Pageoverview @@ -17,7 +17,7 @@ You can decide what view should be rendered via Extension Manager settings. If your installation is configured to show a analysis overview, you will see how this page is performing in this week compared to the week before. - + By clicking on the title you can show or hide (toggle) this information for the current backend user. Of course this status is saved if you change the page or logout and login later again. @@ -27,7 +27,7 @@ Of course this status is saved if you change the page or logout and login later If your installation is configured to show the latest leads, you will see visitors of the current page (Identified and Anonymous) in page module. - + By clicking on "Latest Leads" you can show or hide (toggle) this information for the current backend user. Of course this status is saved if you change the page or logout and login later again. @@ -43,15 +43,15 @@ Of course this status is saved if you change the page or logout and login later The first plugin in lux fits ideally to your privacy notes page. As you may not from Matomo (former known as Piwik) Lux also offers a checkbox in frontend where visitors can de-check if they don't want to be tracked. - + If the browser has a *DoNotTrack* setting enabled, the view changes a bit. - + You can simply add a Plugin Pi1 *trackingOptOut* to a page and add some content to it. - + *Note*: If you want to use opt-in instead of opt-out functionality, there is a possibility for this (see [Privacy](../../Privacy/Index.md)). @@ -72,7 +72,7 @@ content element - related to the category scoring of the current visitor. If you have added more then only one content element per category, the content element is selected randomly. - + @@ -84,4 +84,4 @@ If you have added more then only one content element per category, the content e This plugin allows you to add invisible content elements on your page. Those can be shown via workflow action. - + diff --git a/Documentation/guides.xml b/Documentation/guides.xml new file mode 100644 index 00000000..e642b858 --- /dev/null +++ b/Documentation/guides.xml @@ -0,0 +1,27 @@ + + + + + diff --git a/composer.json b/composer.json index 848e8ab2..b6d6ac00 100644 --- a/composer.json +++ b/composer.json @@ -97,6 +97,7 @@ } }, "scripts": { + "docs:render": "docker run --rm --pull always -v $(pwd):/project -it ghcr.io/typo3-documentation/render-guides:latest --config=Documentation", "test:php:cs": "php-cs-fixer fix --dry-run --config=.project/tests/.php-cs-fixer.php --diff", "test:php:lint": "find *.php Classes Configuration Tests -name '*.php' -print0 | xargs -0 -n 1 -P 4 php -l", "test:ts:lint": "typoscript-lint -c .project/tests/typoscript-lint.yml --fail-on-warnings", diff --git a/ext_emconf.php b/ext_emconf.php index 08d92662..7e3acb64 100644 --- a/ext_emconf.php +++ b/ext_emconf.php @@ -4,7 +4,7 @@ 'description' => 'Living User Experience - LUX - the Marketing Automation tool for TYPO3. Turn your visitors to leads. Identification and profiling of your visitors within your TYPO3 website.', 'category' => 'plugin', - 'version' => '38.2.0', + 'version' => '38.3.0', 'author' => 'Alex Kellner', 'author_email' => 'alexander.kellner@in2code.de', 'author_company' => 'in2code.de',