ajax2Add my vote for this tag component1Add my vote for this tag forms3Add my vote for this tag twiki_application2Add my vote for this tag usability3Add my vote for this tag user_interface3Add my vote for this tag create new tag
, view all tags


Auto-complete input field type for TWiki Forms (NO LONGER MAINTAINED, replaced by AutocompletePlugin)


This plugin provides autocomplete functionality for input field with select options as you type. It is based on Yahoo's User Interface Library.

All this plugin does is implement Arthur Clemens' TWiki:Plugins/AutoCompleteAddOn as a plugin, which allows users to provide an autocomplete text box using the %AUTOCOMPLETE% syntax, and also in TWikiForms (shown below).


Note: This plugin is no longer maintained, it is replaced by the TWiki:Plugins.AutocompletePlugin (with lowercase "c").


Before you can use this plugin, you need to set up some data for the autocomplete. Examples can be found at AutoCompletePluginTestData.

In Topics and Templates

This plugin expands the %AUTOCOMPLETE{...}% variable, which takes the parameters described in AutoCompletePlugin#Parameters.

In TWikiForms

To use this plugin in TWikiForms, create a form template as descibed in TWikiForms#Defining_a_Form. This plugin adds the autocomplete type of field. To pass the parameters required by the plugin, place them in the Values column. An example is shown below:

Name Type Size Values Tooltip message Attributes
Username autocomplete 25em datatopic="Sandbox.AutoCompletePluginTestData" datasection="usernames" delimchar="," itemformat="item[0] + ' (' + item[1] + ')'"    

You can use many of same attributes as you would in topics, except the following:

  • name
  • size
  • value
  • class
  • formname


Parameter Comment Default Example
name A unique name for the textfield required name="users"
datatopic The topic with data. Should be formatted as comma-separated string, or as an array of arrays (see AutoCompletePluginTestData#usernames for an example). Use with datasection. required datatopic="Sandbox.AutoCompletePluginTestData"
datasection The topic section with data. Use with datatopic. required datasection="usernames"
size The width of the input field in em or px. 20em size="20em" or size="200px"
value Default value of the input field none value="AutoCompletePlugin"
tabindex The tabindex of the textfield none tabindex="2"
class Name of css class to add to the input field none class="twikiInputField"
formname Name of the form which the input field is part of none form="userlist"
itemformat The format of an item string in the autocomplete list. Use if the autocomplete list should display different names than the input field - for instance with full person names. The javascript input argument is item. item itemformat="item[0] + ' (' + item[1] + ')'"
delimchar Used to accept multiple delimeted queries. none delimchar=","
onblur, onfocus, onchange, onselect, onmouseover, onmouseout Javascript parameters for the textfield. none onfocus="twiki.Form.clearBeforeFocusText(this);"
itemselecthandler Defines a javascript function to be executed when an item is selected. See http://developer.yahoo.com/yui/autocomplete/#customevents. none itemselecthandler="submitJumpForm"


If installed, the following should create an jump box (TWiki 4.2):


<script type="text/javascript">
var SubmitJump = function(sType, aArgs) {
<form name="myJumpForm" action="%SCRIPTURLPATH{"view"}%/%BASEWEB%/%BASETOPIC%">%AUTOCOMPLETE{name="topic" datatopic="Sandbox.AutoCompletePluginTestData" onfocus="twiki.Form.clearBeforeFocusText(this);" onblur="twiki.Form.restoreBeforeFocusText(this);" datasection="topiclist" value="Jump" formname="myJumpForm" class="twikiInputField twikiInputFieldBeforeFocus"  itemselecthandler="SubmitJump" size="128px" }%</form>


%AUTOCOMPLETE{name="topic" datatopic="Sandbox.AutoCompletePluginTestData" onfocus="twiki.Form.clearBeforeFocusText(this);" onblur="twiki.Form.restoreBeforeFocusText(this);" datasection="topiclist" value="Jump" formname="myJumpForm" class="twikiInputField twikiInputFieldBeforeFocus" itemselecthandler="SubmitJump" size="128px" }%

Installation Instructions

  • For an automated installation, run the configure script and follow "Find More Extensions" in the in the Extensions section.

  • Or, follow these manual installation steps:
    • Download the ZIP file from the extension home on twiki.org (see below).
    • Unzip AutoCompletePlugin.zip in your twiki installation directory.
    • Set the ownership of the extracted directories and files to the webserver user.
    • Install the dependencies (if any).

  • Plugin configuration and testing:
    • Run the configure script and enable the plugin in the Plugins section.
    • Configure additional plugin settings in the Extensions section if needed.
    • Test if the installation was successful using the examples provided.

Plugin Files

File: Description:
data/TWiki/AutoCompletePlugin.txt Documentation
data/TWiki/VarAUTOCOMPLETE.txt Documentation
lib/TWiki/Plugins/AutoCompletePlugin.pm Perl module
data/Sandbox/AutoCompletePluginTestData.txt Test Data
pub/TWiki/AutoCompletePlugin/AutoCompletePluginScreenshot.png Screenshot
lib/TWiki/Plugins/AutoCompletePlugin/Config.spec Spec file for configure

Plugin Info

Plugin Author: TWiki:Main.AndrewRJones
Copyright: © 2007-2008, TWiki:Main.AndrewRJones
© 2007-2012 TWiki:TWiki.TWikiContributor
License: GPL (Gnu General Public License)
Plugin Version: 2012-11-12
Change History:  
2012-11-12: TWikibug:Item7020: Categorize TWiki Variable AUTOCOMPLETE -- TWiki:Main.PeterThoeny
2011-05-14: TWikibug:Item6701: Small fix in Config.spec -- TWiki:Main.PeterThoeny
2011-05-01: TWikibug:Item6701: Doc improvements -- TWiki:Main.PeterThoeny
2010-04-01 TWikibug:Item6415: Added VarAUTOCOMPLETE variable documentation topic -- TWiki:Main.PeterThoeny
2008-09-12 TWikibug:Item5745: Updated to use latest YUI (2.5.2); Fixed forms for 4.2; Fixed Jump Form example for 4.2
14585 TWikibug:Item4469: Removed extra self-closing div-tag tail; Fixed Jump Form example
14413 TWikibug:Item4369: Allow users to define their own item select handler
14391 TWikibug:Item4356: Class names not being added
14382 TWikibug:Item4346: Added Javascript parameters (onblur, onfocus, etc)
14381 TWikibug:Item4345: Was adding 'null' after input if delimchar not set
14379 TWikibug:Item4342: Only sets correct size for one textfield in topic
14290 TWikibug:Item4304: Various bug fixes and enhancements
14277 TWikibug:Item4301: Initial release
TWiki::Contrib::YahooUserInterfaceContrib >1.0Optional. If not found, will use files served from Yahoo! servers. See http://developer.yahoo.com/yui/articles/hosting/.
Benchmarks: GoodStyle nn%, FormattedSearch nn%, AutoCompletePlugin nn%
Plugin Home: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePlugin
Feedback: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePluginDev
Appraisal: http://twiki.org/cgi-bin/view/Plugins/AutoCompletePluginAppraisal

Related Topics: VarAUTOCOMPLETE, AutoCompletePluginTestData, TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences

Topic attachments
I Attachment History Action Size Date Who Comment
Unknown file formatmd5 AutoCompletePlugin.md5 r19 r18 r17 r16 r15 manage 0.2 K 2014-10-07 - 01:56 PeterThoeny  
Compressed Zip archivetgz AutoCompletePlugin.tgz r19 r18 r17 r16 r15 manage 18.2 K 2014-10-07 - 01:55 PeterThoeny  
Compressed Zip archivezip AutoCompletePlugin.zip r19 r18 r17 r16 r15 manage 21.6 K 2014-10-07 - 01:55 PeterThoeny  
Unknown file formatEXT AutoCompletePlugin_installer r7 r6 r5 r4 r3 manage 3.9 K 2014-10-07 - 01:55 PeterThoeny  
Edit | Attach | Watch | Print version | History: r25 < r24 < r23 < r22 < r21 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r25 - 2014-10-07 - PeterThoeny
  • Learn about TWiki  
  • Download TWiki
This site is powered by the TWiki collaboration platform Powered by Perl Hosted by OICcam.com Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.
Copyright © 1999-2015 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.