From adaa76c4b6a18dcbe8407648328c1fe755ceaf8a Mon Sep 17 00:00:00 2001 From: Alexander Kellner Date: Tue, 12 Mar 2024 22:00:01 +0100 Subject: [PATCH] [TASK] Add documentation for breaking changes --- Documentation/Technical/Changelog/Index.md | 34 ++++++++++++---------- Documentation/Technical/Editors/Index.md | 30 +++++++++++++++++++ Documentation/Technical/Index.md | 1 + 3 files changed, 50 insertions(+), 15 deletions(-) create mode 100644 Documentation/Technical/Editors/Index.md diff --git a/Documentation/Technical/Changelog/Index.md b/Documentation/Technical/Changelog/Index.md index 5cd173d4..5405de7d 100644 --- a/Documentation/Technical/Changelog/Index.md +++ b/Documentation/Technical/Changelog/Index.md @@ -7,21 +7,25 @@ Double check if you have cleared all caches after installing a new LUX version to be sure to have no side effects. -| Version | Situation | Upgrade instructions | -|--------------------------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| From former versions to 32.0.0 | Old Flashmessages could be visible in backend views after update | Nothing to do or to worry about. In the past there were flashmessages like "lead deleted" stored to a backend editor, but there was no output. If you upgrade now to LUX 32 it could happen that all old flashmessages are visible for the editors. Once those messages are shown, they will be deleted - everything is fine again after a reload or switch to a different view. | -| From former versions to 28.0.0 | Email4link HTML template via AJAX - overwrite `Email4link.html` | If you have modified the `Email4Link.html`, this is now done in a similar way. 1. You have to set a template path to your sitepackage like `plugin.tx_lux_email4link.view.templateRootPaths.1 = EXT:mysitepackage/Resources/Private/Templates/Extensions/Lux/` 2. Copy the original file from `EXT:lux/Resources/Private/Templates/Frontend/Email4link.html` to your sitepackage in `EXT:mysitepackage/Resources/Private/Templates/Extensions/Lux/Frontend/Email4link.html` and modify it to your needs. | -| From former versions to 28.0.0 | Email4link HTML template via AJAX - set privacy PID | If you used TypoScript settings for setting a privacy PID instead of TypoScript constants, the place has changed. Privacy PID can be set in TypoScript setup via `luxEmail4LinkAjax.10.settings.pidPrivacyPage = 123` | -| From former versions to 28.0.0 | Email4link HTML template via AJAX - typenum in site configuration | You should extend your siteconfiguration under `routeEnhancers.PageTypeSuffix.map` with typenum `1680114177` and (e.g.) `email4link.json` | -| From former versions to 27.0.0 | JS loading changed a bit | While JS was loaded via `page.includeJSFooter.lux` in the past, now `page.includeJSFooterlibs.lux` is used. If you removed JS including, you have to update your TypoScript. | -| From former versions to 27.0.0 | CKeditor plugin js folder changed for TYPO3 11 | While TYPO3 12 is using CKeditor 5 (instead of 4) we need 2 different JS Folders for the email4link functionality. Adjust your CKeditor configuration from `resource: 'EXT:lux/Resources/Public/JavaScript/Static/CkEditorPlugins/luxEmail4Link/plugin.js'` to `resource: 'EXT:lux/Resources/Public/JavaScript/Static/CkEditorPlugins/luxEmail4LinkOld/plugin.js'` | -| 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 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 | +| Version | Situation | Upgrade instructions | +|--------------------------------|---------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| From former versions to 35.0.0 | Multiclient usage on some records need some time to work | Nothing to do for you - just a note: Some records have to be extended with site information, but this can only be done with new records - not with existing (affected tables: Logs, Search, Fingerprint and some boxes on Lead Dashboard). To ensure that privacy is guaranteed, you need to remove all existing LUX data in a multiclient environment. | +| From former versions to 35.0.0 | Define storage pid for editors (linklistener, shortener, utmgenerator) | Records of different tables (tx_lux_domain_model_linklistener, tx_luxenterprise_domain_model_shortener, tx_luxenterprise_domain_model_utmgenerator_uri) can be stored on different pids depending on the backend user - see [Editors configuration](../Editors/Index.md) for details. | +| From former versions to 35.0.0 | Add sites data to existing records to allow multiclient usage | Run upgrade wizward `addSitesUpgradeWizard` to add site information on various tables. Recommendation: We strongly recommend you to run the wizard on CLI to prevent timeouts on larger databases. | +| From former versions to 35.0.0 | Modify relations between visitor and fingerprint table for a better performance | Run upgrade wizward `updateFingerprintRelationsUpgradeWizard` to improve relations. Recommendation: We strongly recommend you to run the wizard on CLI to prevent timeouts on larger databases. | +| From former versions to 32.0.0 | Old Flashmessages could be visible in backend views after update | Nothing to do or to worry about. In the past there were flashmessages like "lead deleted" stored to a backend editor, but there was no output. If you upgrade now to LUX 32 it could happen that all old flashmessages are visible for the editors. Once those messages are shown, they will be deleted - everything is fine again after a reload or switch to a different view. | +| From former versions to 28.0.0 | Email4link HTML template via AJAX - overwrite `Email4link.html` | If you have modified the `Email4Link.html`, this is now done in a similar way. 1. You have to set a template path to your sitepackage like `plugin.tx_lux_email4link.view.templateRootPaths.1 = EXT:mysitepackage/Resources/Private/Templates/Extensions/Lux/` 2. Copy the original file from `EXT:lux/Resources/Private/Templates/Frontend/Email4link.html` to your sitepackage in `EXT:mysitepackage/Resources/Private/Templates/Extensions/Lux/Frontend/Email4link.html` and modify it to your needs. | +| From former versions to 28.0.0 | Email4link HTML template via AJAX - set privacy PID | If you used TypoScript settings for setting a privacy PID instead of TypoScript constants, the place has changed. Privacy PID can be set in TypoScript setup via `luxEmail4LinkAjax.10.settings.pidPrivacyPage = 123` | +| From former versions to 28.0.0 | Email4link HTML template via AJAX - typenum in site configuration | You should extend your siteconfiguration under `routeEnhancers.PageTypeSuffix.map` with typenum `1680114177` and (e.g.) `email4link.json` | +| From former versions to 27.0.0 | JS loading changed a bit | While JS was loaded via `page.includeJSFooter.lux` in the past, now `page.includeJSFooterlibs.lux` is used. If you removed JS including, you have to update your TypoScript. | +| From former versions to 27.0.0 | CKeditor plugin js folder changed for TYPO3 11 | While TYPO3 12 is using CKeditor 5 (instead of 4) we need 2 different JS Folders for the email4link functionality. Adjust your CKeditor configuration from `resource: 'EXT:lux/Resources/Public/JavaScript/Static/CkEditorPlugins/luxEmail4Link/plugin.js'` to `resource: 'EXT:lux/Resources/Public/JavaScript/Static/CkEditorPlugins/luxEmail4LinkOld/plugin.js'` | +| 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 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 | ## Changelog diff --git a/Documentation/Technical/Editors/Index.md b/Documentation/Technical/Editors/Index.md new file mode 100644 index 00000000..d4a6c32f --- /dev/null +++ b/Documentation/Technical/Editors/Index.md @@ -0,0 +1,30 @@ +![LUX](/Documentation/Images/logo_claim.svg#gh-light-mode-only "LUX") +![LUX](/Documentation/Images/logo_claim_white.svg#gh-dark-mode-only "LUX") + +# Settings for editors + +While administrators have access to all data in LUX and LUXenterprise, editors have only limited access to guarantee +privacy in a multiclient installation. + +## Access per Site + +Data is recorded now with site identifiers. This ensures to split information by site identifiers. If an editor needs +access to LUX data in a site, take care that this user has reading access to the root page of a site. + +This means, that if an editor needs access to all LUX data, ensure that this editor has reading access to all root +pages. + +## Storage PID for linklistener, shortener and utm generator records + +Since version 35.0.0 you can define where to store those types of records depending on the backend user. There is now +more flexibility via User TSConfig (in backend user or backend usergroup records): + +``` +tx_lux { + defaultPage { + tx_lux_domain_model_linklistener = 1 + tx_luxenterprise_domain_model_shortener = 2 + tx_luxenterprise_domain_model_utmgenerator_uri = 3 + } +} +``` diff --git a/Documentation/Technical/Index.md b/Documentation/Technical/Index.md index 755778a2..6aea185a 100644 --- a/Documentation/Technical/Index.md +++ b/Documentation/Technical/Index.md @@ -32,6 +32,7 @@ There are some functional settings - saved to localstorage in browser which are: See more information in the chapters: ### [Installation](Installation/Index.md) +### [Editor configuration](Editors/Index.md) ### [Analysis](Analysis/Index.md) ### [Identification](Identification/Index.md) ### [Scoring and Categoryscoring](Categoryscorings/Index.md)