[TASK] Update documentation 51/47851/2
authorFrancois Suter <francois@typo3.org>
Fri, 22 Apr 2016 11:37:03 +0000 (13:37 +0200)
committerFrancois Suter <francois@typo3.org>
Fri, 22 Apr 2016 11:39:49 +0000 (13:39 +0200)
Also fix a minor error in the TCA.

Resolves: #75863
Releases: 2.0
Change-Id: Ie1c0ca41ec0642947e2c8532030a25551eebb8a6
Reviewed-on: https://review.typo3.org/47851
Reviewed-by: Francois Suter <francois@typo3.org>
Tested-by: Francois Suter <francois@typo3.org>
Configuration/TCA/tx_dataquery_queries.php
Documentation/Images/AdditionalSqlField.png
Documentation/Images/DataqueryRecord.png
Documentation/Images/DataqueryRecordAdvancedTab.png
Documentation/Images/DataqueryRecordGeneralTab.png
Documentation/Images/DataqueryRecordIgnoreSettings.png
Documentation/Index.rst
Documentation/Settings.yml
Documentation/User/Index.rst

index aa1237c..f68a7a2 100644 (file)
@@ -78,7 +78,7 @@ return array(
                ),
                'fulltext_indices' => array(
                        'exclude' => 0,
-                       'label' => 'LLL:EXT:dataquery/locallang_db.xlf:tx_dataquery_queries.fulltext_indices',
+                       'label' => 'LLL:EXT:dataquery/Resources/Private/Language/locallang_db.xlf:tx_dataquery_queries.fulltext_indices',
                        'config' => array(
                                'type' => 'user',
                                'userFunc' => 'Tesseract\Dataquery\UserFunction\FormEngine->renderFulltextIndices',
index 13238ff..0c07d4a 100644 (file)
Binary files a/Documentation/Images/AdditionalSqlField.png and b/Documentation/Images/AdditionalSqlField.png differ
index debf77f..3da6635 100644 (file)
Binary files a/Documentation/Images/DataqueryRecord.png and b/Documentation/Images/DataqueryRecord.png differ
index da6303c..8f5eb49 100644 (file)
Binary files a/Documentation/Images/DataqueryRecordAdvancedTab.png and b/Documentation/Images/DataqueryRecordAdvancedTab.png differ
index 28cc56f..2c3c841 100644 (file)
Binary files a/Documentation/Images/DataqueryRecordGeneralTab.png and b/Documentation/Images/DataqueryRecordGeneralTab.png differ
index 3c9ada4..b1ccbd8 100644 (file)
Binary files a/Documentation/Images/DataqueryRecordIgnoreSettings.png and b/Documentation/Images/DataqueryRecordIgnoreSettings.png differ
index cfc6733..30d8845 100644 (file)
@@ -27,7 +27,7 @@ SQL-based Data Query
                  tesseract, sql, database, data consumer
 
        :Copyright:
-                 2007-2015
+                 2007-2016
 
        :Author:
                  Fran├žois Suter (Cobweb)
index 2b5310f..fe1bc02 100644 (file)
@@ -4,10 +4,10 @@
 
 ---
 conf.py:
-  copyright: 2007-2015
+  copyright: 2007-2016
   project: Data Query
-  version: 1.11
-  release: 1.11.1
+  version: 2.0
+  release: 2.0.0
   latex_documents:
   - - Index
     - dataquery.tex
index 979deb9..1d7ceb0 100644 (file)
@@ -23,7 +23,7 @@ General tab
 .. figure:: ../Images/DataqueryRecordGeneralTab.png
        :alt: General tab of dataquery record
 
-       The "General" tab of a dataquery record, with query verified
+       The "General" tab of a dataquery record
 
 The "Hide" field is currently not actively used (i.e. the
 Display Controller does not check for it). It can be used to indicate
@@ -42,9 +42,9 @@ Next to the "SQL query" field is a "Validate Query" button, which can
 be used to verify that the query is alright. It does two checks:
 
 - first, it parses the query and rebuilds it. The internal query parser
-  may come up with errors at that point. If it doesn't the success
-  message will display the resulting query (as in the screenshot above).
-  Note that here TYPO3 mechanisms (see below) and Data Filters are not
+  may come up with errors at that point. If it doesn't a success
+  message will display the resulting query.
+  Note that here TYPO3 CMS mechanisms (see below) and Data Filters are not
   applied. It is only the "raw" query, as typed in the text field, that
   is parsed.
 
@@ -53,6 +53,10 @@ be used to verify that the query is alright. It does two checks:
   query before executing it, to avoid draining server resources
   needlessly.
 
+The "Full Text Indices" field indicates if any fulltext index
+exists for the main table of the query and gives hint about how
+to use it.
+
 
 .. _user-manual-advanced:
 
@@ -64,12 +68,12 @@ Advanced tab
 
        The "Advanced" tab of a dataquery record
 
-The "Cache duration" field defines the period during which the
-result of the query must be kept in cache. The default is 86400
-seconds (1 day). Setting a value of 0 disables the cache.
+The "Cache duration" field defines the period (in seconds) during which the
+result of the query must be kept in cache. The default is 0,
+meaning that the cache is disabled.
 See also the :ref:`Caching chapter <behind-the-scenes-caching>`.
 
-By default, "dataquery" transparently handles all of TYPO3's enable
+By default, "dataquery" transparently handles all of TYPO3 CMS's enable
 fields, i.e. hidden or disabled flag, start and end time, and
 fe\_groups access rights. This makes it very convenient to use, but
 may be undesired in some specific situations. In such a case, it is
@@ -104,9 +108,7 @@ On top of this, "dataquery" also transparently handles everything
 related to language overlays. Again it is possible to disable that
 behavior by checking the "Language handling" box. On a finer level,
 it's possible to give a list of table for which language overlays (and
-conditions) should not be applied (in the above screenshot, records
-from table "tx\_dam" will be taken in the default language and kept as
-is).
+conditions) should not be applied.
 
 Data Query also handles versioning transparently, as soon as it is
 used within a workspace. This behavior cannot be switched off. However