From 9a29d1f06b178335c122c908be793ea5f996827e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafael=20K=C3=A4hm?= Date: Thu, 12 Dec 2024 00:16:07 +0100 Subject: [PATCH] [DOCS] Switch documentation rendering to PHP-based rendering Known issues: * Some RSTs missing index directive. * Tables in `Documentation/Appendix/VersionMatrix.rst` are not renderable. See: https://github.com/TYPO3-Documentation/TYPO3CMS-Guide-HowToDocument/issues/251 Fixes: #4204 --- .github/workflows/ci.yml | 28 +++++++- Build/generate_documentation.sh | 21 +++--- Documentation/Appendix/DockerTweaks.rst | 3 - Documentation/Appendix/DynamicFieldTypes.rst | 3 - Documentation/Appendix/VersionMatrix.rst | 1 - Documentation/Backend/Index.rst | 7 +- Documentation/Backend/ResultsPlugin.rst | 1 - Documentation/Configuration/Index.rst | 3 - .../Reference/ExtensionSettings.rst | 3 - .../Reference/SolrConnection.rst | 3 - .../Configuration/Reference/TxSolr.rst | 3 - .../Configuration/Reference/TxSolrGeneral.rst | 3 - .../Configuration/Reference/TxSolrIndex.rst | 3 - .../Configuration/Reference/TxSolrLogging.rst | 3 - .../Configuration/Reference/TxSolrSearch.rst | 41 ++++++------ .../Reference/TxSolrStatistics.rst | 5 +- .../Configuration/Reference/TxSolrSuggest.rst | 5 +- .../Configuration/Reference/TxSolrView.rst | 3 - Documentation/Database/Index.rst | 2 +- Documentation/Development/Backend.rst | 1 - Documentation/Development/Index.rst | 3 - Documentation/Development/Indexing.rst | 4 +- Documentation/FAQ/Index.rst | 1 - Documentation/Frontend/Index.rst | 23 +++---- .../GettingStarted/InstallTYPO3Extension.rst | 1 - Documentation/Includes.rst.txt | 35 ---------- Documentation/Index.rst | 1 - Documentation/Logging/Index.rst | 3 - Documentation/Releases/Archive/Index.rst | 27 ++++---- .../Releases/Archive/solr-release-10-0.rst | 1 - .../Releases/Archive/solr-release-11-1.rst | 1 - .../Releases/Archive/solr-release-3-0.rst | 1 - .../Releases/Archive/solr-release-4-0.rst | 1 - .../Releases/Archive/solr-release-5-0.rst | 1 - .../Releases/Archive/solr-release-5-1.rst | 1 - .../Releases/Archive/solr-release-6-0.rst | 1 - .../Releases/Archive/solr-release-6-1.rst | 1 - .../Releases/Archive/solr-release-7-0.rst | 1 - .../Releases/Archive/solr-release-8-0.rst | 1 - .../Releases/Archive/solr-release-8-1.rst | 1 - .../Releases/Archive/solr-release-9-0.rst | 1 - .../Releases/Archive/solr_release-3-1.rst | 1 - Documentation/Releases/Index.rst | 1 - Documentation/Releases/solr-release-11-0.rst | 1 - Documentation/Releases/solr-release-11-2.rst | 3 +- Documentation/Releases/solr-release-11-5.rst | 3 +- Documentation/Releases/solr-release-11-6.rst | 1 - Documentation/Releases/solr-release-12-0.rst | 1 - Documentation/Releases/solr-release-13-0.rst | 1 - Documentation/Routing/Index.rst | 11 ++- Documentation/Settings.cfg | 67 ------------------- Documentation/Sitemap.rst | 2 - Documentation/Solr/Index.rst | 3 - Documentation/genindex.rst | 2 - Documentation/guides.xml | 24 +++++++ 55 files changed, 112 insertions(+), 261 deletions(-) delete mode 100644 Documentation/Includes.rst.txt delete mode 100644 Documentation/Settings.cfg create mode 100644 Documentation/guides.xml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index cbe39335a6..6991c79986 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -84,6 +84,30 @@ jobs: path: /tmp/solrci-image.tar retention-days: 1 + test_documentation: + name: test Documentation + runs-on: ubuntu-latest + ## @todo: remove `continue-on-error: true`, if Version matrix tables are fixed. + continue-on-error: true + steps: + # Workaround for issue with actions/checkout "wrong PR commit checkout". See: ci_bootstrapping job + - name: Checkout current state of Pull Request + if: github.event_name == 'pull_request' + uses: actions/checkout@v4 + with: + fetch-depth: 2 + ref: ${{ github.event.pull_request.head.sha }} + - name: Checkout current state of Branch + if: ${{ github.event_name == 'push' || github.event_name == 'schedule' }} + uses: actions/checkout@v4 + with: + fetch-depth: 2 + # End: Workaround for issue with actions/checkout... + + - name: Test if the documentation will render without warnings + run: | + Build/generate_documentation.sh --no-progress + tests: runs-on: ubuntu-latest needs: ci_bootstrapping @@ -177,7 +201,7 @@ jobs: name: Publish new version to TER needs: tests if: startsWith(github.ref, 'refs/tags/') - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest env: TYPO3_API_TOKEN: ${{ secrets.TYPO3_API_TOKEN }} steps: @@ -221,7 +245,7 @@ jobs: echo "Following message will be printed in TER as release description:" echo -e "$TER_COMMENT" if ! composer extension-build; then - >&2 echo -e "Something went wrong on bulding EXT:solr for NON-Composer mode. Please look in the job." + >&2 echo -e "Something went wrong on building EXT:solr for NON-Composer mode. Please look in the job." exit 13 fi php ~/.composer/vendor/bin/tailor ter:publish --comment "$TER_COMMENT" "$RELEASE_VERSION" diff --git a/Build/generate_documentation.sh b/Build/generate_documentation.sh index 6a23e169ca..fd062f6975 100755 --- a/Build/generate_documentation.sh +++ b/Build/generate_documentation.sh @@ -12,23 +12,18 @@ if ! command -v docker &> /dev/null; then exit 1 fi -if ! command -v dockrun_t3rd &> /dev/null; then - echo "The command \"dockrun_t3rd\" is not initialized on system." - echo "Making \"dockrun_t3rd\" available in current script." - if [[ "$(docker images -q ghcr.io/t3docs/render-documentation 2> /dev/null)" == "" ]]; then - docker pull ghcr.io/t3docs/render-documentation && docker tag ghcr.io/t3docs/render-documentation t3docs/render-documentation - fi - # shellcheck disable=SC2034 - DOCKRUN_FN_QUIET=1 - # shellcheck disable=SC1090 - source <(docker run --rm ghcr.io/t3docs/render-documentation show-shell-commands) +if ! docker run --rm --pull always -v "$(pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation "$@"; then + echo "Something went wrong on rendering the docs. Please check the output and affected documentation files of EXT:solr and fix them." + exit 1; +else + echo "Great job, the documentation is fine." fi -dockrun_t3rd makehtml-no-cache - if [[ "$BUILD_DOCS_FOR_PRODUCTION" == 1 || "$BUILD_DOCS_FOR_PRODUCTION" == "true" ]]; then rm -Rf "${PRODUCTION_DOCS_PATH}" "Documentation.HTML" - mv -v "Documentation-GENERATED-temp/Result/project/0.0.0" "${PRODUCTION_DOCS_PATH}" + mv -v "Documentation-GENERATED-temp" "${PRODUCTION_DOCS_PATH}" ln -s "${PRODUCTION_DOCS_PATH}" "Documentation.HTML" rm -Rf "Documentation-GENERATED-temp" fi + +exit 0; diff --git a/Documentation/Appendix/DockerTweaks.rst b/Documentation/Appendix/DockerTweaks.rst index 89c68b4e4e..9a6b71c263 100644 --- a/Documentation/Appendix/DockerTweaks.rst +++ b/Documentation/Appendix/DockerTweaks.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _appendix-docker-tweaks: Appendix - Docker Tweaks diff --git a/Documentation/Appendix/DynamicFieldTypes.rst b/Documentation/Appendix/DynamicFieldTypes.rst index f3b9de61ad..1107df8aa6 100644 --- a/Documentation/Appendix/DynamicFieldTypes.rst +++ b/Documentation/Appendix/DynamicFieldTypes.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _appendix-dynamic-fields: Appendix - Dynamic Fields diff --git a/Documentation/Appendix/VersionMatrix.rst b/Documentation/Appendix/VersionMatrix.rst index 9657b62c9d..7bd651ea61 100644 --- a/Documentation/Appendix/VersionMatrix.rst +++ b/Documentation/Appendix/VersionMatrix.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _appendix-version-matrix: Appendix - Version Matrix diff --git a/Documentation/Backend/Index.rst b/Documentation/Backend/Index.rst index c2868b5d36..de5143e4e8 100644 --- a/Documentation/Backend/Index.rst +++ b/Documentation/Backend/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-backend: ======= @@ -21,5 +18,5 @@ In this chapter we want to go deeper and learn how to write more complex indexin IndexInspector PageProperties Scheduler - Plugins.rst - ResultsPlugin.rst + Plugins + ResultsPlugin diff --git a/Documentation/Backend/ResultsPlugin.rst b/Documentation/Backend/ResultsPlugin.rst index f9248aa67e..ff5adf9b4e 100644 --- a/Documentation/Backend/ResultsPlugin.rst +++ b/Documentation/Backend/ResultsPlugin.rst @@ -1,4 +1,3 @@ - Results Plugin ============== diff --git a/Documentation/Configuration/Index.rst b/Documentation/Configuration/Index.rst index 06e8cefc2f..34c6d510f9 100644 --- a/Documentation/Configuration/Index.rst +++ b/Documentation/Configuration/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-index: Configuration Reference diff --git a/Documentation/Configuration/Reference/ExtensionSettings.rst b/Documentation/Configuration/Reference/ExtensionSettings.rst index 4dcae5162b..fdd73c7e1f 100644 --- a/Documentation/Configuration/Reference/ExtensionSettings.rst +++ b/Documentation/Configuration/Reference/ExtensionSettings.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-settings: Extension Configuration diff --git a/Documentation/Configuration/Reference/SolrConnection.rst b/Documentation/Configuration/Reference/SolrConnection.rst index 79a216bc6c..6b19df4239 100644 --- a/Documentation/Configuration/Reference/SolrConnection.rst +++ b/Documentation/Configuration/Reference/SolrConnection.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-solr-client: Solr Connection diff --git a/Documentation/Configuration/Reference/TxSolr.rst b/Documentation/Configuration/Reference/TxSolr.rst index eb94fd57fd..a7903d58df 100644 --- a/Documentation/Configuration/Reference/TxSolr.rst +++ b/Documentation/Configuration/Reference/TxSolr.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - tx_solr ======= diff --git a/Documentation/Configuration/Reference/TxSolrGeneral.rst b/Documentation/Configuration/Reference/TxSolrGeneral.rst index cca826cfa2..2bd9278954 100644 --- a/Documentation/Configuration/Reference/TxSolrGeneral.rst +++ b/Documentation/Configuration/Reference/TxSolrGeneral.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-general: tx_solr.general diff --git a/Documentation/Configuration/Reference/TxSolrIndex.rst b/Documentation/Configuration/Reference/TxSolrIndex.rst index 375fbc2eaa..fb7af123de 100644 --- a/Documentation/Configuration/Reference/TxSolrIndex.rst +++ b/Documentation/Configuration/Reference/TxSolrIndex.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-index: tx_solr.index diff --git a/Documentation/Configuration/Reference/TxSolrLogging.rst b/Documentation/Configuration/Reference/TxSolrLogging.rst index 7c5faf237f..57b403fff7 100644 --- a/Documentation/Configuration/Reference/TxSolrLogging.rst +++ b/Documentation/Configuration/Reference/TxSolrLogging.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-logging: tx_solr.logging diff --git a/Documentation/Configuration/Reference/TxSolrSearch.rst b/Documentation/Configuration/Reference/TxSolrSearch.rst index 3bd2a42fb1..7f5f3cb07b 100644 --- a/Documentation/Configuration/Reference/TxSolrSearch.rst +++ b/Documentation/Configuration/Reference/TxSolrSearch.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _configuration.reference.solrsearch: tx_solr.search @@ -853,11 +852,12 @@ When ```keepAllFacetsOnSelection``` is active the count of a facet do not get re The following example shows how to keep all options of all facets by keeping the real document count, even when it has zero options: -``` -plugin.tx_solr.search.faceting.keepAllFacetsOnSelection = 1 -plugin.tx_solr.search.faceting.countAllFacetsForSelection = 1 -plugin.tx_solr.search.faceting.minimumCount = 0 -``````````````````````````````````````````````` +.. code-block:: typoscript + + plugin.tx_solr.search.faceting.keepAllFacetsOnSelection = 1 + plugin.tx_solr.search.faceting.countAllFacetsForSelection = 1 + plugin.tx_solr.search.faceting.minimumCount = 0 + faceting.showAllLink.wrap ~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -878,7 +878,7 @@ faceting.showEmptyFacets :Default: 0 :Options: 0, 1 -By setting this option to 1, you will allow rendering of empty facets. Usually, if a facet does not offer any options to filter a resultset of documents, the facet header will not be shown. Using this option allows the header still to be rendered when no filter options are provided. +By setting this option to 1, you will allow rendering of empty facets. Usually, if a facet does not offer any options to filter a result-set of documents, the facet header will not be shown. Using this option allows the header still to be rendered when no filter options are provided. faceting.urlParameterStyle ~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -889,7 +889,7 @@ faceting.urlParameterStyle :Default: index -Allows to change the URL style of facets. +Allows to change the URL style of facets. Possible values: @@ -983,10 +983,10 @@ faceting.facets.[facetName].additionalExcludeTags :Since: 9.0 :Required: no -The settings ``keepAllOptionsOnSelection``` and ``keepAllFacetsOnSelection``` are used internally to build exclude tags for facets in order to exclude the filters from the facet counts. -This helps to keep the counts of a facet as expected by the user, in some usecases (Read also: http://yonik.com/multi-select-faceting/). +The settings ```keepAllOptionsOnSelection``` and ```keepAllFacetsOnSelection``` are used internally to build exclude tags for facets in order to exclude the filters from the facet counts. +This helps to keep the counts of a facet as expected by the user, in some use-cases (Read also: http://yonik.com/multi-select-faceting/). -With the setting ``additionalExcludeTags``` you can add tags of factes that should be excluded from the counts as well. +With the setting ```additionalExcludeTags``` you can add tags of facets that should be excluded from the counts as well. **Note:** This setting is only available for option facets by now. @@ -1032,7 +1032,7 @@ faceting.facets.[facetName].excludeValues Defines a comma separated list of options that are excluded (The value needs to match the value in solr) -Important: This setting only makes sence for option based facets (option, query, hierarchy) +Important: This setting only makes sense for option based facets (option, query, hierarchy) faceting.facets.[facetName].facetLimit @@ -1119,13 +1119,13 @@ faceting.facets.[facetName].sortBy :Type: String :TS Path: plugin.tx_solr.search.faceting.facets.[facetName].sortBy :Since: 1.2 -:Default: - +:Default: by count of results :Options: alpha (aliases: index, lex) -Sets how a single facet's options are sorted, by default they are sorted by number of results, highest on top. +Sets how a single facet's options are sorted, by default they are sorted by count of results, highest on top. Facet options can also be sorted alphabetically by setting the option to alpha. -Note: Since 9.0.0 it is possible to sort a facet by a function. This can be done be defining a metric and use that metric in the sortBy configuration. As sorting name you then need to use by convention "metrics_" +Note: Since 9.0.0 it is possible to sort a facet by a function. This can be done by defining a metric and use that metric in the sortBy configuration. As sorting name you then need to use by convention "metrics_" Example: @@ -1141,7 +1141,6 @@ Example: } - faceting.facets.[facetName].manualSortOrder ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1192,11 +1191,11 @@ faceting.facets.[facetName].minimumCount ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :Type: Integer -:TS Path: plugin.tx_solr.search.faceting.facets.[facetName].minumumCount +:TS Path: plugin.tx_solr.search.faceting.facets.[facetName].minimumCount :Since: 8.0 :Default: 1 -Set's the minimumCount for a single facet. This can be usefull e.g. to set the minimumCount of a single facet to 0, +Set's the minimumCount for a single facet. This can be useful e.g. to set the minimumCount of a single facet to 0, to have the options available even when there is result available. **Note**: This setting is only available for facets that are using the json faceting API of solr. By now this @@ -1236,7 +1235,7 @@ faceting.facets.[facetName].includeInAvailableFacets By setting this option to 0, you can prevent rendering of a given facet within the list of available facets. -This is useful if you render the facet somewhere eles on the page using the facet view helper and don't want the facet to be rendered twice. +This is useful if you render the facet somewhere else on the page using the facet view helper and don't want the facet to be rendered twice. faceting.facets.[facetName].includeInUsedFacets ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -1394,7 +1393,7 @@ EXT:solr provides the following renderingInstructions that you can use in your p **FormatDate**: This rendering instruction can be used in combination with a date field or an integer field that hold a timestamp. You can use this rendering instruction to format the facet value on rendering. -A common usecase for this is, when the datatype in Solr needs to be sortable (date or int) but you need to render the date as readable date option in the frontend: +A common use-case for this is, when the datatype in Solr needs to be sortable (date or int) but you need to render the date as readable date option in the frontend: .. code-block:: typoscript @@ -1633,5 +1632,3 @@ grouping.groups.[groupName].sortBy Allows to set a custom sorting for the group. Useful especially if you have already set `plugin.tx_solr.search.query.sortBy`. By default Solr will sort within a group by relevance, using this setting you can sort by any sortable field. Needs a Solr field name followed by asc for ascending order or desc for descending. - - diff --git a/Documentation/Configuration/Reference/TxSolrStatistics.rst b/Documentation/Configuration/Reference/TxSolrStatistics.rst index 509a9434c2..3c3aac8b90 100644 --- a/Documentation/Configuration/Reference/TxSolrStatistics.rst +++ b/Documentation/Configuration/Reference/TxSolrStatistics.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-statistics: tx_solr.statistics @@ -102,4 +99,4 @@ statistics.queries.limit :Since: 12.0 :Default: 100 -Number of records to read out search queries. \ No newline at end of file +Number of records to read out search queries. diff --git a/Documentation/Configuration/Reference/TxSolrSuggest.rst b/Documentation/Configuration/Reference/TxSolrSuggest.rst index e53cec869c..bd7cbb16b7 100644 --- a/Documentation/Configuration/Reference/TxSolrSuggest.rst +++ b/Documentation/Configuration/Reference/TxSolrSuggest.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-suggest: tx_solr.suggest @@ -30,7 +27,7 @@ suggestField Sets the Solr index field used to get suggestions from. A general advice is to use a field without stemming on it. For practical reasons this is currently the spell checker field. Note: With EXT:solr 11.1.0 ASCII folding and language depending normalization filters were introduced, but due to the special behaviour of the auto suggestions ascii-terms were not treated correctly. So with 11.1.3 the untouched tokens are also kept, as this might lead to duplicate -suggestions, a new field for exact suggestions is introduced, if you want to avoid duplicates and use stricter suggestions, just configure `spellExact` as suggest field. +suggestions, a new field for exact suggestions is introduced, if you want to avoid duplicates and use stricter suggestions, just configure `spellExact` as suggest field. forceHttps ---------- diff --git a/Documentation/Configuration/Reference/TxSolrView.rst b/Documentation/Configuration/Reference/TxSolrView.rst index 55f94fc94a..2d2829e566 100644 --- a/Documentation/Configuration/Reference/TxSolrView.rst +++ b/Documentation/Configuration/Reference/TxSolrView.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-tx-solr-view: tx_solr.view diff --git a/Documentation/Database/Index.rst b/Documentation/Database/Index.rst index 7b17abc05a..537e74fd4a 100644 --- a/Documentation/Database/Index.rst +++ b/Documentation/Database/Index.rst @@ -5,7 +5,7 @@ Database indexes ---------------- Some of the SQL statements performed on the pages table in TYPO3 perform extensive operations while copying -page-trees. These operations can be speeded by by adding 2 indexes to the standard table pages. +page-trees. These operations can be speed up by by adding 2 indexes to the standard table pages. The indexes are: * content_from_pid_deleted (content_from_pid, deleted), diff --git a/Documentation/Development/Backend.rst b/Documentation/Development/Backend.rst index a07637c814..32f5a1b5d7 100644 --- a/Documentation/Development/Backend.rst +++ b/Documentation/Development/Backend.rst @@ -1,4 +1,3 @@ - ########################## Developing Backend Modules ########################## diff --git a/Documentation/Development/Index.rst b/Documentation/Development/Index.rst index 848b365347..f7d7aa0baf 100644 --- a/Documentation/Development/Index.rst +++ b/Documentation/Development/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _development-index: diff --git a/Documentation/Development/Indexing.rst b/Documentation/Development/Indexing.rst index 78cb35daf7..2228363c3a 100644 --- a/Documentation/Development/Indexing.rst +++ b/Documentation/Development/Indexing.rst @@ -1,5 +1,3 @@ -.. This file will be replaced from solrfluid later - ======== Indexing ======== @@ -41,7 +39,7 @@ The corresponding event listener class: } } -For other records than pages, the PSR-14 Event :php:class:`ApacheSolrForTypo3\Solr\Event\Indexing\BeforeDocumentIsProcessedForIndexingEvent` can be used. +For other records than pages, the PSR-14 Event :php:`ApacheSolrForTypo3\Solr\Event\Indexing\BeforeDocumentIsProcessedForIndexingEvent` can be used. AfterPageDocumentIsCreatedForIndexingEvent ------------------------------------------ diff --git a/Documentation/FAQ/Index.rst b/Documentation/FAQ/Index.rst index 57060dd6b0..dcdf752d9c 100644 --- a/Documentation/FAQ/Index.rst +++ b/Documentation/FAQ/Index.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _faq-index: FAQ - Frequently Asked Questions diff --git a/Documentation/Frontend/Index.rst b/Documentation/Frontend/Index.rst index 4d145b9af5..86e0db2882 100644 --- a/Documentation/Frontend/Index.rst +++ b/Documentation/Frontend/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-frontend: @@ -14,13 +11,13 @@ This part describes the frontend part of EXT:solr. Since version 7.0.0 the templ :titlesonly: :glob: - Concepts.rst - Structure.rst - Results.rst - Facets.rst - Autosuggest.rst - Sorting.rst - PerPage.rst - Ajax.rst - Customize.rst - Languages.rst + Concepts + Structure + Results + Facets + Autosuggest + Sorting + PerPage + Ajax + Customize + Languages diff --git a/Documentation/GettingStarted/InstallTYPO3Extension.rst b/Documentation/GettingStarted/InstallTYPO3Extension.rst index f0c776f616..2a8a152b65 100644 --- a/Documentation/GettingStarted/InstallTYPO3Extension.rst +++ b/Documentation/GettingStarted/InstallTYPO3Extension.rst @@ -1,6 +1,5 @@ .. highlight:: bash - .. _started-install-extension: Install EXT:solr diff --git a/Documentation/Includes.rst.txt b/Documentation/Includes.rst.txt deleted file mode 100644 index 3fb744bfc9..0000000000 --- a/Documentation/Includes.rst.txt +++ /dev/null @@ -1,35 +0,0 @@ -.. More information about this file: -.. https://docs.typo3.org/m/typo3/docs-how-to-document/main/en-us/GeneralConventions/FileStructure.html#includes-rst-txt - -.. ---------- -.. text roles -.. ---------- - -.. role:: aspect(emphasis) -.. role:: bash(code) -.. role:: css(code) -.. role:: html(code) -.. role:: js(code) -.. role:: php(code) -.. role:: rst(code) -.. role:: sep(strong) -.. role:: sql(code) - -.. role:: tsconfig(code) - :class: typoscript - -.. role:: typoscript(code) -.. role:: xml(code) - :class: html - -.. role:: yaml(code) - -.. default-role:: code - -.. --------- -.. highlight -.. --------- - -.. By default, code blocks use PHP syntax highlighting - -.. highlight:: php diff --git a/Documentation/Index.rst b/Documentation/Index.rst index 26623b0605..5176160ed2 100644 --- a/Documentation/Index.rst +++ b/Documentation/Index.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt ===================== Apache Solr for TYPO3 diff --git a/Documentation/Logging/Index.rst b/Documentation/Logging/Index.rst index a920981b1e..4421117124 100644 --- a/Documentation/Logging/Index.rst +++ b/Documentation/Logging/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-logging: Logging diff --git a/Documentation/Releases/Archive/Index.rst b/Documentation/Releases/Archive/Index.rst index 8d1bc6c297..e1c99efd66 100644 --- a/Documentation/Releases/Archive/Index.rst +++ b/Documentation/Releases/Archive/Index.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Archive .. _releases-archive: @@ -13,16 +12,16 @@ Archive :titlesonly: :glob: - solr-release-11-1.rst - solr-release-10-0.rst - solr-release-9-0.rst - solr-release-8-1.rst - solr-release-8-0.rst - solr-release-7-0.rst - solr-release-6-1.rst - solr-release-6-0.rst - solr-release-5-1.rst - solr-release-5-0.rst - solr-release-4-0.rst - solr_release-3-1.rst - solr-release-3-0.rst + solr-release-11-1 + solr-release-10-0 + solr-release-9-0 + solr-release-8-1 + solr-release-8-0 + solr-release-7-0 + solr-release-6-1 + solr-release-6-0 + solr-release-5-1 + solr-release-5-0 + solr-release-4-0 + solr_release-3-1 + solr-release-3-0 diff --git a/Documentation/Releases/Archive/solr-release-10-0.rst b/Documentation/Releases/Archive/solr-release-10-0.rst index cc306bbb8d..5b669cfcab 100644 --- a/Documentation/Releases/Archive/solr-release-10-0.rst +++ b/Documentation/Releases/Archive/solr-release-10-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-10: ============= diff --git a/Documentation/Releases/Archive/solr-release-11-1.rst b/Documentation/Releases/Archive/solr-release-11-1.rst index 42e826dd77..8a2e491d15 100644 --- a/Documentation/Releases/Archive/solr-release-11-1.rst +++ b/Documentation/Releases/Archive/solr-release-11-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-11-1: ============= diff --git a/Documentation/Releases/Archive/solr-release-3-0.rst b/Documentation/Releases/Archive/solr-release-3-0.rst index 0e88bacf0d..e0d8e9855d 100644 --- a/Documentation/Releases/Archive/solr-release-3-0.rst +++ b/Documentation/Releases/Archive/solr-release-3-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-3-0: ============ diff --git a/Documentation/Releases/Archive/solr-release-4-0.rst b/Documentation/Releases/Archive/solr-release-4-0.rst index 3a258d08d0..59fc15c9c3 100644 --- a/Documentation/Releases/Archive/solr-release-4-0.rst +++ b/Documentation/Releases/Archive/solr-release-4-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-4-0: ============ diff --git a/Documentation/Releases/Archive/solr-release-5-0.rst b/Documentation/Releases/Archive/solr-release-5-0.rst index c3ec27ee9b..6cab741f75 100644 --- a/Documentation/Releases/Archive/solr-release-5-0.rst +++ b/Documentation/Releases/Archive/solr-release-5-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-5-0: ============ diff --git a/Documentation/Releases/Archive/solr-release-5-1.rst b/Documentation/Releases/Archive/solr-release-5-1.rst index dbd671acd9..a7c504167e 100644 --- a/Documentation/Releases/Archive/solr-release-5-1.rst +++ b/Documentation/Releases/Archive/solr-release-5-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-5-1: ============ diff --git a/Documentation/Releases/Archive/solr-release-6-0.rst b/Documentation/Releases/Archive/solr-release-6-0.rst index 1866559d1b..42c55982a2 100644 --- a/Documentation/Releases/Archive/solr-release-6-0.rst +++ b/Documentation/Releases/Archive/solr-release-6-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-6-0: ============ diff --git a/Documentation/Releases/Archive/solr-release-6-1.rst b/Documentation/Releases/Archive/solr-release-6-1.rst index c93e33f26d..c788d93f8c 100644 --- a/Documentation/Releases/Archive/solr-release-6-1.rst +++ b/Documentation/Releases/Archive/solr-release-6-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-6-1: ============ diff --git a/Documentation/Releases/Archive/solr-release-7-0.rst b/Documentation/Releases/Archive/solr-release-7-0.rst index 0253f43bd5..47cb63f145 100644 --- a/Documentation/Releases/Archive/solr-release-7-0.rst +++ b/Documentation/Releases/Archive/solr-release-7-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-7: ============ diff --git a/Documentation/Releases/Archive/solr-release-8-0.rst b/Documentation/Releases/Archive/solr-release-8-0.rst index 77c9441939..0ddd29efce 100644 --- a/Documentation/Releases/Archive/solr-release-8-0.rst +++ b/Documentation/Releases/Archive/solr-release-8-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-8: ============ diff --git a/Documentation/Releases/Archive/solr-release-8-1.rst b/Documentation/Releases/Archive/solr-release-8-1.rst index 751214460d..c6c9db99a3 100644 --- a/Documentation/Releases/Archive/solr-release-8-1.rst +++ b/Documentation/Releases/Archive/solr-release-8-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-8.1: ============ diff --git a/Documentation/Releases/Archive/solr-release-9-0.rst b/Documentation/Releases/Archive/solr-release-9-0.rst index d0a070b43b..3d1bcc6bff 100644 --- a/Documentation/Releases/Archive/solr-release-9-0.rst +++ b/Documentation/Releases/Archive/solr-release-9-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-9: ============ diff --git a/Documentation/Releases/Archive/solr_release-3-1.rst b/Documentation/Releases/Archive/solr_release-3-1.rst index 8413a140f6..d899964c93 100644 --- a/Documentation/Releases/Archive/solr_release-3-1.rst +++ b/Documentation/Releases/Archive/solr_release-3-1.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. _releases-archive-3-1: ============ diff --git a/Documentation/Releases/Index.rst b/Documentation/Releases/Index.rst index b567511479..1a93ae0456 100644 --- a/Documentation/Releases/Index.rst +++ b/Documentation/Releases/Index.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Releases .. _releases: diff --git a/Documentation/Releases/solr-release-11-0.rst b/Documentation/Releases/solr-release-11-0.rst index 73f1c37a81..62d86048cf 100644 --- a/Documentation/Releases/solr-release-11-0.rst +++ b/Documentation/Releases/solr-release-11-0.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Releases .. _releases-11: diff --git a/Documentation/Releases/solr-release-11-2.rst b/Documentation/Releases/solr-release-11-2.rst index 9966fc4541..413ce1f3fb 100644 --- a/Documentation/Releases/solr-release-11-2.rst +++ b/Documentation/Releases/solr-release-11-2.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Releases .. _releases-11-2: @@ -73,7 +72,7 @@ This release contains: - [BUGFIX:BP:11.2] Use plugin namespace as label for flexforms by @dkd-friedrich in #3553 - [BUGFIX:BP:11.2] Respect indexingPriority in QueueItemRepository by @dkd-friedrich in #3557 - [BUGFIX:BP:11.2] use siteLanguage TypoScript object to get language id by @dkd-friedrich in #3555 -- [TASK:11.2] equalize CI/Github-Actions for release-11.0|2|5 and main by @dkd-kaehm in #3467 +- [TASK:11.2] equalize CI/Github-Actions for release-11.0\|2\|5 and main by @dkd-kaehm in #3467 - [BUGFIX:BP:11.2] Sanitize frequent and last searches output by @dkd-friedrich in #3592 - [BUGFIX:BP:11.2] changed from always picking the 0 array value to pic… by @dkd-friedrich in #3594 - [BUGFIX] Enforce visibility context in Tsfe by @saitho in #3050 diff --git a/Documentation/Releases/solr-release-11-5.rst b/Documentation/Releases/solr-release-11-5.rst index cc6ebb93e7..4534a50205 100644 --- a/Documentation/Releases/solr-release-11-5.rst +++ b/Documentation/Releases/solr-release-11-5.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Archive .. _releases-11-5: @@ -276,7 +275,7 @@ The list of all changes: - [TASK] Fix Index-Queue module: "Clear Index Queue" functionality `1307974e9 `_ - [TASK] Disable temporary testing against TYPO3 < v11.5.4 `9faf73fb6 `_ - [TASK] Refactor LastSearches and FrequentlySearched widgets `b3a9fef4c `_ -- [TASK] Allow to publish (-PRE)-(ALPHA|BETA|RC) releases to TYPO3 TER `5cb71c168 `_ +- [TASK] Allow to publish (-PRE)-(ALPHA\|BETA\|RC) releases to TYPO3 TER `5cb71c168 `_ - [FIX] Allow to edit pages outside of site root `6c8801154 `_ - [FIX] Allow to mark pages as site root `09009909b `_ - [FIX] Don't auto select first configured Solr site if non configured exists `352998671 `_ diff --git a/Documentation/Releases/solr-release-11-6.rst b/Documentation/Releases/solr-release-11-6.rst index eaf69ab0e8..9b756822b1 100644 --- a/Documentation/Releases/solr-release-11-6.rst +++ b/Documentation/Releases/solr-release-11-6.rst @@ -1,4 +1,3 @@ -.. include:: /Includes.rst.txt .. index:: Archive .. _releases-11-6: diff --git a/Documentation/Releases/solr-release-12-0.rst b/Documentation/Releases/solr-release-12-0.rst index 9a27478ad9..15b28829d7 100644 --- a/Documentation/Releases/solr-release-12-0.rst +++ b/Documentation/Releases/solr-release-12-0.rst @@ -1,4 +1,3 @@ -.. include:: ../Includes.rst.txt .. _releases-12-0: ============= diff --git a/Documentation/Releases/solr-release-13-0.rst b/Documentation/Releases/solr-release-13-0.rst index bd725753c0..fc152616fd 100644 --- a/Documentation/Releases/solr-release-13-0.rst +++ b/Documentation/Releases/solr-release-13-0.rst @@ -1,4 +1,3 @@ -.. include:: ../Includes.rst.txt .. _releases-13-0: ============= diff --git a/Documentation/Routing/Index.rst b/Documentation/Routing/Index.rst index 3634743095..beb2793329 100644 --- a/Documentation/Routing/Index.rst +++ b/Documentation/Routing/Index.rst @@ -1,6 +1,3 @@ -.. include:: /Includes.rst.txt - - .. _conf-routing: @@ -18,7 +15,7 @@ The configuration of `routing + + + +