WapplerSystems · linawolf · Jan 3, 2025
diff --git a/Configuration/Sets/Flexslider/config.yaml b/Configuration/Sets/Flexslider/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-flexslider
+label: WS Slider Flexslider
+dependencies:
+  - wapplersystems/ws-slider
diff --git a/Configuration/Sets/Flexslider/constants.typoscript b/Configuration/Sets/Flexslider/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Flexslider/constants.typoscript'
diff --git a/Configuration/Sets/Flexslider/page.tsconfig b/Configuration/Sets/Flexslider/page.tsconfig
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TsConfig/Page/Renderer/Flexslider.tsconfig'
diff --git a/Configuration/Sets/Flexslider/setup.typoscript b/Configuration/Sets/Flexslider/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Flexslider/setup.typoscript'
diff --git a/Configuration/Sets/FlexsliderAssets/config.yaml b/Configuration/Sets/FlexsliderAssets/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-flexslider-assets
+label: WS Slider Flexslider Assets
+dependencies:
+  - wapplersystems/ws-slider-flexslider
diff --git a/Configuration/Sets/FlexsliderAssets/constants.typoscript b/Configuration/Sets/FlexsliderAssets/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Flexslider/constants.typoscript'
diff --git a/Configuration/Sets/FlexsliderAssets/setup.typoscript b/Configuration/Sets/FlexsliderAssets/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Flexslider/setup.typoscript'
diff --git a/Configuration/Sets/General/config.yaml b/Configuration/Sets/General/config.yaml
@@ -0,0 +1,2 @@
+name: wapplersystems/ws-slider
+label: WS Slider General Settings
diff --git a/Configuration/Sets/General/constants.typoscript b/Configuration/Sets/General/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/constants.typoscript'
diff --git a/Configuration/Sets/General/page.tsconfig b/Configuration/Sets/General/page.tsconfig
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TsConfig/Page/General.tsconfig'
diff --git a/Configuration/Sets/General/setup.typoscript b/Configuration/Sets/General/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/setup.typoscript'
diff --git a/Configuration/Sets/Owl/config.yaml b/Configuration/Sets/Owl/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-owl
+label: WS Slider Owl
+dependencies:
+  - wapplersystems/ws-slider
diff --git a/Configuration/Sets/Owl/constants.typoscript b/Configuration/Sets/Owl/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Owl/constants.typoscript'
diff --git a/Configuration/Sets/Owl/page.tsconfig b/Configuration/Sets/Owl/page.tsconfig
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TsConfig/Page/Renderer/Owl.tsconfig'
diff --git a/Configuration/Sets/Owl/setup.typoscript b/Configuration/Sets/Owl/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Owl/setup.typoscript'
diff --git a/Configuration/Sets/OwlAssets/config.yaml b/Configuration/Sets/OwlAssets/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-owl-assets
+label: WS Slider Owl Assets
+dependencies:
+  - wapplersystems/ws-slider-owl
diff --git a/Configuration/Sets/OwlAssets/constants.typoscript b/Configuration/Sets/OwlAssets/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Owl/constants.typoscript'
diff --git a/Configuration/Sets/OwlAssets/setup.typoscript b/Configuration/Sets/OwlAssets/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Owl/setup.typoscript'
diff --git a/Configuration/Sets/Slick/config.yaml b/Configuration/Sets/Slick/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-slick
+label: WS Slider Slick Slider
+dependencies:
+  - wapplersystems/ws-slider
diff --git a/Configuration/Sets/Slick/constants.typoscript b/Configuration/Sets/Slick/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Slick/constants.typoscript'
diff --git a/Configuration/Sets/Slick/page.tsconfig b/Configuration/Sets/Slick/page.tsconfig
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TsConfig/Page/RendererSlick.tsconfig'
diff --git a/Configuration/Sets/Slick/setup.typoscript b/Configuration/Sets/Slick/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Slick/setup.typoscript'
diff --git a/Configuration/Sets/SlickAssets/config.yaml b/Configuration/Sets/SlickAssets/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-slick-assets
+label: WS Slider Slick Slider Assets
+dependencies:
+  - wapplersystems/ws-slider-slick
diff --git a/Configuration/Sets/SlickAssets/constants.typoscript b/Configuration/Sets/SlickAssets/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Slick/constants.typoscript'
diff --git a/Configuration/Sets/SlickAssets/setup.typoscript b/Configuration/Sets/SlickAssets/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/Slick/setup.typoscript'
diff --git a/Configuration/Sets/TinySlider/config.yaml b/Configuration/Sets/TinySlider/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-tiny-slider
+label: WS Slider Tiny Slider
+dependencies:
+  - wapplersystems/ws-slider
diff --git a/Configuration/Sets/TinySlider/constants.typoscript b/Configuration/Sets/TinySlider/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/TinySlider/constants.typoscript'
diff --git a/Configuration/Sets/TinySlider/page.tsconfig b/Configuration/Sets/TinySlider/page.tsconfig
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TsConfig/Page/TinySlider.tsconfig'
diff --git a/Configuration/Sets/TinySlider/setup.typoscript b/Configuration/Sets/TinySlider/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/TinySlider/setup.typoscript'
diff --git a/Configuration/Sets/TinySliderAssets/config.yaml b/Configuration/Sets/TinySliderAssets/config.yaml
@@ -0,0 +1,4 @@
+name: wapplersystems/ws-slider-tiny-slider-assets
+label: WS Slider Tiny Slider Assets
+dependencies:
+  - wapplersystems/ws-slider-tiny-slider
diff --git a/Configuration/Sets/TinySliderAssets/constants.typoscript b/Configuration/Sets/TinySliderAssets/constants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/TinySlider/constants.typoscript'
diff --git a/Configuration/Sets/TinySliderAssets/setup.typoscript b/Configuration/Sets/TinySliderAssets/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ws_slider/Configuration/TypoScript/Assets/TinySlider/setup.typoscript'
diff --git a/Configuration/TypoScript/setup.typoscript b/Configuration/TypoScript/setup.typoscript
@@ -14,5 +14,4 @@ plugin.tx_wsslider {
     }
 [global]
 
-
-<INCLUDE_TYPOSCRIPT: source="DIR:EXT:ws_slider/Configuration/TypoScript/ContentElement/" extensions="typoscript">
+@import 'EXT:ws_slider/Configuration/TypoScript/ContentElement/'
diff --git a/Documentation/Images/SiteSets.png b/Documentation/Images/SiteSets.png
diff --git a/Documentation/Installation/Images.txt b/Documentation/Installation/Images.txt
diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
@@ -1,22 +1,93 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
-.. include:: Images.txt
+.. include:: ../Includes.txt
 
 .. _installation:
 
+============
 Installation
 ============
 
+.. contents:: Table of Contents
+
+.. _installation-composer:
+
+Installation Composer
+=====================
+
+Install extension :composer:`wapplersystems/ws-slider` via Composer:
+
+.. code-block:: bash
+
+   composer req wapplersystems/ws-slider
+
+.. _installation-classic:
+
+Installation Classic mode
+=========================
+
 - Login to the backend of TYPO3 as a user with Administrator privileges
 
-- Download and install the extension EXT:ws\_slider by the **Extension Manager**
+- Download and install the extension :t3ext:`ws_slider` by the **Extension Manager**
+
+.. _configuration:
 
 Configuration
--------------
+=============
+
+In TYPO3 13 we recommend that you include the settings of this extension via
+`Site sets <https://docs.typo3.org/permalink/t3coreapi:site-sets>`_.
+
+You only have to include the set of your choice, it handles all dependencies
+itself.
+
+.. _configuration-site-sets:
+
+Configuration with Site Sets (preferred)
+----------------------------------------
+
+This extension ships, at the time of writing, 4 different Slider Renderer.
+Include the set of the Slider Renderer of you choice in the site configuration
+of your site or depend on it in your site package.
+
+.. figure:: /Images/SiteSets.png
+   :alt: Screenshot of the Site Settings in the TYPO3 Backend, demonstrating choosing WS Slider FlexSlider set for this site.
+
+   Chooser the slider type of your choice. If you do not want to supply the
+   assets yourself chose the version including the assets.
+
+Each site set comes in a version that includes the assets for the slider
+(JavaScript, Css) and a plain version without.
+
+To add a slider type to your
+`site packages set <https://docs.typo3.org/permalink/t3sitepackage:minimal-extension-siteset>`_,
+add it as a dependency as follows:
+
+.. code-block:: diff
+   :caption: packages/my_site_package/Configuration/Sets/SitePackage/config.yaml
+
+    name: my-vendor/my-site-package
+    label: 'My Site Package'
+    dependencies:
+      - typo3/fluid-styled-content
+   +  - wapplersystems/ws-slider-flexslider-assets
+
+The following sets are available:
+
+`wapplersystems/ws-slider`
+   General Slider, if you use this you have to provide a custom rendering including
+   the desired assets.
+`wapplersystems/ws-slider-flexslider`, `wapplersystems/ws-slider-flexslider-assets`
+   FlexSlider `<https://github.com/woocommerce/FlexSlider/wiki/FlexSlider-Properties>`_
+`wapplersystems/ws-slider-owl`, `wapplersystems/ws-slider-flexslider-owl`
+   Owl `<https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html>`_
+`wapplersystems/ws-slider-slick`, `wapplersystems/ws-slider-slick-assets`
+   Slick `<https://kenwheeler.github.io/slick/>`_
+`wapplersystems/ws-slider-tiny-slider`, `wapplersystems/ws-slider-tiny-slider-assets`
+   TinySlider `<https://ganlanyuan.github.io/tiny-slider/#options>`_
+
+.. _configuration-typoscript-records:
+
+Configuration with TypoScript Records
+-------------------------------------
 
 To enable the sliders for editors, you have to add them to the page properties in the TSconfig settings. You can decide which slider or layout you want to add. To do this:
 
@@ -26,7 +97,7 @@ To enable the sliders for editors, you have to add them to the page properties i
 4. Navigate to the `Resources` tab and add the items for the sliders you need in the `Page TSconfig` section as shown in the image below.
 
 
-|TSconfigIncludes|
+.. image:: ../Images/TSconfigIncludes.png
 
 Add the template of the extension to your main template by:
 
@@ -36,27 +107,32 @@ Add the template of the extension to your main template by:
 4. Edit the template.
 5. Go the `Includes` tab and add the items for the sliders you need ad shown in the image below.
 
-|TemplateIncludes|
+
+.. image:: ../Images/TemplateIncludes.png
+
+.. _adding-content:
 
 Adding Content
---------------
+==============
 
 Select which slider you want to use and add slider elements. In each slider element you can set an image source.
 
-|Elements|
+.. image:: ../Images/Elements.png
+
+.. _slider-settings:
 
 Slider Settings
----------------
+===============
 
 Within the `Settings` tab when editing your content element you can find settings for the specific slider you have selected.
 Here is an example for the Owl slider. Each setting has a default value, if you want to change a setting you can select the checkbox and set the specific value.
 
-|OwlSettings|
+.. image:: ../Images/OwlSettings.png
 
 These settings are built after the respective endpoints the sliders offer.
 The respective Documentation that we used can be found here:
 
 * Owl `<https://owlcarousel2.github.io/OwlCarousel2/docs/api-options.html>`_
 * FlexSlider `<https://github.com/woocommerce/FlexSlider/wiki/FlexSlider-Properties>`_
 * TinySlider `<https://ganlanyuan.github.io/tiny-slider/#options>`_
-* Slick `<https://kenwheeler.github.io/slick/>`_
+* Slick `<https://kenwheeler.github.io/slick/>`_
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		@import 'EXT:ws_slider/Configuration/TypoScript/Renderer/Flexslider/constants.typoscript'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		@import 'EXT:ws_slider/Configuration/TsConfig/Page/Renderer/Flexslider.tsconfig'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		name: wapplersystems/ws-slider
		label: WS Slider General Settings