[DOCS] Use working examples in linkvalidator documentation 00/61700/5
authorlinawolf <noreply@example.com>
Fri, 13 Sep 2019 03:16:15 +0000 (03:16 +0000)
committerSusanne Moog <look@susi.dev>
Mon, 28 Oct 2019 19:18:43 +0000 (20:18 +0100)
Fields without softref are not being checked. Since pages:media does not
have softref set in its TCA it will never get checked. Field pages:url
has an unresolved issue since 6 years. So better don't mention it as an
example for configuration until it works.

The default configuration also contains the two fields.

Releases: master, 9.5
Resolves: #89163
Change-Id: Ia9968ef297cedb3d09747acffa4ca07fff2fa0c2
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/61700
Tested-by: Sybille Peters <sypets@gmx.de>
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Daniel Siepmann <coding@daniel-siepmann.de>
Tested-by: Daniel Goerz <daniel.goerz@posteo.de>
Tested-by: Susanne Moog <look@susi.dev>
Reviewed-by: Sybille Peters <sypets@gmx.de>
Reviewed-by: Daniel Siepmann <coding@daniel-siepmann.de>
Reviewed-by: Daniel Goerz <daniel.goerz@posteo.de>
Reviewed-by: Susanne Moog <look@susi.dev>
typo3/sysext/linkvalidator/Documentation/Configuration/Index.rst
typo3/sysext/linkvalidator/Documentation/Settings.cfg

index 28ea019..0e51027 100644 (file)
@@ -15,7 +15,7 @@ Configuration
 You find the standard configuration in
 :file:`EXT:linkvalidator/Configuration/TsConfig/Page/pagetsconfig.txt`.
 
-This may serve you as an example on how to configure the extension for
+This may serve as an example on how to configure the extension for
 your needs.
 
 
@@ -27,8 +27,7 @@ Reference
 You can set the following options in the TSconfig for a page (e.g. the
 root page) and override them in user or groups TSconfig. You must
 prefix them with mod.linkvalidator, e.g.
-:code:`mod.linkvalidator.searchFields.pages = media`.
-
+:ts:`mod.linkvalidator.searchFields.pages = canonical_link`.
 
 
 .. _searchfields-key:
@@ -45,14 +44,39 @@ searchFields.[key]
          string
 
    Description
-         Comma separated list of table fields in which to check for broken
-         links.
+         Comma separated list of table fields in which to check for
+         broken links. Linkvalidator only checks fields that have
+         been defined in :ts:`searchFields`.
 
-         **Example** :
+         Linkvalidator ships with sensible defaults that work well
+         for the TYPO3 core, but additional third party extensions
+         are not considered.
 
-         ::
+         .. warning::
 
-            pages = media,url
+            Currently, Linkvalidator can only detect links for fields having at
+            least one :ref:`softref <columns-input-properties-softref>` set in their TCA configuration.
+
+            For this reason, it is currently not possible to check for
+            `pages.media`. This will be fixed in the future.
+
+            Examples for working fields:
+
+                * `pages.canonical_link`
+                * `pages.url`
+
+            Examples for not working fields:
+
+            * `pages.media`
+
+
+    Examples
+
+          Only check for `bodytext` in `tt_content`:
+
+          .. code-block:: typoscript
+
+             tt_content = bodytext
 
    Default
          .. code-block:: typoscript
@@ -153,7 +177,7 @@ showCheckLinkTab
             Linkvalidator uses a database table to store information
             about the broken links, which it found in your website. If
             showCheckLinkTab is set to 0, you must use the scheduler task provided
-            by linkvalidator to update these information.
+            by linkvalidator to update this information.
 
    Default
          1
@@ -275,7 +299,7 @@ Example
 
    mod.linkvalidator {
            searchFields {
-                   pages = media,url
+                   pages = url,canonical_link
                    tt_content = bodytext,header_link,records
            }
            linktypes = db,file,external
index 0f1a8eb..03722c8 100644 (file)
@@ -24,3 +24,6 @@ path_to_documentation_dir = typo3/sysext/linkvalidator/Documentation
 project_issues       = https://forge.typo3.org/projects/typo3cms-core/issues
 project_repository   = https://git.typo3.org/Packages/TYPO3.CMS.git
 
+[intersphinx_mapping]
+
+t3tca         = https://docs.typo3.org/m/typo3/reference-tca/master/en-us/
\ No newline at end of file