[FEATURE] Make path separator of search result configurable
[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
19 .. _templatefile:
20
21 templateFile
22 """"""""""""
23
24 .. container:: table-row
25
26 Property
27 templateFile
28
29 Data type
30 resource
31
32 Description
33 The template file, see examples in typo3/sysext/indexed\_search/pi/.
34
35
36 .. _breadcrumbWrap:
37
38 breadcrumbWrap
39 """"""""""""""
40
41 .. container:: table-row
42
43 Property
44 breadcrumbWrap
45
46 Data type
47 :ref:`wrap <t3tsref:wrap>` + :ref:`optionSplit <t3tsref:objects-optionsplit>`
48
49 Description
50 This configuration is used to wrap a single page title in a search result item breadcrumb.
51
52 Default
53 / || /
54
55
56 .. _show-forbiddenrecords:
57
58 show.forbiddenRecords
59 """""""""""""""""""""
60
61 .. container:: table-row
62
63 Property
64 show.forbiddenRecords
65
66 Data type
67 boolean
68
69 Description
70 Explicitly display search hits although the visitor has no access to
71 it.
72
73
74
75 .. _show-resultnumber:
76
77 show.resultNumber
78 """""""""""""""""
79
80 .. container:: table-row
81
82 Property
83 show.resultNumber
84
85 Data type
86 boolean
87
88 Description
89 Display the numbers of search results.
90
91
92 .. _show-advancedsearchlink:
93
94 show.advancedSearchLink
95 """""""""""""""""""""""
96
97 .. container:: table-row
98
99 Property
100 show.advancedSearchLink
101
102 Data type
103 boolean
104
105 Description
106 Display the link to the advanced search page.
107
108 Default
109 1
110
111
112
113 .. _search-rootpidlist:
114
115 search.rootPidList
116 """"""""""""""""""
117
118 .. container:: table-row
119
120 Property
121 search.rootPidList
122
123 Data type
124 list of int
125
126 Description
127 A list of integer which should be root-pages to search from. Thus you
128 can search multiple branches of the page tree by setting this property
129 to a list of page id numbers.
130
131 If this value is set to less than zero (eg. -1) searching will happen
132 in ALL of the page tree with no regard to branches at all.
133
134 Notice that by "root-page" we mean a website root defined by
135
136 a TypoScript Template! If you just want to search in branches of your
137 site, use the possibility of searching in levels.
138
139 Default
140 The current root-page id
141
142
143
144 .. _search-detect-sys-domain-records:
145
146 search.detect\_sys\_domain\_records
147 """""""""""""""""""""""""""""""""""
148
149 .. container:: table-row
150
151 Property
152 search.detect\_sys\_domain\_records
153
154 Data type
155 boolean
156
157 Description
158 If set, then the search results are linked to the proper domains where
159 they are found.
160
161
162
163 .. _search-detect-sys-domain-records-target:
164
165 search.detect\_sys\_domain\_records.target
166 """"""""""""""""""""""""""""""""""""""""""
167
168 .. container:: table-row
169
170 Property
171 search.detect\_sys\_domain\_records.target
172
173 Data type
174 string
175
176 Description
177 Target for external URLs.
178
179
180
181 .. _search-medialist:
182
183 search.mediaList
184 """"""""""""""""
185
186 .. container:: table-row
187
188 Property
189 search.mediaList
190
191 Data type
192 string
193
194 Description
195 Restrict the file type list when searching for files.
196
197
198
199 .. _search-defaultfreeindexuidlist:
200
201 search.defaultFreeIndexUidList
202 """"""""""""""""""""""""""""""
203
204 .. container:: table-row
205
206 Property
207 search.defaultFreeIndexUidList
208
209 Data type
210 string
211
212 Description
213 List of Indexing Configuration Uids to show as categories in search
214 form. The order determines the order displayed in the search result.
215
216
217
218 .. _search-exactcount:
219
220 search.exactCount
221 """""""""""""""""
222
223 .. container:: table-row
224
225 Property
226 search.exactCount
227
228 Data type
229 boolean
230
231 Description
232 Force permission check for every record while displaying search
233 results. Otherwise, records are only checked up to the current result
234 page, and this might cause that the result counter does not print the
235 exact number of search hits.
236
237 By enabling this setting, the loop is not stopped, which causes an
238 exact result count at the cost of an (obvious) slowdown caused by this
239 overhead.
240
241 See property "show.forbiddenRecords" for more information.
242
243
244
245 .. _search-skipextendtosubpageschecking:
246
247 search.skipExtendToSubpagesChecking
248 """""""""""""""""""""""""""""""""""
249
250 .. container:: table-row
251
252 Property
253 search.skipExtendToSubpagesChecking
254
255 Data type
256 boolean
257
258 Description
259 If set to false (default), on each search the complete page tree will
260 be transversed to check which pages are accessible, so that the
261 extendToSubpages can be considered. This will work with a limited
262 number of page-ids (which means most sites), but will result in slow
263 performance on huge page trees.
264
265 If set to true, then the final result rows are joined with the pages
266 table to select pages that are currently accessible. This will speed
267 up searching in very huge page trees, but on the other hand
268 extendToSubpages will NOT be taken into account!
269
270 Default
271 false
272
273
274
275 .. _specconfs-pid:
276
277 specConfs.[pid]
278 """""""""""""""
279
280 .. container:: table-row
281
282 Property
283 specConfs.[pid]
284
285 Data type
286 -
287
288 Description
289 "specConfs" is an array of objects with properties that can customize
290 certain behaviours of the display of a result row depending on it's
291 position in the rootline. For instance you can define that all results
292 which links to pages in a branch from page id 123 should have another
293 page icon displayed. Of you can add a suffix to the class names so you
294 can style that section differently.
295
296 **Examples:**
297
298 If a page "Contact" is found in a search for "address" and that
299 "Contact" page is in the rootline "Frontpage [ID=23] > About us
300 [ID=45] > Contact [ID=77]" then you should set the pid value to either
301 "77" or "45". If "45" then all subpages including the "About us" page
302 will have similar configuration.
303
304 If the pid value is set to 0 (zero) it will apply to all pages.
305
306 Please see the options below.
307
308
309
310 .. _specconfs-pid-pageicon:
311
312 specConfs.[pid].pageIcon
313 """"""""""""""""""""""""
314
315 .. container:: table-row
316
317 Property
318 specConfs.[pid].pageIcon
319
320 Data type
321 :ref:`IMAGE cObject <t3tsref:cobj-image>`
322
323 Description
324 Alternative page icon.
325
326
327
328 .. _specconfs-pid-csssuffix:
329
330 specConfs.[pid].CSSsuffix
331 """""""""""""""""""""""""
332
333 .. container:: table-row
334
335 Property
336 specConfs.[pid].CSSsuffix
337
338 Data type
339 string
340
341 Description
342 A string that will be appended to the class-names of all the class-
343 attributes used within the result row presentation. The prefix will be
344 like this:
345
346 **Example:**
347
348 If "...CSSsuffix = doc" then eg. the class name "tx-indexedsearch-
349 title" will be "tx-indexedsearch-title-doc"
350
351
352
353 .. _whatis-stdwrap:
354
355 whatis\_stdWrap
356 """""""""""""""
357
358 .. container:: table-row
359
360 Property
361 whatis\_stdWrap
362
363 Data type
364 :ref:`stdWrap <t3tsref:stdwrap>`
365
366 Description
367 Parse input through the stdWrap function
368
369 .. _resultlist-stdWrap:
370
371 resultlist\_stdWrap
372 """""""""""""""""""
373
374 .. container:: table-row
375
376 Property
377 resultlist\_stdWrap
378
379 Data type
380 :ref:`stdWrap <t3tsref:stdwrap>`
381
382 Description
383 Parse the result list through the stdWrap function
384
385
386 .. _linkSectionTitles-stdWrap:
387
388 linkSectionTitles
389 """""""""""""""""
390
391 .. container:: table-row
392
393 Property
394 linkSectionTitles
395
396 Data type
397 boolean
398
399 Description
400 Toggles whether section titles are linked or not
401
402
403 [tsref:plugin.tx\_indexedsearch]
404