f06f766a19f1ecf33953aeda4bb9e32d2e82e318
[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             tt_news = bodytext,links
63
64
65
66 .. _linktypes:
67
68 linktypes
69 """""""""
70
71 .. container:: table-row
72
73    Property
74          linktypes
75
76    Data type
77          string
78
79    Description
80          Comma separated list of hooks to load.
81
82          **Possible values:**
83
84          db: Check links to database records.
85
86          file: Check links to files located in your local TYPO3 installation.
87
88          external: Check links to external files.
89
90          linkhandler: Check links provided by the extension "linkhandler".
91
92          This list may be extended by other extensions providing a linktype
93          checker, e.g. DAM.
94
95    Default
96          db,file,external
97
98
99
100 .. _checkhidden:
101
102 checkhidden
103 """""""""""
104
105 .. container:: table-row
106
107    Property
108          checkhidden
109
110    Data type
111          boolean
112
113    Description
114          If set, disabled pages and content elements are checked for broken
115          links, too.
116
117    Default
118          0
119
120
121
122 .. _showchecklinktab:
123
124 showCheckLinkTab
125 """"""""""""""""
126
127 .. container:: table-row
128
129    Property
130          showCheckLinkTab
131
132    Data type
133          boolean
134
135    Description
136          If set, the backend module shows a "Check Links" tab, which you can
137          use to perform the checks on demand.
138
139
140          .. figure:: ../Images/CheckLinksTabVisible.png
141             :alt: The Check links tab is visible
142
143             The Check links tab is visible
144
145          .. note::
146
147             Depending on the number of page levels to check and on the
148             number of links in these pages, this check can take some time and need
149             some resources. For large sites it might therefore be advisable to
150             hide the tab.
151
152          .. note::
153
154             Linkvalidator uses a database table to store information
155             about the broken links, which it found in your website. If
156             showCheckLinkTab is set to 0, you must use the scheduler task provided
157             by linkvalidator to update these information.
158
159    Default
160          1
161
162
163
164 .. _mail-fromname:
165
166 mail.fromname
167 """""""""""""
168
169 .. container:: table-row
170
171    Property
172          mail.fromname
173
174    Data type
175          string
176
177    Description
178          Set the from name of the report mail sent by the cron script.
179
180    Default
181          Install Tool
182
183          *defaultMailFromName*
184
185
186
187 .. _mail-fromemail:
188
189 mail.fromemail
190 """"""""""""""
191
192 .. container:: table-row
193
194    Property
195          mail.fromemail
196
197    Data type
198          string
199
200    Description
201          Set the from email of the report mail sent by the cron script.
202
203    Default
204          Install Tool
205
206          *defaultMailFromAddress*
207
208
209
210 .. _mail-replytoname:
211
212 mail.replytoname
213 """"""""""""""""
214
215 .. container:: table-row
216
217    Property
218          mail.replytoname
219
220    Data type
221          string
222
223    Description
224          Set the replyto name of the report mail sent by the cron script.
225
226
227
228 .. _mail-replytoemail:
229
230 mail.replytoemail
231 """""""""""""""""
232
233 .. container:: table-row
234
235    Property
236          mail.replytoemail
237
238    Data type
239          string
240
241    Description
242          Set the replyto email of the report mail sent by the cron script.
243
244
245
246 .. _mail-subject:
247
248 mail.subject
249 """"""""""""
250
251 .. container:: table-row
252
253    Property
254          mail.subject
255
256    Data type
257          string
258
259    Description
260          Set the subject of the report mail sent by the cron script.
261
262    Default
263          TYPO3 Linkvalidator report
264
265
266
267 [page:mod.linkvalidator; beuser:mod.linkvalidator]
268
269
270 .. _configuration-example:
271
272 Example
273 ^^^^^^^
274
275 .. code-block:: typoscript
276
277    mod.linkvalidator {
278            searchFields {
279                    pages = media,url
280                    tt_content = bodytext,header_link,records
281                    tt_news = bodytext,links
282            }
283            linktypes = db,file,external
284            checkhidden = 0
285            mail {
286                    fromname = TYPO3 Linkvalidator
287                    fromemail = no_reply@mydomain.com
288                    replytoname =
289                    replytoemail =
290                    subject = TYPO3 Linkvalidator report
291            }
292    }
293
294