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

Fixed Typo

parent 36640f77
Pipeline #1558 passed with stage
in 2 minutes and 7 seconds
......@@ -1302,8 +1302,8 @@ If a value violates the sanitize class, instead of content on of the following t
* 'c' - The violated class will be set as content, surrounded by '!!'. E.g. '!!digit!!'. This is the default.
* 'e' - Instead of the value an empty string will be set as content.
* '0' - Instead of the value the string '0' will be set as content.
* 'custom text ...' - Instead of the value the custom text will be set as content. If the text contains a ':', that one needs to
be escaped by '\'. Check `variable-escape`_ qualifier 'C' to let QFQ do the colon escaping.
* 'custom text ...' - Instead of the value the custom text will be set as content. If the text contains a ':', that one
needs to be escaped by '\'. Check `variable-escape`_ qualifier 'C' to let QFQ do the colon escaping.
.. _`sql-variables`:
......@@ -3643,14 +3643,14 @@ See also `downloadButton`_ to offer a download of an uploaded file.
* *chmodFile* = <unix file permission mode> - e.g. `660` for owner and group read and writeable. Only the numeric mode is allowed.
* *chmodDir* = <unix file permission mode> - e.g. `770` for owner and group read, writeable and executable. Only the
numeric mode is allowed. Will be applied to all new created directories.
numeric mode is allowed. Will be applied to all new created directories.
* autoOrient: images might contain EXIF data (e.g. captured via mobile phones) incl. an orientation tag like TopLeft,
BottomRight and so on. Web-Browser and other grafic programs often understand and respect those information and rotate
such images automatically. If not, the image might be displayed in an unwanted oritentation.
With active option 'autoOrient', QFQ tries to normalize such images via 'convert' (part of ImageMagick). Especially
if images are processed by the QFQ internal 'Fabric'-JS it's recommended to normalize images first. The normalization
process does not solve all orientation problems.
BottomRight and so on. Web-Browser and other grafic programs often understand and respect those information and rotate
such images automatically. If not, the image might be displayed in an unwanted oritentation.
With active option 'autoOrient', QFQ tries to normalize such images via 'convert' (part of ImageMagick). Especially
if images are processed by the QFQ internal 'Fabric'-JS it's recommended to normalize images first. The normalization
process does not solve all orientation problems.
* *autoOrient* = [0|1]
* *autoOrientCmd* = 'convert -auto-orient {{fileDestination:V}} {{fileDestination:V}}.new; mv {{fileDestination:V}}.new {{fileDestination:V}}'
......@@ -3661,7 +3661,7 @@ See also `downloadButton`_ to offer a download of an uploaded file.
.. _`downloadButton`:
* *downloadButton* = `t:<string>` - If given, shows a button to download the previous uploaded file - instead of the string given in
`fe.value`. The button is only shown if `fe.value` points to a readable file on the server.
`fe.value`. The button is only shown if `fe.value` points to a readable file on the server.
* If `downloadButton` is empty, just shows the regular download glyph.
* To just show the filename: `downloadButton = t:{{filenameOnly:V}}`
......@@ -7424,12 +7424,12 @@ last used (STORE_USER) or (first time call during browser session) takes the def
}
.. _`rest`:
.. _`restApi`:
REST
====
Via `REST https://en.wikipedia.org/wiki/Representational_state_transfer`_ it's possible to access the QFQ based
Via `REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`_ it's possible to access the QFQ based
application. Each REST API endpoint has to be defined as a QFQ Form. The QFQ REST api implements the
four most used REST HTTP methods:
......@@ -7501,7 +7501,7 @@ Only the last <level> of an URI will be processed. The former ones are just to f
GET - Read
----------
A REST (GET) form has two modes: ::
A REST (GET) form has two modes:
data
Specific content to a given id. Defined via 'form.parameter.restSqlData'. This mode is selected if there is an
......@@ -7687,7 +7687,7 @@ Example: ::
Test via commandline: curl -X GET -H 'Authorization: Token token=myCrypticString0123456789' "http://localhost/qfq/typo3conf/ext/qfq/Source/api/rest.php/person/123/address/"
The static setup with `form.parameter.restToken=myCrypticString0123456789 is fine, as long as only one token
The static setup with ``form.parameter.restToken=myCrypticString0123456789`` is fine, as long as only one token
exist. In case of multiple tokens, replace the static string against a SQL query.
.. tip::
......@@ -7701,7 +7701,7 @@ Best Practice: For example all created tokens are saved in a table 'Auth' with a
To restrict access to a subset of data, just save the limitations inside the Auth record and update the query
to check it:
.. code-block:: pmysql
.. code-block:: mysql
form.parameter.restToken={{SELECT a.token FROM Auth AS a WHERE a.token='{{Authorization:C:alnumx}}'}}
form.parameter.restSqlList={{!SELECT p.id, p.name, p.email FROM Person AS p, Auth AS a WHERE a.token='{{Authorization:C:alnumx}}' AND a.attribute=p.attribute}}
......
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