SPIP

Utiliser les plugins

cy_altern, erational, jack, Maïeul — 2023-12-04T18:46:13Z

Qu'est ce qu'un plugin ?

SPIP est fourni avec un nombre de fonctionnalités standard (le noyau ou "core").

Il arrive souvent qu'on ait besoin d'autres fonctionnalités comme par exemple un agenda, une newsletter .... Pour répondre à ces besoins particuliers, SPIP dispose d'un système de plugins (parfois appelé "extensions") à travers une API normalisée qui permet de se brancher ("plug" en anglais) au système pour y ajouter ou compléter des fonctions.

Organisation de plugins

Il existe deux types de plugins :

- Les plugins fournis par défaut dans SPIP
Ils sont placés dans le répertoire réservé ./plugins-dist/. Ces "plugins-dist" sont verrouillés et il n'est pas possible de les désinstaller. Ils sont mis à jour lors de chaque mise à jour de SPIP.

- Les plugins spécifiques au site
Ils sont placés dans le répertoire ./plugins/
Si vous souhaitez pouvoir les installer et mettre à jour automatiquement, il faudra créer un sous-répertoire ./plugins/auto/. (Ce sous-répertoire est automatiquement créé si vous installez SPIP via le spip-loader)

Utiliser SVP le gestionnaire des plugins de SPIP

SPIP dispose d'un système automatisé pour gérer les plugins qui s'appelle SVP (acronyme de "SerVeur d'information et de téléchargement des Plugins").

Il permet de gérer et de mettre à jour au quotidien les plugins.

La gestion des plugins est réservée aux administrateurs-trices complet-es du site.
L'ajout, la mise à jour et suppression des plugins sont restreints aux webmestres.

Gérer les dépôts

SVP va chercher les plugins disponibles dans un "dépôt".
Lors de la première installation le webmestre doit installer le dépôt et valider avec son mot de passe.

Par défaut le dépôt "principal" "SPIP-Zone - Plugins" est proposé.

Il est possible d'ajouter d'autres dépôts.
Certains dépôts sont listés sur https://plugins.spip.net/spip.php?page=depots

Pour des raisons de sécurité, il est nécessaire de saisir son mot de passe pour installer un nouveau dépôt.

Chercher et trouver le plugin

Il est possible de rechercher le plugin via l'interface de SVP, "ajouter un plugin"
Il est peut être utile de rechercher le plugin adapté à votre besoin sur le site dédié aux plugins SPIP : https://plugins.spip.net/

Ajouter un plugin

Lorsque vous avez trouvé votre plugin, vous le sélectionnez et demandez son installation "télécharger et installer" ; SVP va alors proposer d'installer le plugin avec toutes les dépendances nécessaires à son fonctionnement.

Une fois installés certains plugins proposent un bouton "Configurer" qui permet d'ouvrir un formulaire de configuration.

Mettre à jour un plugin

Un plugin comporte un numéro de version sous la forme x.y.z où

z représente une correction mineure,
y représente un ajout de fonctionnalités,
x représente un changement majeur présentant des risques d'incompatibilité.

Lorsqu'une mise à jour est disponible (et que l'installation a été faite par SVP) une information s'affiche :

Une mise à jour corrective est disponible (up de z)
Une mise à jour fonctionnelle est disponible (up de y)
Une mise à jour majeure est disponible (X.0.0). Pensez à vérifier les incompatibilités. (up de x)

Désactiver, Désinstaller et/ou Supprimer

Les webmestres ont plusieurs options pour retirer un plugin installé :

Désactiver : le plugin passe dans les plugins inactifs,
Désinstaller : supprime les données et les paramètres de configuration du plugin, le plugin passe dans les plugins inactifs,

Lorsque le plugin est inactif il est maintenant possible de le :

Supprimer : supprime les fichiers du plugins, pas les données ;
Réactiver : si le plugin a été désactivé (et non désinstallé) on retrouvera toutes les données et les paramètres.

NB :
- Par conséquent, pour retirer complètement un plugin et ses données, il faut d'abord le désinstaller, puis le supprimer.
- Attention, ne pas oublier que désinstaller entraîne une perte de données

Méthodes alternatives pour gérer les plugins

Ajouter un plugin manuellement via l'interface SVP

Il est possible d'installer un plugin manuellement via l'interface SVP, avec par exemple une version de zip récupérée sur git.spip.net.
Pour des raisons de sécurité il est nécessaire de saisir son mot de passe webmestre lors de toute installation de plugin de cette manière.

Gestion des plugins par FTP

On peut déposer les plugins avec transférant par FTP les fichiers des plugins dans le répertoire ./plugins/. Une fois déposé, il faudra activer les plugins via SVP.

Attention, cette méthode ne permet pas de mettre à jour automatiquement les plugins.

Gestion des plugins par SPIP-Cli

SPIP-Cli permet de gérer un site en ligne de commande. Il existe plusieurs commandes dédiées à la gestion des plugins. Pour en savoir plus se reporter à la documentation officielle de SPIP-Cli
https://contrib.spip.net/SPIP-Cli

Créer son plugin

Si vous ne trouvez le plugin correspondant à vos besoins, il est toujours possible de le créer !

Pour apprendre à coder, vos propres plugins :
https://programmer.spip.net/-Developper-des-plugins-

A noter : le plugin La fabrique permet de créer d'une façon simple et rapide un plugin à partir de zéro
https://contrib.spip.net/La-Fabrique

|implode

cy_altern — 2013-12-19T00:39:07Z

Le filtre |implode s'applique à un tableau.

Le filtre '|implode' permet de rassembler un tableau en une chaîne contenant les éléments liés par un séparateur.

Par exemple, à partir de

 [(#SET{mon_tableau, #ARRAY{cle1, 1999, cle2, 12, cle3, 31}})]

[(#GET{mon_tableau}|implode{-})]

retournera : « 1999-12-31 »

Attention :
si le séparateur est le caractère virgule, il faut l'encadrer de guillemets simples :

[(#GET{mon_array}|implode{','})]

- pour que le filtre soit plus pratique à utiliser dans les squelettes, '|implode' inverse l'écriture de la fonction PHP de même nom.

voir aussi le filtre |explode

|explode

cy_altern — 2013-12-19T00:39:03Z

Le filtre |explode permet de découper une chaîne selon un séparateur précisé et d'en placer chaque élément dans un tableau (array au sens PHP).

Par exemple, à partir de #SET{my_date, '31/12/1999'},

#SET{my_array, #GET{my_date}|explode{/}}

générera le tableau ayant pour éléments « 31 », « 12 » et « 1999 » ;

[(#GET{my_array}|foreach)]

retournera donc :

0 => 31 1 => 12 2 => 1999

Attention :

- si le séparateur est le caractère virgule, il faut l'encadrer entre guillemets simples :

#SET{my_array, #GET{my_variable}|explode{','}}

- pour que le filtre soit plus pratique d'utilisation dans les squelettes, '|explode' inverse l'écriture de la fonction PHP de même nom.

voir aussi le filtre |implode

|embarque_src

cy_altern — 2013-02-04T15:34:43Z

Le filtre |embarque_src appliqué à une balise img permet de passer sa source sous forme d'un Data URI Scheme encodé en base 64

Sommaire

Le filtre |embarque_src appliqué à une balise permet de modifier l'attribut src pour générer et récupérer l'image sous forme d'un « Data URI Scheme » encodé en base 64, de la forme : ][;base64]," />.

Exemple

[(#CHEMIN{images/tdm.png}|balise_img)]

retourne

alors que

[(#CHEMIN{images/tdm.png}|balise_img|embarque_src)]

va retourner

…le fichier ne sera donc pas chargé depuis la source mais affiché directement à partir de la chaîne encodée.

Limite de taille

Le but de ce filtre est d'embarquer de petites images.
Si l'image passée est trop grosse (par défaut 4 ko), le filtre ne s'appliquera pas et retournera le chemin de l'image.

Toutefois, il est possible de forcer ce paramètre

[(#CHEMIN{img/newsletter_banner.png}|balise_img|embarque_src{9000})]

NB : ce filtre est fourni par le plugin-dist compresseur, par la fonction PHP filtre_embarque_src.

Attention : le résultat fourni par ce filtre n'est pas pris en charge par tous les navigateurs ou courrielleurs.

Voir aussi

Les balises

les filtres

voir aussi |embarque_fichier

|embarque_fichier

cy_altern — 2013-02-04T15:31:02Z

Le filtre |embarque_fichier permet de remplacer un fichier embarqué dans une balise par son équivalent en Data URI Scheme encodée en base 64

Sommaire

Le filtre |embarque_fichier appliqué à un chemin vers un fichier retourne la version « Data URI Scheme » encodée en base 64 de ce fichier, qui contient directement les données. De la forme : data:[][;base64],.