Manual.rst 412 KB
Newer Older
1
.. ==================================================
2
.. Header hierarchy
3
4
5
6
7
8
9
10
.. ==
..  --
..   ^^
..    ''
..     ;;
..      ,,
..
.. --------------------------------------------------
11
.. Best Practice T3 reST  https://docs.typo3.org/typo3cms/drafts/github/xperseguers/RstPrimer/
12
13
14
15
16
17
18
19
.. External Links: `Bootstrap <http://getbootstrap.com/>`_:
.. Add Images: https://wiki.typo3.org/ReST_Syntax#Images
..
.. -*- coding: utf-8 -*- with BOM.


.. include:: Includes.txt

20
21
22
23
24
.. _general:

General
=======

25
* Project homepage: https://qfq.io
Carsten  Rose's avatar
Carsten Rose committed
26
* Latest releases: https://w3.math.uzh.ch/qfq/
27
* Development: https://git.math.uzh.ch/typo3/qfq
28
* Slack: https://qfq-io.slack.com/
29
30
31
32
33
34

.. _installation:

Installation
============

35
The following features are only tested / supported on linux hosts:
36

37
* General: QFQ is coded to run on Linux hosts, preferable on Debian derivates like Ubuntu.
38
39
40
41
* HTML to PDF conversion - command `wkhtmltopdf`.
* Concatenation of PDF files - command `pdftk`.
* Mime type detection for uploads - command `file`.

42

43
44
.. _`preparation`:

45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
Preparation
-----------

Report & Form
^^^^^^^^^^^^^

In PHP 5.x the QFQ extension needs  the PHP MySQL native driver. The following functions are used and are only available with the
native driver (see also: http://dev.mysql.com/downloads/connector/php-mysqlnd/):

* mysqli::get_result (important),
* mysqli::fetch_all (nice to use)

To normalize UTF8 input, the *php5-intl* resp. *php7.0-intl* package is needed by

* normalizer::normalize()

61
For the `download`_ function, the programs `pdftk` and `file` are necessary to concatenate PDF files.
62

63
64
Preparation for Ubuntu 14.04::

65
	sudo apt-get install php5-mysqlnd php5-intl
66
67
	sudo apt-get install pdftk file                  # for file upload and PDF
	sudo apt-get install inkscape graphicsmagick     # to render thumbnails
68
69
70
	sudo php5enmod mysqlnd
	sudo service apache2 restart

Carsten  Rose's avatar
Carsten Rose committed
71
Preparation for Ubuntu 16.04::
72

73
	sudo apt install php7.0-intl
74
75
	sudo apt install pdftk libxrender1 file pdf2svg  # for file upload, PDF and 'HTML to PDF' (wkhtmltopdf), PDF split
	sudo apt install inkscape graphicsmagick         # to render thumbnails
76

77
.. _wkhtml:
78

79
80
wkhtmltopdf
^^^^^^^^^^^
81

82
83
`wkhtmltopdf <http://wkhtmltopdf.org/>`_ will be used by QFQ to offer 'website print' and 'HTML to PDF' conversion.
The program is not included in QFQ and has to be manually installed.
84

85
86
87
88
* The Ubuntu package `wkhtmltopdf` needs a running Xserver - this does not work on a headless webserver.

  * Best is to install the QT version from the named website above.
  * In case of trouble with wkhtmltopdf, also install 'libxrender1'.
89
90
  * The current version 0.12.4 might have trouble with https connections. Version 0.12.5-dev (github master branch)
    seems more reliable. Please contact the QFQ authors if you need a compiled Ubuntu version of wkhtmltopdf.
91

92
In `configuration`_ specify the: ::
93

94
95
    cmdWkhtmltopdf=/opt/wkhtmltox/bin/wkhtmltopdf`.
    baseUrl=http://www.example.com/`.
96

97
98
99
If wkhtml has been compiled with dedicated libraries, specify the LD_LIBRARY_PATH together with the path-filename: ::

    cmdWkhtmltopdf=LD_LIBRARY_PATH=/opt/wkhtmltox/lib /opt/wkhtmltox/bin/wkhtmltopdf
100

101
102
**Important**: To access FE_GROUP protected pages or content, it's necessary to disable the `[FE][lockIP]` check! `wkhtml`
will access the Typo3 page locally (localhost) and that IP address is different from the client (=user) IP.
103
104

Configure via Typo3 Installtool `All configuration > $TYPO3_CONF_VARS['FE']`: ::
105
106
107

   [FE][lockIP] = 0

108
109
110
**Warning**: this disables an important anti-'session hijacking' protection. The security level of the whole installation
will be *lowered*! Again, this is only needed if `wkhtml` needs access to FE_GROUP protected pages & content. As an
alternative to lower the security level, create a separated page subtree which is only accessible (configured via
111
Typoscript) from specific IPs **or** if a FE-User is logged in.
112

113
114
If there are problems with converting/downloading FE_GROUP protected pages, check `SHOW_DEBUG_INFO = download` to debug.

115
116
117
118
**Important**: Converting HTML to PDF gives no error message but RC=-1? Check carefully all includes of CSS, JS, images
and so on! Typically some of them fails to load and wkhtml stops running!


119
120
121
122
123
124
125
126
127
HTML to PDF conversion
''''''''''''''''''''''

`wkhtmltopdf` converts a website (local or remote) to a (multi)-page PDF file. It's mainly used in `download`_.

Print
'''''

Different browser prints the same page in different variations. To prevent this, QFQ implements a small PHP wrapper
Carsten  Rose's avatar
Carsten Rose committed
128
`print.php` with uses `wkhtmltopdf` to convert HTML to PDF.
129

130
Provide a `print this page`-link (replace 'current pageId' )::
131
132
133
134
135
136
137
138
139

	<a href="typo3conf/ext/qfq/qfq/api/print.php?id={current pageId}">Print this page</a>

Any parameter specified after `print.php` will be delivered to `wkhtmltopdf` as part of the URL.

Typoscript code to implement a print link on every page::

	10 = TEXT
	10 {
140
		wrap = <a href="typo3conf/ext/qfq/qfq/api/print.php?id=|&type=99"><span class="glyphicon glyphicon-print" aria-hidden="true"></span> Printview</a>
141
142
143
		data = page:uid
	}

144
145
146
147
148
149
150
151
152
153
154
155
Send Email
^^^^^^^^^^

QFQ sends mail via `sendEmail` http://caspian.dotconf.net/menu/Software/SendEmail/ - a small perl script without a central
configuration.

By default, `sendEmail` uses the local installed MTA, writes a logfile to `typo3conf/mail.log` and handles attachments
via commandline options. A basic HTML email support is implemented.

The latest version is v1.56, which has at least one bug. That one is patched in the QFQ internal version v1.56p1 (see
QFQ GIT sources in directory 'patches/sendEmail.patch').

Carsten  Rose's avatar
Carsten Rose committed
156
Nevertheless, on latest system the TLS support is broken - please check sendEmailProblem_.
157

158
159
160
161
162
163
164
165
166
The Typo3 sendmail eco-system is not used at all by QFQ.

Thumbnail
^^^^^^^^^

Thumbnails will be rendered via GraphicsMagick (http://www.graphicsmagick.org/) 'convert' and 'inkscape' (https://inkscape.org).
'inkscape' is only used for '.svg' files.

The Typo3 grafic eco-system is not used at all by QFQ.
167

168
169
Usage: `column-thumbnail`_.

170
171
172
173
174
175
176
177
178
179
Setup
-----

* Install the extension via the Extensionmanager.

  * If you install the extension by manual download/upload and get an error message
    "can't activate extension": rename the downloaded zip file to `qfq.zip` or `qfq_<version>.zip` (e.g. version: 0.9.1).

  * If the Extensionmanager stops after importing: check your memory limit in php.ini.

180
* Copy/rename the file *<site path>/typo3conf/ext/qfq/config.example.qfq.php* to *config.qfq.php*.
181
182
  Configure the necessary settings `configuration`_
  The configuration file is outside the of extension directory, to not loose it during updates.
Carsten  Rose's avatar
Carsten Rose committed
183
* When the QFQ Extension is called the first time on the Typo3 Frontend, the file *<ext_dir>/qfq/sql/formEditor.sql* will
184
  played and fills the database with the *Form editor* records. This also happens automatically after each update of QFQ.
185
186
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.

187
188
189
190
.. _setup-css-js:

Setup CSS & JS
^^^^^^^^^^^^^^
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
::

	page.meta {
	  X-UA-Compatible = IE=edge
	  X-UA-Compatible.attribute = http-equiv
	  viewport=width=device-width, initial-scale=1
	}

	page.includeCSS {
		file1 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap.min.css
		file2 = typo3conf/ext/qfq/Resources/Public/Css/bootstrap-theme.min.css
		file3 = typo3conf/ext/qfq/Resources/Public/Css/jqx.base.css
		file4 = typo3conf/ext/qfq/Resources/Public/Css/jqx.bootstrap.css
		file5 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
	}

	page.includeJS {
208
209
210
211
212
213
214
		file01 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
		file02 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
		file03 = typo3conf/ext/qfq/Resources/Public/JavaScript/validator.min.js
		file04 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
		file05 = typo3conf/ext/qfq/Resources/Public/JavaScript/globalize.js
		file06 = typo3conf/ext/qfq/Resources/Public/JavaScript/tinymce.min.js
		file07 = typo3conf/ext/qfq/Resources/Public/JavaScript/EventEmitter.min.js
Carsten  Rose's avatar
Carsten Rose committed
215
        file08 = typo3conf/ext/qfq/Resources/Public/JavaScript/typeahead.bundle.min.js
216
217
218
219
		file09 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.min.js

		# Only needed in case FormElement 'annotate' is used.
		file10 = typo3conf/ext/qfq/Resources/Public/JavaScript/fabric.min.js
Carsten  Rose's avatar
Carsten Rose committed
220
        file11 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq.fabric.min.js
221
222
	}

223

224
.. _form-editor:
225
226
227

FormEditor
----------
228

229
230
231
Setup a *report* to manage all *forms*:

* Create a Typo3 page.
232
* Set the 'URL Alias' to `form` (default) or the individual defined value in parameter `editFormPage` (configuration_).
233
* Insert a content record of type *qfq*.
234
* In the bodytext insert the following code: ::
235

236
237
    # If there is a form given by SIP: show
    form={{form:SE}}
238

239
240
    # In case indexQfq is different from indexData, set indexQfq.
    dbIndex = {{indexQfq:Y}}
241

242
243
244
245
246
247
248
249
250
251
    10 {
        # List of Forms: Do not show this list of forms if there is a form given by SIP.
        # Table header.
        sql = SELECT CONCAT('p:{{pageId:T}}&form=form') as _pagen, '#', 'Name', 'Title', 'Table', '' FROM (SELECT 1) AS fake WHERE '{{form:SE}}'=''
        head = <table class="table table-hover qfq-table-50">
        tail = </table>
        rbeg = <thead><tr>
        rend = </tr></thead>
        fbeg = <th>
        fend = </th>
252

253
254
255
256
257
258
259
260
261
        10 {
            # All forms
            sql = SELECT CONCAT('p:{{pageId:T}}&form=form&r=', f.id) as _pagee, f.id, f.name, f.title, f.tableName, CONCAT('form=form&r=', f.id) as _Paged FROM Form AS f ORDER BY f.name
            rbeg = <tr>
            rend = </tr>
            fbeg = <td>
            fend = </td>
        }
    }
262

263
264
265
266
267
.. _install-checklist:

Install Check List
------------------

268
269
270
271
272
* Protect the directory `<T3 installation>/fileadmin/protected` in Apache against direct file access.

  * `<T3 installation>/fileadmin/protected/` should be used for confidential (uploaded / generated) data.
  * `<T3 installation>/fileadmin/protected/log/...` is the default place for QFQ logfiles.

273
274
* Protect the directory `<T3 installation>/fileadmin` in Apache to not execute PHP Scripts - malicious uploads won't be executed.
* Setup a log rotation rule for `sqlLog`.
275
276
* Check that `sqlLogMode` is set to `modify` on productive sites. With `none` you have no chance to find out who changed
  which data and `all` really logs a mass of data.
277

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
.. _configuration:

Configuration
-------------

.. _extension-manager-qfq-configuration:

Extension Manager: QFQ Configuration
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                       | Default / Example                                     | Description                                                                |
+===============================+=======================================================+============================================================================+
| Config                                                                                                                                                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| documentation                 | http://docs.typo3.org...                              | Link to the online documentation of QFQ. Every QFQ installation also       |
|                               |                                                       | contains a local copy: typo3conf/ext/qfq/Documentation/html/Manual.html    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| thumbnailDirSecure            | fileadmin/protected/qfqThumbnail                      | Important: secure directory 'protected' (recursive) against direct access. |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| thumbnailDirPublic            | typo3temp/qfqThumbnail                                | Both thumbnail directories will be created if not existing.                |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdInkscape                   | inkscape                                              | If inkscape is not available, specify an empty string.                     |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cmdConvert                    | convert                                               | GraphicsMagics 'convert' is recommended.                                   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
304
| cmdWkhtmltopdf                | /usr/bin/wkhtmltopdf                                  | PathFilename of wkhtmltopdf. Optional variables like LD_LIBRARY_PATH=...   |
305
306
307
308
309
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| baseUrl                       | http://example.com                                    | URL where wkhtmltopdf will fetch the HTML (no parameter, those comes later)|
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sendEMailOptions              | -o tls=yes                                            | General options. Check: http://caspian.dotconf.net/menu/Software/SendEmail |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
310
| dateFormat                    | yyyy-mm-dd                                            | Possible options: yyyy-mm-dd, dd.mm.yyyy.                                  |
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Dynamic                                                                                                                                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySql1|2|3     | SELECT s.id AS ...                                    | Specific values read from the database to fill the system store during QFQ |
|                               |                                                       | load. See `fillStoreSystemBySql`_ for a usecase.                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| fillStoreSystemBySqlErrorMsg2 | No current period found                               | Only define an error message, if QFQ should stop running                   |
|                               |                                                       | in case of an SQL error or not exact one record.                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Debug                                                                                                                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| sqlLogMode                    | modify                                                | *all*: every statement will be logged - this might a lot.                  |
|                               |                                                       | *modify*: log only statements who change data. *error*: log only DB errors.|
|                               |                                                       | *none*: no SQL log at all.                                                 |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
326
327
| sqlLog                        | fileadmin/protected/log/sql.log                       | Filename to log SQL commands: relative to <site path> or absolute. If the  |
|                               |                                                       | directory does not exist, create it.                                       |
328
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
329
330
| mailLog                       | fileadmin/protected/log/mail.log                      | Filename to log `sendEmail` commands: relative to <site path> or absolute. |
|                               |                                                       | If the directory does not exist, create it.                                |
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| showDebugInfo                 | auto                                                  | FE - Possible values: yes|no|auto|download. For 'auto': If a BE User is    |
|                               |                                                       | logged in, a debug information will be shown on the FE.                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| redirectAllMailTo             | john@doe.com                                          | If set, redirect all QFQ generated mails (Form, Report) to the specified.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Database                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| dbInit                        | dbInit=set names utf8                                 | Global init for using the database.                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| update                        | auto                                                  | 'auto': apply DB Updates only if there is a newer version.                 |
|                               |                                                       | 'always': apply DB Updates always, especially play formEditor.sql every    |
|                               |                                                       | time QFQ is called - *not* recommended!                                    |
|                               |                                                       | 'never': never apply DB Updates.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
346
| indexData                     | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameData:Y}}.  |
347
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
348
| indexQfq                      | 1                                                     | Optional. Default: 1. Retrieve the current setting via {{_dbNameQfq:Y}}.   |
349
350
351
352
353
354
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Security                                                                                                                                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| escapeTypeDefault             | m                                                     | All variables `{{...}}` get this escape class by default.                  |
|                               |                                                       | See `variable-escape`_.                                                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
355
| securityVarsHoneypot          | email,username,password                               | If empty: no check. All named variables will rendered as INPUT elements.   |
356
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
357
| securityAttackDelay           | 5                                                     | If an attack is detected, sleep 'x' seconds and exit PHP process.          |
358
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
359
| securityShowMessage           | true                                                  | If an attack is detected, show a message.                                  |
360
361
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| securityGetMaxLength          | 50                                                    | GET vars longer than 'x' chars triggers an `attack-recognized`.            |
362
|                               |                                                       | `ExceptionMaxLength`_.                                                     |
363
364
365
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Config                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
366
| recordLockTimeoutSeconds      | 900                                                   | Timeout for record locking. After this time, a record will be replaced.    |
367
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
368
| enterAsSubmit                 | enterAsSubmit = 1                                     | 0: off, 1: Pressing *enter* in a form means *save* and *close*.            |
369
370
371
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| editFormPage                  | form                                                  | T3 Pagealias to edit a form.                                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
372
| formDataPatternError          | please check pattern error                            | Customizable error message used in validator.js. 'pattern' violation.      |
373
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
374
| formDataRequiredError         | missing value                                         | Customizable error message used in validator.js. 'required' fields.        |
375
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
376
| formDataMatchError            | type error                                            | Customizable error message used in validator.js. 'match' retype mismatch.  |
377
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
378
| formDataError                 | generic error                                         | Customizable error message used in validator.js. 'no specific' given.      |
379
380
381
382
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Layout                                                                                                                                                        |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqContainer          | container                                             | QFQ with own Bootstrap: 'container'.                                       |
383
|                               |                                                       | QFQ already nested in Bootstrap of mainpage: <empty>.                      |
384
385
386
387
388
389
390
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqForm               | qfq-color-base                                        | Wrap around QFQ 'Form'.                                                    |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormPill           | qfq-color-grey-1                                      | Wrap around title bar for pills: CSS Class, typically a background color.  |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| cssClassQfqFormBody           | qfq-color-grey-2                                      | Wrap around FormElements: CSS Class, typically a background color.         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
391
| formBsColumns                 | 12                                                    | The whole form will be wrapped in 'col-md-??'. Default is 12 for 100%.     |
392
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
393
| formBsLabelColumns            | 3                                                     | Default number of BS columns for the 'label'-column.                       |
394
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
395
| formBsInputColumns            | 6                                                     | Default number of BS columns for the 'input'-column.                       |
396
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
397
| formBsNoteColumns             | 3                                                     | Default number of BS columns for the 'note'-column.                        |
398
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
399
| extraButtonInfoInline         | <img src="info.png">                                  | Image for `extraButtonInfo`_ (inline).                                     |
400
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
401
| extraButtonInfoBelow          | <img src="info.png">                                  | Image for `extraButtonInfo`_ (below).                                      |
402
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
403
| extraButtonInfoPosition       | below                                                 | 'auto' (default) or 'below'. See `extraButtonInfo`_.                       |
404
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
405
| extraButtonInfoClass          | pull-right                                            | '' (default) or 'pull-right'. See `extraButtonInfo`_.                      |
406
407
408
409
410
411
412
413
414
415
416
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Form-Language                                                                                                                                                      |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Id          | -  E.g.: 1                                            | In Typo3 configured pageLanguage id. The number after the 'L' parameter.   |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| formLanguage[ABCD]Label       | -  E.G.: english                                      | Label shown in *Form editor*, on the 'basic' tab.                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonText                | -                                                     | Text on the form save button. Typically none.                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| saveButtonTooltip             | Save                                                  | Tooltip on the form save button.                                           |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
417
| saveButtonClass               | btn btn-default navbar-btn                            | Bootstrap CSS class for save button on top of the form.                    |
418
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
419
| saveButtonClassOnChange       | alert-info btn-info                                   | Bootstrap CSS class for save button showing 'data changed'.                |
420
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
421
| saveButtonGlyphIcon           | glyphicon-ok                                          | Icon for the form save button.                                             |
422
423
424
425
426
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonText               | -                                                     | Text on the form close button. Typically none.                             |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| closeButtonTooltip            | close                                                 | Tooltip on the form close button.                                          |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
427
| closeButtonClass              | btn btn-default navbar-btn                            | Bootstrap CSS class for close button on top of the form.                   |
428
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
429
| closeButtonGlyphIcon          | glyphicon-remove                                      | Icon for the form close button.                                            |
430
431
432
433
434
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonText              | -                                                     | Text on the form delete button. Typically none.                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| deleteButtonTooltip           | delete                                                | Tooltip on the form delete button.                                         |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
435
| deleteButtonClass             | btn btn-default navbar-btn                            | Bootstrap CSS class for delete button on top of the form.                  |
436
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
437
| deleteButtonGlyphIcon         | glyphicon-trash                                       | Icon for the form delete button.                                           |
438
439
440
441
442
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonText                 | -                                                     | Text on the form new button. Typically none.                               |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonTooltip              | new                                                   | Tooltip on the form new button.                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
443
444
445
| newButtonClass                | btn btn-default navbar-btn                            | Bootstrap CSS class for new button on top of the form.                     |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| newButtonGlyphIcon            | glyphicon-plus                                        | Icon for the form new button.                                              |
446
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
447
| showIdInFormTitle             | 0 (off), 1 (on)                                       | Append at the form title the current record id.                            |
448
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
449
450
| cssClassColumnId              | text-muted                                            | A column in a subrecord with the name id|ID|Id gets this class.            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
451
452


453
.. _config-qfq-php:
454

455
config.qfq.php
456
457
--------------

458
459
460
461
462
463
464
465
466
467
468
469
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| Keyword                       | Example                                               | Description                                                                |
+===============================+=======================================================+============================================================================+
| DB_<n>_USER                   | DB_1_USER=qfqUser                                     | Credentials configured in MySQL                                            |
| DB_<n>_PASSWORD               | DB_1_PASSWORD=1234567890                              | Credentials configured in MySQL                                            |
| DB_<n>_SERVER                 | DB_1_SERVER=localhost                                 | Hostname of MySQL Server                                                   |
| DB_<n>_NAME                   | DB_1_NAME=qfq_db                                      | Database name                                                              |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+
| LDAP_1_RDN                    | LDAP_1_RDN='ou=Admin,ou=example,dc=com'               | Credentials for non-anonymous LDAP access. At the moment only one set of   |
| LDAP_1_PASSWORD               | LDAP_1_PASSWORD=mySecurePassword                      |                                                                            |
+-------------------------------+-------------------------------------------------------+----------------------------------------------------------------------------+

470

471

472
Example: *typo3conf/config.qfq.php*: ::
473

474
    <?php
475

476
477
478
    // QFQ configuration
    //
    // Save this file as: <site path>/typo3conf/config.qfq.php
479

480
481
482
483
484
    return [
        'DB_1_USER' => '<DBUSER>',
        'DB_1_SERVER' => '<DBSERVER>',
        'DB_1_PASSWORD' => '<DBPW>',
        'DB_1_NAME' => '<DB>',
485

486
487
488
489
        //DB_2_USER = <DBUSER>
        //DB_2_SERVER = <DBSERVER>
        //DB_2_PASSWORD = <DBPW>
        //DB_2_NAME = <DB>
490

491
492
        // DB_n ...
        // ...
493

494
495
496
        // LDAP_1_RDN =
        // LDAP_1_PASSWORD =
    ];
497

498
499
After parsing the configuration, the following variables will be set automatically in STORE_SYSTEM:

500
501
502
503
504
+----------------+-----------------------------------------------------------------------------------+
| _dbNameData    | Can be used to dynamically access the current selected database: {{dbNameData:Y}} |
+----------------+-----------------------------------------------------------------------------------+
| _dbNameQfq     | Can be used to dynamically access the current selected database: {{dbNameQfq:Y}}  |
+----------------+-----------------------------------------------------------------------------------+
505

506
507
508
509
.. _`CustomVariables`:

Custom variables
^^^^^^^^^^^^^^^^
510

511
Up to 30 custom variables can be defined in `configuration`_.
512

513
E.g. to setup a contact address and reuse the information inside your installation do: ::
514

515
516
517
   custom1: ADMINISTRATIVE_CONTACT = john@doe.com
   custom2: ADMINISTRATIVE_ADDRESS = John Doe, Hollywood Blvd. 1, L.A.
   custom3: ADMINISTRATIVE_NAME = John Doe
518
519
520
521
522

 * Somewhere in a `Form` or in `Report`::

      {{ADMINISTRATIVE_CONTACT:Y}}, {{ADMINISTRATIVE_ADDRESS:Y}}, {{ADMINISTRATIVE_NAME}}

523
524
It's also possible to configure such variables directly in `config.qfq.php`_.

Carsten  Rose's avatar
Carsten Rose committed
525
.. _`fillStoreSystemBySql`:
526

Carsten  Rose's avatar
Carsten Rose committed
527
528
Fill STORE_SYSTEM by SQL
^^^^^^^^^^^^^^^^^^^^^^^^
529

530
531
A specified SELECT statement in `configuration`_ in variable `fillStoreSystemBySql1` (or `2`,
or `3`) will be fired. The query should have 0 (nothing happens) or 1 row. All columns will be
Carsten  Rose's avatar
Carsten Rose committed
532
**added** to the existing STORE_SYSTEM. Existing variables will be overwritten. Be careful not to overwrite system values.
533
 
Carsten  Rose's avatar
Carsten Rose committed
534
535
536
537
538
539
This option is useful to make generic custom values, saved in the database, accessible to all QFQ Report and Forms.
Access such variables via `{{<varname>:Y}}`.

In case QFQ should stop working if a given query does not select exact one record (e.g. a missing period), define an
error message: ::

540
541
  fillStoreSystemBySql1: SELECT name FROM Person WHERE name='Doe'
  fillStoreSystemBySqlErrorMsg1: Too many or to few "Doe's" in our database
542

543
.. _`periodId`:
544
545
546
547
548
549

periodId
''''''''

This is

Carsten  Rose's avatar
Carsten Rose committed
550
* a usecase, implemented via `fillStoreSystemBySql`_,
551
* a way to access `Period.id` with respect to the current period (the period itself is custom defined).
552

553
After a full QFQ installation:
554
555
556
557

* a table `Period` (extend / change it to your needs, fill them with your periods),
* one sample record in table `Period`,

558
Websites, delivering semester data, school year schedules, or any other type or periods, often need an index to the
Carsten  Rose's avatar
Carsten Rose committed
559
*current* period.
560

561
In configuration_: ::
562

563
	fillStoreSystemBySql1: SELECT id AS periodId FROM Period WHERE start<=NOW() ORDER BY start DESC LIMIT 1
564
565
566
567
568
569
570
571
572
573
574
575
576

a variable 'periodId' will automatically computed and filled in STORE SYSTEM. Access it via `{{periodId:Y0}}`.
To get the name and current period: ::

  SELECT name, ' / ', start FROM Period WHERE id={{periodId:Y0}}

Typically, it's necessary to offer a 'previous' / 'next' link. In this example, the STORE SIP holds the new periodId: ::

  SELECT CONCAT('id={{pageId:T}}&periodId=', {{periodId:SY0}}-1, '|Next') AS _Page, ' ', name, ' ', CONCAT('id={{pageId:T}}&periodId=', {{periodId:SY0}}+1, '|Next') AS _Page FROM Period AS s WHERE s.id={{periodId:SY0}}

Take care for minimum and maximum indexes (do not render the links if out of range).

.. _`DbUserPrivileges`:
577
578
579
580
581
582
583
584
585
586
587
588

DB USER privileges
^^^^^^^^^^^^^^^^^^

The specified DB User needs privileges to the database of at least: SELECT / INSERT / UPDATE / DELETE / SHOW.

To apply automatically QFQ-'DB UPDATE' the following rights are mandatory too: CREATE / ALTER

To get access to the Typo3 installation, 'dbuser' should also have acces to the Typo3 Database with at least SELECT / INSERT / UPDATE / DELETE.



589
590
591
592
593
.. _`ExceptionMaxLength`:

Exception for SECURITY_GET_MAX_LENGTH
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

594
If it is necessary to use a GET variable which exceeds `securityGetMaxLength` limit, name the variable with '_<num>' at
595
the end. E.g. `my_long_variable_130`. Such a variable has an allowed length of 130 chars. Access the variable as
596
597
598
usual with the variable name: `{{my_long_variable_130:C:...}}`.


599
600
601
602
603
.. _local-documentation:

Local Documentation
-------------------

604
A HTML rendered version is available under: <your site>/typo3conf/ext/qfq/Documentation/html/Index.html
605

606
607
If you get a 'Page forbidden / not found' there might be some Webserver restrictions. E.g. the Typo3 example of `.htaccess`
in the Typo3 installation folder will forbid access to any extension documentation (which is a good idea on a productive
608
609
server). For a development server instead, deactivate the forbid rule of 'documentation'. In `.htaccess` (snippet from
Typo3 7.6 _.htaccess): ::
610

611
612
  production:   RewriteRule (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|Documentation|docs?)/ - [F]
  development:  RewriteRule (?:typo3conf/ext|typo3/sysext|typo3/ext)/[^/]+/(?:Configuration|Resources/Private|Tests?|docs?)/ - [F]
613
614
615
616
617
618

.. _concept:

Concept
=======

619
620
621
622
623
SIPs
----

The following is a technical background information. Not needed to just use QFQ.

624
The SIPs (=Server Id Pairs) are uniq timestamps, created/registered on the fly for a specific browser session (=user). Every SIP is
625
626
627
628
629
630
631
632
633
634
635
636
637
638
registered on the server (= stored in a PHP Session) and contains one or more key/value pairs. The key/value pairs never leave
the server. The SIPs will be used:

* to protect values not to be spoofed by anyone,
* to protect values not to be altered by anyone,
* to grant access, e.g.:

  * load and save forms,
  * upload files,
  * download files,
  * PHP AJAX pages.

SIPs becomes invalid, as soon as the current browser session is destroyed. The client (= user) can't manipulate the content
of SIPs - it's only possible to reuse already registered SIPs by the user, who already owns the session.
639
640
641
642
643

Access privileges
-----------------

The Typo3 FE Groups can be used to implement access privileges. Such groups are assigned to
644

645
646
647
648
649
650
651
* Typo3 FE users,
* Typo3 pages,
* and/or Typo3 content records (e.g. QFQ records).

This will be used for general page structure privileges.

A `record base` privileges controlling (e.g. which user can edit
652
653
which person record) will be implicit configured, by the way that records are viewable / editable (or not) through
SQL in the specific QFQ tt-content statements.
654
655
656
657
658
659

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

Insert one or more QFQ content elements on a Typo3 page. Specify column and language per content record as wished.

660
661
The title of the QFQ content element will not be rendered on the frontend. It's only visible to the webmaster in the
backend for orientation.
662
663
664
665
666
667
668
669

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

 +-------------------+---------------------------------------------------------------------------------+
 | Name              | Explanation                                                                     |
 +===================+=================================================================================+
 | form              | Formname defined in ttcontent record bodytext                                   |
670
 |                   | - Fix. E.g.: **form = person**                                                  |
671
 |                   | - by SIP: **form = {{form:SE}}**                                                |
672
 |                   | - by SQL: **form = {{SELECT c.form FROM conference AS c WHERE c.id={{a:C}} }}** |
673
674
 +-------------------+---------------------------------------------------------------------------------+
 | r                 | <record id> The form will load the record with the specified id                 |
675
676
 |                   | - Variants: **r = 123**, by SQL: **r = {{SELECT ...}}**                         |
 |                   | - If not specified, the default is '0'                                          |
677
678
679
680
681
682
683
 +-------------------+---------------------------------------------------------------------------------+
 | <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)                                             |
 +-------------------+---------------------------------------------------------------------------------+
684
 | <level>.shead     | Static start token for whole <level>, independent if records are selected       |
685
 |                   | Shown before `head`.                                                            |
686
 +-------------------+---------------------------------------------------------------------------------+
687
 | <level>.stail     | Static end token for whole <level>, independent if records are selected.        |
688
 |                   | Shown after `tail`.                                                             |
689
690
691
692
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.head      | Dynamic start token for whole <level>. Only if at least one record is select.   |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.tail      | Dynamic end token for whole <level>. Only if at least one record is select.     |
693
694
695
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.rbeg      | Start token for row.                                                            |
 +-------------------+---------------------------------------------------------------------------------+
696
 | <level>.rbgd      | Alternating (per row) token.                                                    |
697
698
699
700
701
702
703
704
705
706
707
 +-------------------+---------------------------------------------------------------------------------+
 | <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                                                                       |
 +-------------------+---------------------------------------------------------------------------------+
708
709
710
 | <level>.althead   | If <level>.sql is empty, these token will be rendered.                          |
 +-------------------+---------------------------------------------------------------------------------+
 | <level>.altsql    | If <level>.sql is empty, these query will be fired. No sub queries.             |
711
 |                   | Shown after `althead`                                                           |
712
 +-------------------+---------------------------------------------------------------------------------+
713
 | debugShowBodyText | If='1' and configuration_:*showDebugInfo: yes*, shows a tooltip with bodytext   |
714
 +-------------------+---------------------------------------------------------------------------------+
715
 | sqlLog            | Overwrites configuration_: `SQL_LOG`_ . Only affects `Report`, not `Form`.      |
716
 +-------------------+---------------------------------------------------------------------------------+
717
 | sqlLogMode        | Overwrites configuration_: `SQL_LOG_MODE`_ . Only affects `Report`, not `Form`. |
718
719
 +-------------------+---------------------------------------------------------------------------------+

720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
.. _`qfq-database`:

QFQ Database
------------

Recommended setup for Typo3 & QFQ Installation is with *two* databases. One for the Typo3 installation and one for QFQ.
A good practice is to name both databases equal, appending the suffix '_t3' and '_db'.

When QFQ is called, it checks for QFQ system tables. If they do not exist or have a lower version than the installed qfq
version, the system tables will be automatically installed or updated.

.. _`system-tables`:

System tables
^^^^^^^^^^^^^

736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
+-------------+------------+------------+
| Name        | Use        | Database   |
+=============+============+============+
| Clipboard   | Temporary  | QFQ        |
+-------------+------------+------------+
| Cron        | Persistent | QFQ        |
+-------------+------------+------------+
| Dirty       | Temporary  | QFQ | Data |
+-------------+------------+------------+
| Form        | Persistent | QFQ        |
+-------------+------------+------------+
| FormElement | Persistent | QFQ        |
+-------------+------------+------------+
| MailLog     | Persistent | QFQ | Data |
+-------------+------------+------------+
| Period      | Persistent | Data       |
+-------------+------------+------------+
| Split       | Persistent | Data       |
+-------------+------------+------------+

* Check Bug #5459 - support of system tables in different DBs not supported.
757

758
759
760
761
.. _`multi-database`:

Multi Database
^^^^^^^^^^^^^^
762

763
764
Base: T3 & QFQ
''''''''''''''
765

766
767
QFQ typically interacts with one database, the QFQ database. The database used by Typo3 is typically a separate one.
Theoretically it might be the same (never tested), but it's strongly recommended to use a separated QFQ database to have
768
no problems on Typo3 updates and to have a clean separation between Typo3 and QFQ
769
770
771
772
773
774
775
776
777
778
779
780

QFQ: System & Data
''''''''''''''''''

QFQ itself can be separated in 'QFQ system' (see `system-tables`_) and 'QFQ data' databases (>=1). The 'QFQ system' stores
the forms, record locking, log tables and so on - `QFQ data` is for the rest.

A `Multi Database` setup is given, if 'QFQ system' is different from 'QFQ data'.

Data: Data1, Data2, ..., Data n
'''''''''''''''''''''''''''''''

781
Every database needs to be configured via `configuration`_ with it's own `index`.
782

783
784
785
`QFQ data` might switch between different 'data'-databases. In configuration_ one main `QFQ data` index will be specified
in `indexQfq`. If specific forms or reports should use a different database than that, `dbIndex` might change
`indexData` temporarily.
786
787

`dbIndex`: A `Report` (field `dbIndex`) as well as a `Form` (field `parameter`.`dbIndex`) can operate on a specific database.
788

789
790
791

A `Form` will:

792
* load the own definition from `indexQfq` (table `Form` and `FormElement`),
793
* loads and save data from/in `indexData` (config.qfq.php) / `dbIndex` (form.parameter.dbIndex),
794
* retrieve extra information via `dbIndexExtra` - this is useful to offer information from a database and save them in a
795
  different one.
796

797
798
The simplest setup, QFQ system & data in the same database, needs no `indexQfq / indexData` definition in
configuration_ or one or both of them set to '1'
799

800
To separate QFQ system and data, indexQfq and indexData will have different indexes.
801
802
803
804
805
806
807


A Multi Database setup might be useful for:

* several independent Typo3 QFQ installations (each have it's own form repository) and one central database, or
* one QFQ installation which should display / load /save records from different databases, or
* a combination of the above two.
808

809
Note:
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831

* Option 'A' is the most simple and commonly used.
* Option 'B' separate the T3 and QFQ databases on two database hosts.
* Option 'C' is like 'B' but with a shared 'QFQ data'-database between three 'Typo3 / QFQ' instances.
* Further variants are possible.

+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
|   | Domain         | Website Host | T3                            | QFQ system                   | QFQ data                         |
+===+================+==============+===============================+==============================+==================================+
| A | standalone.edu | 'w'          | <dbHost>, <dbname>_t3, <dbnameSingle>_db                                                        |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| B | appB1.edu      | 'wApp'       | <dbHostApp>, <dbnameB1>_t3    | <dbHostB1>, <dbnameApp>_db                                      |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| B | appB2.edu      | 'wApp'       | <dbHostApp>, <dbnameB2>_t3    | <dbHostB2>, <dbnameApp>_db                                      |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC1.edu      | 'wAppC'      | <dbHostAppC>, <dbnameC1>_t3   | <dbHostC>, <dbnameSysC1>_db  | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC2.edu      | 'wAppC'      | <dbHostAppC>, <dbnameC2>_t3   | <dbHostC>, <dbnameSysC2>_db  | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+
| C | appC3.edu      | 'wAppC3'     | <dbHostAppC3>, <dbnameC3>_t3  | <dbHostC3>, <dbnameSysC3>_db | <dbHostData>_db, <dbNameData>_db |
+---+----------------+--------------+-------------------------------+------------------------------+----------------------------------+

832
In config-qfq-php_ mutliple database credentials can be prepared. Mandatory is at least one credential setup like
833
834
835
`DB_1_USER`, `DB_1_SERVER`, `DB_1_PASSWORD`, `DB_1_NAME`. The number '1' indicates the `dbIndex`. Increment the number
to specify further database credential setups.

836
Typically the credentials for `DB_1`  also have access to the T3 database.
837
838
839
840
841
842


Different QFQ versions, shared database
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

When using different QFQ versions and a shared 'QFQ data'-database, there is some risk of conflicting
843
'QFQ system' tables. Best is to always use the same QFQ version on all instances ot use a Multi Database setup.
844

845
846
847
.. _debug:

Debug
848
849
850
851
=====

SQL Logging
-----------
852

853
configuration_
854
855
856

.. _SQL_LOG:

857
* *sqlLog*
858
859

  * Filename where to log SQL queries and statistical data.
860
  * File is relative to the `<site path>` or absolute (starting with '/').
861
862
863
  * Content: SQL queries and timestamp, formName/formId, fe_user, success, affected rows, newly created record
    id's and accessed from IP.
  * The global setting can be overwritten by defining `sqlLog` inside of a QFQ tt-content record.
864

865
866
867

.. _SQL_LOG_MODE:

868
* *sqlLogMode: all|modify|error|none*
869
870
871
872
873
874
875

  * *all*: logs every SQL statement.
  * *modify*: logs only statements who might potentially change data.
  * *error*: logs only queries which generate SQL errors.
  * *none*: no query logging at all.
  * The global setting can be overwritten by defining `sqlLogMode` inside of a QFQ tt-content record.

876
* *showDebugInfo = [yes|no|auto],[download]*
877
878

  If active, displays additional information in the Frontend (FE). This is typically helpful during development.
879
880
881
882
883
884

  * *yes*:

    * Form:

      * For every internal link/button, show tooltips with decoded SIP on mouseover.
885
      * Shows an 'Edit form'-button (wrench symbol) on a form. The link points to the T3 page with the :ref:`form-editor`.
886
887
888
889
890
891
892
893
894

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

      *debugShowBodyText = 1*

  * *no*: No debug info.

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

895
896
    * *showDebugInfo = yes*  (BE session exist)
    * *showDebugInfo = no*   (no BE session)
897

898
899
900
  * *download*:

    * During a download (especially by using wkhtml), temporary files are not deleted automatically. Also the
901
      `wkhtmltopdf` and `pdftk` commandlines will be logged to `SQL_LOG`_. Use this only to debug problems on download.
902

903
904
.. _REDIRECT_ALL_MAIL_TO:

905
906
907
Redirect all mail to (catch all)
--------------------------------

908
configuration_
909

910
* *redirectAllMailTo=john@doe.com*
911
912
913
914
915
916
917
918
919

  * During the development, it might be helpful to configure a 'catch all' email address, which QFQ uses as the final receiver
    instead of the original intended one.

  * The setting will:

    * Replace the 'To' with the configured one.
    * Clear 'CC' and 'Bcc'
    * Write a note and the original configured receiver at the top of the email body.
920
921
922

.. _variables:

923
924
Variable
========
925

926
927
Variables in QFQ are surrounded by double curly braces. Four different types of variable substitution functionality is
provided. Access to:
928

929
930
* `store-variables`_
* `sql-variables`_
931
932
* `row-column-variables`_
* `link-column-variables`_
933

934
Some examples, including nesting::
935

936
937
938
939
  # Store
  #---------------------------------------------
  {{r}}
  {{index:FS}}
940
  {{name:FS:alnumx:s:my default}}
941

942
943
944
  # SQL
  #---------------------------------------------
  {{SELECT name FROM person WHERE id=1234}}
945

946
  # Row columns
947
948
949
  #---------------------------------------------
  {{10.pId}}
  {{10.20.pId}}
950

951
952
953
954
955
  # Nesting
  #---------------------------------------------
  {{SELECT name FROM person WHERE id={{r}} }}
  {{SELECT name FROM person WHERE id={{key1:C:alnumx}} }} # explained below
  {{SELECT name FROM person WHERE id={{SELECT id FROM pf LIMIT 1}} }} # it's more efficient to use only one query
956

957
958
  # Link Columns
  {{p:form=Person&r=1|t:Edit Person|E|s AS link}}
959

960
Leading and trailing spaces inside curly braces are removed.
961

962
963
  * *{{ SELECT "Hello World"   }}* becomes *{{SELECT "Hello World"}}*
  * *{{ varname   }}* becomes *{{varname}}*
964

965
966
Types
-----
967

968
.. _`store-variables`:
969

970
971
Store variables
^^^^^^^^^^^^^^^
972

973
Syntax:  *{{VarName[:<store / prio>[:<sanitize class>[:<escape>[:<default>]]]]}}*
974

975
* Example::
976

977
978
979
980
  {{pId}}
  {{pId:FSE}}
  {{pId:FSE:digit}}
  {{name:FSE:alnumx:m}}
981
  {{name:FSE:alnumx:m:John Doe}}
982

983
984
985
* Zero or more stores might be specified to be searched for the given VarName.
* If no store is specified, the by default searched stores are: **FSRVD** (=FORM > SIP > RECORD > VARS > DEFAULT).
* If the VarName is not found in one store, the next store is searched,  up to the last specified store.
986
987
* If the VarName is not found and a default value is given, the default is returned.
* If no value is found, nothing is replaced - the string '{{<VarName>}}' remains.
988
* If anywhere along the line an empty string is found, this **is** a value: therefore, the search will stop.
989

990
See also:
991

992
993
994
 * `store`_
 * `variable-escape`_
 * `sanitize-class`_
995

996

997
.. _`sql-variables`:
998

999
1000
SQL variables
^^^^^^^^^^^^^