Index.rst 182 KB
Newer Older
Carsten  Rose's avatar
Carsten Rose committed
1
.. ==================================================
2
.. Header hierachy
3
.. ==
4
5
6
7
8
9
..  --
..   ^^
..    ''
..     ;;
..      ,,
..
10
11
12
13
14
15
16
17
18
19
20
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.

.. include:: ../Includes.txt


.. _users-manual:

Users manual
============

Carsten  Rose's avatar
Carsten Rose committed
21
The QFQ extension is activated through tt-content records. One or more tt-content records per page are necessary to render
22
*forms*, *reports* (exports) or to perform *delete* and *save* commands submitted by a QFQ form.
23
24


25
Features not implemented yet
26
27
28
----------------------------

* Multi Forms
29
30
31
32

QFQ content element
-------------------

33
QFQ is used by configuring Typo3 content elements. Insert one or more QFQ content elements on a Typo3 page.
34
35
36
37
38
39
40
41
Specify column and language per content record as wished.

The title of the QFQ content element will not be rendered. It's only visible in the backend for orientation.


QFQ Keywords (Bodytext)
^^^^^^^^^^^^^^^^^^^^^^^

42

43
44
45
46
47
48
49
50
 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
 |                   | * Fix. E.g.: **form = person**                                                  |
 |                   | * by SIP: **form = {{form}}**                                                   |
 |                   | * by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
 +-------------------+---------------------------------------------------------------------------------+
51
52
53
 | r                 | recordId. The form will load the record with the specified id                   |
 |                   | * Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | * If not specified, the default is '0'                                          |
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.db        | Select a DB. Only necessary if a different than the standard DB should be used. |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fbeg      | Start token for every field (=column)                                           |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fend      | End token for every field (=column)                                             |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Start token for whole <level>                                                   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | End token for whole <level>                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbgd      | Alternating (per row) token                                                     |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rend      | End token for row. Will be rendered **before** subsequent levels are processed  |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.renr      | End token for row. Will be rendered **after** subsequent levels are processed   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rsep      | Seperator token between rows                                                    |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.fsep      | Seperator token between fields (=columns)                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.sql       | SQL Query                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.althead   | If <level>.sql is empty, these token will be rendered                           |
 +-------------------+---------------------------------------------------------------------------------+
81
 | debugShowBodyText | If ='1' and config.ini:*showDebugInfo=yes*: shows a tooltip with bodytext       |
82
 +-------------------+---------------------------------------------------------------------------------+
83

84
85
.. _debug:

86
87
88
89
90
Debug
^^^^^

* config.ini: *SHOW_DEBUG_INFO = yes|no|auto*

91
92
93
94
95
96
  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
      * Shows 'Edit form' (wrench symbol) button on a form.
97

98
    * Report: Will be configured per tt-content record.
99

100
      *debugShowBodyText = 1*
101

102
  * *no*: No debug info.
103

104
  * *auto*: Depending if there is a Typo3 BE session, set internally:
105

106
107
    * *SHOW_DEBUG_INFO = yes*  (BE session exist)
    * *SHOW_DEBUG_INFO = no*   (no BE session)
Carsten  Rose's avatar
Carsten Rose committed
108
109
110
111

Form
----

112
113
* Forms will be created by using the *Form editor* on the Typo3 frontend (HTML form).
* The Formeditor itself consist of two predefined QFQ forms: *form* and *formElement*
114
115
* Every form consist of a) a *Form* record and b) multiple *FormElement* records.
* A form is assigned to a  *table*. Such a table is called the *primary table* for this form.
116
* There are three types of forms which can roughly categorized into:
117

118
  * *Simple* form: the form acts on one record, stored in one table.
119

Carsten  Rose's avatar
Carsten Rose committed
120
    * The form will create necessary SQL commands for insert, update and delete (only primary record) automatically.
121

122
  * *Advanced* form: the form acts on multiple records, stored in more than one table.
123

124
    * Fields of the primary table acts like a *simple* form, all other fields have to be specified with *addNupdate* records.
125

126
  * *Multi* form: the form acts simultanously on more than one record. All records use the same *FormElements*.
127

128
129
    * The *FormElements* are defined as a regular *simple* / or *advanced* form, plus a SQL Query, which selects and
      iterates over all records. Those records will be loaded at the same time.
Carsten  Rose's avatar
Carsten Rose committed
130

131
.. _variables:
Carsten  Rose's avatar
Carsten Rose committed
132

133
134
Variable (incl. mixed SQL Statement)
------------------------------------
Carsten  Rose's avatar
Carsten Rose committed
135
136

Most fields of a form specification might contain:
137

Carsten  Rose's avatar
Carsten Rose committed
138
139
140
141
142
* ''constants'' (=strings), this is the standard use case.
* ''variables'' retrieved from the stores (see below),
* ''SQL statements'' (limited set of),
* or any combination of the above.

143
* A variable (or SQL) statement is surrounded by curly braces:
Carsten  Rose's avatar
Carsten Rose committed
144

145
  *{{VarName[:<store / prio>[:<sanitize class>[:<escape>]]]}}*
Carsten  Rose's avatar
Carsten Rose committed
146
147
148

* Example:

149
  *{{r}}*
Carsten  Rose's avatar
Carsten Rose committed
150

151
152
153
154
  *{{index:FS}}*

  *{{name:FS:alnumx:s}}*

155
  *{{SELECT name FROM person WHERE id=1234}}*
Carsten  Rose's avatar
Carsten Rose committed
156

157
  *{{SELECT name FROM person WHERE id={{r}} }}*
Carsten  Rose's avatar
Carsten Rose committed
158

159
  *{{SELECT name FROM person WHERE id={{key1:C:alnumx}} }}*
Carsten  Rose's avatar
Carsten Rose committed
160

161
* Leading and trailing spaces inside curly braces are removed.
Carsten  Rose's avatar
Carsten Rose committed
162

163
164
  * *{{ SELECT "Hello World"   }}* acts as *{{SELECT "Hello World"}}*
  * *{{ varname   }}* acts as *{{varname}}*
Carsten  Rose's avatar
Carsten Rose committed
165

166

167
168
* There are several stores, from where to retrieve the value. If a value is not found in one store, the next store is searched,
  until a value is found or there are no more stores available.
169
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
Carsten  Rose's avatar
Carsten Rose committed
170
171
172
173
174
* If no value is found, the value is an <empty string>.

URL Parameter
-------------

175
* URL (=GET) Parameter can be used in *forms* and *reports* as variables.
176
177
178
179
180
181
182
183
184
185
186
187
188
189
* If a value violates a parameter sanitize class, the value becomes an empty string.

Escape
------

* Variables used in SQL Statements might cause trouble, if they contain single or double ticks.
* Escaping of single or double is defined by the parameter <escape> (fourth parameter):

  * 's' - single ticks will be escaped.
  * 'd' - double ticks will be escaped.

* It's not possible to escape single and double ticks at the same time.
* Which of them to escape (single or double) depends on the surrounding SQL query.
* Escaping is only necessary inside of SQL queries.
Carsten  Rose's avatar
Carsten Rose committed
190
191
192
193

Sanitize class
--------------

194
195
196
197
198
199
* All values in Store *C* (Client) and store *F* (Form) will be sanitized:
* All :ref:`predefined-variable-names` have a specific default sanitize class. For these variables, it's not necessary
  to specify a sanitize class.
* All other variables (Store: C, F) get by default the sanitize class defined in the corresponding form. If not defined
  the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
Carsten  Rose's avatar
Carsten Rose committed
200

201
202
203
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| Name             | Form | Query | Pattern                                                                                 |
+==================+======+=======+=========================================================================================+
204
| **alnumx**       | Form | Query | [A-Za-z][0-9]@-_.,;: /() ÀÈÌÒÙàèìòùÁÉÍÓÚÝáéíóúýÂÊÎÔÛâêîôûÃÑÕãñõÄËÏÖÜŸäëïöüÿ             |
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **digit**        | Form | Query | [0-9].-+                                                                                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **email**        | Form | Query | [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}                                          |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max**      | Form |       | Compares the value against an lower and upper limit (numeric or string).                |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **min|max date** | Form |       | Compares the value against an lower and upper date or datetime.                         |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **pattern**      | Form |       | Compares the value against a regexp.                                                    |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **allbut**       | Form | Query | All characters allowed, but not [ ]  { } % & \ #. The used regexp: '^[^\[\]{}%&\\#]+$', |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **all**          | Form | Query | no sanitizing                                                                           |
+------------------+------+-------+-----------------------------------------------------------------------------------------+

Carsten  Rose's avatar
Carsten Rose committed
221
222
223
224
225


Store / prio
------------

226
227
228
229
230
Only variables that are known in a specified store can be substituted.

 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 |Name |Description                                                                             | Content                                                                    |
 +=====+========================================================================================+============================================================================+
231
 | F   | :ref:`STORE_FORM`: data not saved in database yet.                                     | All native *FormElements*. Recent values from the Browser.                 |
232
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
233
234
 | S   | :ref:`STORE_SIP`: Client parameter 's' will indicate the current SIP, which will be    | sip, r (record_id), form                                                   |
 |     | loaded from the SESSION repo to the SIP-Store.                                         |                                                                            |
235
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
236
 | R   | :ref:`STORE_RECORD`: Record - the current record loaded in the form                    | All columns of the current record from the current table                   |
237
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
238
239
 | B   | :ref:`STORE_BEFORE`: Record - the current record loaded in the form before any update  | All columns of the current record from the current table                   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
240
241
 | P   | Parent record. E.g.: on multi forms the current record of the outer query              | All columns of the MultiSQL Statement from the table for the current row   |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
242
 | D   | Default values column : The *table.column* specified *default value*.                  |                                                                            |
243
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
244
 | M   | Column type: The *table.column* specified *type*                                       |                                                                            |
245
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
246
 | C   | :ref:`STORE_CLIENT`: POST variable, if not found: GET variable                         | Parameter sent from the Client (=Browser).                                 |
247
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
248
 | T   | :ref:`STORE_TYPO3`: a) Bodytext (ttcontent record), b) Typo3 internal variables        | See Typo3 tt_content record configuration                                  |
249
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
250
 | V   | :ref:`STORE_VARS`: Generic variables                                                   |                                                                            |
251
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
252
253
254
255
256
 | 0   | Zero - allways value: 0, might be helpful if a variable is empty or undefined and will | All possible keys                                                          |
 |     | be used in an SQL statement.                                                           |                                                                            |
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
 | E   | Empty - allways value: 0, might be helpful if a variable is empty or undefined and will| All possible keys                                                          |
 |     | be used in an SQL statement                                                            |                                                                            |
257
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
258
 | Y   | :ref:`STORE_SYSTEM`: a) Database, b) helper vars for logging/debugging:                |                                                                            |
259
 |     | SYSTEM_SQL_RAW ... SYSTEM_FORM_ELEMENT_COLUMN, c) Any custom fields: CONTACT, HELP, .. |                                                                            |
260
 +-----+----------------------------------------------------------------------------------------+----------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
261

262
* Default *<prio>*: *FSRD* - Form / SIP / Record / Table definition.
Carsten  Rose's avatar
Carsten Rose committed
263
264
* Hint: Preferable, parameter should be submitted by SIP, not by Client (=URL).

265
266
267
  * Warning: Data submitted via 'Client' can be easily spoofed and altered.
  * Best: Data submitted via SIP never leaves the server, cannot be spoofed or altered by the user.
  * SIPs can _only_ be defined by using *Report*. Inside of *Report* use columns 'Link' (with attribute 's'), 'page?' or 'Page?'.
Carsten  Rose's avatar
Carsten Rose committed
268
269
270
271
272
273

.. _predefined-variable-names:

Predefined variable names
-------------------------

274
275
276
277
278
279
280
281
.. _STORE_FORM:

Store: *FORM* - F
^^^^^^^^^^^^^^^^^

* Represents the values in the form, typically before saving them.
* Used for:

282
283
284
  * *FormElements* who will be rerendered, after a parent *FormElement* has been changed by the user.
  * *FormElement* actions, before saving the form.
  * Values will be sanitized by the class configured in corresponding the *FormElement*. By default, the sanitize class is `alnumx`.
285

286
287
288
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                                |
 +=========================+============================================================================================================================================+
289
 | FormElement name        | Name of native *FormElement*. To get, exactly and only, the specified *FormElement* (for 'p_id'): *{{p_id:F}}*                             |
290
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
291
292
293
294
295
296
297
298
299
300
301

.. _STORE_SIP:

Store: *SIP* - S
^^^^^^^^^^^^^^^^

* Filled automatically by creating links. E.g.:

  * in `Report` by using `_page?` or `_link` (with active 's')
  * in `Form` by using subrecords: 'new', 'edit', 'delete' links (system) or by column type `_page?`, `_link`.

302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 +-------------------------+-----------------------------------------------------------+
 | Name                    | Explanation                                               |
 +=========================+===========================================================+
 | sip                     | 13 char uniqid                                            |
 +-------------------------+-----------------------------------------------------------+
 | r                       | current record id                                         |
 +-------------------------+-----------------------------------------------------------+
 | form                    | current form name                                         |
 +-------------------------+-----------------------------------------------------------+
 | table                   | current table name                                        |
 +-------------------------+-----------------------------------------------------------+
 | urlparam                | all non Typo3 paramter in one string                      |
 +-------------------------+-----------------------------------------------------------+
 | <user defined>          | additional user defined link parameter                    |
 +-------------------------+-----------------------------------------------------------+
317
318
319
320
321
322

.. _STORE_RECORD:

Store: *RECORD* - R
^^^^^^^^^^^^^^^^^^^

323
324
325
* Current record loaded in Form.
* If r=0, alle values are empty.

326
327
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
328
329
330
331
332
333
334
335
336
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{p_id:R}}* |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+

.. _STORE_BEFORE:

Store: *BEFORE* - B
^^^^^^^^^^^^^^^^^^^

337
* Current record loaded in Form without any modification.
338
339
* If r=0, alle values are empty.

340
341
This store is handy to compare new and old values of a form.

342
343
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                   | Explanation                                                                                                                                      |
344
345
346
 +========================+==================================================================================================================================================+
 | <column name>          | Name of a column of the primary table (as defined in the current form). To get, exactly and only, the specified form *FormElement*: *{{p_id:R}}* |
 +------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------+
347
348
349

.. _STORE_CLIENT:

350
Store: *CLIENT* - C
Carsten  Rose's avatar
Carsten Rose committed
351
352
^^^^^^^^^^^^^^^^^^^

353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                              |
 +=========================+==========================================================================================================================================+
 | s                       | =SIP                                                                                                                                     |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | r                       | record id. Typically stored in SIP, rarely specified on the URL                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemId                | always current Semester Id                                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | keySemIdUser            | *{{keySemIdUser}}*, may be changed by user                                                                                               |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | HTTP_HOST               | current HTTP HOST                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | REMOTE_ADDR             | Client IP address                                                                                                                        |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | '$_SERVER[*]'           | All other variables accessable by *$_SERVER[]*. Only the often used have a pre-defined sanitize class.                                   |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | form                    | Unique name of current form                                                                                                              |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | ANREDE                  | *{{sex}}* == male >> Sehr geehrter Herr, *{{sex}}* == female  Sehr geehrte Frau                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
 | EANREDE                 | *{{sex}}* == male >> Dear Mr., *{{sex}}* == female >> Dear Mrs.                                                                          |
 +-------------------------+------------------------------------------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
376

377
378
.. _STORE_TYPO3:

379
Store: *TYPO3* (Bodytext) - T
Carsten  Rose's avatar
Carsten Rose committed
380
381
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
 +-------------------------+-------------------------------------------------------------------+----------+
 | Name                    | Explanation                                                       | Note     |
 +=========================+===================================================================+==========+
 | form                    | Formname defined in ttcontent record bodytext                     | see note |
 |                         |                                                                   |          |
 |                         | * Fix. E.g. *form = person*                                       |          |
 |                         | * via SIP. E.g. *form = {{form}}*                                 |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageId                  | Record id of current Typo3 page                                   | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageType                | Current selected page type (typically URL parameter 'type')       | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | pageLanguage            | Current selected page language (typically URL parameter 'L')      | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | ttcontentUid            | Record id of current Typo3 content element                        | see note |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUser                  | Logged in Typo3 FE User                                           |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserUid               | Logged in Typo3 FE User uid                                       |          |
 +-------------------------+-------------------------------------------------------------------+----------+
 | feUserGroup             | FE groups of logged in Typo3 FE User                              |          |
 +-------------------------+-------------------------------------------------------------------+----------+
404
405
406

* **note**: not available
  * in 'dynamicUpdate' or
407
  * by *FormElement* class 'action' with type 'beforeSave', 'afterSave', 'beforeDelete', 'afterDelete'.
408
409

.. _STORE_VARS:
Carsten  Rose's avatar
Carsten Rose committed
410

411
412
413
Store: *VARS* - V
^^^^^^^^^^^^^^^^^

414
415
416
417
418
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
 | Name                    | Explanation                                                                                                                                |
 +=========================+============================================================================================================================================+
 | random                  | random string with length of 32 chars, alphanum                                                                                            |
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
419
 | slaveId                 | see *FormElement* `action`                                                                                                                 |
420
 +-------------------------+--------------------------------------------------------------------------------------------------------------------------------------------+
421

422
423
424

.. _STORE_SYSTEM:

425
Store: *SYSTEM* - Y
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
^^^^^^^^^^^^^^^^^^^

 +-------------------------+------------------------------------------------------------+
 | Name                    | Explanation                                                |
 +=========================+============================================================+
 | DB_USER                 | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | DB_SERVER               | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | DB_NAME                 | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | DB_INIT                 | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | SQL_LOG                 | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | SQL_LOG_MODE            | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | SHOW_DEBUG_INFO         | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | CSS_LINK_CLASS_INTERNAL | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | CSS_LINK_CLASS_EXTERNAL | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | CSS_CLASS_QFQ_CONTAINER | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | EXT_PATH                | computed during runtime                                    |
 +-------------------------+------------------------------------------------------------+
 | SITE_PATH               | computed during runtime                                    |
 +-------------------------+------------------------------------------------------------+
 | DATE_FORMAT             | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
457
458
459
460
461
462
463
464
 | FORM_DATA_PATTERN_ERROR | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | FORM_DATA_REQUIRED_ERROR| defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | FORM_DATA_MATCH_ERROR   | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
 | FORM_DATA_ERROR         | defined in config.ini                                      |
 +-------------------------+------------------------------------------------------------+
465
466
467
468
469
470
471
472
473
 | sqlFinal                | computed during runtime, used for error reporting          |
 +-------------------------+------------------------------------------------------------+
 | sqlParamArray           | computed during runtime, used for error reporting          |
 +-------------------------+------------------------------------------------------------+
 | sqlCount                | computed during runtime, used for error reporting          |
 +-------------------------+------------------------------------------------------------+

SQL Statement
-------------
Carsten  Rose's avatar
Carsten Rose committed
474

475
* The detection of an SQL command is case *insensitive*.
476
* Leading  whitespace will be skipped.
477
* The following commands are interpreted as SQL commands:
Carsten  Rose's avatar
Carsten Rose committed
478

479
  * SELECT
480
481
  * INSERT, UPDATE, DELETE, REPLACE, TRUNCATE
  * SHOW, DESCRIBE, EXPLAIN, SET
Carsten  Rose's avatar
Carsten Rose committed
482

483
* A SQL Statement might contain parameters, including additional SQL statements. Inner SQL queries will be executed first.
Carsten  Rose's avatar
Carsten Rose committed
484
* All variables will be substituted one by one from inner to outer.
485
* Maximum recursion depth: 5 (a recursion depth of 2 is sometimes used for mailing with templates, 3 and more probably confuses too much and is therefore not practicable, but supported until depth of 5)
Carsten  Rose's avatar
Carsten Rose committed
486
* The number of variables inside an input field or a SQL statement is not limited.
487
* A resultset of a SQL statement will be imploded over all: concat all columns of a row, concat all rows - there is no glue string.
Carsten  Rose's avatar
Carsten Rose committed
488

489
* Example::
Carsten  Rose's avatar
Carsten Rose committed
490

491
  {{SELECT id, name FROM Person}}
492
493
  {{SELECT id, name, IF({{feUser}}=0,'Yes','No')  FROM Vorlesung WHERE sem_id={{keySemId:Y}} }}
  {{SELECT id, city FROM Address AS adr WHERE adr.p_id={{SELECT id FROM Account AS acc WHERE acc.name={{feUser}} }} }}
494

495
* Special case for SELECT input fields. To deliver a result array specify an '!' before the SELECT: ::
496

497
   {{!SELECT ...}}
498

499
  * This is only possible for the outermost SELECT.
500

501
502
Form: main
----------
Carsten  Rose's avatar
Carsten Rose committed
503
504

+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
505
| Name                   | Type                                                     | Description                                                                             |
Carsten  Rose's avatar
Carsten Rose committed
506
507
508
509
510
+========================+==========================================================+=========================================================================================+
|id                      | int, autoincrement                                       | created by by MySQL                                                                     |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|name                    | string                                                   | unique and speaking name of the form. Form will be identified by this name              |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
511
|title                   | string                                                   | Title, shown on/above the form.                                                         |
Carsten  Rose's avatar
Carsten Rose committed
512
513
514
515
516
517
518
519
520
521
522
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|noteInternal            | textarea                                                 | Internal notes: special functionality, used variables, ...                              |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|tableName               | string                                                   | Primay table of the form                                                                |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|permitNew               | enum('sip', 'logged_in', 'logged_out', 'always', 'never')| Default: sip                                                                            |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|permitEdit              | enum('sip', 'logged_in', 'logged_out', 'always', 'never')| Default: sip                                                                            |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|render                  | enum('plain','table', 'bootstrap')                       | Default bootstrap                                                                       |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
523
524
525
526
|requiredParameter       | string                                                   | Name of required SIP parameter, seperated by comma. '#' as comment delimiter            |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|showButton              | set('new', 'delete', 'close', 'save')                    | Default 'new,delete,close,save'. Shown buttons in the upper right corner of the form.   |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
527
528
|multiMode               | enum('none','horizontal','vertical')                     | Default 'none'                                                                          |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
529
|multiSql                | text                                                     | Optional. SQL Query which selects all records to edit.                                  |
Carsten  Rose's avatar
Carsten Rose committed
530
531
532
533
534
535
536
537
538
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiDetailForm         | string                                                   | Optional. Form to open, if a record is selected to edit (double click on record line)   |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|multiDetailFormParameter| string                                                   | Optional. Translated Parameter submitted to detailform (like subrecord parameter)       |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|forwardMode             | string: 'auto|no|page'.                                  |                                                                                         |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|forwardPage             | string / query                                           | If $forward=="page": page to jump to                                                    |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
539
540
|bsLabelColumns          | string                                                   | The bootstrap grid system is based on 12 columns. The sum of *bsLabelColumns*,          |
+------------------------+----------------------------------------------------------+ *bsInputColumns* and *bsNoteColumns* should be 12. These values here are the base values|
541
|bsInputColumns          | string                                                   | for all *FormElements*. Exceptions per *FormElement* can be specified per *FormElement*.|
542
543
+------------------------+----------------------------------------------------------+ Default: label=3, input=6, note=3                                                       |
|bsNoteColumns           | string                                                   |                                                                                         |
Carsten  Rose's avatar
Carsten Rose committed
544
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
545
|parameter               | text                                                     | Misc additional parameters. See :ref:`form-parameter`                                   |
Carsten  Rose's avatar
Carsten Rose committed
546
547
548
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|deleted                 | string                                                   | 'yes'|'no'.                                                                             |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
549
|modified                | timestamp                                                | updated automatically through stored procedure                                          |
Carsten  Rose's avatar
Carsten Rose committed
550
551
552
553
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+
|created                 | datetime                                                 | set once through QFQ                                                                    |
+------------------------+----------------------------------------------------------+-----------------------------------------------------------------------------------------+

554
555
showButton
^^^^^^^^^^
556

557
Display or hide the button `new`, `delete`, `close`, `save`.
558
559

* *new*: Creates a new record. If the form needs any special parameter via SIP or Client, hide this 'new' button - the necessary parameter are not provided.
560
* *delete*: This either deletes the current record only, or (if defined via action *FormElement* 'before Delete' ) any specified subrecords.
561
562
* *close*: Close the current form. If there are changes, a popup opens and ask to save / close / cancel. The last page from the history will be shown.
* *save*: Save the form.
563

564
* Default: show all buttons.
565

566
.. _form-parameter:
Carsten  Rose's avatar
Carsten Rose committed
567

568
569
parameter
^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
570

571
* The following parameter are optional and can be configured in the *Form.parameter* field.
Carsten  Rose's avatar
Carsten Rose committed
572

573
574
575
576
577
578
579
580
581
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| Name                   | Type   | Description                                                                                              |
+========================+========+==========================================================================================================+
| maxVisiblePill         | int    | Show pills upto <maxVisiblePill> as button, all further in a dropdown menu. Eg.: maxVisiblePill=3        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| class                  | string | HTML div with given class, surrounding the whole form. Eg.: class=container-fluid                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| classPill              | string | HTML div with given class, surrounding the `pill` title line.                                            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
582
| classBody              | string | HTML div with given class, surrounding all *FormElement*.                                                |
583
584
585
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| submitButtonText       | string | Show save button, with the <submitButtonText> at the bottom of the form                                  |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
586
587
| extraDeleteForm        | string | Name of a form which specifies how to delete the primary record and optional slave records               |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
588
589
590
591
592
593
594
595
| data-pattern-error     | string | Pattern violation: Text for error message used for all FormElements of current form                      |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-required-error    | string | Required violation: Text for error message used for all FormElements of current form                     |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-match-error       | string | Match violation: Text for error message used for all FormElements of current form                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-error             | string | If none specific is defined: Text for error message used for all FormElements of current form            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
596

597
598
* Example:

599
600
  * maxVisiblePill = 5
  * class = container-fluid
601
  * classBody = qfq-form-right
602

603
604
submitButtonText
''''''''''''''''
605
606
607
608
609
610
611

* Optional.
* Default: Empty
* Empty: a 'submit' button with a Bootstrap glyph 'check' symbol is rendered at the *top right corner* of the form.
* Non Empty: a 'submit' button, with <submitButtonText>, is rendered at the bottom of the form (without a 'check' glyph
  symbol). Typically 'ShowButton: Save' will be unchecked to hide the regular save glyph symbol.

612
613
class
'''''
614
615
616
617
618
619
620
621
622

* Optional.
* Default: `container`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use: adjust the floating rules of the form.
  * See: http://getbootstrap.com/css/#overview-container
  * Expand the form over the whole area: `container-fluid`

623
624
classPill
'''''''''
625
626
627
628
629
630
631
632
633
634

* Optional.
* Default: `qfq-color-grey-1`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use: adjust the background color of the `pill title` area.
* Predefined background colors: `qfq-color-white`, `qfq-color-grey-1` (dark), `qfq-color-grey-2` (light),
  `qfq-color-blue-1` (dark), `qfq-color-blue-2`. (light)
* `classPill` is only visible on forms with container elemants of type 'Pill'.

635
636
classBody
'''''''''
637
638
639
640
641
642
643

* Optional.
* Default: `qfq-color-grey-2`
* Any CSS class name(s) can be specified.
* Check `typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css` for predefined classes.
* Typical use:

644
  1) adjust the background color of the *FormElement* area.
645
646
647
648
  1) make all form labels right align: `qfq-form-right`.

* Predefined background colors: `qfq-color-white`, `qfq-color-grey-1` (dark), `qfq-color-grey-2` (light),
  `qfq-color-blue-1` (dark), `qfq-color-blue-2`. (light)
649

650
651
652
653
654
655
656
657
658
659
660
submitButtonText
''''''''''''''''

If specified and non empty, display a regular submit button at the bottom of the page with the given text.
This gives the form a ordinary HTML-form look'n' feel. With this option, the standard buttons on the top right border
should be hided to not confuse the user.

extraDeleteForm
'''''''''''''''

Depending on the database definition, it might be necessary to delete the primary record *and* corresponding slave records.
661
To not repeat such 'slave record delete definition', an 'extraDeleteForm' can be specified. If the user opens a record
662
663
664
665
666
667
668
in a form and clicks on the 'delete' button, a defined 'extraDeleteForm'-form will be used to delete primary and slave
records instead of using the current form.
E.g. if there are multiple different forms to work on the same table, all of theses forms might reference to the same
'extraDeleteForm'-form. This simplifies the maintenance.

The 'extraDeleteForm' parameter might be specified for a 'form' and/or for 'subrecords'

669
670
671
672
673
FormElements
------------
* Each *form* contains one or more *FormElement*.
* The *FormElements* are divided in three categories:
  
674
675
676
  * :ref:`class-container`
  * :ref:`class-native`
  * :ref:`class-action`
Carsten  Rose's avatar
Carsten Rose committed
677

678
* Ordering and grouping: Native *FormElements* and Container-Elements (both with feIdContainer=0) will be ordered by 'ord'.
Carsten  Rose's avatar
Carsten Rose committed
679
680
* Inside of a container, all nested elements will be displayed.

681
682
.. _class-container:

Carsten  Rose's avatar
Carsten Rose committed
683
684
685
Class: Container
----------------

686
687
* Pills are containers for 'fieldset' *and* / *or* 'native' *FormElements*.
* Fieldsets are containers for 'native' *FormElements*.
Carsten  Rose's avatar
Carsten Rose committed
688
689
690
691

Type: fieldset
^^^^^^^^^^^^^^

692
* Native *FormElements* can be assigned to a fieldset.
Carsten  Rose's avatar
Carsten Rose committed
693
694
695
696
697
698
* name: technical name, used as HTML identifier.
* label: Shown title of the fieldset.

Type: pill
^^^^^^^^^^

699
700
* Pill is synonymous for a tab. A pill looks like a tab.
* Pills are only available with mode render='bootstrap'.
701
* If there is at least one pill defined, every native *FormElement* needs to be assigned to a pill or to a fieldset.
702
* If there is at least one pill defined, every fieldset needs to be assigned to a pill.
Carsten  Rose's avatar
Carsten Rose committed
703
704
705

* Parameter:

706
707
708
709
  * FormElement.*name*: technical name, used as HTML identifier.
  * FormElement.*label*: Label shown on the corresponding pill button or inside the dropdown menu.
  * FormElement.*type*: *pill*
  * FormElement.*feIdContainer*: 0  # Pill's can't be nested.
710
  * Form.'''Parameter''': *maxVisiblePill=<nr>* Number of Pill-Buttons shown. Undefined means unlimited. Excess Pill buttons will be displayed as a dropdown menu.
Carsten  Rose's avatar
Carsten Rose committed
711

712
713
.. _class-native:

Carsten  Rose's avatar
Carsten Rose committed
714
715
716
Class: Native
-------------

717
718
Fields:

719
720
721
722
723
724
725
726
727
728
729
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| Name          | Type                        | Description                                                                                       |
+===============+=============================+===================================================================================================+
| id            | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
| formId        | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feIdContainer  | int                         |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|enabled        | enum('yes'|'no')            |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
730
731
|dynamicUpdate  | enum('yes'|'no')            | In the browser, *FormElements* with "dynamicUpdate='yes'"  will be updated depending on user      |
|               |                             | input. :ref:`dynamic-update`                                                                      |
732
733
734
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|name           | string                      |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
735
|label          | string                      | Label of *FormElement*. Depending on layout model, left or on top of the *FormElement*            |
736
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
737
738
739
|mode           | enum('show', 'readonly',    | *Show*: regular user input field. This is the default.                                            |
|               | 'required',                 | *Required*: User has to specify a value. Typically, an <empty string> represents 'no value'.      |
|               | 'disabled' )                | *Readonly*: user can't change any data. Data not saved.                                           |
740
|               |                             | *Disabled*: *FormElement* is not visible.                                                         |
741
742
743
744
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|class          | enum('native', 'action',    | Details below.                                                                                    |
|               | 'container')                |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
745
|type           | enum('checkbox', 'date', 'time', 'datetime',  'dateJQW', 'datetimeJQW', 'extra', 'gridJQW', 'text', 'editor', 'note',           |
746
|               | 'password', 'radio', 'select', 'subrecord', 'upload', 'fieldset', 'pill', 'beforeLoad', 'beforeSave',                           |
747
|               | 'beforeInsert', 'beforeUpdate', 'beforeDelete', 'afterLoad', 'afterSave', 'afterInsert', 'afterUpdate', 'afterDelete',          |
748
|               | 'sendMail')                                                                                                                     |
749
750
751
752
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|checkType      | enum('min|max', 'pattern',  |                                                                                                   |
|               | 'number', 'email')          |                                                                                                   |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
753
|checkPattern   | 'regexp'                    |If $check_type=='pattern': pattern to match                                                        |
754
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
755
|onChange       | string                      |List of *FormElement*-names of current form, separated by ', ', If one of the named *FormElements* |
756
757
|               |                             | change, reload own data / status / mode                                                           |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
758
|ord            | string                      | Display order of *FormElements* ('order' is a reserved keyword)                                   |
759
760
761
762
763
764
765
766
767
768
769
770
771
772
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|tabindex       | string                      |HTML tabindex attribute                                                                            |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|size           | string                      |Visible length of input element. Might be ommited, depending on the choosen form layout.           |
|               |                             |Format: <width>,<height> (in characters)                                                           |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsLabelColumns | string                      | Number of bootstrap grid columns for label. By default empty, value inherits from the form.       |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsInputColumns | string                      | Number of bootstrap grid columns for input. By default empty, value inherits from the form.       |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|bsNoteColumns  | string                      | Number of bootstrap grid columns for note. By default empty, value inherits from the form.        |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|maxLength      | string                      |Maximum characters for input.                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
773
|note           | string                      |Note of *FormElement*. Depending on layout model, right or below of the *FormElement*.             |
774
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
775
|tooltip        | text                        |Display this text as tooltip on mouse over.                                                        |
776
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
777
|placeholder    | string                      |Text, displayed inside the input element in light grey.                                            |
778
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
779
|clientJs       | text                        |Javascript called on 'on change' *FormElement*                                                     |
780
781
782
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|value          | text                        |Default value                                                                                      |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
783
|sql1           | text                        |SQL query                                                                                          |
784
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
785
|parameter      | text                        |Might contain misc parameter. Depends on the type of *FormElement*.                                |
786
787
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|feGroup        | string                      | Comma-separated list of Typo3 FE Group ID. NOT SURE IF THIS WILL BE IMPLEMENTED. Native           |
788
789
|               |                             | *FormElements*, fieldsets and pills can be assigned to feGroups. Group status: show, hidden,      |
|               |                             | disabled. Group Access: FE-Groups. User will be assigned to FE-Groups and the form definition     |
790
791
|               |                             | reference such FE-groups. Easy way of granting permission.                                        |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
792
|deleted        | string                      | 'yes'|'no'.                                                                                       |
793
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
794
|modified       | timestamp                   |updated automatically through stored procedure                                                     |
795
796
797
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
|created        | datetime                    |set once through QFQ                                                                               |
+---------------+-----------------------------+---------------------------------------------------------------------------------------------------+
Carsten  Rose's avatar
Carsten Rose committed
798

799
800
801
802
803
804
.. _fe-parameter-attributes:

Attributes defined in the parameter field
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

See also at specific *FormElement* definitions.
805
806
807
808
809
810
811
812
813
814
815
816

+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-pattern-error     | string | Pattern violation: Text for error message used for all FormElements of current form                      |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-required-error    | string | Required violation: Text for error message used for all FormElements of current form                     |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-match-error       | string | Match violation: Text for error message used for all FormElements of current form                        |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+
| data-error             | string | If none specific is defined: Text for error message used for all FormElements of current form            |
+------------------------+--------+----------------------------------------------------------------------------------------------------------+


817
818
Effect matrix
^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
819

820
821
822
823
824
825
826
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| Attribute        | checkbox | dateJQW | datetimeJQW |  gridJQW | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+==================+==========+=========+=============+==========+========+=======+======+==========+=======+========+===========+=========+========+========+
|id                |Internal id                                                                                                                              |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|formId            |Form                                                                                                                            |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
827
|containerId       |Assign the *FormElement* to user defined fieldSet or pill                                                                       |        |
828
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
829
|enabled           |*FormElement* is active or not                                                                                                  |        |
830
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
831
|name              |Name of a column of the primary table. *FormElements* with a corresponding table will be saved automatically.                   |        |
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|label             |Label shown to the user.                                                                                                        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|mode              |show, readonly, required, lock, disable.                                                                                        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|class             |native                                                                                                                          |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|type              | checkbox | dateJQW | datetimeJQW |  gridJQW | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|checkType         |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -     |        |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|checkPattern      |          |   -     |   -         |          |        |   -   |      |   -      |       |        |           |   -     |        |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|onChange          |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|ord               |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|tabindex          |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|size              |   -      |         |             |          |        |   -   |      |   -      |   -   |   -  2 |           |   -     |   -  ? |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|maxLength         |   1      |         |             |          |        |   -   |      |   -      |   - 1 |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|note              |   -      |   -     |   -         |          |        |   -   |   -  |   -      |   -   |   -    |   -       |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|tooltip           |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   ?    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|placeholder       |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|clientJs          |          |   -     |   -         |   -      |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|value             |   -      |   -     |   -         |   -      |   -    |   -   |   -  |   -      |   -   |   -    |           |   -     |   -    |   -    |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
|sql1              |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
867
|*Additional attributes in Field 'parameter'. Typically in key=value format.*                                                                                |
868
869
870
871
872
873
874
875
876
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| type             | checkbox | dateJQW | datetimeJQW | gridJQW  | extra  | text  | note | password | radio | select | subrecord | timeJQW | upload | editor |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| accept           |?                                                                                                                                        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| alt              |?                                                                                                                               |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| autocomplete     |          |   -     |   -         |          |        |   -   |      |          |       |        |           |   -     |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
877
| autofocus        |   -      |   -     |   -         |          |        |   -   |      |   -      |   -   |   -    |           |   -     |   -    |   -    |
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checkBoxMode     |   -      |   -     |             |          |        |       |      |          |       |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| checked          |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| unchecked        |   -      |         |             |          |        |   -   |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| label2           |   -      |         |             |          |        |       |      |          |   -   |        |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| itemList         |   -      |         |             |          |        |       |      |          |   -   |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtStart |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyItemAtEnd   |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
| emptyHide        |          |         |             |          |        |       |      |          |       |   -    |           |         |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
895
896
| retype           |          | -       | -           |          |        | -     |      | -        |       |        |           | -       |        |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
897
898
| accept           |          |         |             |          |        |       |      |          |       |        |           |         |   -  3 |        |
+------------------+----------+---------+-------------+----------+--------+-------+------+----------+-------+--------+-----------+---------+--------+--------+
Carsten  Rose's avatar
Carsten Rose committed
899

900

Carsten  Rose's avatar
Carsten Rose committed
901
902
903
904
* 1: A line break created every <size> elements. Easy way to make checkboxes or radio vertical instead of horizontal.
* 2: Any number >1 makes the 'select' input 'multiple' ready.
* See: https://www.w3.org/TR/html5/forms.html#file-upload-state-(type=file)

905
* All 'native' *FormElements* like 'input', 'checkbox', ...
Carsten  Rose's avatar
Carsten Rose committed
906

907
908
909
910
911
912
'autofocus': The first *FormElement* with this attribute will get the focus after form load. If there is no such attribute
 given to any *FormElement*, the attribute will be automatically assigned to the first editable *FormElement*.

To disable 'autofocus' on a form, set 'autofocus=0' on the first editable *FormElement*.

Note: If there are multiple pills defined on a form, only the first pill will be set with 'autofocus'.
913

Carsten  Rose's avatar
Carsten Rose committed
914
915
916
Type: checkbox
^^^^^^^^^^^^^^

917
Checkboxes can be rendered in mode:
Carsten  Rose's avatar
Carsten Rose committed
918

919
* *single*:
Carsten  Rose's avatar
Carsten Rose committed
920

921
  * One column in a table corresponds to one checkbox.
922
  * The value for statuses *checked* and *unchecked* are free to choose.
923
924
  * This mode is selected, if a) *checkBoxMode* = single, or b) *checkBoxMode* is missing **and** the number of fields of the column definition is <3.
  * *parameter*:
Carsten  Rose's avatar
Carsten Rose committed
925

926
927
    * *checkBoxMode* = single (optional)
    * *checked* = <value> (optional, the value which represents 'checked')
Carsten  Rose's avatar
Carsten Rose committed
928

929
      * If *checked* is empty or missing: If *type* = 'enum' or 'set', get first item of the definition. If *type* = string, get default.
Carsten  Rose's avatar
Carsten Rose committed
930

931
    * *unchecked* = <value> (optional, the value which represents 'unchecked')
Carsten  Rose's avatar
Carsten Rose committed
932

933
      * If *unchecked* is empty or missing: If *type* = 'enum' or 'set', get second item of checked. If *type* = 'string', get ''.
Carsten  Rose's avatar
Carsten Rose committed
934

935
    * *label2* = <value>       (Text right beside checkbox) (optional)
Carsten  Rose's avatar
Carsten Rose committed
936
937


938
939
* *multi*:

940
  * One column in a table represents multiple checkboxes. This is typically useful for the column type *set*.
941
942
943
944
945
946
947
948
949
950
  * The value for status *checked* are free to choose, the value for status *unchecked* is always the empty string.
  * Each field key (or the corresponding value from the key/value pair) will be rendered right beside the checkbox.
  * *parameter*

    * *checkBoxMode*: multi
    * *itemList* - E.g.:

      * ``itemList=red,blue,orange``
      * ``itemList=1:red,2:blue,3:orange``
      * ``itemList={{!SELECT id, value FROM someTable}}``
Carsten  Rose's avatar
Carsten Rose committed
951

952
  * *FormElement* Maxlength - vertical or horizontal alignment:
953
954
955
956

     * Value: '', 0, 1 - The radios will be aligned vertical.
     * Value: >1 - The readios will be aligned horizontal, with a linebreak every 'value' elements.

Carsten  Rose's avatar
Carsten Rose committed
957
958
959
Type: date
^^^^^^^^^^

960
961
962
* Range datetime: '1000-01-01' to '9999-12-31' or '0000-00-00'. (http://dev.mysql.com/doc/refman/5.5/en/datetime.html)
* Optional:
  * *dateFormat*: ; yyyy-mm-dd | dd.mm.yyyy
963

Carsten  Rose's avatar
Carsten Rose committed
964
Type: datetime
965
^^^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
966

967
968
969
970
971
* Range datetime: '1000-01-01 00:00:00' to '9999-12-31 23:59:59' or '0000-00-00 00:00:00'. (http://dev.mysql.com/doc/refman/5.5/en/datetime.html)
* Optional:
  * *dateFormat*: ; yyyy-mm-dd | dd.mm.yyyy
  * *showSeconds*: 0|1 - shows the seconds. Independent if the user specifies seconds, they are displayed '1' or not '0'.
  * *showZero*: 0|1 - For an empty timestamp, With '0' nothing is displayed. With '1' the string '0000-00-00 00:00:00' is displayed.
972

973
974
Type: extra
^^^^^^^^^^^
975
* Element is not shown in the browser.
976
* The element can be used to define / precalculate values for a column, which do not already exist as a native *FormElement*.
977
* The element is build /computed on form load.
Carsten  Rose's avatar
Carsten Rose committed
978

979
980
Type: text
^^^^^^^^^^
981

982
* General input for text and number.
Carsten  Rose's avatar
Carsten Rose committed
983
984
985
* size:

  * <number>:  width of input element in characters. Lineheight = 1.
986
  * <cols>,<rows>: input element = textarea, width=<cols>, height=<rows>
Carsten  Rose's avatar
Carsten Rose committed
987

988
989
990
991
992
* *parameter*

  * *retype=1* (optional): Current input element will be rendered twice. The form can only submitted if both elements are equal.
  * *retypeLabel=<text>* (optional): The label of the second element.
  * *retypeNote=<text>* (optional): The note of the second element.
993
  * Also check the  :ref:`fe-parameter-attributes` *data-...-error* to customize error messages shown by the validator.
994

995
996
997
Type: editor
^^^^^^^^^^^^

998
* TinyMCE (https://www.tinymce.com, community edition) is used as the QFQ Rich Text Editor.
999
1000
* The content will be saved as HTML inside the database.
* All configuration and plugins will be configured via the 'parameter' field. Just prepend the word 'editor-' in front
1001
  of each TinyMCE keyword. Check possible options under https://www.tinymce.com/docs/configure/,
1002
1003
1004
1005
1006
  https://www.tinymce.com/docs/plugins/, https://www.tinymce.com/docs/advanced/editor-control-identifiers/#toolbarcontrols
* Bars:

  * Top: *menubar* - by default hidden.
  * Top: *toolbar* - by default visible.
1007
1008
  * Bottom: *statusbar* - by default hidden, exception: *min_height* and *max_height* are given via size parameter.

1009
1010
1011

* The default setting is::

1012
1013
    editor-plugins=code link searchreplace table textcolor textpattern visualchars
    editor-toolbar=code searchreplace undo redo | styleselect link table | fontselect fontsizeselect | bullist numlist outdent indent | forecolor backcolor bold italic editor-menubar=false
1014
1015
1016
1017
    editor-statusbar=false

* size:

1018
  * <min_height>,<max_height>: in pixels, including top and bottom bars. E.g.: 300,600
1019
1020


Carsten  Rose's avatar
Carsten Rose committed
1021
Type: note
1022
^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
1023

1024
1025
1026
An FormElement without any 'input' functionality -just to show some text. Use the typical fields 'label', 'value' and
'note' to be displayed in the corresponding three standard columns.

1027
1028
1029
Type: password
^^^^^^^^^^^^^^

1030
* Like a `text` element, but every character is shown as an asterisk.
1031

Carsten  Rose's avatar
Carsten Rose committed
1032
Type: radio
1033
^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
1034

1035
* Radio Buttons will be built from one of three sources:
Carsten  Rose's avatar
Carsten Rose committed
1036

1037
  * a) 'sql1': E.g. *{{!SELECT type AS label FROM car }}* or *{{!SELECT type AS label, typeNr AS id FROM car}}* or *{{!SHOW tables}}*.
Carsten  Rose's avatar
Carsten Rose committed
1038
1039
1040

    * Resultset format 'named': column 'label' and optional a column 'id'.
    * Resultset format 'index':
1041
1042
1043

      * One column in resultset >> first column represents *label*
      * Two or more columns in resultset >> first column represents *id* and second column represents *label*.
Carsten  Rose's avatar
Carsten Rose committed
1044

1045
  * b) *FormElement*.'''parameter''':
Carsten  Rose's avatar
Carsten Rose committed
1046

1047
    * '''itemList''' attribute. E.g.: *itemList=red,blue,orange* or *itemList=1:red,2:blue:3:orange*
Carsten  Rose's avatar
Carsten Rose committed
1048

1049
  * c) Definition of the *enum* or *set* field (only labels, no ids are possible).
Carsten  Rose's avatar
Carsten Rose committed
1050

1051
* *FormElement* '''Maxlength''' - *vertical* or *horizontal* alignment:
1052

1053
1054
   * Value: '', 0, 1 - The radios will be aligned vertical.
   * Value: >1 - The readios will be aligned horizontal, with a linebreak every 'value' elements.
1055

1056
* *FormElement*.'''parameter''':
Carsten  Rose's avatar
Carsten Rose committed
1057
1058
1059

  * '''emptyItemAtStart''': Existence of this item inserts an empty entry at the beginning of the selectlist.
  * '''emptyItemAtEnd''': Existence of this item inserts an empty entry at the end of the selectlist.
Elias Villiger's avatar
Elias Villiger committed
1060
  * '''emptyHide''': Existence of this item hides the empty entry. This is useful for e.g. Enums, which have a en empty
1061
    entry and the empty value should not be an option to be selected.
Carsten  Rose's avatar
Carsten Rose committed
1062
1063

Type: select
1064
^^^^^^^^^^^^
Carsten  Rose's avatar
Carsten Rose committed
1065

1066
* Select lists will be built from one of three sources:
Carsten  Rose's avatar
Carsten Rose committed
1067

1068
  * a) 'sql1': E.g. *{{!SELECT type AS label FROM car }}* or *{{!SELECT type AS label, typeNr AS id FROM car}}* or *{{!SHOW tables}}*.
Carsten  Rose's avatar
Carsten Rose committed
1069
1070
1071
1072

    * Resultset format 'named': column 'label' and optional a column 'id'.
    * Resultset format 'index':

1073
1074
      * One column in resultset >> first column represents *label*
      * Two or more columns in resultset >> first column represents *id* and second column represents *label*.
Carsten  Rose's avatar
Carsten Rose committed
1075

1076
  * b) *FormElement*.'''parameter''':
Carsten  Rose's avatar
Carsten Rose committed
1077

1078
    * '''itemList''' attribute. E.g.: *itemList=red,blue,orange* or *itemList=1:red,2:blue:3:orange*
Carsten  Rose's avatar
Carsten Rose committed
1079

1080
  * c) Definition of the *enum* or *set* field (only labels, no ids are possible).
Carsten  Rose's avatar
Carsten Rose committed
1081

1082
* *FormElement*.'''size''':
Carsten  Rose's avatar
Carsten Rose committed
1083
1084

  * <empty>|0|1: Dropdown list.
1085
  * >1: Select field with 'size' rows height. Multiple selection of items is possible.
Carsten  Rose's avatar
Carsten Rose committed
1086

1087
* *FormElement*.'''parameter''':
Carsten  Rose's avatar
Carsten Rose committed
1088
1089
1090

  * '''emptyItemAtStart''': Existence of this item inserts an empty entry at the beginning of the selectlist.
  * '''emptyItemAtEnd''': Existence of this item inserts an empty entry at the end of the selectlist.
Elias Villiger's avatar
Elias Villiger committed
1091
  * '''emptyHide''': Existence of this item hides the empty entry. This is useful for e.g. Enums, which have an empty
1092
    entry and the empty value should not be an option to be selected.
Carsten  Rose's avatar
Carsten Rose committed
1093
1094
1095
1096

Type: subrecord
^^^^^^^^^^^^^^^

1097
1098
The *FormElement* type 'subrecord' renders a list of records (so called secondary records), typically to show, edit, delete
or add new records. The list is defined as a SQL query. The number of records shown is not limited. These *FormElement*
1099
will be rendered inside the form as a HTML table.
Carsten  Rose's avatar
Carsten Rose committed
1100

1101
1102
* *sql1*: SQL query to select records. E.g.::

1103
   {{!SELECT a.id AS id, CONCAT(a.street, a.streetnumber) AS a, a.city AS b, a.zip AS c FROM Address AS a}}
1104

1105
1106
  * Notice the **exclamation mark** after '{{' - this is necessary to return an array of elements, instead of a single string.
  * Exactly one column **'id'** has to exist; it specifies the primary record