Dokumentation

Voraussetzungen

Das sind die Voraussetzungen für den ersten Build, den für WordPress. Jede weitere Plattform bekommt einen eigenen Build mit eigenen Voraussetzungen, und der Stand steht jeweils auf Läuft mit deinem CMS.

• WordPress 6.0 oder neuer
• PHP 8.1 oder neuer
• Ein API-Schlüssel von OpenAI, Anthropic, Google oder Mistral
• Keine Abhängigkeit von Cron, kein Shellzugriff, kein Node auf dem Server

Installation

1. Plugins, Installieren, Plugin hochladen, ZIP auswählen, Jetzt installieren.
2. Aktivieren.
3. Einstellungen, DFYe. Modellschlüssel einfügen und speichern.

Die erste Indexierung startet sofort. Auf einer großen Website läuft sie im Hintergrund weiter, und das Widget geht live, sobald der erste Durchlauf fertig ist.

Auswählen, was indexiert wird

Standardmäßig indexiert DFYe jeden veröffentlichten Beitrag, jede Seite und jedes Produkt. Nie indexiert werden:

• Alles, was dein SEO-Plugin auf noindex setzt
• Alles, was passwortgeschützt oder privat ist
• Entwürfe, Revisionen und Inhalte im Papierkorb

Ein Schalter je Beitrag in der Seitenleiste des Editors nimmt alles Weitere heraus.

Das Widget gestalten

Jede visuelle Entscheidung ist eine CSS-Variable auf dem Host des Widgets. Setz sie in den Einstellungen oder in deinem Theme, wenn du sie lieber im Code hältst:

dfye-chat {
  --dfye-action:    #6c4dff;   /* deine Akzentfarbe: die Frageblase, der Sendebutton, der Launcher */
  --dfye-action-on: #ffffff;   /* Text auf der Akzentfarbe */
  --dfye-bg:        #ffffff;   /* die Kopfzeile und das Eingabefeld */
  --dfye-surface:   #ffffff;   /* das Panel */
  --dfye-ink:       #0b0d12;   /* Text */
  --dfye-radius:    18px;
  --dfye-font:      "Your Face", system-ui, sans-serif;
}

Das Widget nutzt absichtlich die Systemschrift deiner Besucher, damit deine Website nie eine Schriftart laden muss. Deine eigene übergibst du mit --dfye-font. Der Dark Mode kommt automatisch; setz ihn mit data-theme="dark" am Element fest, wenn deine Website immer dunkel ist.

Das Widget rendert in einem Shadow Root, also dringt nichts aus deinem Theme hinein und nichts aus dem Widget hinaus. Deshalb sind diese Variablen die gesamte Gestaltungsfläche: Es gibt kein Stylesheet, gegen das du ankämpfen musst.

Die Einbindung, auf jeder Plattform

Das Widget ist ein einfaches Skript und es ist ihm egal, was die Seite drumherum erzeugt hat. Es läuft also auf einem CMS, für das es noch kein Plugin gibt, und auf einer Website ganz ohne CMS. Was das Plugin obendrauf legt, ist das Lesen: deine veröffentlichten Seiten crawlen, den Index aktuell halten, wenn du eine bearbeitest, und das Fragenprotokoll. Ein Skript-Tag für das schwebende Widget:

<script src="https://dfye.com/w.js" data-dfye="demo" defer></script>

Oder ein Container für ein Inline-Panel, so wie es die Demoseite nutzt:

<div data-dfye-inline data-opening="Frag mich alles."></div>
<script src="https://dfye.com/w.js" defer></script>

Größenbudget

Der Build schlägt fehl, wenn das Widget über 20 kB gzipped kommt. Der aktuelle Build liegt bei 9.7 kB gzipped, 8.3 kB brotli, 27.1 kB unkomprimiert. Diese Zahl schreibt der Build selbst in diese Seite, sie kann also nicht von der Realität abweichen.

Noch nicht gebaut

Ehrliche Liste dessen, was diese Dokumentation beschreibt und das Plugin heute noch nicht kann:

• Der WordPress-Build selbst. Das Widget und die Retrieval-Engine sind fertig; der PHP-Wrapper kommt als Nächstes, und jede weitere Plattform auf Läuft mit deinem CMS steht dahinter.
• Der Lizenzschlüssel und der Update-Endpunkt.
• Das Fragenprotokoll im Adminbereich.

Den Fortschritt verfolgst du auf der Launch-Seite, und sie wird aktualisiert, wenn etwas fertig ist, nicht vorher.