Documentation

Prérequis

Voici les prérequis de la première version, celle pour WordPress. Chaque autre plateforme reçoit sa propre version avec ses propres prérequis, et l'état de chacune figure sur Fonctionne avec votre CMS.

• WordPress 6.0 ou version ultérieure
• PHP 8.1 ou version ultérieure
• Une clé API OpenAI, Anthropic, Google ou Mistral
• Aucune dépendance à cron, aucun accès shell, aucun Node sur le serveur

Installation

1. Plugins, Ajouter, Téléverser le plugin, choisissez le zip, Installer maintenant.
2. Activez.
3. Réglages, DFYe. Collez la clé de votre modèle et enregistrez.

La première indexation démarre immédiatement. Sur un grand site, elle se poursuit en arrière-plan et le widget est en ligne dès que la première passe est terminée.

Choisir ce qui est indexé

Par défaut, DFYe indexe tous les articles, pages et produits publiés. Il n'indexe jamais :

• Tout ce que votre plugin SEO marque en noindex
• Tout contenu privé ou protégé par mot de passe
• Les brouillons, les révisions et les contenus mis à la corbeille

Un bouton par article, dans la barre latérale de l'éditeur, permet d'exclure tout le reste.

Habiller le widget

Chaque décision visuelle est une propriété personnalisée CSS posée sur l'hôte du widget. Définissez-les dans le panneau de réglages, ou dans votre thème si vous préférez rester dans le code :

dfye-chat {
  --dfye-action:    #6c4dff;   /* votre accent : la bulle de question, le bouton d'envoi, le lanceur */
  --dfye-action-on: #ffffff;   /* le texte sur l'accent */
  --dfye-bg:        #ffffff;   /* l'en-tête et la zone de saisie */
  --dfye-surface:   #ffffff;   /* le panneau */
  --dfye-ink:       #0b0d12;   /* le texte */
  --dfye-radius:    18px;
  --dfye-font:      "Your Face", system-ui, sans-serif;
}

Le widget utilise par défaut la police système de votre visiteur, et c'est volontaire, pour que votre site n'ait jamais à télécharger une typographie. Passez-lui la vôtre avec --dfye-font. Le mode sombre est automatique ; figez-le avec data-theme="dark" sur l'élément si votre site est toujours sombre.

Le widget s'affiche dans un shadow root, donc rien de votre thème n'entre et rien du widget ne sort. C'est pourquoi ces propriétés constituent toute la surface d'habillage : il n'y a aucune feuille de style à combattre.

L'intégration, sur n'importe quelle plateforme

Le widget est un simple script qui ne se soucie pas de ce qui a généré la page autour de lui, il tourne donc sur un CMS qui n'a pas encore de version du plugin, et sur un site sans aucun CMS. Ce que le plugin ajoute par-dessus, c'est la lecture : le parcours de vos pages publiées, l'index tenu à jour quand vous en modifiez une, et le journal des questions. Une seule balise script pour le widget flottant :

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

Ou un conteneur pour un panneau intégré à la page, ce qu'utilise la page de démonstration :

<div data-dfye-inline data-opening="Posez-moi vos questions."></div>
<script src="https://dfye.com/w.js" defer></script>

Budget de poids

La compilation échoue si le widget dépasse 20 ko compressé en gzip. La version actuelle pèse 9.7 ko en gzip, 8.3 ko en brotli, 27.1 ko brut. Ce chiffre est inscrit dans cette page par la compilation elle-même, il ne peut donc pas s'écarter de la réalité.

Pas encore développé

Liste honnête de ce que cette documentation décrit mais que le plugin ne fait pas aujourd'hui :

• La version WordPress elle-même. Le widget et le moteur de recherche documentaire sont en place ; l'enveloppe PHP est la prochaine étape, et toutes les autres plateformes listées sur Fonctionne avec votre CMS viennent après elle.
• La clé de licence et le point de terminaison de mise à jour.
• Le journal des questions dans l'administration.

L'avancement est suivi sur la page de lancement et elle est mise à jour à mesure que les choses arrivent, pas à l'avance.