Ajouter un plugin "Mes Favoris" à SPIP

Article publié le 27 février 2021, et actualisé en mai 2024

 
 
 
 
 
 
 
 
 
 
 
 
 
 
Attention, cette page est encore en    

Le but (auquel répond ce plugin) est de proposer comme facilité à chaque rédacteur ou visiteur inscrit et connecté sur le site, d’enregistrer sa liste de lecture favorite, pour retrouver très rapidement un index des articles préférés dans l’instant....
Cela représente un contexte parfait de mise en œuvre de Installation de plugins, pas de soucis SVP et Intégrer une noisette SPIP dans un contexte des plus complexes [1].

Comme pour toute intégration d’une noisette de fonctionnalités nouvelles, plusieurs phases de travail devront s’enchaîner dans une démarche assez générale d’usage :

  1. analyser la documentation et le fonctionnement décrit du plugin,
  2. comprendre (éventuellement) sa gestion de/dans l’espace privé,
  3. concevoir, écrire et tester les noisettes nécessaires au fonctionnement
  4. identifier les points exacts d’insertion dans les squelettes,
    Les inclusions à réaliser sont alors des plus simples....

 Le fonctionnement du plugin

Pour comprendre le fonctionnement proposé par le plugin, vous pouvez utiliser les squelettes de démo proposés en public [2]

  • ?page=demo/mesfavoris_boucle.html :
  • ?page=demo/mesfavoris_critere.html :
  • ?page=demo/mesfavoris_exemple.html :
  • ?page=demo/mesfavoris_form-categories.html :
  • ?page=demo/mesfavoris_simple.html :

Pour résumer la documentation [3], il faut intégrer deux fonctionnalités pour les visiteurs authentifiés :
- s’afficher une liste d’articles (voire d’objets) favoris (comme pense-bête temporaire),
donc intégrer la noisette et/ou le lien d’accès à celle-ci dans une page existante,
- pouvoir s’ajouter dans sa liste un article (voire objet supplémentaire) en le lisant,

 La configuration et la table en BDD

L’installation du plugin Mes_Favoris crée une table spip favoris La table SPIP3 Favoris en base de données, dont la structure ci-contre est typique des tables de liens SPIP 3 : chaque occurrence pointe vers un enregistrement d’un objet éditorial défini par son type et son index-identificateur, et lié à l’auteur concerné.

Configurer Mes Favoris 3 La configuration directe est très limitée, mais on pourra imaginer ensuite de sélectionner les types d’objets éligibles en Favoris (comme pour la gestion des groupes de mots-clés) et d’avoir plusieurs rôles/catégories pour ces favoris, avec les logos visuels associés...

 Analyse des noisettes proposées

Pour répondre aux deux fonctionnalités attendues, résumées ci-dessus,
le plugin Mesfavoris propose déjà deux noisettes SPIP :
- la gestion des Favoris(ajout et suppression individuelle de chaque objet) passe par une balise automatisant le #FORMULAIRE_FAVORI,
à ajouter sur le squelette d’affichage (public et/ou privé : déjà automatisé par le plugin ?) de chaque objet éditorial ciblé : avec le développement des pipelines, on pourrait imaginer d’automatiser son insertion automatique, par exemple juste après l’affichage de la balise #TITRE...
- l’affichage pour l’auteur est prévu par une noisette inclure/favoris.htmldisponible dans le plugin : outre l’attente du code id_auteur récupérable dans l’environnement, cette noisette peut accepter de nombreux paramètres possibles...
Noter que la noisette d’affichage intègre nativement sur chaque objet listé, l’appel au #FORMULAIRE_FAVORI ci-dessus pour le retirer sans chercher !
C’est au webmestre d’intégrer celle-ci dans le/les squelettes voulus dans l’espace public... voir ci-dessous

 Lister les squelettes d’insertion

- Pour commencer, il serait utile (et simple d’inclure la liste des favoris ’potentiels’ dans l’écran d’accueil, pour un accès rapide, donc a priori dans votre squelette sommaire.html : à vous de choisir où !
- Le webmestre devra ensuite ajouter l’appel à la noisette de gestion dans chaque squelette d’affichage public des objets qu’il veut proposer....
Couramment cela se fera d’abord sur les squelettes article.html , voire rubrique.html, par exemple juste après la ligne affichant la balise #TITRE

 Mise en œuvre et tests


 Une extension pour un Intranet ?

Comme le plugin Mes Favoris n’est accessible qu’aux auteurs authentifiés, il est particulièrement intéressant pour l’usage en collaboratif (voir COLLABORER avec SPIP), à la fois pour faciliter de retrouver les articles en-cours de travail, ou pour permettre à chaque participant de se constituer un menu personnalisé [4], surtout si le webmestre décide d’introduire la rubrique comme indicateur de catégorie...


Merci de nous signaler les coquilles, imprécisions ou erreurs qui figureraient dans cette page.

[1Les Squelettes configurables comme SarkaSpip et Soyez Createurs sont particulièrement tordus à investiguer pour les débutants SPIP, du fait de l’usage intensif de noisettes imbriquées par #INCLURE{fond=..} à grand renfort de paramètres de configuration récupérés par #CONFIG{meta/casier/valeur, valeur par defaut} et #ENV{variable, valeur par défaut...

[2Cela sera plus facile en téléchargeant un squelette minimal de page demo_mesfavoris.html ci-dessous (directement dans votre sous-dossier ./squelettes/content/ si vous utilisez Zcore)  :

  1. <h2>Page de démo-tests sur la récupération des favoris pour l'auteur #ENV{id_auteur,[(#SESSION{id_auteur}|sinon{"Aucun auteur connecté"})]} ! </h2>
  2. <ul>  
  3. <li><a href="#URL_PAGE{demo/mesfavoris_boucle}">demo/mesfavoris_boucle.html</a>
  4. </li>
  5. </li>
  6. <li><a href="#URL_PAGE{demo/mesfavoris_critere}">demo/mesfavoris_critere.html</a>
  7. </li>
  8. <li><a href="#URL_PAGE{demo/mesfavoris_exemple}">demo/mesfavoris_exemple.html</a>
  9. </li>
  10. <li><a href="#URL_PAGE{demo/mesfavoris_form-categories}">demo/mesfavoris_form-categories.html </a>
  11. </li>
  12. <li><a href="#URL_PAGE{demo/mesfavoris_simple}">demo/mesfavoris_simple.html</a>
  13. </li>
  14. </ul>
  15. Aucun favori n'est géré pour l'auteur #ENV{id_auteur,#SESSION{id_auteur}}

Télécharger

[3La rubrique de documentation de ce plugin sur Contrib comporte plusieurs articles successifs, correspondant aux versions successives : il vous appartiendra de retenir finalement l’article décrivant exactement la version du plugin que vous voulez utiliser (ici se référer à Mes Favoris 3.0 : le 3.0 référence la version utile du plugin, et ne correspond pas à la version de SPIP !) !

[4On pourrait même imaginer alors de "dérouter" les visiteurs authentifiés vers leur sommaire personnalisé,par usage du plugin Favoris !


Liens A2A visibles seulement pour les inscrits.
Liens visibles seulement pour les inscrits.

Article publié le 27 février 2021, et actualisé en mai 2024 Provisoire (à compléter...) .

Répondre à cet article