.. include:: /Includes.rst.txt
.. _drkservice_commitment_search:
.. index:: drkservice_commitment_search
.. index:: Extension; drkservice_commitment_search
.. index:: Erweiterungen; Engagement-Suche
.. index:: Engagement Suche
.. index:: Engagement Plattform
.. index:: Aktion Mensch

============================
drkservice_commitment_search
============================

.. versionadded:: 12

Was macht die Erweiterung "DRK Engagement-Suche"?
=================================================

Die Erweiterung 'DRK Engagement-Suche' bietet Ihnen die Möglichkeit, eine Suche nach Engagement-Angeboten des DRK auf ihrer Seite einzubinden.

Als Grundlage dient die Engagement-Platform der `Aktion Mensch <https://www.aktion-mensch.de/was-du-tun-kannst/ehrenamt/engagement-plattform>`_.


Integrator-Schlüssel
====================

Für eine Nutzung der Engagement-Suche wird ein Integrator-Schlüssel der Engagement-Platform benötigt.

Diese erhalten sie wie folgt.


Registrierung und Login
_______________________

1. Rufen sie die Webseite `https://freiwilligendatenbank.aktion-mensch.de/admin/login <https://freiwilligendatenbank.aktion-mensch.de/admin/login>`_ auf.

 .. figure:: Images/ea-plattform-login.png
    :alt: Login
    :class: with-shadow

2. Registrieren sie sich als **Integrator**. Bei einem bestehenden Login, melden sie sich mit ihren Zugangsdaten an.

 .. figure:: Images/ea-plattform-register.png
    :alt: Registrieren
    :class: with-shadow

3. Sie erhalten nach einer erfolgreichen Anmeldung, eine Übersicht aller angelegten Integrator-Schlüssel.

 .. figure:: Images/ea-plattform-list.png
    :alt: Übersicht
    :class: with-shadow


Integrator-Schlüssel anlegen
____________________________

1. Wählen sie im Menüpunkt *Integrationen* den Punkt *Neu hinzufügen*.

 .. figure:: Images/ea-plattform-add-menu.png
     :alt: Menüpunkt
     :class: with-shadow

2. Geben sie eine Bezeichnung und den absoluten Pfad zur Seite, auf der die Engagement-Suche erscheinen soll ein.

 .. figure:: Images/ea-plattform-add.png
    :alt: Seite anlegen
    :class: with-shadow

3. Sie erhalten im Anschluss den Integrator-Schlüssel.

 .. figure:: Images/ea-plattform-integration.png
    :alt: Integrator-Schlüssel
    :class: with-shadow

.. hint::

   Die URL muss genau bis zur Seite mit der Suche eingegeben werden. Ein Eintrag der Startseite, wenn die Suche auf einer Unterseite liegt genügt nicht!


Plugin einfügen
===============

1. Wechseln sie nun in ihr TYPO3 Backend und legen sie das Plugin *DRK Service Engagement Suche* an.

 .. figure:: Images/ea-plattform-plugin-add.png
    :alt: Plugin einfügen
    :class: with-shadow

2. Öffnen sie das Plugin und fügen unter *Einstellungen* den zuvor erstellten Integrator-Schlüssel ein.

 .. figure:: Images/ea-plattform-plugin-key.png
    :alt: Integrator-Schlüssel einfügen
    :class: with-shadow

Ort als Standort für Suchanfragen ändern
________________________________________

1. Rufen sie im Konstanteneditor die Kategorie "engagement-suche" auf.

 .. figure:: Images/ea-plattform-constant-editor.png
    :alt: Konstanteneditor
    :class: with-shadow

2. Folgende Standortdaten können sie nun ändern:

* name: [string] Name des Ortes
* position: Längen- und Breitengrade mit den Parametern latitude [float] und longitude [float]
* ignoreUserIPLocation: [true|false] Default: false. Der Wert true bewirkt, dass der Nutzer*innen nicht automatisch vom Server geolokalisiert werden, sondern initial der hier angegebene Ort als Standort genutzt wird. Nutzer*innen können den Ort weiterhin manuell überschreiben oder die in der App integrierte, browserbasierte IP-Lokalisierung nutzen.

 .. figure:: Images/ea-plattform-constants.png
    :alt: Konstanten
    :class: with-shadow


Referenz der Konfiguration
==========================

Eine komplette Referenz der Konfiguration erhalten sie als Leitfaden im Integrator-Menü der Aktion-Mensch.


 .. figure:: Images/ea-plattform-reference.png
    :alt: Leitfaden
    :class: with-shadow