# FAQ
## Modulbeschreibung
Das kennen Sie doch bestimmt auch: Sie möchten ein Produkt kaufen, doch Sie sind sich unschlüssig, da Ihnen noch einige Fragen zum Produkt auf dem Herzen liegen oder Sie möchten eine Frage hinsichtlich einer Kategorie beantwortet haben, welches ggf. zum Produkt gehört.
Mit dem Modul **„FAQ“** können Ihre Kunden Fragen zu einem bestimmten Produkt oder zu bestimmten Shop-Kategorien stellen. Fragen anderer Kunden sind auch sichtbar.
Für den Shopbetreiber bietet das Modul von der Verwaltung verschiedener Fragen und Antworten bis hin zu der Erstellung von Kategorien und eigener Fragen/Antworten eine einfache Handhabung.
Es können bereits vom Kunden gestellte Fragen verwaltet werden und eigene Fragen erstellt werden, welche auch direkt von Ihnen beantwortet werden können. Je nach Bedarf lassen sich beliebig viele Themen erstellen, wofür Ihre Kunden sich interessieren könnten.
## Systemvoraussetzungen
### PHP-Version OXID 6
* PHP 7.4 - 8.1 (OXID 6.5.x)
### PHP-Version OXID 7
* PHP 8.1 - 8.2 (OXID 7.1.x)
* PHP 8.2 - 8.3 (OXID 7.2.x - 7.3.x)
* PHP 8.4 (OXID 7.3.x - 7.4.x)
### Webserver-Konfiguration
* IonCube Loader (v14 - v15)
### Kompatibel mit den Themes
* Flow (OXID 6)
* RoxIVE (OXID 6)
* Wave (OXID 6 und 7.0)
* Apex ab OXID 7.0
### Kompatibel mit den OXID Versionen
* OXID CE/PE/EE 6.5.x
* OXID CE/PE/EE 7.0.x bis 7.4.x
* bei OXID 7.0 wird das "WYSIWYG Editor + Mediathek" von OXID benötigt
* ab OXID 7.1 wird das "Mediathek"-Modul von OXID benötigt
{% hint style="warning" %}
Ab der Modulversion 5.0.5 muss für das FAQ-Modul die Einbindung der jQuery-Bibliothek über das Basismodul erfolgen. Siehe . Wird jQuery bereits im Theme verwendet, kann dieser Schritt entfallen.
{% endhint %}
## Installation
### Ab OXID 6/7
1. Falls noch nicht geschehen, laden Sie bitte zunächst das digidesk Basis-Modul herunter und installieren Sie es gemäß der enthaltenen Installationsanleitung.\
Sie erhalten dieses unter:
2. Für dieses Modul erstellen Sie nun einen weiteren Unterordner "faq" im Ordner "packages/digidesk", in den die heruntergeladene Zip-Datei entpackt wird.
3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:\
`composer require digidesk/faq`
4. Nun kann das Modul im OXID eShop Admin aktiviert werden
5. Ggf. Tmp-Verzeichnis leeren und Views generieren
6. Bitte fahren Sie nun mit der Einrichtung des Moduls fort
## Update
### Ab Oxid 6/7
1. Entpacken Sie die neue Modulversion in den Ordner "packages/digidesk/faq"
2. Deaktivieren Sie das Modul im OXID eShop Admin
3. Führen Sie anschließend folgenden Befehl aus dem Hauptverzeichnis des Shopsystems aus:
`composer update digidesk/faq`
Die Frage, ob die Dateien des Pakets überschrieben werden sollen, bestätigen Sie bitte mit "Y", alle anderen können Sie mit "Enter" überspringen.
4. Aktivieren Sie das Modul im OXID eShop Admin
5. Ggf. Tmp-Verzeichnis leeren und Views neu generieren
## Backend-Einstellungen
Nach der Modulinstallation finden Sie im OXID eShop Admin den neuen Punkt links in der Leiste **"FAQ-Modul"**. An dieser Stelle befinden sich 5 weitere Reiter:
### 1. Grundeinstellungen
#### Allgemeine Einstellungen
Hier können Sie unter anderem die "Hilfe"-Seite durch die Shop-FAQ Seite ersetzen und überschreiben.\
Wenn Ihr Shop in weitere Subshops aufgeteilt ist und Sie andere Artikel besitzen, empfiehlt es sich die Produkt-FAQ-Zuordnung für ShopId's zu aktivieren.
Praktisch ist die Benachrichtigungsemail, wenn eine neue Frage gestellt wurde.
Auf den Produktseiten haben Sie die Möglichkeit Artikel-FAQ zu aktivieren.
Die Fragen-Formulare können nach Bedarf aktiviert oder deaktiviert werden, dazu lässt sich einstellen ob Jeder oder nur Angemeldete Benutzer Fragen stellen dürfen.
#### FAQ - Startseite Einstellungen
**Zeichen in Kategorien-Filter-Buttons begrenzen auf** - mit dieser Einstellung können Sie bei sehr Langen Kategorienamen die Filter-Buttons auf der FAQ-Hauptseite klein halten. Bei Mouseover wird der komplette Name der Kategorie angezeigt.
Mit der Einstellung **Anzahl der Kategorien-Filter-Buttons** haben Sie die Möglichkeit nur eine bestimmte Anzahl der aktiven Kategorien als Filter-Buttons anzeigen zu lassen.
**Benutzerdefinierte Kategorien für Filter-Buttons** - mit dieser Einstellung können Sie eine eigene Auswahl an der Kategorien auswählen, die im Frontend als Filter-Buttons angezeigt werden sollen. Falls dieses Feld nicht gefüllt wird, werden alle aktiven FAQ-Kategorien im Frontend angezeigt.
#### FAQ-Seite Button-Einstellungen
Hier können die Farben für die Filter-Buttons im Frontend definiert werden. Mit einem Mausklick in ein Farbfeld wird eine Farbskala eingeblendet, wo Sie bequem per Schiebeschalter eine Farbe auswählen können. Alternativ können Sie auch einen Farben-HEX-Code eingeben.
#### Beispiel FAQ-Daten importieren
Wenn Sie das Modul neu installieren und sich zuerst einen Überblick über dir Funktionen verschaffen möchten, haben Sie die Möglichkeit unsere Beispiel-FAQ´s zu importieren. Klicken Sie dafür im oberen rechten Bereich auf den Button **Beispiel FAQ-Daten importieren.** Sobald die Daten importiert wurden, bekommen Sie eine grüne Benachrichtigung über den Import und der Button ändert seinen Namen zu **Beispiel FAQ-Daten entfernen** - damit können Sie bequem die Beispiel-Daten wieder entfernen. Natürlich dürfen Sie unsere Beispiel-FAQ´s nach belieben ändern und für Ihren Shop anpassen.
####
#### Zu der FAQ-Seite im Frontend wechseln
Aus dem admin-Bereich können Sie bequem per Mausklick auf den Button **FAQ öffnen** die FAQ- Frontend- Seite im neuen Fenster öffnen.
### 2. Shop-FAQ-Kategorien
Im Reiter **Shop-FAQ-Kategorien** lassen sich neue Themen/Kategorien erstellen, damit Kunden Fragen zu diesen stellen können und es lassen sich bereits vorhandene Kategorien anzeigen. \
1\. Klicken Sie auf das grüne "+"-Symbol in der rechten oberen Ecke um eine neue Kategorie anlegen zu können.\
2\. Setzen den Haken auf aktiv, geben Sie einen Namen ein und ggf. geben Sie eine Sortierung als Zahl an. Wenn Sortierung nicht angegeben oder = 0 - wird standardmäßig alphabetisch sortiert. Ansonsten wird die Reihenfolge nach Zahlen sortiert (0 oben, 1 drunter, danach die 2 usw.)\
3\. Anschließend auf **Speichern** drücken.
### 3. Shop-FAQ bearbeiten
Nun ist es möglich eingegangene Fragen zu bestimmten Kategorien/Themen zuzuordnen oder welche neu anzulegen, insofern Bedarf besteht. Eingegangene Fragen sind zunächst auf "inaktiv" gesetzt und beinhalten nur die Kundenfrage.\
1\. Klicken Sie auf das "Stift"-Symbol eines bestehenden Eintrags (wird erst eingeblendet wenn man die Maus ganz nach rechts entlang des Eintrags bewegt) oder auf das "+"-Symbol in der oberen rechten Ecke, dann öffnet sich ein Fenster mit Einstellungsmöglichkeiten.\
2\. Hier ist es möglich, den Eintrag (in)aktiv zu setzen, die Kategorie auszusuchen, wo die Frage und die Antwort zugeordnet werden kann und diese zu bearbeiten.\
3\. Natürlich ist es wieder möglich eine Sortierung anzugeben. Wenn Sortierung nicht angegeben oder = 0 - wird standardmäßig alphabetisch sortiert. Ansonsten wird die Reihenfolge nach Zahlen sortiert (0 oben, 1 drunter, danach die 2 usw.)\
4\. Anschließend auf **Speichern** drücken.
{% hint style="warning" %}
Fragen müssen unbedingt einer FAQ-Kategorie zugeordnet werden, da sie sonst nicht im Frontend angezeigt werden.
{% endhint %}
### 4. Produkt-FAQ bearbeiten
Im letzten Reiter, lassen sich die die Fragen und Antworten, welche von Ihren Kunden zu bestimmten Produkten gestellt worden sind anzeigen.\
1\. Klicken Sie auf das "Stift"-Symbol eines bestehenden Eintrags (wird erst eingeblendet wenn man die Maus ganz nach rechts entlang des Eintrags bewegt) oder auf das "+"-Symbol in der oberen rechten Ecke, dann öffnet sich ein Fenster mit Einstellungsmöglichkeiten.\
2\. Im Fenster sind 2 Reiter zu sehen: **FAQ** und **Artikel**\
3\. Im Reiter **FAQ** (wo Sie automatisch landen) ist es möglich, den Eintrag (in)aktiv zu setzen, die Sortierung anzugeben, die Frage und die Antwort zu bearbeiten. Wenn Sortierung nicht angegeben oder = 0 - wird standardmäßig alphabetisch sortiert. Ansonsten wird die Reihenfolge nach Zahlen sortiert (0 oben, 1 drunter, danach die 2 usw.)\
4\. Im Reiter **Artikel** lässt sich der Eintrag zu bestimmten Artikeln zuordnen. Wenn es sich um eine Kundenfrage handelt, ist ein Artikel bereits schon vorhanden. Sie haben die Möglichkeit, diese FAQ anderen Artikeln zusätzlich zuzuordnen. Klicken Sie dafür in das Feld und geben Sie die Artikel-Nummer oder Suchbegriff ein. Es öffnet sich eine Auswahl mit passenden Suchergebnissen, die Sie selektieren können.\
5\. Anschließend auf **Speichern**
### **5. Overlay-FAQ bearbeiten**
Hier können Sie das Aussehen des Overlay-FAQ´s im Frontend einstellen und definieren. Es gibt 2 unterschiedliche Overlay- Buttons die FontAwesome- Icons benutzen. Es kann nur einer zugleich aktiv sein, man kann aber beide deaktivieren.
{% hint style="warning" %}
Bei Verwendung der Twig-Engine werden anstelle der FontAwesome-Webfont-Icons die im Modul hinterlegten SVG-Grafiken von FontAwesome verwendet.
{% endhint %}
Bei dem Punkt **Button Z-Index** können Sie den Button und das Overlay in den Vordergrund bringen, falls diese von anderen Elementen verdeckt werden sollten. **Button Offset Y** definiert den vertikalen Versatz von oben oder von unten, je nachdem was Sie bei dem **Button/Widget Position** einstellen. Button Offset X **i**st für horizontalen Versatz zuständig, entweder vom linken oder vom rechten Rand, je nachdem was Sie bei dem **Button/Widget Position** einstellen. Und beim letzten Punkt **Button/Widget Position** definieren Sie die Grundpositionierung des Overlay- Buttons und des Overlay- Fensters.
Die Einstellungen für **Overlay mit eckigem Sticky Button** sind ähnlich.
Allgemeine EInstellungen**:** wenn **Button Verlinkung zu FAQ-Seite** aktiviert ist, wird man beim Klick auf den Overlay- Button auf die FAQ- Seite weitergeleitet. Andernfalls wird das Overlay- Fenster eingeblendet. \
Aktivierung von **FAQ-Seite im neuen Fenster** wirkt zusammen zum einen mit dem oberen Punkt, wenn dieser aktiv ist- oder mit dem Link im Overlay- Fenster. Wenn **Mobile Ansicht kein Overlay** aktiviert ist- wird in der mobilen Ansicht keine Overlay-Button angezeigt. Mit Überschrift des Overlays , Überschrift des Footers und den beiden Farbeinstellungen definieren Sie die die Überschriften und Farben im Overlay- Fenster. Der Footer ist gleichzeitig ein Link zu der FAQ- Seite. Hier ist ein Beispiel wie das Overlay- Fenster im Frontend bei den oben definierten Einstellungen aussehen kann:
Falls Sie eigene Bilder anstatt der mitgelieferten SVG-Icons im Overlay nutzen möchten, können Sie als **Alternative Icons** eigene Bilder definieren. Der X-Button wird angezeigt um das Overlay-Fenster zu schliessen, der ?- Button ist der Anfangs-Button, beim Klick auf dieses wird das Overlay-Fenster eingeblendet. Der Pfeil-Button wird angezeigt wenn man im Overlay-Fenster auf eine Frage klickt und dabei die Ansicht zu dieser Frage wechselt. Um zurück zu der Hauptansicht zu gelangen, wird ein Klick auf den Zurück-Pfeil benötigt. Der Suche-Button wird rechts neben dem Input für die Suche angezeigt. \
Um die Einstellungen zu übernehmen, klicken Sie bitte auf Speichern.
### **Produkt-FAQ bei Artikel-Varianten**
Bei Artikel- Varianten, die keine eigene FAQ haben ist die Nutzung des FAQ vom Vater- Artikel möglich. Dazu setzen Sie bitte bei dem FAQ-Modul im Shop-Admin unter **Erweiterungen->Module** unter Reiter **Einstell. -> Allgemein** den Hacken bei der Checkbox **Verwende Parent-FAQ** **bei Varianten** und Speichern Sie ab.
### FAQ-Einträge in eine andere Sprache übersetzen
Jeder Menu-Punkt im FAQ-Modul hat den Button für andere Sprachen (Sprachen können Sie im Shop-admin unter Menu-Punkt **Stammdaten -> Sprachen** anlegen und aktivieren) . Wenn Sie die Einträge bereits in einer Sprache angelegt haben, haben Sie die Möglichkeit diese Einträge (Kategorien, FAQ´s, Produkt-FAQ´s) in eine andere Sprache zu übersetzen. Klicken Sie dafür auf den Sprachbutton oben rechts und selektieren Sie gewünschte Sprache. Damit Sie die Einträge auch identifizieren können, werden diese in der Liste ausgegraut und mit dem Sprach- Kürzel am Ende angezeigt, in der sie schon angelegt worden sind. Bewegen Sie die Maus zu der rechten Seite eines Eintrags, um die Editier-Icons einzublenden und klicken Sie auf das "Stift"-Symbol um den Eintrag anzeigen zu lassen und in die ausgewählte Sprache zu übersetzen.
## Frontend-Ansichten
### FAQ-Ansicht
Im Frontend können Sie die im Backend angelegten und aktiven Kategorien als **Kategorien-Filter-Buttons** sehen, die FAQ-Einträge lassen sich mit einem Klick auf einen Filter-Button nach bestimmten Kategorien Filtern. Standardmäßig werden alle FAQ´s angezeigt.
Im unteren Bereich kann man zu der nächsten Seite wechseln. Standardmäßig werden 10 FAQ´s pro Seite angezeigt. Mit dem Klick auf den Button **Schreiben Sie uns Ihre Frage** haben Ihre Kunden die Möglichkeit Fragen zu Ihren erstellten Kategorien/Themen zu stellen. Diese Fragen landen im admin unter dem Menüpunkt '**Shop-FAQ bearbeiten**' und sind zuerst deaktiviert. Erst wenn diese durch den admin beantwortet und aktiviert werden- sind die Kundenfragen im Frontend sichtbar.
Falls Sie die FAQ-Startseite einbinden möchten, lautet der Link:
**`https://ihreshopdomain/?cl=dd_faq`**
Wenn Sie bei den Grundeinstellungen die Option **Shop-Hilfe URL mit FAQ URL überschreiben** aktiviert haben, dann ist diese Seite über "Hilfe" des Shops auch aufrufbar.
### Produkt-FAQ Ansicht
Um eine Frage zu einem Produkt erstellen zu können, ist es nötig auf die Detailseite eines Artikels zu gelangen.\
Dort wird der Reiter **FAQ** angezeigt. Wird darauf geklickt, erscheinen Fragen und Antworten zu dem Produkt und darunter ist ein Kontaktformular, wo eigene Fragen zum Produkt gestellt werden können. In Backend-Einstellungen kann man den FAQ-Reiter bei Bedarf komplett deaktivieren. Ausserdem lässt es sich einstellen dass nur angemeldete Kunden Fragen stellen dürfen. Die von Kunden gestellten Fragen landen im admin unter dem Menüpunkt 'Produkt-FAQ bearbeiten' und sind zunächst inaktiv. Erst wenn diese durch den admin beantwortet und aktiviert werden- sind die Kundenfragen im Frontend im zugeordneten Artikel auch sichtbar.
{% hint style="warning" %}
**Bei Verwendung des Apex-Themes in OXID 7:**\
Aufgrund der fehlerhaften CSS-Anweisung `display: block` in der CSS-Regel `.details .accordeon .collapse` im Apex-Theme werden die "Accordion"-Elemente nicht korrekt zusammengeklappt. Dieser Fehler betrifft auch den FAQ-Block auf der Produktseite. Um das Problem zu beheben, sollte die oben genannte Css-Anweisung aus der Css-Regel innerhalb eines Child-Themes entfernt werden.
{% endhint %}
### Overlay im Frontend
Um nach einer Frage zu suchen, geben Sie bitte ein Stichwort in das Suchfenster und klicken Sie auf das Suchen- Icon rechts neben dem Suchfeld oder bestätigen Sie mit Enter. In der Unteren Hälfte werden die Ergebnisse gelistet.
Beim Klick auf eine der angezeigten Fragen gelangt man zu der Frage. Um wieder zurück zu gelangen, klicken Sie bitte auf den Pfeil- Button in der linken oberen Ecke.
Beim Klick auf den Button unten im Footer "**Zu allen FAQ´s von uns.**" wird man zu der FAQ-Seite umgeleitet und das Overlay- Fenster wird geschlossen.
### Einbindung der jQuery-Library
Für dieses Modul wird die jQuery-Bibliothek benötigt. Sie kann über das Basis-Modul eingebunden werden, sofern sie nicht bereits mit dem Theme geladen wird. Siehe
## Hilfe & Support
Haben Sie Fragen oder benötigen Sie Hilfe bei der Installation? Gerne bieten wir Ihnen auch einen Installationsservice an. Kontaktieren Sie uns einfach über eine der unten stehenden Adressen.
* E-Mail: ****
* Telefon: **+49 (0) 5246 / 9099110**
* Kontaktformular: [**http://www.digidesk.de/kontakt**](http://www.digidesk.de/kontakt)
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.digidesk.de/moduldokumentationen/faq.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.