[DOCS] Fix documentation after first test rendering

cobwebch · Oct 18, 2020 · 3fc2ef2 · 3fc2ef2
1 parent 703cbe3
commit 3fc2ef2
Show file tree

Hide file tree

Showing 11 changed files with 81 additions and 63 deletions.
diff --git a/Documentation/Administration/Children/Index.rst b/Documentation/Administration/Children/Index.rst
@@ -59,10 +59,10 @@ Properties
 
 .. container:: ts-properties
 
-	========================= ==================== ===================
-	Property                  Data type            Step/Scope
-	========================= ==================== ===================
-	table_                    string               Store data
+   ========================= ==================== ===================
+   Property                  Data type            Step/Scope
+   ========================= ==================== ===================
+   table_                    string               Store data
    columns_                  array                Store data
    controlColumnsForUpdate_  string               Store data
    controlColumnsForDelete_  string               Store data

diff --git a/Documentation/Administration/Columns/Index.rst b/Documentation/Administration/Columns/Index.rst
@@ -47,25 +47,25 @@ Properties
 
 .. container:: ts-properties
 
-	========================= ====================================================================== ===================
-	Property                  Data type                                                              Step/Scope
-	========================= ====================================================================== ===================
-	arrayPath_                string                                                                 Handle data (array)
-	arrayPathSeparator_       string                                                                 Handle data (array)
-	attribute_                string                                                                 Handle data (XML)
-	attributeNS_              string                                                                 Handle data (XML)
+   ========================= ====================================================================== ===================
+   Property                  Data type                                                              Step/Scope
+   ========================= ====================================================================== ===================
+   arrayPath_                string                                                                 Handle data (array)
+   arrayPathSeparator_       string                                                                 Handle data (array)
+   attribute_                string                                                                 Handle data (XML)
+   attributeNS_              string                                                                 Handle data (XML)
    children_                 :ref:`Children records configuration <administration-children>`        Store data
-	disabledOperations_       string                                                                 Store data
-	field_                    string                                                                 Handle data
-	fieldNS_                  string                                                                 Handle data (XML)
-	MM_                       :ref:`MM configuration <administration-mm>`                            Store data
+   disabledOperations_       string                                                                 Store data
+   field_                    string                                                                 Handle data
+   fieldNS_                  string                                                                 Handle data (XML)
+   MM_                       :ref:`MM configuration <administration-mm>`                            Store data
    multipleRows_             boolean                                                                Store data
    multipleSorting_          string                                                                 Store data
-	substructureFields_       array                                                                  Handle data
-	transformations_          :ref:`Transformations configuration <administration-transformations>`  Transform data
-	xmlValue_                 boolean                                                                Handle data (XML)
-	xpath_                    string                                                                 Handle data (XML)
-	========================= ====================================================================== ===================
+   substructureFields_       array                                                                  Handle data
+   transformations_          :ref:`Transformations configuration <administration-transformations>`  Transform data
+   xmlValue_                 boolean                                                                Handle data (XML)
+   xpath_                    string                                                                 Handle data (XML)
+   ========================= ====================================================================== ===================
 
 
 .. _administration-columns-properties-field:
@@ -386,7 +386,7 @@ Description
 
    Obviously if you have a single element in the nested structure, no denormalisation happens.
    Due to this denormalisation you probably want to use this property in conjunction with the
-   :ref:`multipleRows <administration-columns-properties-multiple-rows` or
+   :ref:`multipleRows <administration-columns-properties-multiple-rows>` or
    :ref:`children <administration-columns-properties-children>` properties.
 
    .. note::
@@ -413,7 +413,7 @@ Description
 
    .. warning::
 
-      This property is deprecated. Use :ref:`multipleRows <administration-columns-properties-multiple-rows`
+      This property is deprecated. Use :ref:`multipleRows <administration-columns-properties-multiple-rows>`
       or :ref:`children <administration-columns-properties-children>` according to your needs.
 
 Scope

diff --git a/Documentation/Administration/GeneralTca/Index.rst b/Documentation/Administration/GeneralTca/Index.rst
@@ -400,7 +400,7 @@ Type
   string
 
 Description
-  This property is not part of the general information anymore. Please refer to
+  This property is not part of the general configuration anymore. Please refer to
   :ref:`the dedicated chapter <administration-additionalfields>`.
 
 Scope

diff --git a/Documentation/Administration/LogCleanup/Index.rst b/Documentation/Administration/LogCleanup/Index.rst
@@ -10,5 +10,10 @@ The log table can be cleaned up automatically using the *Table garbage collectio
 
 A new entry for that task can be created with the following options:
 
-* *Table to clean up*: :sql:`tx_externalimport_domain_model_log`
+* *Table to clean up*: :code:`tx_externalimport_domain_model_log`
 * *Delete entries older than given number of days*: 30 (default)
+
+A pre-configuration exists in the :file:`ext_localconf.php` file with a configuration
+of 180 days.
+
+If you run a lot of imports, make sure that this table is cleaned up regularly.
diff --git a/Documentation/Administration/Mapping/Index.rst b/Documentation/Administration/Mapping/Index.rst
@@ -201,7 +201,7 @@ Description
   .. note::
 
      This property does nothing when used in combination with the
-     :ref:`MM property <administration-mm>`, because we expect denoramlized
+     :ref:`MM property <administration-mm>`, because we expect normalized
      data with one and denormalized data with the other. The chapter about
      :ref:`mapping data <user-mapping-data-mm>` hopefully helps understand this.
 

diff --git a/Documentation/Administration/MmRelations/Index.rst b/Documentation/Administration/MmRelations/Index.rst
@@ -11,9 +11,9 @@ configuration is required. The related properties are described below.
 
 .. warning::
 
-   This property is deprecated. Use :ref:`multipleRows <administration-columns-properties-multiple-rows`
+   This property is deprecated. Use :ref:`multipleRows <administration-columns-properties-multiple-rows>`
    or :ref:`children <administration-columns-properties-children>` according to your needs. If you used
-   the "sorting" property, use :ref:`multipleSorting <administration-columns-properties-multiple-sorting` instead.
+   the "sorting" property, use :ref:`multipleSorting <administration-columns-properties-multiple-sorting>` instead.
 
    Depending on how you used this property, there's no fallback and you will need to change your code.
    If your need was to enrich a MM table with additional information, change your TCA to use an IRRE

diff --git a/Documentation/Administration/Transformations/Index.rst b/Documentation/Administration/Transformations/Index.rst
@@ -135,13 +135,13 @@ Description
 				]
 		];
 
-  A user function requires three parameters:
+  The definition of a user function takes three parameters:
 
   class
-    *(string)* Name of the class to be instantiated.
+    *(string)* Required. Name of the class to be instantiated.
 
   method
-    *(string)* Defines which method of the class should be called.
+    *(string)* Required. Name of the method that should be called.
 
   params
     *(array)* Optional. Can contain any number of data, which will be passed

diff --git a/Documentation/Appendix/Index.rst b/Documentation/Appendix/Index.rst
@@ -78,40 +78,40 @@ This is an ordered array, which makes it possible to use transformation properti
 on the same field (e.g. calling several user functions) and to do that in a precise order.
 As an example, usage of such properties should be changed from:
 
-  .. code-block:: php
+.. code-block:: php
 
-		$GLOBALS['TCA']['fe_users']['columns']['starttime']['external'] = [
-				0 => [
-						'field' => 'start_date',
-						'trim' => true
-						'userFunc' => [
-								'class' => \Cobweb\ExternalImport\Task\DateTimeTransformation::class,
-								'method' => 'parseDate'
-						]
-				]
-		];
+   $GLOBALS['TCA']['fe_users']['columns']['starttime']['external'] = [
+         0 => [
+               'field' => 'start_date',
+               'trim' => true
+               'userFunc' => [
+                     'class' => \Cobweb\ExternalImport\Task\DateTimeTransformation::class,
+                     'method' => 'parseDate'
+               ]
+         ]
+   ];
 
 
 to:
 
-  .. code-block:: php
-
-		$GLOBALS['TCA']['fe_users']['columns']['starttime']['external'] = [
-				0 => [
-						'field' => 'start_date',
-						'transformations => [
-								10 => [
-										'trim' => true
-								],
-								20 => [
-										'userFunc' => [
-												'class' => \Cobweb\ExternalImport\Task\DateTimeTransformation::class,
-												'method' => 'parseDate'
-										]
-								]
-						]
-				]
-		];
+.. code-block:: php
+
+   $GLOBALS['TCA']['fe_users']['columns']['starttime']['external'] = [
+         0 => [
+               'field' => 'start_date',
+               'transformations => [
+                     10 => [
+                           'trim' => true
+                     ],
+                     20 => [
+                           'userFunc' => [
+                                 'class' => \Cobweb\ExternalImport\Task\DateTimeTransformation::class,
+                                 'method' => 'parseDate'
+                           ]
+                     ]
+               ]
+         ]
+   ];
 
 
 If you want to preserve "old-style" order, the transformation properties were called in the

diff --git a/Documentation/Installation/Index.rst b/Documentation/Installation/Index.rst
@@ -38,7 +38,7 @@ with all the same options as standard column mappings. Backwards-compatibility i
 For more details, :ref:`see the relevant chapter <administration-additionalfields>`.
 
 The "MM" property is deprecated. It should not be used anymore. Instead the new
-:ref:`multipleRows <administration-columns-properties-multiple-rows` or
+:ref:`multipleRows <administration-columns-properties-multiple-rows>` or
 :ref:`children <administration-columns-properties-children>` properties
 should be used according to your import scenario.
 
@@ -59,7 +59,7 @@ Breaking changes
 ~~~~~~~~~~~~~~~~
 
 The :php:`\Cobweb\ExternalImport\Step\StoreDataStep` class puts the list of stored
-records into the "records" member variable of the `\Cobweb\ExternalImport\Domain\Model\Data`
+records into the "records" member variable of the :php:`\Cobweb\ExternalImport\Domain\Model\Data`
 object. This used to be a simple list of records for the imported table. Since child
 tables are now supported, the structure has changed so that there's now a list of
 records for each table that was imported. The table name is the key in the first

diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst
@@ -96,4 +96,14 @@ extension. You will get mentioned here.
   `State of Vaud <http://vd.ch>`_.
 
 - The :ref:`xmlValue <administration-columns-properties-xmlvalue>`
-  property was sponsored by `Bendoo e-work solutions <http://www.bendoo.nl/en/>`_.
+  property was sponsored by `Bendoo e-work solutions <https://www.bendoo.nl/en/>`_.
+
+- The development of version 5.0 benefited from much sponsoring:
+
+  - `Idéative <https://www.ideative.ch/>`_
+  - `Bendoo e-work solutions <https://www.bendoo.nl/en/>`_
+  - `mehrwert intermediale kommunikation GmbH <https://www.mehrwert.de/>`_
+  - Benni Mack
+  - Tomas Norre
+
+  Without these companies and people, it would never have been such a great update!
diff --git a/Documentation/KnownProblems/Index.rst b/Documentation/KnownProblems/Index.rst
@@ -8,7 +8,10 @@ Known problems
 
 Nested imports (with the :ref:`children <administration-columns-properties-children>`
 property) are a new feature from 5.0 and certainly not all scenarios have been
-explored. This could be a source of bugs.
+explored. This could be a source of bugs. In particular, nothing is provided
+for sorting records if the default ordering (i.e. the order in which the data
+was read from the external source) is not wanted. Maybe mapping the "sorting" field
+is enough. I will gladly have feedback from your experience.
 
 In general please report bugs and improvements at:
 https://github.com/cobwebch/external_import/issues.