From be7d22aac8384cdb5f8e71ddc9138f8216ce01a5 Mon Sep 17 00:00:00 2001 From: Carsten Rose <carsten.rose@math.uzh.ch> Date: Wed, 15 Mar 2017 14:41:59 +0100 Subject: [PATCH] Documentation: reorganized RST files back to one big file - that one is easily searchable --- extension/Documentation/1_Installation.rst | 1 - extension/Documentation/2_Concept.rst | 0 extension/Documentation/3_Form.rst | 19 ---------- extension/Documentation/4_Report.rst | 19 ---------- extension/Documentation/5_Release.rst | 17 --------- extension/Documentation/Manual.rst | 41 ++++++++++++++++++++++ 6 files changed, 41 insertions(+), 56 deletions(-) delete mode 100644 extension/Documentation/1_Installation.rst delete mode 100644 extension/Documentation/2_Concept.rst delete mode 100644 extension/Documentation/3_Form.rst delete mode 100644 extension/Documentation/4_Report.rst delete mode 100644 extension/Documentation/5_Release.rst diff --git a/extension/Documentation/1_Installation.rst b/extension/Documentation/1_Installation.rst deleted file mode 100644 index 5f282702b..000000000 --- a/extension/Documentation/1_Installation.rst +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/extension/Documentation/2_Concept.rst b/extension/Documentation/2_Concept.rst deleted file mode 100644 index e69de29bb..000000000 diff --git a/extension/Documentation/3_Form.rst b/extension/Documentation/3_Form.rst deleted file mode 100644 index 1119d8a5f..000000000 --- a/extension/Documentation/3_Form.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. ================================================== -.. 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: diff --git a/extension/Documentation/4_Report.rst b/extension/Documentation/4_Report.rst deleted file mode 100644 index bbd962b80..000000000 --- a/extension/Documentation/4_Report.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. ================================================== -.. 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: diff --git a/extension/Documentation/5_Release.rst b/extension/Documentation/5_Release.rst deleted file mode 100644 index ced3cfc85..000000000 --- a/extension/Documentation/5_Release.rst +++ /dev/null @@ -1,17 +0,0 @@ -.. ================================================== -.. 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 - diff --git a/extension/Documentation/Manual.rst b/extension/Documentation/Manual.rst index 963cbf8a1..baaf3b8e4 100644 --- a/extension/Documentation/Manual.rst +++ b/extension/Documentation/Manual.rst @@ -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 ^^^^^^^^^^^^ -- GitLab