Skip to content

Commit

Permalink
[TASK] Complete extension settings documentation
Browse files Browse the repository at this point in the history
Adds missing documentation for the following extension configuration
settings:
- pluginNamespaces
- includeGlobalQParameterInCacheHash
- useConfigurationMonitorTables
- enableRouteEnhancer

Relates: 2725
Relates: 3810
  • Loading branch information
dkd-friedrich committed Oct 13, 2023
1 parent 6f7d4b0 commit c3bcf7f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
42 changes: 42 additions & 0 deletions Documentation/Configuration/Reference/ExtensionSettings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,28 @@ Extension Configuration

The following settings can be defined in the "Settings":>"Extension Configuration":>"solr"

pluginNamespaces
----------------

:Type: String
:Since: 11.1
:Default: tx_solr

A list of white listed plugin namespaces (Required by cacheHash/excludedParameters and plugin flex form).

.. note::
This list only is available in Plugin -> Options -> Plugin Namespace.

includeGlobalQParameterInCacheHash
----------------------------------

:Type: Boolean
:Since: 11.1
:Default: 0

Include/Exclude global q parameter in/from cacheHash.


useConfigurationFromClosestTemplate
-----------------------------------

Expand All @@ -29,6 +51,15 @@ A common common scenario is to have a site and a storage folder for records para
on the same level (f.e.)
If you don't want this behaviour - it should be set to false.

useConfigurationMonitorTables
-----------------------------

:Type: String
:Since: 6.1
:Default:

Monitor tables - explicitly monitor these (still requires TypoScript configuration)

allowSelfSignedCertificates
---------------------------

Expand All @@ -53,3 +84,14 @@ options are available:

- Delayed: Record update events will be queue and processed later, the scheduler task "Event Queue Worker" is required for processing.
- No monitoring: Monitoring is completely disabled, please note that you have to take care of Solr index updates yourself.

enableRouteEnhancer
-------------------

:Type: Boolean
:Since: 12.0
:Default: 0

To use the EXT:solr possibility to create speaking URLs for Solr facets, activate this option.

As this feature requires additional configuration and costly processing, it's disabled by default.
4 changes: 4 additions & 0 deletions Documentation/Routing/ConfigureRouting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ The extension key have to be set to `tx_solr`.

Solr specific configuration will placed inside of key `solr`.

.. note::
To use the EXT:solr possibility to create speaking URLs for Solr facets, activate option enableRouteEnhancer in the
Extension Configuration.

The following example shows a the basement of the enhancer configuration.

.. code-block:: yaml
Expand Down

0 comments on commit c3bcf7f

Please sign in to comment.