DEPRECATION WARNING
This documentation is not using the current rendering mechanism and is probably outdated. The extension maintainer should switch to the new system. Details on how to use the rendering mechanism can be found here.
EXT: Accessible browse results for indexed search¶
Author: | Christopher |
---|---|
Created: | 2010-12-18T19:57:23 |
Changed by: | Bernhard Kraft |
Changed: | 2013-06-05T14:18:21 |
Classification: | webcon_searchresultsbrowser |
Keywords: | indexed, search, browser, results, accessible, accessible_is_browse_results, alternative, kb_ |
Author: | Bernhard Kraft |
Email: | kraft@webconsulting.at |
Language: | en |
EXT: Accessible browse results for indexed search¶
Extension Key: webcon_searchresultsbrowser
Language: en
Version: 0.0.1
Keywords: indexed, search, browser, results, accessible, accessible_is_browse_results, alternative, kb_
Copyright 2013, Bernhard Kraft, <kraft@webconsulting.at>
This document is published under the Open Content License
available from http://www.opencontent.org/opl.shtml
The content of this document is related to TYPO3
- a GNU/GPL CMS/Framework available from www.typo3.org
Table of Contents¶
`EXT: Accessible browse results for indexed search 1 <#__RefHeading__5708_1738894311>`_
`Introduction 3 <#__RefHeading__5710_1738894311>`_
`Users manual 4 <#__RefHeading__467_413120346>`_
`Administration 5 <#__RefHeading__31511_818911409>`_
`Known problems 6 <#__RefHeading__31525_818911409>`_
`To-Do list 7 <#__RefHeading__477_413120346>`_
`ChangeLog 8 <#__RefHeading__31623_818911409>`_
Introduction¶
What does it do?¶
This extension affects the rendering of the page browser links of indexed_search. Normally those links have a href attribute of “#” and an onclick attribute which sends the search form with a modified “pointer” parameter. When this extension is installed all required parameters get encoded in the href attribute. This is similar to the the extension “accessible_is_browse_results” but instead of passing all indexed_search parameters one can configure which parameters are required on the site.
Users manual¶
Simply install the extension via the Extension Manager. After clearing all caches the page browser links of an indexed_search result should already get generated with href attributes instead of onclick.
By default only the “sword” (search word) and “pointer” (result page) parameters will get encoded in the URL. If your indexed_search setup uses additional features like “freeIndexUid”, “results” (results at a time), “type”, etc. you will have to configure those parameters via TypoScript. Read about this in the following section “Administration”.
Administration¶
If you need additional parameters like “defOp”, “type” or any other parameter recognized by indexed_search to get encoded in the page browser links you will have to configure them via TypoScript.
For an example how those parameters have to get configured look at “ext_typoscript_setup.txt”
plugin.tx_indexedsearch.search.pageBrowser.linkConfig.additionalParams.cObject {
# [...]
# 30 = TEXT
# 30 {
# field = pageBrowser_freeIndexUid
# intval = 1
# dataWrap = &{field:prefixId}[freeIndexUid]=|
# }
# [...]
}
You can uncomment the two supplied examples in ext_typoscript_setup.txt or add your own setup for the parameters which are required by your indexed_search plugin.
For every parameter you add you have to define an unique index key (30) in above example and generate a “&tx_indexedsearch[fieldname]=value” string.
You can have a look at all the available parameters with a TypoScript like the following:
plugin.tx_indexedsearch.search.pageBrowser.linkConfig.additionalParams.cObject {
70 = TEXT
70.debugData = 1
}
This will generate debug output in the FE showing all available fields accessible via the “.field” operator. Of course TYPO3 debug output has to be enabled (devIPmask, etc.)
Usually the TypoScript path “plugin.tx_indexedsearch.search.pageBrowser.linkConfig” has to be typoLink configuration which gets used for generating the links of the page browser. If you also want to alter the text which is shown for every generated page browser link you can completely remove the predefined setup and define a TEXT (or any other) object instead:
plugin.tx_indexedsearch.search.pageBrowser.linkConfig >
plugin.tx_indexedsearch.search.pageBrowser.linkConfig = TEXT
plugin.tx_indexedsearch.search.pageBrowser.linkConfig {
value = Seite {field:pageBrowser_pointer}
typoLink {
parameter.data = TSFE:id
additionalParams.cObject = COA
additionalParams.cObject {
# You could use the default configuration here
}
}
insertData = 1
}
Known problems¶
No know problems currently.
To-Do list¶
It would be nice if the parameters which should get encoded in the links could get selected upon extension installation (ext_conf_template.txt).