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