[BUGFIX] Remove usage of non core tables in linkvalidator configuration
[Packages/TYPO3.CMS.git] / typo3 / sysext / linkvalidator / Documentation / Configuration / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../Includes.txt
7
8
9
10 .. _configuration:
11
12 Configuration
13 -------------
14
15 You find the standard configuration in
16 :file:`EXT:linkvalidator/Configuration/TsConfig/Page/pagetsconfig.txt`.
17
18 This may serve you as an example on how to configure the extension for
19 your needs.
20
21
22 .. _reference:
23
24 Reference
25 ^^^^^^^^^
26
27 You can set the following options in the TSconfig for a page (e.g. the
28 root page) and override them in user or groups TSconfig. You must
29 prefix them with mod.linkvalidator, e.g.
30 :code:`mod.linkvalidator.searchFields.pages = media`.
31
32
33
34 .. _searchfields-key:
35
36 searchFields.[key]
37 """"""""""""""""""
38
39 .. container:: table-row
40
41    Property
42          searchFields.[key]
43
44    Data type
45          string
46
47    Description
48          Comma separated list of table fields in which to check for broken
49          links.
50
51          **Example** :
52
53          ::
54
55             pages = media,url
56
57    Default
58          .. code-block:: typoscript
59
60             pages = media,url
61             tt_content = bodytext,header_link,records
62
63
64
65 .. _linktypes:
66
67 linktypes
68 """""""""
69
70 .. container:: table-row
71
72    Property
73          linktypes
74
75    Data type
76          string
77
78    Description
79          Comma separated list of hooks to load.
80
81          **Possible values:**
82
83          db: Check links to database records.
84
85          file: Check links to files located in your local TYPO3 installation.
86
87          external: Check links to external files.
88
89          linkhandler: Check links provided by the extension "linkhandler".
90
91          This list may be extended by other extensions providing a linktype
92          checker, e.g. DAM.
93
94    Default
95          db,file,external
96
97
98
99 .. _checkhidden:
100
101 checkhidden
102 """""""""""
103
104 .. container:: table-row
105
106    Property
107          checkhidden
108
109    Data type
110          boolean
111
112    Description
113          If set, disabled pages and content elements are checked for broken
114          links, too.
115
116    Default
117          0
118
119
120
121 .. _showchecklinktab:
122
123 showCheckLinkTab
124 """"""""""""""""
125
126 .. container:: table-row
127
128    Property
129          showCheckLinkTab
130
131    Data type
132          boolean
133
134    Description
135          If set, the backend module shows a "Check Links" tab, which you can
136          use to perform the checks on demand.
137
138
139          .. figure:: ../Images/CheckLinksTabVisible.png
140             :alt: The Check links tab is visible
141
142             The Check links tab is visible
143
144          .. note::
145
146             Depending on the number of page levels to check and on the
147             number of links in these pages, this check can take some time and need
148             some resources. For large sites it might therefore be advisable to
149             hide the tab.
150
151          .. note::
152
153             Linkvalidator uses a database table to store information
154             about the broken links, which it found in your website. If
155             showCheckLinkTab is set to 0, you must use the scheduler task provided
156             by linkvalidator to update these information.
157
158    Default
159          1
160
161
162
163 .. _mail-fromname:
164
165 mail.fromname
166 """""""""""""
167
168 .. container:: table-row
169
170    Property
171          mail.fromname
172
173    Data type
174          string
175
176    Description
177          Set the from name of the report mail sent by the cron script.
178
179    Default
180          Install Tool
181
182          *defaultMailFromName*
183
184
185
186 .. _mail-fromemail:
187
188 mail.fromemail
189 """"""""""""""
190
191 .. container:: table-row
192
193    Property
194          mail.fromemail
195
196    Data type
197          string
198
199    Description
200          Set the from email of the report mail sent by the cron script.
201
202    Default
203          Install Tool
204
205          *defaultMailFromAddress*
206
207
208
209 .. _mail-replytoname:
210
211 mail.replytoname
212 """"""""""""""""
213
214 .. container:: table-row
215
216    Property
217          mail.replytoname
218
219    Data type
220          string
221
222    Description
223          Set the replyto name of the report mail sent by the cron script.
224
225
226
227 .. _mail-replytoemail:
228
229 mail.replytoemail
230 """""""""""""""""
231
232 .. container:: table-row
233
234    Property
235          mail.replytoemail
236
237    Data type
238          string
239
240    Description
241          Set the replyto email of the report mail sent by the cron script.
242
243
244
245 .. _mail-subject:
246
247 mail.subject
248 """"""""""""
249
250 .. container:: table-row
251
252    Property
253          mail.subject
254
255    Data type
256          string
257
258    Description
259          Set the subject of the report mail sent by the cron script.
260
261    Default
262          TYPO3 Linkvalidator report
263
264
265
266 [page:mod.linkvalidator; beuser:mod.linkvalidator]
267
268
269 .. _configuration-example:
270
271 Example
272 ^^^^^^^
273
274 .. code-block:: typoscript
275
276    mod.linkvalidator {
277            searchFields {
278                    pages = media,url
279                    tt_content = bodytext,header_link,records
280            }
281            linktypes = db,file,external
282            checkhidden = 0
283            mail {
284                    fromname = TYPO3 Linkvalidator
285                    fromemail = no_reply@mydomain.com
286                    replytoname =
287                    replytoemail =
288                    subject = TYPO3 Linkvalidator report
289            }
290    }
291
292