Skip to content

Commit daa996a

Browse files
dmitryddkd-kaehm
authored andcommitted
[DOCS] Add documentation about site sets
Refs: #4527
1 parent 991dc11 commit daa996a

4 files changed

Lines changed: 111 additions & 4 deletions

File tree

Documentation/Configuration/Index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,6 @@ Configuration Reference
2929
./Reference/TxSolrSuggest
3030
./Reference/TxSolrStatistics
3131
./Reference/TxSolrLogging
32+
./SiteSets
3233
./Reference/ExtensionSettings
3334
./Reference/SolrConnection
Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
.. _configuration-site-sets:
2+
3+
Site Sets
4+
=========
5+
6+
.. versionadded:: 14.0
7+
8+
EXT:solr provides TYPO3 site sets in :file:`Configuration/Sets/`.
9+
10+
TYPO3 site sets are the recommended way to provide reusable site-scoped
11+
configuration in TYPO3 14 projects. EXT:solr ships site sets for the base
12+
configuration, optional frontend assets, OpenSearch and the example
13+
configurations that were previously available as static TypoScript includes.
14+
15+
If your project does not use TypoScript template records
16+
(``sys_template``), add EXT:solr configuration through site set
17+
dependencies. TYPO3 resolves, orders and deduplicates site set dependencies,
18+
which makes this approach more robust than managing dependencies manually in
19+
TypoScript records.
20+
21+
Example site configuration:
22+
23+
.. code-block:: yaml
24+
:caption: config/sites/my-site/config.yaml
25+
26+
dependencies:
27+
- apache-solr-for-typo3/solr
28+
- apache-solr-for-typo3/solr-stylesheets
29+
30+
TypoScript template records are still supported for existing installations and
31+
mixed setups. When using site sets, prefer dependencies between sets instead
32+
of cross-extension TypoScript imports or duplicated static includes.
33+
34+
Available Site Sets
35+
-------------------
36+
37+
The following site sets are provided by EXT:solr:
38+
39+
.. list-table::
40+
:header-rows: 1
41+
:widths: 45 55
42+
43+
* - Site set
44+
- Description
45+
* - ``apache-solr-for-typo3/solr``
46+
- Base Configuration
47+
* - ``apache-solr-for-typo3/solr-bootstrap-css``
48+
- Bootstrap CSS Framework
49+
* - ``apache-solr-for-typo3/solr-stylesheets``
50+
- Default Stylesheets
51+
* - ``apache-solr-for-typo3/solr-open-search``
52+
- OpenSearch
53+
* - ``apache-solr-for-typo3/solr-example-ajaxify``
54+
- Ajaxify the search results
55+
* - ``apache-solr-for-typo3/solr-example-boost-queries``
56+
- Boost more recent results
57+
* - ``apache-solr-for-typo3/solr-example-everything-on``
58+
- Everything On
59+
* - ``apache-solr-for-typo3/solr-example-filter-pages``
60+
- Filter to only show page results
61+
* - ``apache-solr-for-typo3/solr-example-suggest``
62+
- Suggest/autocomplete
63+
* - ``apache-solr-for-typo3/solr-example-facets-options``
64+
- Options facet on author field
65+
* - ``apache-solr-for-typo3/solr-example-facets-options-toggle``
66+
- Options with on/off toggle
67+
* - ``apache-solr-for-typo3/solr-example-facets-options-prefix-grouped``
68+
- Options grouped by prefix
69+
* - ``apache-solr-for-typo3/solr-example-facets-options-single-mode``
70+
- Options with singlemode (only one option at a time)
71+
* - ``apache-solr-for-typo3/solr-example-facets-options-filtered``
72+
- Options filterable by option value
73+
* - ``apache-solr-for-typo3/solr-example-facets-query-group``
74+
- QueryGroup facet on the created field
75+
* - ``apache-solr-for-typo3/solr-example-facets-hierarchy``
76+
- Hierarchy facet on the rootline field
77+
* - ``apache-solr-for-typo3/solr-example-facets-date-range``
78+
- DateRange facet with datepicker on created field
79+
* - ``apache-solr-for-typo3/solr-example-numeric-range``
80+
- NumericRange facet with slider on pid field
81+
* - ``apache-solr-for-typo3/solr-example-type-field-group``
82+
- Fieldgroup on type field
83+
* - ``apache-solr-for-typo3/solr-example-pid-query-group``
84+
- Querygroup on pid field
85+
* - ``apache-solr-for-typo3/solr-example-index-queue-news``
86+
- Index Queue Configuration for news
87+
* - ``apache-solr-for-typo3/solr-example-index-queue-news-content-elements``
88+
- Index Queue Configuration for news with content elements

Documentation/GettingStarted/ConfigureExtension.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,19 @@ Underlying settings can be found in the extension configuration, though the defa
2323

2424

2525

26-
Static TypoScript
27-
-----------------
26+
Site Sets or Static TypoScript
27+
------------------------------
2828

29-
The extension already comes with basic TypoScript configuration that will work for small pages out of the box. For now create or
30-
edit an existing TypoScript Template record in your page tree and add the provided static TypoScript:
29+
The extension already comes with basic TypoScript configuration that will work
30+
for small pages out of the box.
31+
32+
For TYPO3 14 projects, the recommended setup is to include EXT:solr through
33+
site set dependencies. See :ref:`configuration-site-sets` for the available
34+
site sets and an example site configuration.
35+
36+
If your project still uses TypoScript Template records, create or edit an
37+
existing TypoScript Template record in your page tree and add the provided
38+
static TypoScript:
3139

3240
.. image:: /Images/GettingStarted/typo3-include-static-typoscript.png
3341

Documentation/Releases/solr-release-14-0.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,16 @@ TYPO3 14 LTS Compatibility
2121
EXT:solr has been fully adapted for TYPO3 14 LTS, including Fluid v5 ViewHelper
2222
compatibility, TCA changes, deprecation removals, and testing framework updates.
2323

24+
TYPO3 Site Sets
25+
~~~~~~~~~~~~~~~
26+
27+
EXT:solr now provides TYPO3 site sets for the base configuration, optional
28+
frontend assets, OpenSearch and the shipped example configurations. For TYPO3
29+
14 projects that do not use TypoScript template records, site set dependencies
30+
are the recommended way to include EXT:solr configuration.
31+
32+
See :ref:`configuration-site-sets` for the full list of available site sets.
33+
2434
XLIFF 2.0 Migration
2535
~~~~~~~~~~~~~~~~~~~
2636

0 commit comments

Comments
 (0)