From 5bb184d3e726e28e4d351925d944c78181165824 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Tim=20D=C3=BCsterhus?= Date: Wed, 20 Oct 2021 11:26:06 +0200 Subject: [PATCH] Remove references to old WoltLab Suite versions The fact that a feature was introduced in 3.1 is no longer relevant when referencing the documentation for WoltLab Suite 5.5. Removing these references makes the documentation easier to read by removing unnecessary words. see #219 --- docs/getting-started.md | 2 -- docs/javascript/general-usage.md | 6 ++---- docs/javascript/new-api_events.md | 5 ++--- docs/package/database-php-api.md | 2 -- docs/package/pip/media-provider.md | 2 -- docs/php/api/sitemaps.md | 6 ++---- docs/php/gdpr.md | 4 +--- 7 files changed, 7 insertions(+), 20 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 0103989c..37a08824 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -198,8 +198,6 @@ Congratulations, you have just created your first package! ## Developer Tools -!!! warning "This feature is available with WoltLab Suite 3.1 or newer only." - The developer tools provide an interface to synchronize the data of an installed package with a bare repository on the local disk. You can re-import most PIPs at any time and have the changes applied without crafting a manual update. This process simulates a regular package update with a single PIP only, and resets the cache after the import has been completed. ### Registering a Project diff --git a/docs/javascript/general-usage.md b/docs/javascript/general-usage.md index 8b2b5200..9353634d 100644 --- a/docs/javascript/general-usage.md +++ b/docs/javascript/general-usage.md @@ -87,10 +87,8 @@ the minified and optimized file to the average visitor. You should use the !!! info "You can learn more on the [Accelerated Guest View](../migration/wsc30/javascript.md) in the migration docs." -The "Accelerated Guest View" was introduced in WoltLab Suite 3.1 and aims to -decrease page size and to improve responsiveness by enabling a read-only mode -for visitors. If you are providing a separate compiled build for this mode, you'll -need to include yet another switch to serve the right version to the visitor. +The “Accelerated Guest View” aims to decrease page size and to improve responsiveness by enabling a read-only mode for visitors. +If you are providing a separate compiled build for this mode, you'll need to include yet another switch to serve the right version to the visitor. ```html diff --git a/docs/javascript/new-api_events.md b/docs/javascript/new-api_events.md index 83a85f1e..1273b567 100644 --- a/docs/javascript/new-api_events.md +++ b/docs/javascript/new-api_events.md @@ -56,9 +56,8 @@ events or trigger events itself at any time. ### Identifiying Events with the Developer Tools -The Developer Tools in WoltLab Suite 3.1 offer an easy option to identify existing -events that are fired while code is being executed. You can enable this watch -mode through your browser's console using `Devtools.toggleEventLogging()`: +The Developer Tools offer an easy option to identify existing events that are fired while code is being executed. +You can enable this watch mode through your browser's console using `Devtools.toggleEventLogging()`: ``` > Devtools.toggleEventLogging(); diff --git a/docs/package/database-php-api.md b/docs/package/database-php-api.md index 26a84eef..0876f417 100644 --- a/docs/package/database-php-api.md +++ b/docs/package/database-php-api.md @@ -1,7 +1,5 @@ # Database PHP API -!!! info "Available since WoltLab Suite 5.2." - While the [sql](pip/sql.md) package installation plugin supports adding and removing tables, columns, and indices, it is not able to handle cases where the added table, column, or index already exist. We have added a new PHP-based API to manipulate the database scheme which can be used in combination with the [script](pip/script.md) package installation plugin that skips parts that already exist: diff --git a/docs/package/pip/media-provider.md b/docs/package/pip/media-provider.md index 9d43f536..9fc4c952 100644 --- a/docs/package/pip/media-provider.md +++ b/docs/package/pip/media-provider.md @@ -1,7 +1,5 @@ # Media Provider Package Installation Plugin -!!! info "Available since WoltLab Suite 3.1" - Media providers are responsible to detect and convert links to a 3rd party service inside messages. ## Components diff --git a/docs/php/api/sitemaps.md b/docs/php/api/sitemaps.md index 68fce681..d7eabd3c 100644 --- a/docs/php/api/sitemaps.md +++ b/docs/php/api/sitemaps.md @@ -1,8 +1,6 @@ # Sitemaps -!!! warning "This feature is available with WoltLab Suite 3.1 or newer only." - -Since version 3.1, WoltLab Suite Core is capable of automatically creating a sitemap. +WoltLab Suite is capable of automatically creating a sitemap. This sitemap contains all static pages registered via the page package installation plugin and which may be indexed by search engines (checking the `allowSpidersToIndex` parameter and page permissions) and do not expect an object ID. Other pages have to be added to the sitemap as a separate object. @@ -51,4 +49,4 @@ The `priority` should be `0.5` by default, unless there is an important reason t The parameter `rebuildTime` specifies the number of seconds after which the sitemap should be regenerated. Finally, you have to create the language variable for the sitemap object. -The language variable follows the pattern `wcf.acp.sitemap.objectType.{objectTypeName}` and is in the category `wcf.acp.sitemap`. \ No newline at end of file +The language variable follows the pattern `wcf.acp.sitemap.objectType.{objectTypeName}` and is in the category `wcf.acp.sitemap`. diff --git a/docs/php/gdpr.md b/docs/php/gdpr.md index 4f1faf33..0aba0648 100644 --- a/docs/php/gdpr.md +++ b/docs/php/gdpr.md @@ -12,9 +12,7 @@ on woltlab.com. ## Including Data in the Export -The `wcf\acp\action\UserExportGdprAction` introduced with WoltLab Suite 3.1.3 -already includes the Core itself as well as all official apps, but you'll need to -include any personal data stored for your plugin or app by yourself. +The `wcf\acp\action\UserExportGdprAction` already includes WoltLab Suite Core itself as well as all official apps, but you'll need to include any personal data stored for your plugin or app by yourself. The event `export` is fired before any data is sent out, but after any Core data has been dumped to the `$data` property. -- 2.20.1