[DOCS] Review and update the documentation

cobwebch · Nov 26, 2024 · 93b3b39 · 93b3b39
1 parent d2eccd7
commit 93b3b39
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 31 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,6 +1,7 @@
-2024-11-25 Francois Suter (Idéative)  <[email protected]>
+2024-11-26 Francois Suter (Idéative)  <[email protected]>
 
     * Verify compatibility with TYPO3 13 ELTS, resolves #28
+    * Review and update the documentation
 
 2024-11-10 Francois Suter (Idéative)  <[email protected]>
 

diff --git a/Documentation/Developers/Events/Index.rst b/Documentation/Developers/Events/Index.rst
@@ -22,8 +22,8 @@ of manipulating the data retrieved by the service in its various forms.
 
 .. _developers-events-initialize:
 
-\Cobweb\Svconnector\Event\InitializeConnectorEvent
-""""""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\InitializeConnectorEvent
+""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired by the `initialize()` method. It is meant to perform custom
 initializations needed by specific uses of the service, and can store results in
@@ -33,53 +33,53 @@ dynamic usage in the connector parameters.
 
 .. _developers-events-parameters:
 
-\Cobweb\Svconnector\Event\ProcessParametersEvent
-""""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\ProcessParametersEvent
+""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after :ref`parameters have been parsed <developers-api-connection-information>`
 and allows for further manipulation of the connector parameters.
 
 
 .. _developers-events-rawdata:
 
-\Cobweb\Svconnector\Event\ProcessRawDataEvent
-"""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\ProcessRawDataEvent
+"""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after the service has retrieved data in raw format. It is designed
 for use in the :code:`fetchRaw()` method.
 
 
 .. _developers-events-arraydata:
 
-\Cobweb\Svconnector\Event\ProcessArrayDataEvent
-"""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\ProcessArrayDataEvent
+"""""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after the service has retrieved data in array format. It is designed
 for use in the :code:`fetchArray()` method.
 
 
 .. _developers-events-xmldata:
 
-\Cobweb\Svconnector\Event\ProcessXmlDataEvent
-""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\ProcessXmlDataEvent
+"""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after the service has retrieved data in XML format. It is designed
 for use in the :code:`fetchXml()` method.
 
 
 .. _developers-events-response:
 
-\Cobweb\Svconnector\Event\ProcessResponseEvent
-""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\ProcessResponseEvent
+""""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after the service has called the distant source and received a
 response from that source. It is designed for use in the :code:`query()` method.
 
 
 .. _developers-events-postprocess:
 
-\Cobweb\Svconnector\Event\PostProcessOperationsEvent
-""""""""""""""""""""""""""""""""""""""""""""""""""""
+\\Cobweb\\Svconnector\\Event\\PostProcessOperationsEvent
+""""""""""""""""""""""""""""""""""""""""""""""""""""""""
 
 This event is fired after all operations have been performed by the connector services.
 Actually, it will be triggered only if the code that used the service called the

diff --git a/Documentation/Developers/Exceptions/Index.rst b/Documentation/Developers/Exceptions/Index.rst
@@ -30,7 +30,5 @@ methods in a try/catch block:
 		// Issue error message or log error, whatever...
 	}
 
-.. note::
-
-   Since version 3.0.0, there exists a base exception class which
-   should be used by all connector services (:code:`\Cobweb\Svconnector\Exception\ConnectorException`).
+All connector services should use the base exception class
+:php:`\Cobweb\Svconnector\Exception\ConnectorException` or extend it.
diff --git a/Documentation/Developers/Hooks/Index.rst b/Documentation/Developers/Hooks/Index.rst
@@ -33,10 +33,6 @@ processParameters
   the :code:`query()` method and a back-reference to the calling connector
   object.
 
-  .. warning::
-
-     This hook is deprecated. Use the :php:`\Cobweb\Svconnector\Event\ProcessParametersEvent` instead.
-
 processResponse
   This hook is designed to process the data inside
   the :code:`query()` method, just as it is returned from the distant source.

diff --git a/Documentation/Index.rst b/Documentation/Index.rst
@@ -21,30 +21,31 @@ Connector Services
 		|release|
 
 	:Description:
-		  Base for a family of services used to connect to external data sources and fetch data from them.
+      Base for a family of services used to connect to external data sources and fetch data from them.
 
 	:Keywords:
-		  data import, fetch data, services
+      data import, fetch data, services
 
 	:Copyright:
-		2007-2023
+      2007-2024
 
 	:Author:
-		  François Suter (Idéative)
+      François Suter (Idéative)
 
 	:Email:
-		  [email protected]
+      [email protected]
 
 	:License:
-		This document is published under the Open Content License
-		available from http://www.opencontent.org/opl.shtml
+        This document is published under the
+        `Creative Commons BY 4.0 <https://creativecommons.org/licenses/by/4.0/>`__
+        license.
 
 	:Rendered:
 		|today|
 
 
 The content of this document is related to TYPO3,
-a GNU/GPL CMS/Framework available from `www.typo3.org <http://www.typo3.org/>`_.
+a GNU/GPL CMS/Framework available from `www.typo3.org <https://www.typo3.org/>`_.
 
 
 .. Table of Contents