TypoScript¶
Plugin settings¶
Each of the following options is defined for the TypoScript setup path plugin.tx_indexedsearch.settings
.
Table of Contents
Target pid¶
- targetPid¶
- Type
boolean
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Set the target page ID for the Extbase variant of the plugin. An empty value (default) falls back to the current page ID.
Display Rules¶
- displayRules¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Display the search rules.
Display advanced search link¶
- displayAdvancedSearchLink¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Display the link to the advanced search page.
Display result number¶
- displayResultNumber¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Display the numbers of search results.
Breadcrumb wrap¶
- breadcrumbWrap¶
- Type
- Default
/ || /
- Path
plugin.tx_indexedsearch.settings
This configuration is used to wrap a single page title in the breadcrumb of a search result item.
Display level 1 sections¶
- displayLevel1Sections¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
This selects the first menu for the "sections" selector - so it can be searched in sections.
Display level 2 sections¶
- displayLevel2Sections¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
This selects the secondary menu for the "sections" selector - so it can be searched in sub sections. This setting only has an effect if displayLevel1Sections is true.
Display level X all types¶
- displayLevelxAllTypes¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Loaded are, by default:
the subpages of the given page IDs of rootPidList, if displayLevel1Sections is true, and
the subpages of the second level, if displayLevel2Sections is true.
If
displayLevelxAllTypes
is set to true, then the page records for all evaluated IDs are loaded directly.
Display forbidden records¶
- displayForbiddenRecords¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Explicitly display search hits, although the visitor has no access to it.
Media list¶
- mediaList¶
- Type
string
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Restrict the file type list when searching for files.
Root pid list¶
- rootPidList¶
- Type
string (list of integers, separated by comma)
- Default
empty
- Path
plugin.tx_indexedsearch.settings
A list of integers which should be root pages to search from. Thus you can search multiple branches of the page tree by setting this property to a list of page ID numbers.
If this value is set to less than zero (eg. -1), the search will be performed in ALL parts of the page tree without regard to branches at all. An empty value (default) falls back to the current root page ID.
Note
By "root page" we mean a website root defined by a TypoScript record! If you just want to search in branches of your site, use the possibility of searching in levels.
Page links¶
- page_links¶
- Type
int
- Default
10
- Path
plugin.tx_indexedsearch.settings
The maximum number of result pages is defined here.
Detect domain records¶
- detectDomainRecords¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
If set, the search results are linked to the proper domains where they are found.
Default free index UID list¶
- defaultFreeIndexUidList¶
- Type
string (list of integers, separated by comma)
- Default
empty
- Path
plugin.tx_indexedsearch.settings
List of Indexing Configuration UIDs to show as categories in the search form. The order determines the order displayed in the search result.
Exact count¶
- exactCount¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Force permission check for every record while displaying search results. Otherwise, records are only checked up to the current result page, and this might cause that the result counter does not print the exact number of search hits.
By enabling this setting, the loop is not stopped, which causes an exact result count at the cost of an (obvious) slowdown caused by this overhead.
See property show.forbiddenRecords for more information.
Results¶
- results¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Various crop/offset settings for single result items.
Length of the cropped results title¶
- results.titleCropAfter¶
- Type
int
- Default
50
- Path
plugin.tx_indexedsearch.settings
Determines the length of the cropped title.
Crop signifier for results title¶
- results.titleCropSignifier¶
- Type
string
- Default
...
- Path
plugin.tx_indexedsearch.settings
Determines the string being appended to a cropped title.
Length of the cropped summary¶
- results.summaryCropAfter¶
- Type
int
- Default
180
- Path
plugin.tx_indexedsearch.settings
Determines the length of the cropped summary.
Crop signifier for the summary¶
- results.summaryCropSignifier¶
- Type
string
- Default
...
- Path
plugin.tx_indexedsearch.settings
Determines the string being appended to a cropped summary.
Length of cropped links in summary¶
- results.hrefInSummaryCropAfter¶
- Type
int
- Default
60
- Path
plugin.tx_indexedsearch.settings
Determines the length of cropped links in the summary.
Crop signifier for links in summary¶
- results.hrefInSummaryCropSignifier¶
- Type
string
- Default
...
- Path
plugin.tx_indexedsearch.settings
Determines the string being appended to cropped links in the summary.
Length of a summary to highlight search words¶
- results.markupSW_summaryMax¶
- Type
int
- Default
300
- Path
plugin.tx_indexedsearch.settings
Maximum length of a summary to highlight search words in.
Character count next to highlighted search word¶
- results.markupSW_postPreLgd¶
- Type
int
- Default
60
- Path
plugin.tx_indexedsearch.settings
Determines the amount of characters to keep on both sides of the highlighted search word.
Characters offset from the right side of a highlighted search word¶
- results.markupSW_postPreLgd_offset¶
- Type
int
- Default
5
- Path
plugin.tx_indexedsearch.settings
Determines the offset of characters from the right side of a highlighted search word. Higher values will "move" the highlighted search word further to the left.
Divider for highlighted search words¶
- results.markupSW_divider¶
- Type
string
- Default
...
- Path
plugin.tx_indexedsearch.settings
Divider for highlighted search words in the summary.
Excludes doktypes in path¶
- results.pathExcludeDoktypes¶
- Type
string
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Excludes doktypes in rootline.
Example:
plugin.tx_indexedsearch.settings { results { pathExcludeDoktypes = 254 } }
Exclude folder (doktype: 254) in path for the result.
/Footer(254)/Navi(254)/Imprint(1)
->/Imprint
.plugin.tx_indexedsearch.settings { results { pathExcludeDoktypes = 254,4 } }
Exclude folder (doktype: 254) and shortcuts (doktype: 4) in path for result.
/About-Us(254)/Company(4)/Germany(1)
->/Germany
.
Default options¶
- defaultOptions¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Setting of default values.
Please see the options below.
Default: Operand¶
- defaultOptions.defaultOperand¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
- 0
All words (AND)
- 1
Any words (OR)
Default: Sections¶
- defaultOptions.sections¶
- Type
string (list of integers, separated by comma)
- Default
0
- Path
plugin.tx_indexedsearch.settings
Default: Free index UID¶
- defaultOptions.freeIndexUid¶
- Type
int
- Default
-1
- Path
plugin.tx_indexedsearch.settings
Default: Media type¶
- defaultOptions.mediaType¶
- Type
int
- Default
-1
- Path
plugin.tx_indexedsearch.settings
Default: Sort order¶
- defaultOptions.sortOrder¶
- Type
string
- Default
rank_flag
- Path
plugin.tx_indexedsearch.settings
Default: Language UID¶
- defaultOptions.languageUid¶
- Type
string
- Default
current
- Path
plugin.tx_indexedsearch.settings
Default: Sort desc¶
- defaultOptions.sortDesc¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Default: Search type¶
- defaultOptions.searchType¶
- Type
int
- Default
1
- Path
plugin.tx_indexedsearch.settings
Possible values are 0, 1 (any part of the word), 2, 3, 10 and 20 (sentence).
Default: Extended resume¶
- defaultOptions.extResume¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Blind¶
- blind¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Blinding of option selectors / values in these (advanced search).
Please see the options below.
Blind: Search type¶
- blind.searchType¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Default operand¶
- blind.defaultOperand¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Sections¶
- blind.sections¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Free index UID¶
- blind.freeIndexUid¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Blind: Media type¶
- blind.mediaType¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Sort order¶
- blind.sortOrder¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Group¶
- blind.group¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Language UID¶
- blind.languageUid¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Desc¶
- blind.desc¶
- Type
boolean
- Default
0
- Path
plugin.tx_indexedsearch.settings
Blind: Number of results¶
- blind.numberOfResults¶
- Type
string (list of integers, separated by comma)
- Default
10,25,50,100
- Path
plugin.tx_indexedsearch.settings
List of amount of results to be displayed per page. Sending a different amount via GET or POST will result in the default value being used to prevent DoS attacks.
Blind: Extended resume¶
- blind.extResume¶
- Type
boolean
- Default
1
- Path
plugin.tx_indexedsearch.settings
Flag rendering¶
- flagRendering.[languageUid]¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
FlagRendering
is rendered as a TypoScript object and is used to output a flag icon according to the used language of a result item. The ID of the used language (sys_language_uid) is passed as value for "current". This makes it possible to use a CASE TypoScript object to create a separate rendering for each language.Examples:
plugin.tx_indexedsearch.settings { flagRendering = CASE flagRendering { key.current = 1 2 = TEXT 2.value = German default = TEXT default.value = English } }
Icon rendering¶
- iconRendering.[imageType]¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
iconRendering
is rendered as a TypoScript object and is used to output an icon according to the file extension of the file type of the result item, wich is passed as a value for "current". This makes it possible to use a CASE TypoScript object to create a separate rendering for each file type.Examples:
plugin.tx_indexedsearch.settings { iconRendering = CASE iconRendering { key.current = 1 default = IMAGE default.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pages.gif csv = IMAGE csv.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/csv.gif doc = IMAGE doc.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/doc.gif docx = IMAGE docx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/docx.gif dotx = IMAGE dotx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/dotx.gif html = IMAGE html.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/html.gif htm < .html jpg = IMAGE jpg.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/jpg.gif jpeg < .jpg pdf = IMAGE pdf.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pdf.gif potx = IMAGE potx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/potx.gif pps = IMAGE pps.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pps.gif ppsx = IMAGE ppsx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/ppsx.gif ppt = IMAGE ppt.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/ppt.gif pptx = IMAGE pptx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pptx.gif rtf = IMAGE rtf.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/rtf.gif sxc = IMAGE sxc.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/sxc.gif sxi = IMAGE sxi.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/sxi.gif sxw = IMAGE sxw.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/sxw.gif tif = IMAGE tif.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/tif.gif txt = IMAGE txt.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/txt.gif xls = IMAGE xls.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xls.gif xlsx = IMAGE xlsx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xlsx.gif xltx = IMAGE xltx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xltx.gif xml = IMAGE xml.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xml.gif # The following file types are recognized by the file content parser, # but currently there is no image file. ods = TEXT ods.value = ods odp = TEXT odp.value = odp odt = TEXT odt.value = odt } }
Special configuration¶
- specialConfiguration.[pid]¶
- Type
Array
- Default
empty
- Path
plugin.tx_indexedsearch.settings
specialConfiguration
is an array of objects with properties that can customize certain behaviours of the display of a result row depending on its position in the rootline. For instance, you can define that all results which links to pages in a branch from page ID 123 should have another page icon displayed. Or you can add a suffix to the class names so you can style that section differently.Examples:
If a page "Contact" is found in a search for "address" and that "Contact" page is in the rootline
Frontpage [ID=23] > About us [ID=45] > Contact [ID=77]
then you should set the pid value to either "77" or "45". If "45" then all subpages including the "About us" page will have similar configuration.
If the pid value is set to 0 (zero), it will apply to all pages.
Please see the options below.
Special configuration page icon¶
- specialConfiguration.[pid].pageIcon¶
- Type
- Default
empty
- Path
plugin.tx_indexedsearch.settings
Alternative page icon.
Example:
plugin.tx_indexedsearch.settings { specialConfiguration { 0.pageIcon = IMAGE 0.pageIcon.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pages.gif 1.pageIcon = IMAGE 1.pageIcon.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pdf.gif } }
Special configuration CSS suffix¶
- specialConfiguration.[pid].CSSsuffix¶
- Type
string
- Default
empty
- Path
plugin.tx_indexedsearch.settings
A string that will be appended to the class names of all the class attributes used within the presentation of the result row. The prefix will be like this:
Example:
plugin.tx_indexedsearch.settings { specialConfiguration { 1.CSSsuffix = doc } }
if e.g. the value of
CSSsuffix
is "doc" then the class nametx-indexedsearch-title
will betx-indexedsearch-title-doc
.
[tsref:plugin.tx_indexedsearch]