diff --git a/Documentation/Configuration.rst b/Documentation/Configuration.rst new file mode 100644 index 0000000..ac14278 --- /dev/null +++ b/Documentation/Configuration.rst @@ -0,0 +1,59 @@ +.. include:: Includes.txt +.. _configuration: + +============= +Configuration +============= + +.. _api-key: + +API Key +------- + +Some API requests are only possible by providing an API Key. +This key can be configured via "Extension Configuration". + +.. _storage-pids: + +Storage Pids +------------ + +The configuration of imports is stored within TYPO3 records. +Those records can be created via backend module. +Each new record is stored on a default page. The default is ``0``. +That would prevent editors from creating and editing records. +This page uid can be configured via TypoScript:: + + module { + tx_thuecat { + settings { + newRecordPid { + tx_thuecat_import_configuration = 10 + } + } + } + } + +.. _import-configuration: + +Import configuration +-------------------- + +Each import is defined via a special import configuration record. +This record can be created via TYPO3 backend module. + +There are different configurations available: + +Static list of URLs + Allows to define a list of URLs which should be imported. + These URLs should reference a single resource to import without any given parameters like a format. + +Synchronization area + Allows to import a so called "Synchronisationsbereich". + Find out more at https://cms.thuecat.org/developer. + Add the given ``syncScopeId`` to the configuration to update the given resources + for that specific sync scope. + This requires an configured :ref:`api-key`. + +All configurations also provide an input to define the page where records should be +stored and updated. diff --git a/Documentation/Features.rst b/Documentation/Features.rst new file mode 100644 index 0000000..3b57d47 --- /dev/null +++ b/Documentation/Features.rst @@ -0,0 +1,53 @@ +.. _features: + +======== +Features +======== + +* Support multiple languages. + +Import +====== + +Import of specific resources via static URLs. +This allows import of specific tourist attractions and towns. + +* The following data types can be imported (not all properties are supported): + + * Organisations (responsible for content) + + * Towns + + * Tourist information + + * Tourist attraction + +Backend module +============== + +Allows to create new import configurations. + +Allows to inspect: + +* Current existing organisations and their towns and tourist information + +* Existing import configuration + +* past imports and possible errors, as well as number of affected records. + +.. figure:: /Images/BE-Module-Overview.png + :align: center + + Figure 1-1: Overview of currently available configurations and Organisations. + +.. figure:: /Images/BE-Module-Imports.png + :align: center + + Figure 1-2: Overview of executed imports and their results. + +Frontend +======== + +A dedicated content element is provided to display tourist attraction. + +A dedicated Page Type is provided to reference tourist attraction. diff --git a/Documentation/Images/BE-Module-Imports.png b/Documentation/Images/BE-Module-Imports.png new file mode 100644 index 0000000..d95098e Binary files /dev/null and b/Documentation/Images/BE-Module-Imports.png differ diff --git a/Documentation/Images/BE-Module-Overview.png b/Documentation/Images/BE-Module-Overview.png new file mode 100644 index 0000000..9bf03a0 Binary files /dev/null and b/Documentation/Images/BE-Module-Overview.png differ diff --git a/Documentation/Includes.txt b/Documentation/Includes.txt new file mode 100644 index 0000000..243c63b --- /dev/null +++ b/Documentation/Includes.txt @@ -0,0 +1,9 @@ +.. role:: html(code) +.. role:: typoscript(code) +.. role:: ts(typoscript) + :class: typoscript +.. role:: php(code) +.. role:: yaml(code) + +.. default-role:: typoscript +.. highlight:: typoscript diff --git a/Documentation/Index.rst b/Documentation/Index.rst new file mode 100644 index 0000000..5c5012c --- /dev/null +++ b/Documentation/Index.rst @@ -0,0 +1,22 @@ +.. _start: + +=========== +EXT:thuecat +=========== + +ThüCAT is ¨Thüringer Content Architektur Tourismus¨. +This is an extension for TYPO3 CMS (https://typo3.org/) to integrate ThüCAT. +The existing API is integrated and allows importing data into the system. + +Table of Contents +================= + +.. toctree:: + :maxdepth: 2 + :titlesonly: + :glob: + + Features + Installation + Configuration + Sitemap diff --git a/Documentation/Installation.rst b/Documentation/Installation.rst new file mode 100644 index 0000000..626b6ec --- /dev/null +++ b/Documentation/Installation.rst @@ -0,0 +1,24 @@ +.. _installation: + +============ +Installation +============ + +The extension can be installed via composer, +see `the package at packagist.org `_. +Further info is available at :ref:`t3install:install-extension-with-composer` from +TYPO3 installation guide. + +The extension can be installed via file system. +Download the corresponding version `at GitHub `_. +Unpack into :file:`typo3conf/ext/`. + +The extension needs to be activated via the "Extension Manager". +See :ref:`t3gettingstarted:extension-manager`. + +Integrators can include and configure TypoScript once it is installed and enabled. +See :ref:`t3tsref:static-includes`. +All available configurations can be found at :ref:`configuration`. + +At least one import configuration needs to be created and imported. +See :ref:`import-configuration`. diff --git a/Documentation/Introduction/Index.rst b/Documentation/Introduction/Index.rst new file mode 100644 index 0000000..0df1e6d --- /dev/null +++ b/Documentation/Introduction/Index.rst @@ -0,0 +1,16 @@ +.. include:: ../Includes.txt + +.. _introduction: + +============== +Introduction +============== + +.. _what-it-does: + +What does it do? +================ + +This TYPO3 extension is an example of best practices in continuous integration and automated code checks, also +writing unit and functional tests with PHPUnit in Extbase/Fluid-based extensions for TYPO3 CMS, and then running them +in a pipeline. diff --git a/Documentation/Settings.cfg b/Documentation/Settings.cfg new file mode 100644 index 0000000..205948b --- /dev/null +++ b/Documentation/Settings.cfg @@ -0,0 +1,52 @@ +[general] + +# ................................................................................. +# ... (required) title (displayed in left sidebar (desktop) or top panel (mobile) +# ................................................................................. +project = TYPO3 EXT:thuecat + +# ................................................................................. +# ... (recommended) version, displayed next to title (desktop) and in