.. You may want to use the usual include line. Uncomment and adjust the path. .. include:: ../Includes.txt ======================================= 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 |img-1| |img-2| jQuery autocomplete for indexed\_search - rzautocomplete .. _jQuery-autocomplete-for-indexed-search: jQuery autocomplete for indexed\_search ======================================= Extension Key: rzautocomplete Language: en Keywords: jQuery, autocomplete, indexed\_search Copyright 2000-2010, Raphael Zschorsch, 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: Table of Contents ----------------- `jQuery autocomplete for indexed\_search 1 <#__RefHeading__596_1787386341>`_ **`Introduction 3 <#__RefHeading__598_1787386341>`_** `What does it do? 3 <#__RefHeading__600_1787386341>`_ `Screenshots 3 <#__RefHeading__602_1787386341>`_ `Thanks to 3 <#__RefHeading__1516_1787386341>`_ **`Users manual 4 <#__RefHeading__604_1787386341>`_** **`Configuration 5 <#__RefHeading__612_1787386341>`_** `Reference 5 <#__RefHeading__616_1787386341>`_ **`Known problems 7 <#__RefHeading__620_1787386341>`_** **`To-Do list 8 <#__RefHeading__622_1787386341>`_** **`ChangeLog 9 <#__RefHeading__624_1787386341>`_** .. _Introduction: Introduction ------------ .. _What-does-it-do: 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: Screenshots ^^^^^^^^^^^ |img-3| A Screenshot of what your searchbox will look like, once the extension is installed. .. _Thanks-to: 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: 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. |img-4| - 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: Configuration ------------- The main configuration is done through TypoScript Constants, so you should easily edit everything through the constant editor |img-5| .. _Reference: Reference ^^^^^^^^^ - plugin.rzautocomplete properties: TS Constants .. ### BEGIN~OF~TABLE ### .. _enableGlobal: enableGlobal """""""""""" .. container:: table-row 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: noConflict """""""""" .. container:: table-row 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: cssPath """"""" .. container:: table-row 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: searchPage """""""""" .. container:: table-row Property searchPage Data type int Description The Search page where the indexed\_search plugin is located Default false .. _minChars: minChars """""""" .. container:: table-row Property minChars Data type int Description Minimum number of chars Default 3 .. _maxResults: maxResults """""""""" .. container:: table-row Property maxResults Data type int Description Maximum number of results Default 10 .. _autoFill: autoFill """""""" .. container:: table-row Property autoFill Data type boolean Description Fill the textinput while still selecting a value Default 0 .. _delay: delay """"" .. container:: table-row Property delay Data type int Description The delay in milliseconds the autocompleter waits after a keystroke to activate itself Default 400 .. _matchContains: matchContains """"""""""""" .. container:: table-row 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: submitClick """"""""""" .. container:: table-row Property submitClick Data type boolean Description Submit form onclick if there are results Default 1 .. _scroll: scroll """""" .. container:: table-row Property scroll Data type boolean Description Whether to scroll when more results than configured Default 1 .. _selectFirst: selectFirst """"""""""" .. container:: table-row 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: multiple """""""" .. container:: table-row Property multiple Data type boolean Description Whether to allow more than one autocompleted-value to enter Default 0 .. _multipleSeparator: multipleSeparator """"""""""""""""" .. container:: table-row Property multipleSeparator Data type string Description Seperator to put between values when using multiple option. Default , .. ###### END~OF~TABLE ###### - plugin.tx\_rzautocomplete\_pi1: TS Setup .. ### BEGIN~OF~TABLE ### .. _template: template """""""" .. container:: table-row Property template Data type string Description Set the template file for the search input field Default EXT:rzautocomplete/res/template/rzautocomplete.html .. _startID: startID """"""" .. container:: table-row 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 .. ###### END~OF~TABLE ###### .. _Known-problems: Known problems -------------- - None so far - Please report bugs: `http://forge.typo3.org/projects/extension- rzautocomplete `_ .. _To-Do-list: 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: ChangeLog --------- .. ### BEGIN~OF~TABLE ### .. _0-0-1: 0.0.1 ^^^^^ .. container:: table-row Version 0.0.1 Changes Initial upload .. _0-0-3: 0.0.3 ^^^^^ .. container:: table-row Version 0.0.3 Changes Added “scroll”, “selectFirst”, “multiple”, “multipleSeparator” constants, manual update, bugfixing, set state to “beta” .. _0-0-4: 0.0.4 ^^^^^ .. container:: table-row Version 0.0.4 Changes Added CDATA for JS outout .. _0-0-5: 0.0.5 ^^^^^ .. container:: table-row Version 0.0.5 Changes Bugfixing, added startID for multiple domain support, manual update (TS Setup) .. _0-0-6: 0.0.6 ^^^^^ .. container:: table-row Version 0.0.6 Changes Added t3jquery implementation (thanks to Florian Ott), added french, spanish and italian translations .. ###### END~OF~TABLE ###### |img-2| 9 .. ######CUTTER_MARK_IMAGES###### .. |img-1| image:: img-1.png .. :align: left .. |img-2| image:: img-2.png .. :border: 0 .. :height: 21 .. :hspace: 9 .. :id: Grafik2 .. :name: Grafik2 .. :width: 87 .. |img-3| image:: img-3.jpeg .. :align: left .. :border: 0 .. :height: 55 .. :id: Grafik3 .. :name: Grafik3 .. :width: 236 .. |img-4| image:: img-4.jpeg .. :align: left .. :border: 0 .. :height: 171 .. :id: Grafik1 .. :name: Grafik1 .. :width: 508 .. |img-5| image:: img-5.jpeg .. :align: left .. :border: 0 .. :height: 603 .. :id: Grafik4 .. :name: Grafik4 .. :width: 422