General
The most basic requirement for the search engine to work is that pages are getting indexed. That will not happen by just installing the plugin! You will have to set up in TypoScript that a certain page should be indexed. That is needed for several good reasons. First of all not all sites in a TYPO3 database might need indexing. So therefore we disable it on a per-site basis. Secondly a single site may have frames and in that case we need only index the page-object which actually shows the page content.
Lets say that you have a PAGE object called "page" (that is pretty typical), then you will have to set this config-option:
page.config.index_enable = 1
When this option is set you should begin to see your pages being indexed when they are shown next time. Remember that only cached pages are indexed!
This is documented in TSref in the CONFIG section. Please look there for further options. For instance indexing of external media can also be enabled there.
Languages
The plugin supports all system languages in TYPO3. Translation is done using the typo3.org tools.
If you want to use eg. danish language that will automatically be used if this option is set in your template (the value is the internal language key):
config.language = dk
TypoScript
[Still missing the major parts here. Just use the object browser for now since that includes all options]
Property: | Data type: | Description: | Default: |
|---|---|---|---|
templateFile | resource | The template file, see examples in typo3/sysext/indexed_search/pi/. | |
show.forbiddenRecords | boolean | Explicitely display search hits although the visitor has no access to it. Notice: This behavior was different in TYPO3 < 4.0. | |
show.resultNumber | boolean | Display the numbers of search results. Notice: This behavior was different in TYPO3 < 4.0. | |
show.advancedSearchLink | boolean | Display the link to the advanced search page. | 1 |
search.rootPidList | list of int | 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. 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. Notice that 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. | The current root-page id |
search.detect_sys_domain_records | boolean | If set, then the search results are linked to the proper domains where they are found. | |
search.detect_sys_domain_records.target | string | Target for external URLs. | |
search.mediaList | string | Restrict the file type list when searching for files. | |
search.defaultFreeIndexUidList | string | List of Indexing Configuration Uids to show as categories in search form. The order determines the order displayed in the search result. | |
search.exactCount | boolean | 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. | |
search.skipExtendToSubpagesChecking | boolean | 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! | false |
specConfs.[pid] | - | “specConfs” 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. 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. | |
specConfs.[pid].pageIcon | ->IMAGE cObject | Alternative page icon. | |
specConfs.[pid].CSSsuffix | string | 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: Example: If “...CSSsuffix = doc” then eg. the class name “tx-indexedsearch-title” will be “tx-indexedsearch-title-doc” | |
whatis_stdWrap | ->stdWrap | Parse input through the stdWrap function |
[tsref:plugin.tx_indexedsearch]
