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

AdministratorManual/Index.rst: Installation of sphinx added

UsersManual/Index.rst: fixed some typos, replace sanatize class enumeration against table.
parent 1b08409a
......@@ -20,19 +20,28 @@ native driver (see also: http://dev.mysql.com/downloads/connector/php-mysqlnd/):
* mysqli::get_result (important),
* mysqli::fetch_all (nice to use)
Installation for Ubuntu::
Preparation for Ubuntu 14.04::
sudo apt-get install php5-mysqlnd
sudo php5enmod mysqlnd
sudo service apache2 restart
Preparation steps for Ubuntu 16.04::
none
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`.
* Activate the Documentation_.
* Copy/rename the file *<ext_dir>/config.example.qfq.ini* to *typo3conf/config.qfq.ini* and configure the necessary values: `config.qfq.ini`_
* Play the SQL File *<ext_dir>/qfq/sql/formEditor.sql* to fill the database with the *FormEditor* records.
* Configure Typoscript to include Bootstrap, jQuery and QFQ javascript and CSS files.
* Configure Typoscript to include Bootstrap, jQuery, QFQ javascript and CSS files.
::
......@@ -62,9 +71,9 @@ Setup a *report* to manage all *forms*: Create a Typo3 page and insert a content
::
form = {{form}}
form = {{form:T}}
10 {
sql = SELECT CONCAT('{{pageId}}&form=Form&r=', f.id) as Pagee, f.id, f.name, f.title, f.tableName FROM FormEditor As f ORDER BY f.name
sql = SELECT CONCAT('{{pageId}}&form=Form&r=', f.id) as Pagee, f.id, f.name, f.title, f.tableName FROM Form AS f ORDER BY f.name
head = <br><table class="table">
tail = </table>
rbeg = <tr class="table-hover">
......@@ -73,8 +82,9 @@ Setup a *report* to manage all *forms*: Create a Typo3 page and insert a content
fend = </td>
}
config.qfq.ini
--------------------
--------------
+------------------------+----------------------------------+----------------------------------------------------------------------------+
| Keyword | Example | Description |
......@@ -119,4 +129,18 @@ Example: *typo3conf/config.qfq.ini*
SQL_LOG = sql.log
SHOW_DEBUG_INFO = auto
CSS_LINK_CLASS_INTERNAL = internal
CSS_LINK_CLASS_EXT = external
\ No newline at end of file
CSS_LINK_CLASS_EXT = external
Documentation
-------------
To render the QFQ reST documentation:
* Install the extension "Sphinx Python Documentation Generator and Viewer" (sphinx).
* Execute the update script (symbol 'two arrows as a circle' behind the extension name)
* Choose 'Sphinx 1.4.4' - click on 'Import'.
* In the Exension Manager open the configuration dialog of the extension 'sphinx'. Activate the 'Sphinx 1.4.4' option and save it.
* On top of the browser window click on the 'question mark' to open the menu, choose 'Sphinx'.
* Show doumentation 'QFQ Extension'
......@@ -191,14 +191,26 @@ Sanitize class
the default class is 'digit'.
* A default sanitize class can be overwritten by individual definition: *{{a:C:all}}*
* **alnumx**: [A-Za-z][0-9]@-_.,;: /()
* **digit**: [0-9].-+
* **email**: [a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}
* **min|max**: only usable in forms. Compares the value against an lower and upper limit (numeric or string).
* **min|max date**: only usable in forms. Compares the value against an lower and upper date or datetime.
* **pattern**: only usable in forms. Compares the value against a regexp.
* **allbut**: all characters allowed, but not [ ] { } % & \ #. The used regexp: '^[^\[\]{}%&\\#]+$',
* **all**: no sanitizing
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| Name | Form | Query | Pattern |
+==================+======+=======+=========================================================================================+
| **alnumx** | Form | Query | [A-Za-z][0-9]@-_.,;: /() |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
| **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 |
+------------------+------+-------+-----------------------------------------------------------------------------------------+
Store / prio
......@@ -449,7 +461,7 @@ SQL Statement
* Special case for SELECT input fields. To deliver a result array specify an '!' before the SELECT: ::
*{{!SELECT ...}}*
{{!SELECT ...}}
* This is only possible for the outermost SELECT.
......@@ -1782,7 +1794,7 @@ Columns: _Page[X]
::
[<page id|alias>[&param=value&...]] | [text] | [tooltip] | [question parameter] | [class] | [target] | [render mode] | [create sip] "" as _pagee.
[<page id|alias>[&param=value&...]] | [text] | [tooltip] | [question parameter] | [class] | [target] | [render mode] | [create sip] "" as _Pagee.
..
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment