TypoScript¶

Plugin settings¶

Changed in version 13.3

It is recommended to change the settings via the Site set "Indexed Search" whenever possible.

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 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
Path: plugin.tx_indexedsearch.settings

Display the numbers of search results.

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
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
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
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.

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
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
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
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