Distribuer une contribution

Publier simplement une contribution

Le moins que vous puissiez faire pour mettre à disposition une contribution pour SPIP est de :

  • packager la contribution dans un zip téléchargeable,
  • rédiger son mode d’emploi,
  • publier ce mode d’emploi ainsi que le zip sur le Web.

C’est la vocation initiale de SPIP-Contrib que d’accueillir vos modes d’emploi : vos contributions y sont donc les bienvenues ! Toutefois, si vous le préférez, vous pouvez aussi publier votre contribution ailleurs sur le web, du moment que vous en assurez la pérennité.

Transformer une contribution en plugin pour SPIP

Faire de votre contribution un plugin SPIP facilite grandement son utilisation. Pour cela, suivez la démarche expliquée dans la rubrique Développer des plugins du site programmer.spip.net.

Pour plus d’information sur les fichiers paquet.xml qui contiennent la définition du plugin à partir de SPIP 3, consultez les articles suivants :

N’oubliez pas d’indiquer l’emplacement de votre mode d’emploi dans ce fichier XML afin que la documentation soit prise en compte et rendue accessible depuis les divers affichages du plugin : interface d’administration, site des plugins...

Pour distribuer votre plugin, nous vous conseillons de suivre la méthode proposée dans les paragraphes suivants.

Déposer une contribution sur la dépot communautaire

La Zone est un espace propulsé par git - un outil de gestion des versions - qui facilite le travail collaboratif. Sauf spécifications contraires précisées dans un fichier nommé _REGLES_DE_COMMIT tous les utilisateurs enregistrés peuvent participer au développement de vos contributions : corrections de bug, améliorations, évolutions, maintenance...

Pour accéder à cette Zone vous devez le demander au moyen du formulaire "Contribuer au développement".

Ensuite, veuillez consulter les ressources suivantes pour vous familiariser avec les outils et les usages de la Zone :
 Guide SPIP pour git
 FAQ pratique : comment giter pour SPIP

Enfin, plusieurs forums ou mailing-listes permettent de suivre la vie de la Zone et plus particulièrement de vos contributions, ou d’en discuter :
 Discussion autour des développements
 Suivi des commits sur les plugins
 Suivi des commits sur le core

Diffuser une contribution hébergée sur la Zone

L’un des avantages de déposer sa contribution sur la Zone est que la génération du zip et sa distribution par SVP dans toutes les SPIP peut y être automatisée : vous disposerez donc constamment d’une archive à jour.

Pour cela, il suffit
 de déclarer une nouvelle version dans le fichier paquet.xml (au format semver ; exemple : 1.2.3)
 de créer un tag formé de la lettre ’v’ suivie du numéro de version (exemple : v1.2.3)

Votre zip sera généré dans l’heure qui suit et automatiquement présenté sur l’annuaire officiel des plugins SPIP plugins.spip.net [1] : Plugins SPIP.

Par ailleurs, si le lien de documentation est présent dans le fichier XML et pointe vers un article de SPIP-Contrib, alors les mots-clés de compatibilité avec SPIP sont automatiquement mis à jour dans l’article correspondant (synchronisation avec l’intervalle SPIP précisé dans le fichier XML).

Installer un plugin dans un site SPIP

Que votre plugin soit hébergé ou pas sur la Zone, l’interface d’administration des plugins de SPIP 2 ou SPIP 3 vous permettra toujours de charger le zip (via son url ou par choix dans une liste).

Néanmoins, un plugin hébergé sur la Zone communautaire bénéficiera de la nouvelle interface d’administration motorisée par le plugin SVP, et il sera installable sur tous les sites SPIP via leur page de gestion des plugins.

[1N’oubliez pas que ce sont les informations du fichier XML qui sont à la base de cet annuaire : il est donc essentiel d’y porter toute votre attention