Boussole v4

La version v4 du plugin Boussole, disponible à partir de SPIP 4, est une évolution majeure qui apporte son lot d’améliorations et de simplifications mais aussi quelques incompatibilités avec la version v2 [1]. Le schéma de base de données n’a pas été modifié.

Les évolutions

Il n’y a pas vraiment d’ajout fonctionnel dans la nouvelle version v4 du plugin Boussole mais des améliorations de code et aussi d’interface utilisateur que l’on peut résumer ainsi:

  • refactoring du code pour mettre en valeur une API propre pour gérer les boussoles et les serveurs;
  • mise au point du code pour tenir compte des avancées de spip 4;
  • utilisation du plugin Cache Factory, devenu obligatoire;
  • utilisation, pour un serveur de boussoles, d’une API REST basée sur le plugin REST Factory;
  • nouveau logo en SVG;
  • la page «boussoles» affiche maintenant uniquement la liste des boussoles et le formulaire de chargement d’une boussole en base de données. La liste des serveurs accessibles et le formulaire de déclaration d’un serveur sont affichés dans une page dédiée, «serveurs_boussole»;
  • En plus du format XML, le fichier de description d’une boussole accepte les formats JSON et YAML.

En outre, la possibilité de définir une boussole dite «manuelle» a été dépréciée. Pour créer une boussole, il est maintenant toujours nécessaire d’utiliser la méthode du plugin.

Pour la fonction serveur, il n’est plus nécessaire de créer les caches qui étaient précédemment envoyés au client demandeur car c’est l’API REST qui prend le relais et gère les demandes de manière transparente. Il suffit, comme dans la v2 d’activer le site souhaité comme un serveur de boussole et d’activer le plugin REST Factory et ses dépendances (Serveur HTTP abstrait).

Les blocs de type Z proposés dans la version v2 ont été supprimés. Les noisettes elles sont conservées.

Migrer depuis Boussole v2

Si un site utilise uniquement les fonctions client de Boussole, c’est-à-dire, le chargement de boussoles comme la boussole SPIP à partir de serveurs externes, mais n’expose aucune de ses boussoles comme un serveur, la migration consiste uniquement à mettre à jour le plugin Boussole en v4 et à installer le plugin Cache Factory qui est devenu indispensable à son utilisation.

Si un site est configuré comme un serveur de boussoles personnelles, alors la migration en v4 va avoir une incidence sur tous les sites clients qui utilisent ce serveur. En effet, le serveur v4 ne renvoyant les boussoles que via l’API REST, les anciens client v2 ne sont plus en mesure de mettre à jour leurs boussoles : il faudra donc faire évoluer le serveur et les clients concomitamment.

En conclusion, pour les sites qui ne font qu’afficher la boussole SPIP, la migration de Boussole v2 à Boussole v4 est transparente.

Fonctions avancées

Ce chapitre reprend les fonctions avancées de la version v2 décrites dans l’article Boussole v2, usages avancés et explique les différences en v4.

Créer un serveur de boussoles

La fonction est conservée à l’identique pour ce qui est du formulaire de configuration. Le seul changement consiste en l’utilisation du plugin REST Factory. Pour activer la fonction serveur, il faut au préalable activer le plugin REST Factory.

Voir la description v2.

Utiliser un serveur personnel sur un site client

La fonction est conservée à l’identique si ce n’est que la liste des serveurs et le formulaire de déclaration sont maintenant accessibles via la page «serveurs_boussoles».

Voir la description v2.

Créer une boussole personnelle avec un plugin

La fonction est conservée à l’identique mais il est aussi possible aujourd’hui de proposer un fichier descriptif au format JSON ou YAML.

Voir la description v2.

Créer une boussole personnelle sans utiliser un plugin

Cette fonction est totalement dépréciée en v4. Seule la méthode du plugin est supportée.

Administrer les caches des boussoles hébergées par un site serveur

Cette fonction est dépréciée en v4. C’est le plugin REST Factory qui gère les données REST en cache de façon transparente.

Administrer les boussoles installées sur un site client

La fonction est conservée à l’identique. Néanmoins, le formulaire d’ajout d’une boussole propose de façon séparée la liste des boussoles accessibles par serveur (API REST) et la liste des boussoles disponibles au travers de plugins installés sur le site localement.

Les boussoles disponibles par plugin ne sont proposées que si il n’existe pas de serveur externe les proposant. On considère en effet, qu’un serveur est toujours plus fiable et à jour qu’une installation locale. De fait, cette option de chargement est utilisée pour les serveurs principalement.

Voir la description v2.

Synchroniser les données des sites de la boussole

Voir la description v2.

Importer une boussole

Voir la description v2.

Footnotes

[1La version v3 ne verra jamais le jour car elle est uniquement destinée à assurer une compatibilité du serveur officiel de la boussole spip pendant une période transitoire

Discussion

No discussion

Add a comment

Avant de faire part d’un problème sur un plugin X, merci de lire ce qui suit :

  • Désactiver tous les plugins que vous ne voulez pas tester afin de vous assurer que le bug vient bien du plugin X. Cela vous évitera d’écrire sur le forum d’une contribution qui n’est finalement pas en cause.
  • Cherchez et notez les numéros de version de tout ce qui est en place au moment du test :
    • version de SPIP, en bas de la partie privée
    • version du plugin testé et des éventuels plugins nécessités
    • version de PHP (exec=info en partie privée)
    • version de MySQL / SQLite / PostgreSQL
  • Si votre problème concerne la partie publique de votre site, donnez une URL où le bug est visible, pour que les gens puissent voir par eux-mêmes.
  • En cas de page blanche, merci d’activer l’affichage des erreurs, et d’indiquer ensuite l’erreur qui apparait.

Merci d’avance pour les personnes qui vous aideront !

Par ailleurs, n’oubliez pas que les contributeurs et contributrices ont une vie en dehors de SPIP.

Who are you?
[Log in]

To show your avatar with your message, register it first on gravatar.com (free et painless) and don’t forget to indicate your Email addresse here.

Enter your comment here

This form accepts SPIP shortcuts {{bold}} {italic} -*list [text->url] <quote> <code> and HTML code <q> <del> <ins>. To create paragraphs, just leave empty lines.

Add a document

Follow the comments: RSS 2.0 | Atom