|
| 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 |
0 commit comments