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.
jQuery autocomplete for indexed_search¶
Created: | 2010-02-18T17:33:18 |
---|---|
Changed by: | Raphael Zschorsch |
Changed: | 2010-12-02T13:12:50.030000000 |
Classification: | rzautocomplete |
Description: | The keywords help with categorizing and tagging of the manuals. You can combine two or more keywords and add additional keywords yourself. Please use at least one keyword from both lists. If your manual is NOT in english, see next tab "language" ---- forEditors (use this for editors / german "Redakteure") forAdmins (use this for Administrators) forDevelopers (use this for Developers) forBeginners (manuals covering TYPO3 basics) forIntermediates (manuals going into more depth) forAdvanced (covering the most advanced TYPO3 topics) see more: http://wiki.typo3.org/doc_template#tags ---- |
Keywords: | jQuery, autocomplete, indexed_search |
Author: | Raphael Zschorsch |
Email: | rafu1987@gmail.com |
Info 4: | |
Language: | en |
jQuery autocomplete for indexed_search - rzautocomplete
jQuery autocomplete for indexed_search¶
Extension Key: rzautocomplete
Language: en
Keywords: jQuery, autocomplete, indexed_search
Copyright 2000-2010, Raphael Zschorsch, <rafu1987@gmail.com>
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¶
jQuery autocomplete for indexed_search 1
`Introduction 3 <#__RefHeading__598_1787386341>`_
`Users manual 4 <#__RefHeading__604_1787386341>`_
`Configuration 5 <#__RefHeading__612_1787386341>`_
`Known problems 7 <#__RefHeading__620_1787386341>`_
`To-Do list 8 <#__RefHeading__622_1787386341>`_
`ChangeLog 9 <#__RefHeading__624_1787386341>`_
Introduction¶
What does it do?¶
- This extension includes a searchbox for indexed_search and uses the autocomplete script http://bassistance.de/jquery-plugins/jquery- plugin-autocomplete/ based on jQuery.
- I was sick of extensions which didn't work (correctly) for me, so I created this extension. The extension ods_autocomplete gave me some basic ideas.
- I'm aware that the original plugin is deprecated, but it always worked fine for me. Maybe in the future, I will add the new jQuery UI autocomplete script, but for now, this extension should work just fine.
- rzautocomplete uses version 1.4.3 of the jQuery Library
- rzautocomplete is localized in german, french, spanish and italian
Screenshots¶
A Screenshot of what your searchbox will look like, once the extension is installed.
Thanks to¶
- http://bassistance.de/jquery-plugins/jquery-plugin-autocomplete/ for the original jQuery plugin.
- Florian Ott for his t3jquery implementation and some other changes
Users manual¶
Just install the extension through the extension manager like every other extension.
Include the static TypoScript in your template, for the searchbox to work.
Basically your done. You can now add the searchbox as plugin on a site of your choice or call the searchbox globally:lib.searchbox < plugin.tx_rzautocomplete_pi1
Configuration¶
The main configuration is done through TypoScript Constants, so you should easily edit everything through the constant editor
Reference¶
- plugin.rzautocomplete properties: TS Constants
enableGlobal¶
Property
enableGlobal
Data type
boolean
Description
Enable jQuery globally. If you already defined jQuery Plugins in your site, just set this to “1” and rzautocomplete won't include the jQuery JavaScript.
Default
0
noConflict¶
Property
noConflict
Data type
boolean
Description
Set to “1” if you want to add the noConflict mode. (For example if you use jQuery and Mootools on your site.)
Default
0
cssPath¶
Property
cssPath
Data type
string
Description
If you want to customize the CSS File, define the path like: fileadmin/templates/css/styles.css
Default
false
searchPage¶
Property
searchPage
Data type
int
Description
The Search page where the indexed_search plugin is located
Default
false
minChars¶
Property
minChars
Data type
int
Description
Minimum number of chars
Default
3
maxResults¶
Property
maxResults
Data type
int
Description
Maximum number of results
Default
10
autoFill¶
Property
autoFill
Data type
boolean
Description
Fill the textinput while still selecting a value
Default
0
delay¶
Property
delay
Data type
int
Description
The delay in milliseconds the autocompleter waits after a keystroke to activate itself
Default
400
matchContains¶
Property
matchContains
Data type
boolean
Description
Whether or not the comparison looks inside (i.e. does "ba" match "foo bar") the search results (This will only work when multiple is set to 0)
Default
0
submitClick¶
Property
submitClick
Data type
boolean
Description
Submit form onclick if there are results
Default
1
scroll¶
Property
scroll
Data type
boolean
Description
Whether to scroll when more results than configured
Default
1
selectFirst¶
Property
selectFirst
Data type
boolean
Description
If this is set to true, the first autocomplete value will be automatically selected on tab/return, even if it has not been handpicked by keyboard or mouse action. If there is a handpicked (highlighted) result, that result will take precedence
Default
1
multiple¶
Property
multiple
Data type
boolean
Description
Whether to allow more than one autocompleted-value to enter
Default
0
multipleSeparator¶
Property
multipleSeparator
Data type
string
Description
Seperator to put between values when using multiple option.
Default
,
- plugin.tx_rzautocomplete_pi1: TS Setup
template¶
Property
template
Data type
string
Description
Set the template file for the search input field
Default
EXT:rzautocomplete/res/template/rzautocomplete.html
startID¶
Property
startID
Data type
in
Description
Set the startID for the autocomplete search to work on multiple domains. (i.e. if you have 2 domains and 2 page trees in your TYPO3 installation with the id's 1 and 50, then you have to set 1 as startID for the first page tree and 50 for the second).
Default
Known problems¶
- None so far
- Please report bugs: http://forge.typo3.org/projects/extension- rzautocomplete
To-Do list¶
- Contact me :)
- I'll work on the extension as my time allows me...
- Add jQuery UI autocomplete
- Feature requests: http://forge.typo3.org/projects/extension- rzautocomplete
ChangeLog¶
0.0.1¶
Version
0.0.1
Changes
Initial upload
0.0.3¶
Version
0.0.3
Changes
Added “scroll”, “selectFirst”, “multiple”, “multipleSeparator” constants, manual update, bugfixing, set state to “beta”
0.0.4¶
Version
0.0.4
Changes
Added CDATA for JS outout
0.0.5¶
Version
0.0.5
Changes
Bugfixing, added startID for multiple domain support, manual update (TS Setup)
0.0.6¶
Version
0.0.6
Changes
Added t3jquery implementation (thanks to Florian Ott), added french, spanish and italian translations
9