[FEATURE] Add support for site sets, closes #278

Example taken from EXT:news, thanks to Lina Wolf georgringer/news@b4075db
tpwd · Jan 24, 2025 · e762364 · nebrot · Jan 24, 2025 · christianbltr
1 parent b102965
commit e762364
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 4 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,6 +1,7 @@
 ChangeLog
 
 Upcoming version
+[FEATURE] Add support for site sets. https://github.com/tpwd/ke_search/issues/278
 [BUGFIX]  Avoid PHP warning when saving category. Thanks to Simon Praetorius. https://github.com/tpwd/ke_search/issues/276
 [DOCS]    Add documentation about indexing content elements made with EXT:content_blocks. https://github.com/tpwd/ke_search/issues/254
 

diff --git a/Configuration/Sets/KeSearch/config.yaml b/Configuration/Sets/KeSearch/config.yaml
@@ -0,0 +1,2 @@
+name: tpwd/ke_search
+label: 'Faceted Search (ke_search)'
diff --git a/Configuration/Sets/KeSearch/contants.typoscript b/Configuration/Sets/KeSearch/contants.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ke_search/Configuration/TypoScript/constants.typoscript'
diff --git a/Configuration/Sets/KeSearch/setup.typoscript b/Configuration/Sets/KeSearch/setup.typoscript
@@ -0,0 +1 @@
+@import 'EXT:ke_search/Configuration/TypoScript/setup.typoscript'
diff --git a/Documentation/QuickStart/Index.rst b/Documentation/QuickStart/Index.rst
@@ -26,10 +26,36 @@ You can find the current version (and older ones) at
 
 https://extensions.typo3.org/extension/ke_search
 
-Include static template
-=======================
+Include TypoScript
+==================
 
-In your main template include the "static template" of the extension ke_search.
+.. _configuration-site-set:
+Site Sets
+---------
+..  versionadded:: TYPO3 v13.1 / ke_search v6.3.0
+    If you are working with TYPO3 v12.4, use :ref:`configuration-typoscript-record`.
+
+The extension ships some TypoScript code which can be included in the site
+configuration via :ref:`Site sets <t3coreapi/13:site-sets>`:
+
+#.  Got to backend module :guilabel:`Site Management > Sites`.
+#.  Edit the configuration of your site.
+#.  On the first tab go to :guilabel:`Sets for this Site`.
+#.  Include the set :guilabel:`Faceted Search (ke_search)`.
+
+.. _configuration-typoscript-record:
+
+TypoScript sets (the traditional way)
+-------------------------------------
+
+If you are not using :ref:`configuration-site-set` you can
+add the TypoScript via the TypoScript module (formerly known as "Include
+static template"):
+
+#.  Got to backend module :guilabel:`Site Management > TypoScript`.
+#.  Select :guilabel:`Edit TypoScript record` --> :guilabel:`Edit the whole TypoScript record`.
+#.  On the first tab go to :guilabel:`Include TypoScript sets`.
+#.  Include the set :guilabel:`Faceted Search (ke_search)`.
 
 Create pages
 ============
@@ -117,4 +143,4 @@ Open the backend module :guilabel:`Web` > :guilabel:`Faceted Search` and start t
 
 You're done!
 
-Open the `Search` page in the frontend and start finding ...
+Open the `Search` page in the frontend and start finding ...
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		name: tpwd/ke_search
		label: 'Faceted Search (ke_search)'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		@import 'EXT:ke_search/Configuration/TypoScript/constants.typoscript'
This comment has been minimized. Sign in to view Copy link nebrot Jan 24, 2025 There is a typo in filename (not line 1), it should be `constants.typoscript` instead of `contants.typoscript`. This comment has been minimized. Sign in to view Copy link christianbltr Jan 31, 2025 Author Member Thank you, good catch. This has been fixed in master and will be in the next version. nebrot reacted with thumbs up emoji