Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Add documentation for working with Linkvalidator
Information for working with Linkvalidator as editor is added. Resolves: #92718 Releases: master Change-Id: I5c116c4561b91b2f8020f6803f6a1d50cd18a413 Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/66275 Tested-by: TYPO3com <noreply@typo3.com> Tested-by: Chris Müller <typo3@krue.ml> Tested-by: Benni Mack <benni@typo3.org> Reviewed-by: Chris Müller <typo3@krue.ml> Reviewed-by: Benni Mack <benni@typo3.org>
- Loading branch information
Showing
4 changed files
with
71 additions
and
0 deletions.
There are no files selected for viewing
70 changes: 70 additions & 0 deletions
70
typo3/sysext/linkvalidator/Documentation/Editors/Index.rst
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
.. include:: /Includes.txt | ||
|
||
|
||
.. _editors: | ||
|
||
========================== | ||
Working with Linkvalidator | ||
========================== | ||
|
||
This page handles how to work with Linkvalidator as editor. | ||
It is intended for a non-technical audience. | ||
|
||
Linkvalidator Report | ||
==================== | ||
|
||
#. First, select the page you want to work on in the page tree | ||
#. Access the Info module. | ||
#. In the top menu, select :guilabel:`Linkvalidator`. | ||
|
||
.. figure:: ../Images/EditorReports.png | ||
:alt: Access Linkvalidator Report via Info module | ||
|
||
Access Linkvalidator Report via Info module | ||
|
||
You will now see the :guilabel:`Report` with the list of broken links. | ||
In order to get results, select the checkboxes ("Internal Links", | ||
etc.) and choose the appropriate depth under :guilabel:`Show this level`. | ||
This will determine the page level, for example for depth :guilabel:`This page`, | ||
Linkvalidator will only show broken links for the page that is | ||
currently selected in the page tree. The deeper you go, the more | ||
broken links may possibly be shown. After you change the settings, | ||
you must click :guilabel:`Refresh display`. | ||
|
||
When you jump to a different page in the page tree, the :guilabel:`Report` | ||
will be refreshed. | ||
|
||
Listing of broken links | ||
======================= | ||
|
||
.. figure:: ../Images/ReportsTab.png | ||
:alt: Linkvalidator Report with results | ||
|
||
Linkvalidator Report with results | ||
|
||
The list shows the following, from left to right: | ||
|
||
#. **Element:** The title of the field which contains the broken link | ||
#. **Path:** The title of the page and its parents | ||
#. **Link:** The anchor text of the link | ||
#. **URL / Link target:** The link target, where the link points to. | ||
#. **Error message:** Information about the error. Often, this will be | ||
a 404 error, which means the link target simply does not exist. | ||
#. **Last check:** When the broken link was detected | ||
#. The pencil icon can be used to edit the field where the broken | ||
link exists. | ||
|
||
You can now fix the broken links one after another, by clicking on | ||
the pencil icon. | ||
|
||
The corresponding form will open. The broken link will be marked | ||
in a special style to make it visually stand out. | ||
|
||
.. figure:: ../Images/EditorEditField.png | ||
:alt: Edit a field | ||
|
||
Edit a field | ||
|
||
You can now double-click on it to open the Link Browser and fix the | ||
link. When you are done, click on save and close in order to | ||
return to the :guilabel:`Report`. |
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters