Commit be7d22aa authored by Carsten  Rose's avatar Carsten Rose
Browse files

Documentation: reorganized RST files back to one big file - that one is easily searchable

parent b0e57139
.. ==================================================
.. Header hierachy
.. ==
.. --
.. ^^
.. ''
.. ;;
.. ,,
..
.. --------------------------------------------------
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _form-manual:
.. ==================================================
.. Header hierachy
.. ==
.. --
.. ^^
.. ''
.. ;;
.. ,,
..
.. --------------------------------------------------
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
.. _report-manual:
.. ==================================================
.. Header hierachy
.. ==
.. --
.. ^^
.. ''
.. ;;
.. ,,
..
.. --------------------------------------------------
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.
.. include:: Includes.txt
......@@ -1391,6 +1391,47 @@ Type: text
* *retypeNote* =<text> (optional): The note of the second element.
* Also check the :ref:`fe-parameter-attributes` *data-...-error* to customize error messages shown by the validator.
Type Ahead
''''''''''
Activating `typeahead` functionality offers an instant lookup of data and displaying them to the user, while the user is
typing. A dropdown box offers the results. As datasource the regular SQL connection or a LDAP query can be used.
With every keystroke (starting from the *typeAheadMinLength* characters), the already typed value will be transmitted to
the server, the lookup will be performed and the result is displayed as the dropdown box.
* *FormElement.parameter*:
* *typeAheadLimit* = <number>. Max numbers of result records to be shown. Default is 20.
* *typeAheadMinLength* = <number>. Minimum length to type before the first lookup starts.
Depending of the `typeahead` setup, the given FormElement will contain the displayed `value` or `key` (if a key/value dict is
configured).
SQL
;;;
* *FormElement.parameter*:
* *typeAheadSql* = `SELECT ... AS 'key', ... AS 'value' WHERE name LIKE ? OR firstName LIKE ? LIMIT 100`
* If there is only one column in the SELECT statement, that one will be used and there is no dict (key/value pair).
* The query will be fired as a 'prepared statement'.
* The value, typed by the user, will be replaced on all places where a `?` appears.
* All `?` will be automatically surrounded by '%'. Therefore wildcard search is implemented: `... LIKE '%<?>%' ...`
LDAP
;;;;
* *FormElement.parameter*:
* *typeAheadLdapServer* = FQDN of the searched server. E.g.: `directory.uzh.ch`
* *typeAheadLdapBaseDn* = Base DN. E.g.: `ou=Addressbook,dc=uzh,dc=ch`
* *typeAheadLdapSearch* = LDAP search expression. E.g.: `(|(cn=*?*)(mail=*?*)(ou=*?*)(roomNumber=*?*)(telephoneNumber=*?*))`
* *typeAheadLdapValuePrintf* = regular printf expression, LDAP attributenames will be used as variablenames. Will be shown
in the dropdownbox. E.g.: `'%s / %s / %s', mail, roomNumber, telephoneNumber`
* *typeAheadLdapKeyPrintf* = Same as `ldapValuePrintf` - on save, these content will be saved. E.g.: `'%s', mail`
Type: editor
^^^^^^^^^^^^
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment