SPIP

[ar] [ast] [bg] [br] [ca] [co] [cpf] [cs] [da] [de] [en] [eo] [es] [eu] [fa] [fon] [fr] [gl] [id] [it] [ja] [lb] [nl] [oc] [pl] [pt] [ro] [ru] [sk] [sv] [tr] [vi] [zh] Espace de traduction

Télécharger

Installer un plugin

Juillet 2006 — mis à jour le : Mai 2013

Toutes les versions de cet article :

Depuis SPIP 1.9, il est possible d’intégrer des plugins, qui rajoutent des fonctionnalités à SPIP.


Un plugin (également désigné par le nom de « greffon ») est un logiciel permettant d’améliorer ou d’ajouter des fonctionnalités dans SPIP [1]. Il est écrit spécifiquement pour SPIP et respecte un formalisme (une API) qui lui permet d’interagir. Le plugin tire son nom de l’anglais to plug (brancher) car il doit être très facile de le brancher sur SPIP, mais aussi de le débrancher. L’existence des plugins répond principalement à la nécessité d’éviter l’hypertrophie du « noyau » de SPIP —notamment pour des raisons de maintenance— tout en facilitant grandement les possibilités de personnalisation poussée de son fonctionnement.

Récupérer et installer le plugin

Chaque plugin se présente sous la forme d’un dossier à son nom, contenant un ensemble de fichiers.

Installer ce dossier dans le répertoire /plugins à la racine du site. Ce répertoire n’existe pas par défaut lors de l’installation de SPIP. Vous devez donc le créer vous-même. Vous pouvez par ailleurs y ajouter des sous-répertoires pour classer par familles les plugins que vous allez utiliser.

-  Installation automatique

Activation du système :
Depuis SPIP 2.0, il est possible d’activer l’installation automatique de plugins. Pour cela, il faut créer un sous-dossier plugins/auto/, et donner au serveur les droits d’écriture dans ce sous-dossier.

  • Avec SPIP 3.0 une refonte complète concernant l’installation et la mise à jour des plugins à été faite (.../ecrire/ ?exec=admin_plugin) ! Si vous n’avez pas fait la création des répertoires plugins/auto/, vous verrez

Il est possible, via l’installation automatique :

  • d’ajouter des plugins individuels, en indiquant l’URL d’un fichier Zip (y compris du type Gitup depuis SPIP 3.0.6),
  • d’ajouter des plugins par lot.
  • d’ajouter des listes de plugins répertoriés dans un flux RSS.
  • de mettre à jour les plugins utilisés par votre site.

Trouver des plugins :
Trois espaces permettent aux utilisateurs de trouver des plugins selon différentes orientations (développeurs, contributif, référencement) :

  • tous les plugins développés sur la Zone peuvent apparaître, à l’initiative de leurs auteurs, dans le répertoire http://files.spip.org/spip-zone/ ;
  • SPIP-Contrib a été adapté pour améliorer la recherche de plugins ;
  • lancé à l’occasion de la sortie de SPIP 2.0, le site Plugins.spip propose un référencement plus fin, par thème, par compatibilité de version SPIP, par langues…
  • depuis SPIP 3.0, en utilisant le gestionnaire de plugin, vous avez la possibilité de faire une recherche de plugin via catégorie, état de développement, dépôt et compatibilité.

À savoir que tant que vous n’aurez pas ajouté l’adresse d’un dépôt (cliquer simplement sur "ajouter"), vous verrez

Les sites « Plugins.spip » et « SPIP-contrib » proposent des flux RSS directement utilisables pour l’installation automatique de plugins compatibles avec SPIP 2.0 et plus

Activer le plugin

Dans l’espace privé, le sous-menu « gestion des plugins » du menu « configuration » permet d’activer / désactiver, d’installer / désinstaller et de mettre à jour les plugins .

Pour accéder à ce menu, il est nécessaire d’être webmestre ou administrateur

Vous verrez apparaître la liste des plugins. Cochez ceux que vous souhaitez activer ou mettre à jour, décochez ceux que vous souhaitez désactiver. En cliquant sur le nom du plugin, vous pouvez voir :

  • version et état de développement.
  • auteurs.
  • crédits.
  • licence du plugin.
  • répertoire d’installation.
  • description du plugin.
  • lien vers une page d’information.
  • si besoin est, le nom des plugins supplémentaires nécessaires au fonctionnement de votre plugin.

En cliquant sur vous verrez apparaître le formulaire de configuration de votre plugin si celui-ci en a un.

Si vous voyez ce symbole c’est qu’une mise à jour de votre plugin est disponible. Pour l’installer, cochez la case à côté du symbole, puis en bas, sélectionnez "mettre à jour" avant de cliquer sur "appliquer".

À savoir : depuis SPIP 3.0 des plugins sont livrés en natif avec SPIP, vous les retrouverez dans les plugins "actif" et "verrouillés". Il s’agit de fonctions qui étaient présentes dans les versions de SPIP inférieures à 3 ou qui étaient très souvent utilisées sur les sites, la décision a été prise de les séparer sous forme de plugin pour simplifier la maintenance de SPIP.

Avertissement

Attention : comme pour tout logiciel, il est sérieusement recommandé d’être attentif à ne pas installer n’importe quoi sur votre serveur. Un plugin peut être à un stade de son développement qui n’autorise pas à l’utiliser sans risque. Un plugin présenté comme stable peut aussi contenir des erreurs et ouvrir de ce fait des failles de sécurité dans votre site.

Notez aussi qu’il est possible, dans certains cas, que deux plugins ne soient pas compatibles entre eux.

Si vous constatez ce qui vous semble être un bug de SPIP mais que vous utilisez des plugins vous devez impérativement vérifier que ce bug est reproductible sans aucun plugin activé avant de le signaler.
Si le bug disparait en l’absence de plugins, recherchez le plugin fautif en activant vos plugins un par un afin de préciser la configuration dans laquelle le bug a été constaté. Faute de ces précautions, la résolution de votre problème par la communauté sera des plus aléatoire.

Notes

[1On trouvera une liste conséquente de plugins disponibles


Voir le squelette de cette page Site réalisé avec SPIP | Espace de traduction | Espace privé