Commit 757ec754 authored by Carsten  Rose's avatar Carsten Rose
Browse files

Documentation/AdministratorManual: Installation described

parent ae619664
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _admin-manual:
Administrator Manual
====================
Setup
-----
* Install the extension via the Extensionmanager.
* Rename the file *<ext_dir>/config.example.ini* to *<ext_dir>/config.ini* and configure the necessary values: `<ext_dir>/config.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.
::
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.darkblue.css
file5 = typo3conf/ext/qfq/Resources/Public/Css/qfq-bs.css
}
page.includeJS {
file1 = typo3conf/ext/qfq/Resources/Public/JavaScript/jquery.min.js
file2 = typo3conf/ext/qfq/Resources/Public/JavaScript/bootstrap.min.js
file3 = typo3conf/ext/qfq/Resources/Public/JavaScript/jqx-all.js
file4 = typo3conf/ext/qfq/Resources/Public/JavaScript/qfq-min.js
}
FormEditor
----------
Setup a *report* to manage all *forms*: Create a Typo3 page and insert a content record of type *qfq*. In the bodytext insert the following code:
::
form = {{form}}
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
10.head = <br><table class="table">
10.tail = </table>
10.rbeg = <tr class="table-hover">
10.rend = </tr>
10.fbeg = <td>
10.fend = </td>
<ext_dir>/config.ini
--------------------
+------------------------+--------------+----------------------------------------------------------------------------+
| Keyword | Example | Description |
+========================+==============+============================================================================+
| DBUSER | qfqUser | Credentials configured in MySQL |
+------------------------+--------------+----------------------------------------------------------------------------+
| DBPW | 12345678 | Credentials configured in MySQL |
+------------------------+--------------+----------------------------------------------------------------------------+
| DBSERVER | localhost | Hostname of MySQL Server |
+------------------------+--------------+----------------------------------------------------------------------------+
| DB | qfq_db | Database name |
+------------------------+--------------+----------------------------------------------------------------------------+
| TESTDB | qfq_db_test | Used during development of QFQ |
+------------------------+--------------+----------------------------------------------------------------------------+
| SESSIONNAME | qfq | By default 'qfq' |
+------------------------+--------------+----------------------------------------------------------------------------+
| SQLLOG | sql.log | filename to log all SQL commands |
+------------------------+--------------+----------------------------------------------------------------------------+
| SHOW_DEBUG_INFO | auto | Possible values: auto|yes|no. For 'auto': If a BE User is logged in, |
| | | debug information will be shown on the fronend. |
+------------------------+--------------+----------------------------------------------------------------------------+
| CSS_LINK_CLASS_INTERNAL| internal | CSS class name of links which points to internal tagets |
+------------------------+--------------+----------------------------------------------------------------------------+
| CSS_LINK_CLASS_EXTERNAL| external | CSS class name of links which points to internal tagets |
+------------------------+--------------+----------------------------------------------------------------------------+
Example:
::
DBUSER = qfqUser
DBSERVER = localhost
DBPW = 12345678
DB = qfq_db
TESTDB = qfq_db_test
SESSIONNAME = qfq
SQLLOG = sql.log
SHOW_DEBUG_INFO = auto
CSS_LINK_CLASS_INTERNAL = internal
CSS_LINK_CLASS_EXT = external
\ No newline at end of file
.. ==================================================
.. FOR YOUR INFORMATION
.. --------------------------------------------------
.. -*- coding: utf-8 -*- with BOM.
.. include:: ../Includes.txt
.. _admin-manual:
Administrator Manual
====================
Describes how to manage the extension from an administrator’s point of
view. That relates to Page/User TSconfig, permissions, configuration
etc., which administrator level users have access to.
Language should be non/semi-technical, explaining, using small
examples.
Target group: **Administrators**
Installation
------------
How should the extension be set up? E.g. is there a static template to include?
.. figure:: ../Images/AdministratorManual/ExtensionManager.png
:width: 500px
:alt: Extension Manager
Extension Manager (caption of the image)
List of extensions within the Extension Manager also shortend as "EM" (legend of the image)
FAQ
^^^
Possible subsection: FAQ
...@@ -57,5 +57,6 @@ QFQ Extension ...@@ -57,5 +57,6 @@ QFQ Extension
:maxdepth: 4 :maxdepth: 4
Introduction/Index Introduction/Index
AdministratorManual/Index
UsersManual/Index UsersManual/Index
Links Links
...@@ -94,9 +94,7 @@ URL Parameter ...@@ -94,9 +94,7 @@ URL Parameter
------------- -------------
* URL (=GET) Parameter can be used in *forms* and *reports* as variables. * URL (=GET) Parameter can be used in *forms* and *reports* as variables.
* Every parameter has to be declared in 'Form.url_parameter_type', together with a sanitize class. * If a value a parameter sanitize class, an exception is thrown.
* Undeclared parameter or parameter without a sanitize class, are classified as *digit*.
* Violates the value of a parameter the sanitize class, such a value will be cleared (empty string).
Sanitize class Sanitize class
-------------- --------------
......
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