fb83230c352a6b045313c19ce583791444c65a57
[Packages/TYPO3.CMS.git] / typo3 / sysext / indexed_search / Documentation / Configuration / TypoScript / Index.rst
1 .. ==================================================
2 .. FOR YOUR INFORMATION
3 .. --------------------------------------------------
4 .. -*- coding: utf-8 -*- with BOM.
5
6 .. include:: ../../Includes.txt
7
8
9
10 .. _typoscript:
11
12 TypoScript
13 ^^^^^^^^^^
14
15 [Still missing the major parts here. Just use the object browser for
16 now since that includes all options]
17
18 Following options live under :typoscript:`plugin.tx_indexedsearch.settings`.
19
20
21 .. _breadcrumbWrap:
22
23 breadcrumbWrap
24 """"""""""""""
25
26 .. container:: table-row
27
28 Property
29 breadcrumbWrap
30
31 Data type
32 :ref:`wrap <t3tsref:data-type-wrap>` + :ref:`optionSplit <t3tsref:objects-optionsplit>`
33
34 Description
35 This configuration is used to wrap a single page title in a search result item breadcrumb.
36
37 Default
38 / || /
39
40
41 .. _show-forbiddenrecords:
42
43 displayForbiddenRecords
44 """""""""""""""""""""""
45
46 .. container:: table-row
47
48 Property
49 displayForbiddenRecords
50
51 Data type
52 boolean
53
54 Description
55 Explicitly display search hits although the visitor has no access to
56 it.
57
58
59
60 .. _show-resultnumber:
61
62 displayResultNumber
63 """""""""""""""""
64
65 .. container:: table-row
66
67 Property
68 displayResultNumber
69
70 Data type
71 boolean
72
73 Description
74 Display the numbers of search results.
75
76 Default
77 0
78
79
80 .. _show-advancedsearchlink:
81
82 displayAdvancedSearchLink
83 """""""""""""""""""""""""
84
85 .. container:: table-row
86
87 Property
88 displayAdvancedSearchLink
89
90 Data type
91 boolean
92
93 Description
94 Display the link to the advanced search page.
95
96 Default
97 1
98
99
100 .. _blind-numberOfResults:
101
102 blind.numberOfResults
103 """""""""""""""""""""
104
105 .. container:: table-row
106
107 Property
108 blind.numberOfResults
109
110 Data type
111 string (list of integers, separated by comma)
112
113 Description
114 List of amount of results to be displayed per page.
115 Sending a different amount via GET or POST will result in the default value
116 being used to prevent DOS attacks.
117
118 Default
119 10,25,50,100
120
121
122
123 .. _search-rootpidlist:
124
125 rootPidList
126 """""""""""
127
128 .. container:: table-row
129
130 Property
131 rootPidList
132
133 Data type
134 list of int
135
136 Description
137 A list of integer which should be root-pages to search from. Thus you
138 can search multiple branches of the page tree by setting this property
139 to a list of page id numbers.
140
141 If this value is set to less than zero (eg. -1) searching will happen
142 in ALL of the page tree with no regard to branches at all.
143
144 Notice that by "root-page" we mean a website root defined by
145
146 a TypoScript Template! If you just want to search in branches of your
147 site, use the possibility of searching in levels.
148
149 Default
150 Empty, which fall backs to the current root-page id
151
152
153
154 .. _search-detect-sys-domain-records:
155
156 detectDomainRecords
157 """""""""""""""""""
158
159 .. container:: table-row
160
161 Property
162 detectDomainRecords
163
164 Data type
165 boolean
166
167 Description
168 If set, then the search results are linked to the proper domains where
169 they are found.
170
171
172
173 .. _search-detect-sys-domain-records-target:
174
175 detectDomainRecords.target
176 """"""""""""""""""""""""""
177
178 .. container:: table-row
179
180 Property
181 detectDomainRecords.target
182
183 Data type
184 string
185
186 Description
187 Target for external URLs.
188
189
190
191 .. _search-medialist:
192
193 mediaList
194 """""""""
195
196 .. container:: table-row
197
198 Property
199 mediaList
200
201 Data type
202 string
203
204 Description
205 Restrict the file type list when searching for files.
206
207
208
209 .. _search-defaultfreeindexuidlist:
210
211 defaultFreeIndexUidList
212 """""""""""""""""""""""
213
214 .. container:: table-row
215
216 Property
217 defaultFreeIndexUidList
218
219 Data type
220 string
221
222 Description
223 List of Indexing Configuration Uids to show as categories in search
224 form. The order determines the order displayed in the search result.
225
226
227
228 .. _settings-exactcount:
229
230 exactCount
231 """"""""""
232
233 .. container:: table-row
234
235 Property
236 exactCount
237
238 Data type
239 boolean
240
241 Description
242 Force permission check for every record while displaying search
243 results. Otherwise, records are only checked up to the current result
244 page, and this might cause that the result counter does not print the
245 exact number of search hits.
246
247 By enabling this setting, the loop is not stopped, which causes an
248 exact result count at the cost of an (obvious) slowdown caused by this
249 overhead.
250
251 See property "show.forbiddenRecords" for more information.
252
253
254
255 .. _search-skipextendtosubpageschecking:
256
257 searchSkipExtendToSubpagesChecking
258 """"""""""""""""""""""""""""""""""
259
260 .. container:: table-row
261
262 Property
263 searchSkipExtendToSubpagesChecking
264
265 Data type
266 boolean
267
268 Description
269 If set to false (default), on each search the complete page tree will
270 be transversed to check which pages are accessible, so that the
271 extendToSubpages can be considered. This will work with a limited
272 number of page-ids (which means most sites), but will result in slow
273 performance on huge page trees.
274
275 If set to true, then the final result rows are joined with the pages
276 table to select pages that are currently accessible. This will speed
277 up searching in very huge page trees, but on the other hand
278 extendToSubpages will NOT be taken into account!
279
280 Default
281 0
282
283
284
285 .. _specialConfiguration-pid:
286
287 specialConfiguration.[pid]
288 """"""""""""""""""""""""""
289
290 .. container:: table-row
291
292 Property
293 specialConfiguration.[pid]
294
295 Data type
296 -
297
298 Description
299 "specialConfiguration" is an array of objects with properties that can customize
300 certain behaviours of the display of a result row depending on it's
301 position in the rootline. For instance you can define that all results
302 which links to pages in a branch from page id 123 should have another
303 page icon displayed. Of you can add a suffix to the class names so you
304 can style that section differently.
305
306 **Examples:**
307
308 If a page "Contact" is found in a search for "address" and that
309 "Contact" page is in the rootline "Frontpage [ID=23] > About us
310 [ID=45] > Contact [ID=77]" then you should set the pid value to either
311 "77" or "45". If "45" then all subpages including the "About us" page
312 will have similar configuration.
313
314 If the pid value is set to 0 (zero) it will apply to all pages.
315
316 Please see the options below.
317
318
319
320 .. _specialConfiguration-pid-pageicon:
321
322 specialConfiguration.[pid].pageIcon
323 """""""""""""""""""""""""""""""""""
324
325 .. container:: table-row
326
327 Property
328 specialConfiguration.[pid].pageIcon
329
330 Data type
331 :ref:`IMAGE cObject <t3tsref:cobj-image>`
332
333 Description
334 Alternative page icon.
335
336
337
338 .. _specialConfiguration-pid-csssuffix:
339
340 specialConfiguration.[pid].CSSsuffix
341 """"""""""""""""""""""""""""""""""""
342
343 .. container:: table-row
344
345 Property
346 specialConfiguration.[pid].CSSsuffix
347
348 Data type
349 string
350
351 Description
352 A string that will be appended to the class-names of all the class-
353 attributes used within the result row presentation. The prefix will be
354 like this:
355
356 **Example:**
357
358 If "...CSSsuffix = doc" then eg. the class name "tx-indexedsearch-
359 title" will be "tx-indexedsearch-title-doc"
360
361
362
363 .. _targetPid:
364
365 targetPid
366 """""""""
367
368 .. container:: table-row
369
370 Property
371 targetPid
372
373 Data type
374 int
375
376 Description
377 Set the target page UID for the extbase variant of the plugin.
378
379
380
381 .. _results-titleCropAfter:
382
383 results.titleCropAfter
384 """"""""""""""""""""""
385
386 .. container:: table-row
387
388 Property
389 results.titleCropAfter
390
391 Data type
392 int
393
394 Description
395 Determines the length of the cropped title
396 Defaults to 50
397
398
399 .. _results-titleCropSignifier:
400
401 results.titleCropSignifier
402 """"""""""""""""""""""""""
403
404 .. container:: table-row
405
406 Property
407 results.titleCropSignifier
408
409 Data type
410 string
411
412 Description
413 Determines the string being appended to a cropped title
414 Defaults to "..."
415
416
417 .. _results-summaryCropAfter:
418
419 results.summaryCropAfter
420 """"""""""""""""""""""""
421
422 .. container:: table-row
423
424 Property
425 results.summaryCropAfter
426
427 Data type
428 int
429
430 Description
431 Determines the length of the cropped summary
432 Defaults to 180
433
434
435 .. _results-summaryCropSignifier:
436
437 results.summaryCropSignifier
438 """"""""""""""""""""""""""""
439
440 .. container:: table-row
441
442 Property
443 results.summaryCropSignifier
444
445 Data type
446 string
447
448 Description
449 Determines the string being appended to a cropped summary
450 Defaults to "..."
451
452
453 .. _results-hrefInSummaryCropAfter:
454
455 results.hrefInSummaryCropAfter
456 """"""""""""""""""""""""""""""
457
458 .. container:: table-row
459
460 Property
461 results.hrefInSummaryCropAfter
462
463 Data type
464 int
465
466 Description
467 Determines the length of cropped links in the summary
468 Defaults to 60
469
470
471 .. _results-hrefInSummaryCropSignifier:
472
473 results.hrefInSummaryCropSignifier
474 """"""""""""""""""""""""""""""""""
475
476 .. container:: table-row
477
478 Property
479 results.hrefInSummaryCropSignifier
480
481 Data type
482 string
483
484 Description
485 Determines the string being appended to cropped links in the summary
486 Defaults to "..."
487
488
489 .. _results-markupSW_summaryMax:
490
491 results.markupSW_summaryMax
492 """""""""""""""""""""""""""
493
494 .. container:: table-row
495
496 Property
497 results.markupSW_summaryMax
498
499 Data type
500 int
501
502 Description
503 Maximum length of a summary to highlight searchwords in
504 Defaults to 300
505
506
507 .. _results-markupSW_postPreLgd:
508
509 results.markupSW_postPreLgd
510 """""""""""""""""""""""""""
511
512 .. container:: table-row
513
514 Property
515 results.markupSW_postPreLgd
516
517 Data type
518 int
519
520 Description
521 Determines the amount of characters to keep on both sides of the highlighted searchword
522 Defaults to 60
523
524
525 .. _results-markupSW_postPreLgd_offset:
526
527 results.markupSW_postPreLgd_offset
528 """"""""""""""""""""""""""""""""""
529
530 .. container:: table-row
531
532 Property
533 results.markupSW_postPreLgd_offset
534
535 Data type
536 int
537
538 Description
539 Determines the offset of characters from the right side of a highlighted searchword. Higher values will "move"
540 the highlighted searchword further to the left.
541 Defaults to 5
542
543
544 .. _results-markupSW_divider:
545
546 results.markupSW_divider
547 """"""""""""""""""""""""
548
549 .. container:: table-row
550
551 Property
552 results.markupSW_divider
553
554 Data type
555 string
556
557 Description
558 Divider for highlighted searchwords in the summary
559 Defaults to "..."
560
561 .. _results-pathExcludeDoktypes:
562
563 results.pathExcludeDoktypes
564 """""""""""""""""""""""""""
565
566 .. container:: table-row
567
568 Property
569 results.pathExcludeDoktypes
570
571 Data type
572 string
573
574 Description
575 Excludes doktypes in path.
576 Defaults to ""
577
578 **Example:**
579 pathExcludeDoktypes = 254
580 Exclude sys_folder (doktype: 254) in path for result.
581
582 "/Footer(254)/Navi(254)/Imprint(1)" -> "/Imprint".
583
584 pathExcludeDoktypes = 254,4
585 Exclude sys_folder (doktype: 254) and shortcuts (doktype:4) in path for result.
586 "/About-Us(254)/Company(4)/Germany(1)" -> "/Germany".
587
588
589
590 .. _forwardSearchWordsInResultLink:
591
592 forwardSearchWordsInResultLink.no_cache
593 """""""""""""""""""""""""""""""""""""""
594
595 .. container:: table-row
596
597 Property
598 forwardSearchWordsInResultLink.no_cache
599
600 Data type
601 boolean
602
603 Description
604 Toggles whether result links add the no_cache parameter.
605 It is evaluated only if :typoscript:`forwardSearchWordsInResultLink = 1` is also set.
606
607
608 [tsref:plugin.tx\_indexedsearch]
609