diff --git a/typo3/sysext/indexed_search/Documentation/Configuration/TypoScript/Index.rst b/typo3/sysext/indexed_search/Documentation/Configuration/TypoScript/Index.rst
index 1a3aabb79cefb0cad7f3e2b7924db0da443bc584..777f8b121af2e8e4b39f93457d8bb2f325cd8bfc 100644
--- a/typo3/sysext/indexed_search/Documentation/Configuration/TypoScript/Index.rst
+++ b/typo3/sysext/indexed_search/Documentation/Configuration/TypoScript/Index.rst
@@ -1,604 +1,998 @@
-.. include:: /Includes.rst.txt
+.. include:: /Includes.rst.txt
+.. _typoscript:
+==========
+TypoScript
+==========
-.. _typoscript:
+.. _typoscriptPlugin:
-TypoScript
-^^^^^^^^^^
+Plugin settings
+===============
-[Still missing the major parts here. Just use the object browser for
-now since that includes all options]
+Each of the following options is defined for the TypoScript setup path :typoscript:`plugin.tx_indexedsearch.settings`.
-Following options live under :typoscript:`plugin.tx_indexedsearch.settings`.
+.. contents:: Table of Contents
+ :depth: 2
+ :local:
+.. _targetPid:
-.. _breadcrumbWrap:
+Target pid
+----------
-breadcrumbWrap
-""""""""""""""
+.. confval:: targetPid
-.. container:: table-row
+ :Type: boolean
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Property
- breadcrumbWrap
+ Set the target page ID for the Extbase variant of the plugin. An empty
+ value (default) falls back to the current page ID.
- Data type
- :ref:`wrap <t3tsref:data-type-wrap>` + :ref:`optionSplit <t3tsref:objects-optionsplit>`
+.. _displayRules:
- Description
- This configuration is used to wrap a single page title in a search result item breadcrumb.
+Display Rules
+-------------
- Default
- / || /
+.. confval:: displayRules
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
-.. _show-forbiddenrecords:
+ Display the search rules.
-displayForbiddenRecords
-"""""""""""""""""""""""
+.. _show-advancedsearchlink:
-.. container:: table-row
+Display advanced search link
+----------------------------
- Property
- displayForbiddenRecords
+.. confval:: displayAdvancedSearchLink
- Data type
- boolean
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
- Description
- Explicitly display search hits although the visitor has no access to
- it.
+ Display the link to the advanced search page.
+.. _show-resultnumber:
+Display result number
+---------------------
-.. _show-resultnumber:
+.. confval:: displayResultNumber
-displayResultNumber
-"""""""""""""""""""
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-.. container:: table-row
+ Display the numbers of search results.
- Property
- displayResultNumber
+.. _breadcrumbWrap:
- Data type
- boolean
+Breadcrumb wrap
+---------------
- Description
- Display the numbers of search results.
+.. confval:: breadcrumbWrap
- Default
- 0
+ :Type: :ref:`wrap <t3tsref:data-type-wrap>` + :ref:`optionSplit <t3tsref:optionsplit>`
+ :Default: / || /
+ :Path: plugin.tx_indexedsearch.settings
+ This configuration is used to wrap a single page title in the breadcrumb of
+ a search result item.
-.. _show-advancedsearchlink:
+.. _show-level1sections:
-displayAdvancedSearchLink
-"""""""""""""""""""""""""
+Display level 1 sections
+------------------------
-.. container:: table-row
+.. confval:: displayLevel1Sections
- Property
- displayAdvancedSearchLink
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- boolean
+ This selects the first menu for the "sections" selector - so it can be
+ searched in sections.
- Description
- Display the link to the advanced search page.
+.. _show-level2sections:
- Default
- 1
+Display level 2 sections
+------------------------
+.. confval:: displayLevel2Sections
-.. _blind-numberOfResults:
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-blind.numberOfResults
-"""""""""""""""""""""
+ This selects the secondary menu for the "sections" selector - so it can
+ be searched in sub sections. This setting only has an effect if
+ :ref:`displayLevel1Sections <show-level1sections>` is true.
-.. container:: table-row
+.. _show-Levelxalltypes:
- Property
- blind.numberOfResults
+Display level X all types
+-------------------------
- Data type
- string (list of integers, separated by comma)
+.. confval:: displayLevelxAllTypes
- Description
- 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.
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Default
- 10,25,50,100
+ Loaded are, by default:
+ - the subpages of the given page IDs of
+ :ref:`rootPidList <search-rootpidlist>`, if
+ :ref:`displayLevel1Sections <show-level1sections>` is true, and
+ - the subpages of the second level, if
+ :ref:`displayLevel2Sections <show-level2sections>` is true.
+ If :typoscript:`displayLevelxAllTypes` is set to true, then the page
+ records for all evaluated IDs are loaded directly.
-.. _search-rootpidlist:
+.. _show-forbiddenrecords:
-rootPidList
-"""""""""""
+Display forbidden records
+-------------------------
-.. container:: table-row
+.. confval:: displayForbiddenRecords
- Property
- rootPidList
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- list of int
+ Explicitly display search hits, although the visitor has no access to it.
- Description
- A list of integer 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.
+.. _search-medialist:
- If this value is set to less than zero (eg. -1) searching will happen
- in ALL of the page tree with no regard to branches at all.
+Media list
+----------
- Notice that by "root-page" we mean a website root defined by
+.. confval:: mediaList
- a TypoScript Template! If you just want to search in branches of your
- site, use the possibility of searching in levels.
+ :Type: string
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Default
- Empty, which fall backs to the current root-page id
+ Restrict the file type list when searching for files.
+.. _search-rootpidlist:
+Root pid list
+-------------
-.. _search-detect-sys-domain-records:
+.. confval:: rootPidList
-detectDomainRecords
-"""""""""""""""""""
+ :Type: string (list of integers, separated by comma)
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
-.. container:: table-row
+ 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.
- Property
- detectDomainRecords
+ 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.
- Data type
- boolean
+ .. note::
+ By "root page" we mean a website root defined by a TypoScript template!
+ If you just want to search in branches of your site, use the possibility
+ of searching in levels.
- Description
- If set, then the search results are linked to the proper domains where
- they are found.
+.. _search-page-links:
+Page links
+----------
+.. confval:: page_links
-.. _search-detect-sys-domain-records-target:
+ :Type: int
+ :Default: 10
+ :Path: plugin.tx_indexedsearch.settings
-detectDomainRecords.target
-""""""""""""""""""""""""""
+ The maximum number of result pages is defined here.
-.. container:: table-row
+.. _search-detect-sys-domain-records:
- Property
- detectDomainRecords.target
+Detect domain records
+---------------------
- Data type
- string
+.. confval:: detectDomainRecords
- Description
- Target for external URLs.
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
+ If set, the search results are linked to the proper domains where
+ they are found.
+.. _search-detect-sys-domain-records-target:
-.. _search-medialist:
+Target
+~~~~~~
-mediaList
-"""""""""
+.. confval:: detectDomainRecords.target
-.. container:: table-row
+ :Type: string
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Property
- mediaList
+ Target for external URLs.
- Data type
- string
+.. _search-defaultfreeindexuidlist:
- Description
- Restrict the file type list when searching for files.
+Default free index UID list
+---------------------------
+.. confval:: defaultFreeIndexUidList
+ :Type: string (list of integers, separated by comma)
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
-.. _search-defaultfreeindexuidlist:
+ List of Indexing Configuration UIDs to show as categories in the search
+ form. The order determines the order displayed in the search result.
-defaultFreeIndexUidList
-"""""""""""""""""""""""
+.. _search-skipextendtosubpageschecking:
-.. container:: table-row
+searchSkipExtendToSubpagesChecking
+----------------------------------
- Property
- defaultFreeIndexUidList
+.. confval:: searchSkipExtendToSubpagesChecking
- Data type
- string
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Description
- List of Indexing Configuration Uids to show as categories in search
- form. The order determines the order displayed in the search result.
+ If set to false (default), on each search the complete page tree will
+ be transversed to check which pages are accessible, so that the
+ extendToSubpages can be considered. This will work with a limited
+ number of page-ids (which means most sites), but will result in slow
+ performance on huge page trees.
+ If set to true, then the final result rows are joined with the pages
+ table to select pages that are currently accessible. This will speed
+ up searching in very huge page trees, but on the other hand
+ extendToSubpages will NOT be taken into account!
+.. _settings-exactcount:
-.. _settings-exactcount:
+Exact count
+-----------
-exactCount
-""""""""""
+.. confval:: exactCount
-.. container:: table-row
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Property
- exactCount
+ 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.
- Data type
- boolean
+ 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.
- Description
- 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.
+ See property :ref:`show.forbiddenRecords <show-forbiddenrecords>` for more
+ information.
- 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.
+.. _forwardSearchWordsInResultLink:
- See property "show.forbiddenRecords" for more information.
+Forward search words in the result link
+---------------------------------------
+.. confval:: forwardSearchWordsInResultLink
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-.. _search-skipextendtosubpageschecking:
+ Toggles whether result links should forward the search words.
-searchSkipExtendToSubpagesChecking
-""""""""""""""""""""""""""""""""""
+.. _forwardSearchWordsInResultLink-nocache:
+
+Add `no_cache` parameter in the result link
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: forwardSearchWordsInResultLink.no_cache
+
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
+
+ Toggles whether result links add the `no_cache` parameter.
+ It is evaluated only if :ref:`forwardSearchWordsInResultLink <forwardSearchWordsInResultLink>`
+ is true.
+
+.. _results:
+
+Results
+-------
+
+.. confval:: results
+
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
+
+ Various crop/offset settings for single result items.
+
+.. _results-titleCropAfter:
+
+Length of the cropped results title
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.titleCropAfter
+
+ :Type: int
+ :Default: 50
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the length of the cropped title.
+
+.. _results-titleCropSignifier:
+
+Crop signifier for results title
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.titleCropSignifier
+
+ :Type: string
+ :Default: ...
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the string being appended to a cropped title.
+
+.. _results-summaryCropAfter:
+
+Length of the cropped summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.summaryCropAfter
+
+ :Type: int
+ :Default: 180
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the length of the cropped summary.
+
+.. _results-summaryCropSignifier:
+
+Crop signifier for the summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.summaryCropSignifier
+
+ :Type: string
+ :Default: ...
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the string being appended to a cropped summary.
+
+.. _results-hrefInSummaryCropAfter:
+
+Length of cropped links in summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.hrefInSummaryCropAfter
+
+ :Type: int
+ :Default: 60
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the length of cropped links in the summary.
+
+.. _results-hrefInSummaryCropSignifier:
+
+Crop signifier for links in summary
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.hrefInSummaryCropSignifier
+
+ :Type: string
+ :Default: ...
+ :Path: plugin.tx_indexedsearch.settings
+
+ Determines the string being appended to cropped links in the summary.
+
+.. _results-markupSW_summaryMax:
+
+Length of a summary to highlight search words
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.markupSW_summaryMax
+
+ :Type: int
+ :Default: 300
+ :Path: plugin.tx_indexedsearch.settings
+
+ Maximum length of a summary to highlight search words in.
+
+.. _results-markupSW_postPreLgd:
+
+Character count next to highlighted search word
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: 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.
+
+.. _results-markupSW_postPreLgd_offset:
+
+Characters offset from the right side of a highlighted search word
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: 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.
+
+.. _results-markupSW_divider:
+
+Divider for highlighted search words
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.markupSW_divider
+
+ :Type: string
+ :Default: ...
+ :Path: plugin.tx_indexedsearch.settings
+
+ Divider for highlighted search words in the summary.
+
+.. _results-pathExcludeDoktypes:
+
+Excludes doktypes in path
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: results.pathExcludeDoktypes
+
+ :Type: string
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
+
+ Excludes doktypes in rootline.
+
+ **Example:**
+
+ .. code-block:: typoscript
+
+ plugin.tx_indexedsearch.settings {
+ results {
+ pathExcludeDoktypes = 254
+ }
+ }
+
+ Exclude folder (doktype: 254) in path for the result.
+
+ `/Footer(254)/Navi(254)/Imprint(1)` -> `/Imprint`.
+
+ .. code-block:: typoscript
+
+ 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`.
+
+.. _defaultOptions:
+
+Default options
+---------------
+
+.. confval:: defaultOptions
+
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
+
+ Setting of default values.
+
+ Please see the options below.
+
+.. _defaultOptions-defaultOperand:
+
+Default: Operand
+~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.defaultOperand
+
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
+
+ 0
+ All words (AND)
+ 1
+ Any words (OR)
+
+.. _defaultOptions-sections:
+
+Default: Sections
+~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.sections
+
+ :Type: string (list of integers, separated by comma)
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-freeIndexUid:
+
+Default: Free index UID
+~~~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.freeIndexUid
+
+ :Type: int
+ :Default: -1
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-mediaType:
+
+Default: Media type
+~~~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.mediaType
+
+ :Type: int
+ :Default: -1
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-sortOrder:
+
+Default: Sort order
+~~~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.sortOrder
+
+ :Type: string
+ :Default: rank_flag
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-languageUid:
+
+Default: Language UID
+~~~~~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.languageUid
+
+ :Type: string
+ :Default: current
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-sortDesc:
+
+Default: Sort desc
+~~~~~~~~~~~~~~~~~~
+
+.. confval:: defaultOptions.sortDesc
+
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
+
+.. _defaultOptions-searchType:
-.. container:: table-row
+Default: Search type
+~~~~~~~~~~~~~~~~~~~~
- Property
- searchSkipExtendToSubpagesChecking
+.. confval:: defaultOptions.searchType
- Data type
- boolean
+ :Type: int
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
- Description
- If set to false (default), on each search the complete page tree will
- be transversed to check which pages are accessible, so that the
- extendToSubpages can be considered. This will work with a limited
- number of page-ids (which means most sites), but will result in slow
- performance on huge page trees.
+ Possible values are 0, 1 (any part of the word), 2, 3, 10 and 20
+ (sentence).
- If set to true, then the final result rows are joined with the pages
- table to select pages that are currently accessible. This will speed
- up searching in very huge page trees, but on the other hand
- extendToSubpages will NOT be taken into account!
+.. _defaultOptions-extResume:
- Default
- 0
+Default: Extended resume
+~~~~~~~~~~~~~~~~~~~~~~~~
+.. confval:: defaultOptions.extResume
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
-.. _specialConfiguration-pid:
+.. _blind:
-specialConfiguration.[pid]
-""""""""""""""""""""""""""
+Blind
+-----
-.. container:: table-row
+.. confval:: blind
- Property
- specialConfiguration.[pid]
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- -
+ Blinding of option selectors / values in these (advanced search).
- Description
- "specialConfiguration" is an array of objects with properties that can customize
- certain behaviours of the display of a result row depending on it's
- 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. Of you can add a suffix to the class names so you
- can style that section differently.
+ Please see the options below.
- **Examples:**
+.. _blind-searchType:
- 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.
+Blind: Search type
+~~~~~~~~~~~~~~~~~~
- If the pid value is set to 0 (zero) it will apply to all pages.
+.. confval:: blind.searchType
- Please see the options below.
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
+.. _blind-defaultOperand:
+Blind: Default operand
+~~~~~~~~~~~~~~~~~~~~~~
-.. _specialConfiguration-pid-pageicon:
+.. confval:: blind.defaultOperand
-specialConfiguration.[pid].pageIcon
-"""""""""""""""""""""""""""""""""""
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-.. container:: table-row
+.. _blind-sections:
- Property
- specialConfiguration.[pid].pageIcon
+Blind: Sections
+~~~~~~~~~~~~~~~
- Data type
- :ref:`IMAGE cObject <t3tsref:cobj-image>`
+.. confval:: blind.sections
- Description
- Alternative page icon.
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
+.. _blind-freeIndexUid:
+Blind: Free index UID
+~~~~~~~~~~~~~~~~~~~~~
-.. _specialConfiguration-pid-csssuffix:
+.. confval:: blind.freeIndexUid
-specialConfiguration.[pid].CSSsuffix
-""""""""""""""""""""""""""""""""""""
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
-.. container:: table-row
+.. _blind-mediaType:
- Property
- specialConfiguration.[pid].CSSsuffix
+Blind: Media type
+~~~~~~~~~~~~~~~~~
- Data type
- string
+.. confval:: blind.mediaType
- Description
- A string that will be appended to the class-names of all the class-
- attributes used within the result row presentation. The prefix will be
- like this:
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- **Example:**
+.. _blind-sortOrder:
- If "...CSSsuffix = doc" then eg. the class name "tx-indexedsearch-
- title" will be "tx-indexedsearch-title-doc"
+Blind: Sort order
+~~~~~~~~~~~~~~~~~
+.. confval:: blind.sortOrder
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-.. _targetPid:
+.. _blind-group:
-targetPid
-"""""""""
+Blind: Group
+~~~~~~~~~~~~
-.. container:: table-row
+.. confval:: blind.group
- Property
- targetPid
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- int
+.. _blind-languageUid:
- Description
- Set the target page UID for the extbase variant of the plugin.
+Blind: Language UID
+~~~~~~~~~~~~~~~~~~~
+.. confval:: blind.languageUid
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
-.. _results-titleCropAfter:
+.. _blind-desc:
-results.titleCropAfter
-""""""""""""""""""""""
+Blind: Desc
+~~~~~~~~~~~
-.. container:: table-row
+.. confval:: blind.desc
- Property
- results.titleCropAfter
+ :Type: boolean
+ :Default: 0
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- int
+.. _blind-numberOfResults:
- Description
- Determines the length of the cropped title
- Defaults to 50
+Blind: Number of results
+~~~~~~~~~~~~~~~~~~~~~~~~
+.. confval:: blind.numberOfResults
-.. _results-titleCropSignifier:
+ :Type: string (list of integers, separated by comma)
+ :Default: 10,25,50,100
+ :Path: plugin.tx_indexedsearch.settings
-results.titleCropSignifier
-""""""""""""""""""""""""""
+ 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.
-.. container:: table-row
+.. _blind-extResume:
- Property
- results.titleCropSignifier
+Blind: Extended resume
+~~~~~~~~~~~~~~~~~~~~~~
- Data type
- string
+.. confval:: blind.extResume
- Description
- Determines the string being appended to a cropped title
- Defaults to "..."
+ :Type: boolean
+ :Default: 1
+ :Path: plugin.tx_indexedsearch.settings
+.. _flagRendering-languageUid:
-.. _results-summaryCropAfter:
+Flag rendering
+--------------
-results.summaryCropAfter
-""""""""""""""""""""""""
+.. confval:: flagRendering.[languageUid]
-.. container:: table-row
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Property
- results.summaryCropAfter
+ :typoscript:`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 :ref:`CASE <t3tsref:cobj-case>`
+ TypoScript object to create a separate rendering for each language.
- Data type
- int
+ **Examples:**
- Description
- Determines the length of the cropped summary
- Defaults to 180
+ .. code-block:: typoscript
+ plugin.tx_indexedsearch.settings {
+ flagRendering = CASE
+ flagRendering {
+ key.current = 1
-.. _results-summaryCropSignifier:
+ 2 = TEXT
+ 2.value = German
-results.summaryCropSignifier
-""""""""""""""""""""""""""""
+ default = TEXT
+ default.value = English
+ }
+ }
-.. container:: table-row
+.. _iconRendering-imageType:
- Property
- results.summaryCropSignifier
+Icon rendering
+--------------
- Data type
- string
+.. confval:: iconRendering.[imageType]
- Description
- Determines the string being appended to a cropped summary
- Defaults to "..."
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
+ :typoscript:`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 :ref:`CASE <t3tsref:cobj-case>` TypoScript object to
+ create a separate rendering for each file type.
-.. _results-hrefInSummaryCropAfter:
+ **Examples:**
-results.hrefInSummaryCropAfter
-""""""""""""""""""""""""""""""
+ .. code-block:: typoscript
-.. container:: table-row
+ plugin.tx_indexedsearch.settings {
+ iconRendering = CASE
+ iconRendering {
+ key.current = 1
- Property
- results.hrefInSummaryCropAfter
+ default = IMAGE
+ default.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pages.gif
- Data type
- int
+ csv = IMAGE
+ csv.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/csv.gif
- Description
- Determines the length of cropped links in the summary
- Defaults to 60
+ 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
-.. _results-hrefInSummaryCropSignifier:
+ dotx = IMAGE
+ dotx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/dotx.gif
-results.hrefInSummaryCropSignifier
-""""""""""""""""""""""""""""""""""
+ html = IMAGE
+ html.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/html.gif
+ htm < .html
-.. container:: table-row
+ jpg = IMAGE
+ jpg.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/jpg.gif
+ jpeg < .jpg
- Property
- results.hrefInSummaryCropSignifier
+ pdf = IMAGE
+ pdf.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pdf.gif
- Data type
- string
+ potx = IMAGE
+ potx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/potx.gif
- Description
- Determines the string being appended to cropped links in the summary
- Defaults to "..."
+ 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
-.. _results-markupSW_summaryMax:
+ ppt = IMAGE
+ ppt.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/ppt.gif
-results.markupSW_summaryMax
-"""""""""""""""""""""""""""
+ pptx = IMAGE
+ pptx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pptx.gif
-.. container:: table-row
+ rtf = IMAGE
+ rtf.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/rtf.gif
- Property
- results.markupSW_summaryMax
+ sxc = IMAGE
+ sxc.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/sxc.gif
- Data type
- int
+ sxi = IMAGE
+ sxi.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/sxi.gif
- Description
- Maximum length of a summary to highlight searchwords in
- Defaults to 300
+ 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
-.. _results-markupSW_postPreLgd:
+ txt = IMAGE
+ txt.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/txt.gif
-results.markupSW_postPreLgd
-"""""""""""""""""""""""""""
+ xls = IMAGE
+ xls.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xls.gif
-.. container:: table-row
+ xlsx = IMAGE
+ xlsx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xlsx.gif
- Property
- results.markupSW_postPreLgd
+ xltx = IMAGE
+ xltx.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xltx.gif
- Data type
- int
+ xml = IMAGE
+ xml.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/xml.gif
- Description
- Determines the amount of characters to keep on both sides of the highlighted searchword
- Defaults to 60
+ # The following file types are recognized by the file content parser,
+ # but currently there is no image file.
+ ods = TEXT
+ ods.value = ods
-.. _results-markupSW_postPreLgd_offset:
+ odp = TEXT
+ odp.value = odp
-results.markupSW_postPreLgd_offset
-""""""""""""""""""""""""""""""""""
+ odt = TEXT
+ odt.value = odt
+ }
+ }
-.. container:: table-row
+.. _specialConfiguration-pid:
- Property
- results.markupSW_postPreLgd_offset
+Special configuration
+---------------------
- Data type
- int
+.. confval:: specialConfiguration.[pid]
- Description
- Determines the offset of characters from the right side of a highlighted searchword. Higher values will "move"
- the highlighted searchword further to the left.
- Defaults to 5
+ :Type: Array
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
+ :typoscript:`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.
-.. _results-markupSW_divider:
+ **Examples:**
-results.markupSW_divider
-""""""""""""""""""""""""
+ If a page "Contact" is found in a search for "address" and that
+ "Contact" page is in the rootline
-.. container:: table-row
+ `Frontpage [ID=23] > About us [ID=45] > Contact [ID=77]`
- Property
- results.markupSW_divider
+ 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.
- Data type
- string
+ If the pid value is set to 0 (zero), it will apply to all pages.
- Description
- Divider for highlighted searchwords in the summary
- Defaults to "..."
+ Please see the options below.
-.. _results-pathExcludeDoktypes:
+.. _specialConfiguration-pid-pageicon:
-results.pathExcludeDoktypes
-"""""""""""""""""""""""""""
+Special configuration page icon
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. container:: table-row
+.. confval:: specialConfiguration.[pid].pageIcon
- Property
- results.pathExcludeDoktypes
+ :Type: :ref:`IMAGE cObject <t3tsref:cobj-image>`
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
- Data type
- string
+ Alternative page icon.
- Description
- Excludes doktypes in path.
- Defaults to ""
+ **Example:**
- **Example:**
- pathExcludeDoktypes = 254
- Exclude sys_folder (doktype: 254) in path for result.
+ .. code-block:: typoscript
- "/Footer(254)/Navi(254)/Imprint(1)" -> "/Imprint".
+ plugin.tx_indexedsearch.settings {
+ specialConfiguration {
+ 0.pageIcon = IMAGE
+ 0.pageIcon.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pages.gif
- pathExcludeDoktypes = 254,4
- Exclude sys_folder (doktype: 254) and shortcuts (doktype:4) in path for result.
- "/About-Us(254)/Company(4)/Germany(1)" -> "/Germany".
+ 1.pageIcon = IMAGE
+ 1.pageIcon.file = EXT:indexed_search/Resources/Public/Icons/FileTypes/pdf.gif
+ }
+ }
+.. _specialConfiguration-pid-csssuffix:
+Special configuration CSS suffix
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-.. _forwardSearchWordsInResultLink:
+.. confval:: specialConfiguration.[pid].CSSsuffix
-forwardSearchWordsInResultLink.no_cache
-"""""""""""""""""""""""""""""""""""""""
+ :Type: string
+ :Default: empty
+ :Path: plugin.tx_indexedsearch.settings
-.. container:: table-row
+ 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:
- Property
- forwardSearchWordsInResultLink.no_cache
+ **Example:**
- Data type
- boolean
+ .. code-block:: typoscript
- Description
- Toggles whether result links add the no_cache parameter.
- It is evaluated only if :typoscript:`forwardSearchWordsInResultLink = 1` is also set.
+ plugin.tx_indexedsearch.settings {
+ specialConfiguration {
+ 1.CSSsuffix = doc
+ }
+ }
+ if e.g. the value of :typoscript:`CSSsuffix` is "doc" then the class
+ name :typoscript:`tx-indexedsearch-title` will be
+ :typoscript:`tx-indexedsearch-title-doc`.
-[tsref:plugin.tx\_indexedsearch]
+[tsref:plugin.tx\_indexedsearch]
\ No newline at end of file