[DOCS] Align with new TYPO3 documentation standards (#3242)

- align Index.rst, Includes.txt, Settings.cfg - add genindex.rst, Sitemap.rst - remove outdated conf.py, Makefile, Settings.yml - ignore documentation rendering folder - replace http:// with https:// - streamline Slack channel URL See https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html for further details. This helps to avoid incorrect relative image paths due to the displacement of the embedding reST file. This aligns with official documentation standards.
TYPO3-Solr · Apr 19, 2022 · b0a618c · b0a618c
1 parent 9b4a115
commit b0a618c
Show file tree

Hide file tree

Showing 65 changed files with 281 additions and 932 deletions.
diff --git a/.editorconfig b/.editorconfig
@@ -22,8 +22,8 @@ indent_size = 2
 indent_style = tab
 
 # ReST-Files
-[*.rst]
-indent_size = 4
+[*.{rst,rst.txt}]
+indent_size = 3
 max_line_length = 80
 
 # YAML-Files

diff --git a/.gitignore b/.gitignore
@@ -16,3 +16,7 @@ typo3_src
 uploads
 var
 vendor
+/composer.lock
+.Build
+Documentation/_make
+/Documentation-GENERATED-temp/
diff --git a/Documentation/Appendix/DynamicFieldTypes.rst b/Documentation/Appendix/DynamicFieldTypes.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _appendix-dynamic-fields:
@@ -82,4 +77,4 @@ Extension               Type                                 Multivalue  Comment
 \*_coordinate           double
 \*_locationRpt          locationRpt                          No
 \*_currency             currency                             No
-======================  ===================================  ==========  ===============================================
+======================  ===================================  ==========  ===============================================
diff --git a/Documentation/Appendix/VersionMatrix.rst b/Documentation/Appendix/VersionMatrix.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _appendix-version-matrix:

diff --git a/Documentation/Backend/BackendModule.rst b/Documentation/Backend/BackendModule.rst
@@ -5,7 +5,7 @@ Backend Modules
 
 The backend modules are in the "APACHE SOLR" section available and can be unlocked for BE-users or/and groups. The modules help you to do maintenance tasks and get an overview on the system status:
 
-.. image:: ../Images/Backend/solr-backend_modules-listing.png
+.. image:: /Images/Backend/solr-backend_modules-listing.png
 
 During the next paragraphs we will go over the modules and explain, what could be done with them.
 
@@ -21,23 +21,23 @@ Connections
 
 It lists all the for the site configured connections and their status.
 
-.. image:: ../Images/Backend/solr-backend-module_Info-Connections.png
+.. image:: /Images/Backend/solr-backend-module_Info-Connections.png
 
 Statistics
 ^^^^^^^^^^
 
 The **Search Statistics** module allows you to see Top Search Phrases with and without results. In addition it possible to see a
 complete listing with hits etc. ranked by Top search keywords.
 
-.. image:: ../Images/Backend/solr-backend-module_Info-Statistics.png
+.. image:: /Images/Backend/solr-backend-module_Info-Statistics.png
 
 
 Index Fields
 ^^^^^^^^^^^^
 
 The **Index Fields** module allows you to see, how many documents you have in which solr core and which fields those documents have.
 
-.. image:: ../Images/Backend/solr-backend-module_Info-IndexFields.png
+.. image:: /Images/Backend/solr-backend-module_Info-IndexFields.png
 
 Core Optimization
 -----------------
@@ -52,7 +52,7 @@ Stop Words
 
 With the stopwords module you can define a list of words that should be excluded from the search.
 
-.. image:: ../Images/Backend/solr-backend-module_CoreOptimization-StopWords.png
+.. image:: /Images/Backend/solr-backend-module_CoreOptimization-StopWords.png
 
 Common usecases are:
 
@@ -75,7 +75,7 @@ Example
 
 smartphone => smartphone, cellphone, mobile, mobilephone will match "smartphone, cellphone, mobile, mobilephone", when smartphone is missing on the right side, you will not find the document for smartphone anymore!
 
-.. image:: ../Images/Backend/solr-backend-module_CoreOptimization-Synonyms.png
+.. image:: /Images/Backend/solr-backend-module_CoreOptimization-Synonyms.png
 
 
 Index Queue
@@ -89,7 +89,7 @@ The **Index Queue** module is the most important module. It allows you to do the
 * Start an instant indexing run, directly from the module.
 * Clear the indexing queue and re-queue items.
 
-.. image:: ../Images/Backend/solr-backend-module_IndexQueue.png
+.. image:: /Images/Backend/solr-backend-module_IndexQueue.png
 
 Index Administration (earlier Index Maintenance)
 ------------------------------------------------
@@ -100,4 +100,4 @@ The **Index Administration** module allows you, to do the following administrati
 * Empty your solr index. This removes all documents from the index of the current selected site.
 * Clear the indexing queue.
 
-.. image:: ../Images/Backend/solr-backend-module_IndexAdministration.png
+.. image:: /Images/Backend/solr-backend-module_IndexAdministration.png
diff --git a/Documentation/Backend/ConnectionManager.rst b/Documentation/Backend/ConnectionManager.rst
@@ -74,9 +74,10 @@ Example:
     solr_scheme_read: http
     solr_use_write_connection: false
 
-::
-
-The example above shows that you are able to define the setting ```solr_host_read``` on the language level. Since this is a more advanced configuration and the user interface should be kept simple, this can only be configured in the yaml.
+The example above shows that you are able to define the setting
+``solr_host_read`` on the language level. Since this is a more advanced
+configuration and the user interface should be kept simple, this can only be
+configured in the yaml.
 
 Legacy Mode
 -----------
@@ -92,7 +93,7 @@ In EXT:solr all the configuration, including options affecting backend functions
 * On your site's root page set the flag Use as Root Page on the Behaviour tab.
 * Initialize the Solr connections through the clear cache menu
 
-.. figure:: ../Images/GettingStarted/typo3-initialize-connections.png
+.. figure:: /Images/GettingStarted/typo3-initialize-connections.png
 
     Initialize all solr connections
 
@@ -102,4 +103,4 @@ The extension also repeats that process for each language configured on the inst
 
 Once all the configured Solr connections in the installation are found, they're stored in TYPO3's registry so that they can easily be retrieved without needing to reevaluate the TypoScript configuration every time we connect to Solr.
 
-All that magic happens in class source:Classes/ConnectionManager.php. The connection manager and it's public API actually must be used whenever a Solr connection is needed.
+All that magic happens in class source:Classes/ConnectionManager.php. The connection manager and it's public API actually must be used whenever a Solr connection is needed.
diff --git a/Documentation/Backend/Index.rst b/Documentation/Backend/Index.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-backend:
@@ -27,4 +22,4 @@ In this chapter we want to go deeper and learn how to write more complex indexin
 	PageProperties
 	Scheduler
 	Plugins.rst
-	ResultsPlugin.rst
+	ResultsPlugin.rst
diff --git a/Documentation/Backend/IndexInspector.rst b/Documentation/Backend/IndexInspector.rst
@@ -8,7 +8,7 @@ what data is stored for this entity in the solr index.
 
 The **"Search Index Inspector"** can be opened with the TYPO3 Info Module (*"Web > Info > Search Index Inspector"*) it shows the stored data in solr from the page or sysfolder that is selected in the pagetree:
 
-.. figure:: ../Images/Backend/solr-backend-indexinspector.png
+.. figure:: /Images/Backend/solr-backend-indexinspector.png
 
     The EXT:solr Search Index Inspector
 
diff --git a/Documentation/Backend/IndexQueue.rst b/Documentation/Backend/IndexQueue.rst
@@ -98,7 +98,7 @@ The typoscript constant "plugin.tx_news.settings.detailPid" is used to configure
 * The constant (*plugin.tx_news.settings.detailPid*) need to point to a valid news single page.
 * The page with the news single view, should be configured with *"Include in Search => Disable"* because indexing this page with the normal page indexing without a news id will produce an error page.
 
-.. figure:: ../Images/Backend/backend-disable-in-search.png
+.. figure:: /Images/Backend/backend-disable-in-search.png
 
     Include in Search - Disable
 
@@ -114,7 +114,7 @@ index queue configuration needs to contains "additionalPageIds" (e.g.: 'plugin.t
 
 Since the monitoring of changes in these records is expensive from performance perspective, you need to enable this feature in the extension configuration:
 
-.. figure:: ../Images/Backend/backend-record-outside-siteroot.png
+.. figure:: /Images/Backend/backend-record-outside-siteroot.png
 
     Enable tracking of records outside siteroot
 
diff --git a/Documentation/Backend/PageProperties.rst b/Documentation/Backend/PageProperties.rst
@@ -12,7 +12,7 @@ Depending on the state of page properties the pages and or sub pages may be inde
 Behaviour
 =========
 
-.. figure:: ../../Images/Backend/PagePropertiesBehaviour.png
+.. figure:: /Images/Backend/PagePropertiesBehaviour.png
    :alt: The Behaviour tab of the page properties
    :class: with-border
 
@@ -28,4 +28,4 @@ Include sub entries in Search (no_search_sub_entries)
 
     .. tip::
 
-        To exclude the page and its sub pages disable no_search and no_search_sub_entries at same time.
+        To exclude the page and its sub pages disable no_search and no_search_sub_entries at same time.
diff --git a/Documentation/Backend/Plugins.rst b/Documentation/Backend/Plugins.rst
@@ -8,4 +8,4 @@ EXT:solr provides the following plugin instances that can be configured in the b
 * Form plugin: **"Search: Form only"**
 * Frequent Searches plugin: **"Search: Frequent Searches"**
 
-.. image:: ../Images/Backend/plugin_instances.png
+.. image:: /Images/Backend/plugin_instances.png
diff --git a/Documentation/Backend/ResultsPlugin.rst b/Documentation/Backend/ResultsPlugin.rst
@@ -75,7 +75,7 @@ This option is used to configure if the results of an initial query should be sh
 
 This flexform element allows you to define custom filters by selecting a solr field and a value:
 
-.. image:: ../Images/Backend/plugin_search_flexform_filter.png
+.. image:: /Images/Backend/plugin_search_flexform_filter.png
 
 
 +-----------------------------+--------------------------------------------------------+

diff --git a/Documentation/Backend/Scheduler.rst b/Documentation/Backend/Scheduler.rst
@@ -16,7 +16,7 @@ The **"Index Queue Worker"** task has the following custom properties:
 - **Number of documents to Index:** Here you can configure how many documents you want to index in one run. Depending on the performance of your system and the expected update time of the search you can choose a realistic number here.
 - **Forced webroot:** The scheduler task can be executed in the cli context, because no webserver is used there, TYPO3 is unable to detect your webroot. As assumption we use PATH_site as default here. When you need to configure something else, you can do it with this option. You can use the marker ###PATH_site### and ###PATH_typo3### to define relative pathes here, to be independent from the concrete instance.
 
-.. figure:: ../Images/Backend/solr-scheduler-index-worker.png
+.. figure:: /Images/Backend/solr-scheduler-index-worker.png
 
     The EXT:solr Index Queue Worker - Scheduler Task
 
@@ -31,7 +31,7 @@ The **Force Re-Indexing of a site** task has the following custom properties:
 - **Site**: Here you select the solr site, that you want to index with this task instance.
 - **Index Queue configurations to re-index**: Here you can limit the set of indexing configurations that should be Re-Indexed.
 
-.. figure:: ../Images/Backend/solr-scheduler-requeue.png
+.. figure:: /Images/Backend/solr-scheduler-requeue.png
 
     The EXT:solr Force Re-Indexing of a site - Scheduler Task
 
@@ -46,6 +46,6 @@ The **Optimize index of a site** task has the following custom properties:
 - **Site** : Here you select the solr site, that you want to index with this task instance.
 - **Cores to optimize index for** : Here you can select the cores that should be optimized by the task.
 
-.. figure:: ../Images/Backend/solr-scheduler-optimize.png
+.. figure:: /Images/Backend/solr-scheduler-optimize.png
 
     The EXT:solr Optimize index of a site - Scheduler Task
diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-index:

diff --git a/Documentation/Configuration/Reference/ExtensionSettings.rst b/Documentation/Configuration/Reference/ExtensionSettings.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-settings:

diff --git a/Documentation/Configuration/Reference/SolrConnection.rst b/Documentation/Configuration/Reference/SolrConnection.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-solr-client:

diff --git a/Documentation/Configuration/Reference/TxSolr.rst b/Documentation/Configuration/Reference/TxSolr.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 tx_solr

diff --git a/Documentation/Configuration/Reference/TxSolrGeneral.rst b/Documentation/Configuration/Reference/TxSolrGeneral.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-general:

diff --git a/Documentation/Configuration/Reference/TxSolrIndex.rst b/Documentation/Configuration/Reference/TxSolrIndex.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-index:

diff --git a/Documentation/Configuration/Reference/TxSolrLogging.rst b/Documentation/Configuration/Reference/TxSolrLogging.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-logging:
@@ -125,4 +120,4 @@ query.rawGet
 :Options: 0,1
 :Since: 1.0
 
-If enabled, GET requests against the Solr server will be logged.
+If enabled, GET requests against the Solr server will be logged.
diff --git a/Documentation/Configuration/Reference/TxSolrSearch.rst b/Documentation/Configuration/Reference/TxSolrSearch.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 .. _configuration.reference.solrsearch:
 
 tx_solr.search

diff --git a/Documentation/Configuration/Reference/TxSolrSolr.rst b/Documentation/Configuration/Reference/TxSolrSolr.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-solr:

diff --git a/Documentation/Configuration/Reference/TxSolrStatistics.rst b/Documentation/Configuration/Reference/TxSolrStatistics.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-statistics:

diff --git a/Documentation/Configuration/Reference/TxSolrSuggest.rst b/Documentation/Configuration/Reference/TxSolrSuggest.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-suggest:

diff --git a/Documentation/Configuration/Reference/TxSolrView.rst b/Documentation/Configuration/Reference/TxSolrView.rst
@@ -1,9 +1,4 @@
-.. ==================================================
-.. FOR YOUR INFORMATION
-.. --------------------------------------------------
-.. -*- coding: utf-8 -*- with BOM.
-
-.. include:: ../../Includes.txt
+.. include:: /Includes.rst.txt
 
 
 .. _conf-tx-solr-view: