.. include:: /Includes.rst.txt .. _typoscript: ========== TypoScript ========== .. _typoscriptPlugin: Plugin settings =============== Each of the following options is defined for the TypoScript setup path :typoscript:`plugin.tx_indexedsearch.settings`. .. contents:: Table of Contents :depth: 2 :local: .. _targetPid: Target pid ---------- .. confval:: 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. .. _displayRules: Display Rules ------------- .. confval:: displayRules :Type: boolean :Default: 1 :Path: plugin.tx_indexedsearch.settings Display the search rules. .. _show-advancedsearchlink: Display advanced search link ---------------------------- .. confval:: displayAdvancedSearchLink :Type: boolean :Default: 1 :Path: plugin.tx_indexedsearch.settings Display the link to the advanced search page. .. _show-resultnumber: Display result number --------------------- .. confval:: displayResultNumber :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings Display the numbers of search results. .. _breadcrumbWrap: Breadcrumb wrap --------------- .. confval:: breadcrumbWrap :Type: :ref:`wrap ` + :ref:`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-level1sections: Display level 1 sections ------------------------ .. confval:: 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. .. _show-level2sections: Display level 2 sections ------------------------ .. confval:: 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 :ref:`displayLevel1Sections ` is true. .. _show-Levelxalltypes: Display level X all types ------------------------- .. confval:: displayLevelxAllTypes :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings Loaded are, by default: - the subpages of the given page IDs of :ref:`rootPidList `, if :ref:`displayLevel1Sections ` is true, and - the subpages of the second level, if :ref:`displayLevel2Sections ` is true. If :typoscript:`displayLevelxAllTypes` is set to true, then the page records for all evaluated IDs are loaded directly. .. _show-forbiddenrecords: Display forbidden records ------------------------- .. confval:: displayForbiddenRecords :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings Explicitly display search hits, although the visitor has no access to it. .. _search-medialist: Media list ---------- .. confval:: mediaList :Type: string :Default: empty :Path: plugin.tx_indexedsearch.settings Restrict the file type list when searching for files. .. _search-rootpidlist: Root pid list ------------- .. confval:: 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. .. _search-page-links: Page links ---------- .. confval:: page_links :Type: int :Default: 10 :Path: plugin.tx_indexedsearch.settings The maximum number of result pages is defined here. .. _search-detect-sys-domain-records: Detect domain records --------------------- .. confval:: 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. .. _search-detect-sys-domain-records-target: Target ~~~~~~ .. confval:: detectDomainRecords.target :Type: string :Default: empty :Path: plugin.tx_indexedsearch.settings Target for external URLs. .. _search-defaultfreeindexuidlist: Default free index UID list --------------------------- .. confval:: 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. .. _settings-exactcount: Exact count ----------- .. confval:: 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 :ref:`show.forbiddenRecords ` for more information. .. _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: Default: Search type ~~~~~~~~~~~~~~~~~~~~ .. confval:: 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). .. _defaultOptions-extResume: Default: Extended resume ~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: defaultOptions.extResume :Type: boolean :Default: 1 :Path: plugin.tx_indexedsearch.settings .. _blind: Blind ----- .. confval:: 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-searchType: Blind: Search type ~~~~~~~~~~~~~~~~~~ .. confval:: blind.searchType :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-defaultOperand: Blind: Default operand ~~~~~~~~~~~~~~~~~~~~~~ .. confval:: blind.defaultOperand :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-sections: Blind: Sections ~~~~~~~~~~~~~~~ .. confval:: blind.sections :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-freeIndexUid: Blind: Free index UID ~~~~~~~~~~~~~~~~~~~~~ .. confval:: blind.freeIndexUid :Type: boolean :Default: 1 :Path: plugin.tx_indexedsearch.settings .. _blind-mediaType: Blind: Media type ~~~~~~~~~~~~~~~~~ .. confval:: blind.mediaType :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-sortOrder: Blind: Sort order ~~~~~~~~~~~~~~~~~ .. confval:: blind.sortOrder :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-group: Blind: Group ~~~~~~~~~~~~ .. confval:: blind.group :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-languageUid: Blind: Language UID ~~~~~~~~~~~~~~~~~~~ .. confval:: blind.languageUid :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-desc: Blind: Desc ~~~~~~~~~~~ .. confval:: blind.desc :Type: boolean :Default: 0 :Path: plugin.tx_indexedsearch.settings .. _blind-numberOfResults: Blind: Number of results ~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: 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-extResume: Blind: Extended resume ~~~~~~~~~~~~~~~~~~~~~~ .. confval:: blind.extResume :Type: boolean :Default: 1 :Path: plugin.tx_indexedsearch.settings .. _flagRendering-languageUid: Flag rendering -------------- .. confval:: flagRendering.[languageUid] :Type: Array :Default: empty :Path: plugin.tx_indexedsearch.settings :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 ` TypoScript object to create a separate rendering for each language. **Examples:** .. code-block:: typoscript plugin.tx_indexedsearch.settings { flagRendering = CASE flagRendering { key.current = 1 2 = TEXT 2.value = German default = TEXT default.value = English } } .. _iconRendering-imageType: Icon rendering -------------- .. confval:: iconRendering.[imageType] :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 ` TypoScript object to create a separate rendering for each file type. **Examples:** .. code-block:: typoscript 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 } } .. _specialConfiguration-pid: Special configuration --------------------- .. confval:: specialConfiguration.[pid] :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. **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. .. _specialConfiguration-pid-pageicon: Special configuration page icon ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: specialConfiguration.[pid].pageIcon :Type: :ref:`IMAGE cObject ` :Default: empty :Path: plugin.tx_indexedsearch.settings Alternative page icon. **Example:** .. code-block:: typoscript 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 } } .. _specialConfiguration-pid-csssuffix: Special configuration CSS suffix ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ .. confval:: 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:** .. code-block:: typoscript 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]