[DOCS] Define permalinks in redirects manual

Resolves: #105614
Releases: main, 13.4, 12.4
Change-Id: I517fed5389aac3c4a851c22b8a0ec35bffc96223
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/86951
Tested-by: Garvin Hicking <[email protected]>
Reviewed-by: Garvin Hicking <[email protected]>
Tested-by: core-ci <[email protected]>

typo3/sysext/redirects/Documentation/Basics/Index.rst

@@ -1,7 +1,7 @@
 .. include:: /Includes.rst.txt
 
-.. _glossary:
-.. _basics:
+..  _glossary:
+..  _basics:
 
 ======
 Basics
@@ -13,6 +13,8 @@ specific to EXT:redirects.
 .. todo: add term for t3:// URI (e.g. typo3 URI, linkhandler URI, etc.) after term is clarified
 .. see https://forge.typo3.org/issues/95820
 
+..  _basics-url:
+
 Components of a URL
 ===================
 
@@ -30,7 +32,7 @@ of the URL:
 -   query parameters
 -   fragment
 
-.. _http-status-codes:
+..  _http-status-codes:
 
 HTTP status codes
 =================
@@ -87,7 +89,7 @@ that the URL has changed permanently and that they should update their index
 accordingly. Thus, from SEO point of view, permanent redirects are often a good
 choice. If domains are changed or sites restructured, 301 are often used.
 
-.. _redirect-chain:
+..  _redirect-chain:
 
 Redirect chain
 ==============
@@ -101,7 +103,7 @@ Examples for redirect chains:
 -   `/a => /b => /c` (it would be more efficient if `/a` redirected to `/c`
     directly and `/b` redirected to `/c`)
 
-.. _redirect-loop:
+..  _redirect-loop:
 
 Redirect loop
 =============
@@ -115,6 +117,8 @@ Examples for redirect loops:
 -   `/a => /a` (source and target for a redirect resolve to the same URL)
 -   `/a => /b => /a`
 
+..  _slug:
+
 Slug
 ====
 
@@ -126,6 +130,3 @@ enhancers and decorators.
 
 Example: A slug `/path` is used, the final URL may be
 `https://example.org/en/path.html`.
-
-
-

typo3/sysext/redirects/Documentation/BestPractices/Index.rst

@@ -1,6 +1,6 @@
 .. include:: /Includes.rst.txt
 
-.. _best-practices:
+..  _best-practices:
 
 ==============
 Best practices
@@ -26,7 +26,7 @@ Here are some general tips for managing redirects:
     become inefficient. A "redirect chain" are several redirects which must be
     followed until the destination is reached. Ideally, these should be merged.
 
-.. _best-practices-editors:
+..  _best-practices-editors:
 
 Editors
 =======
@@ -45,7 +45,7 @@ possibility to only grant advanced editor groups access to parts of the content
     so that pages with changing slugs are still accessible but a better
     strategy is to only change slugs when absolutely necessary.
 
-.. _best-practices-performance:
+..  _best-practices-performance:
 
 Performance
 ===========
@@ -73,6 +73,8 @@ The following rules of thumb should be followed:
     It is recommended to monitor performance and - if necessary - export
     redirects to your webserver configuration or load balancer.
 
+..  _best-practices-troubleshooting-tools:
+
 Troubleshooting tools
 =====================
 

typo3/sysext/redirects/Documentation/Events/Index.rst

@@ -1,20 +1,22 @@
 .. include:: /Includes.rst.txt
 
-.. _psr14events:
+..  _psr14events:
 
 =============
 PSR-14 events
 =============
 
 The following PSR-14 events are available to extend the functionality:
 
+..  _AfterAutoCreateRedirectHasBeenPersistedEvent:
 
 AfterAutoCreateRedirectHasBeenPersistedEvent
 ============================================
 
 React on persisted auto-created redirects.
 :ref:`More details <t3coreapi:AfterAutoCreateRedirectHasBeenPersistedEvent>`
 
+..  _BeforeRedirectMatchDomainEvent:
 
 BeforeRedirectMatchDomainEvent
 ==============================
@@ -23,13 +25,15 @@ Implement a custom redirect matching upon the loaded redirects or return a
 matched redirect record from other sources.
 :ref:`More details <t3coreapi:BeforeRedirectMatchDomainEvent>`
 
+..  _ModifyAutoCreateRedirectRecordBeforePersistingEvent:
 
 ModifyAutoCreateRedirectRecordBeforePersistingEvent
 ===================================================
 
 Modify the redirect record before it is persisted to the database.
 :ref:`More details <t3coreapi:ModifyAutoCreateRedirectRecordBeforePersistingEvent>`
 
+..  _ModifyRedirectManagementControllerViewDataEvent:
 
 ModifyRedirectManagementControllerViewDataEvent
 ===============================================
@@ -38,13 +42,15 @@ Modify or enrich view data for the
 :php:`\TYPO3\CMS\Redirects\Controller\ManagementController`.
 :ref:`More details <t3coreapi:ModifyRedirectManagementControllerViewDataEvent>`
 
+..  _RedirectWasHitEvent:
 
 RedirectWasHitEvent
 ===================
 
 Process the matched redirect further and adjust the PSR-7 response.
 :ref:`More details <t3coreapi:RedirectWasHitEvent>`
 
+..  _SlugRedirectChangeItemCreatedEvent:
 
 SlugRedirectChangeItemCreatedEvent
 ==================================

typo3/sysext/redirects/Documentation/Installation/Index.rst

@@ -1,5 +1,7 @@
 .. include:: /Includes.rst.txt
 
+..  _installation:
+
 ============
 Installation
 ============
@@ -9,6 +11,8 @@ This extension is part of the TYPO3 Core, but not installed by default.
 ..  contents:: Table of contents
     :local:
 
+..  _installation-composer:
+
 Installation with Composer
 ==========================
 
@@ -33,6 +37,8 @@ the extension:
 
 The given version depends on the version of the TYPO3 Core you are using.
 
+..  _installation-non-composer:
+
 Installation without Composer
 =============================
 

typo3/sysext/redirects/Documentation/Introduction/Index.rst

@@ -1,5 +1,7 @@
 .. include:: /Includes.rst.txt
 
+..  _introduction:
+
 ============
 Introduction
 ============
@@ -29,6 +31,8 @@ For more technical information on how redirects work, visit
 For more information about the types of redirects, see
 :ref:`HTTP status codes <http-status-codes>`
 
+..  _introduction-what:
+
 What does it do?
 ================
 
@@ -49,6 +53,8 @@ Features:
     URL*" (`pages.doktype=3`), "*Shortcut*" (`pages.doktype=4`) or redirects created
     within the web server (e.g. :file:`.htaccess` or web server configuration).
 
+..  _conventions:
+
 Conventions
 ===========
 

typo3/sysext/redirects/Documentation/KnownProblems/Index.rst

@@ -1,10 +1,12 @@
 .. include:: /Includes.rst.txt
 
+..  _known-problems:
+
 ==============
 Known problems
 ==============
 
-.. _usagePitfallsConstants:
+..  _usagePitfallsConstants:
 
 Problem with constants in LinkHandler TSConfig
 ==============================================
@@ -13,6 +15,8 @@ It is important, that the `storagePid` is hard coded in the LinkHandler Page
 TSConfig, because using constants, e.g. from the site configuration, won't work
 here. :ref:`More details <t3coreapi:linkhandler-pagetsconfig>`
 
+..  _known-problems-other:
+
 Other known problems
 ====================
 

typo3/sysext/redirects/Documentation/Setup/Index.rst

@@ -1,5 +1,7 @@
 .. include:: /Includes.rst.txt
 
+..  _setup:
+
 =====
 Setup
 =====
@@ -10,7 +12,7 @@ the settings and commands outlined in this page. Depending on your site and how
 editing is handled, changes in the configuration and regular maintenance may be
 required.
 
-.. _site-configuration:
+..  _site-configuration:
 
 Site configuration
 ==================
@@ -61,6 +63,8 @@ redirects. This can be adjusted via TCA
     The `settings` in the site configuration are generally explained in
     "TYPO3 Explained" > :ref:`t3coreapi:sitehandling-settings`.
 
+..  _console-commands:
+
 Console commands
 ================
 
@@ -72,7 +76,7 @@ Please see the general information about this in "TYPO3 Explained" >
 We explain executing the commands from the command line here, it is recommended
 to automate regular execution, e.g. via cron.
 
-.. _redirects-cleanup:
+..  _redirects-cleanup:
 
 redirects:cleanup
 -----------------
@@ -144,7 +148,7 @@ and have a status code of 302 or 303.
             --age 90 --hitCount 100 --path "/foo/bar%" --statusCode 302 --statusCode 303
 
 
-.. _redirects-checkintegrity:
+..  _redirects-checkintegrity:
 
 redirects:checkintegrity
 ------------------------
@@ -203,7 +207,7 @@ this:
 You can now search for the affected redirects in the redirects module, e.g.
 by filtering with *Source Path* `/test-1`.
 
-.. _editor-permission:
+..  _editor-permission:
 
 Configure editor permission
 ===========================
@@ -247,7 +251,7 @@ group in the :guilabel:`Access Lists` tab > :guilabel:`Allowed excludefields` >
 
     Allowed excludefields
 
-.. _hit-counter:
+..  _hit-counter:
 
 Hit counter
 ===========
@@ -276,6 +280,9 @@ hit counter, a delete policy for unnecessary redirects can be defined.
 Visit the :ref:`redirects:cleanup <redirects-cleanup>` with the option
 `-c` for more information.
 
+
+..  _system-reports:
+
 System reports
 ==============
 

typo3/sysext/redirects/Documentation/Sitemap.rst

@@ -2,6 +2,8 @@
 
 .. include:: /Includes.rst.txt
 
+..  _sitemap:
+
 =======
 Sitemap
 =======