Version 7 — Septembre 2012 — b_b
Remarque : une fois cet article complété, il devra être déplacé dans les pages d’aide de plugins.spip.net.
Le moins que vous puissiez faire pour mettre à disposition une contribution pour SPIP est de
- rédiger son mode d’emploi
- publier ce mode d’emploi sur le Web.
C’est la vocation initiale de SPIP-Contrib d’accueillir vos modes d’emplois, donc vos contributions y sont bienvenues ! Toutefois, vous pouvez aussi déposer votre contribution ailleurs sur le web, si vous le préférez, du moment que c’est sur un site pérenne.
Si ce n’est pas déjà le cas, vous ajoutez pour cela un fichier paquet.xml (ou plugin.xml si c’est pour SPIP2).
Voyez :
- Rédaction des plugin.xml
- http://doc.spip.org/@Plugin-xml pour SPIP2
- pour les plugins implémentant des squelettes, voyez Plugins pour squelettes pour SPIP2 ou Plugins pour squelettes (pour SPIP3)
N’oubliez pas le mode d’emploi : le fichier plugin.xml ou paquet.xml doit contenir un lien vers ce mode d’emploi.
Pour distribuer votre plugin, vous pouvez ensuite compresser ce plugin en paquet zip vous-même, ou en déposer le source sur la Zone de SPIP : votre plugin disposera alors d’un paquet toujours à jour.
- Avantage : la zone et SVN facilitent le travail collaboratif : d’autres peuvent corriger un bug, améliorer le plugin, le faire évoluer, le maintenir, le rendre compatible avec les nouvelles versions de spip
- Autre avantage : votre plugin disposera alors d’un paquet toujours à jour
- Attention : nettoyez votre code, documentez-le, et éliminez les fichiers accessoires ou personnels...
Voyez les explications :
- Comment récupérer les sources mais aussi comment en ajouter
- sur le carnet wiki de contrib : http://contrib.spip.net/La-Zone-Facile ou http://contrib.spip.net/Publier-son...
Si vous avez déposé votre plugin sur la zone, il suffit de le déclarer dans le fichier archivelist.txt pour qu’ensuite un zip soit automatiquement généré. Le format de ce fichier est expliqué dans ses premières lignes. Le zip est généré dans l’heure qui suit.
Le plugin est ensuite automatiquement présenté dans la liste de files.spip.org ainsi que sur le site officiel plugins.spip.net : ce sont les informations présentes dans le fichier .xml qui alimentent automatiquement ce site.
Par ailleurs, si le lien de documentation présente dans le XML pointe vers un article de spip-contrib, alors les motclés de compatibilité avec SPIP sont automatiquement mis à jour sur spip-contrib, à partir des informations de compatibilité également présentes dans le XML.
Il n’y a rien de spécial à faire pour ça : dés lors qu’il est référencé sur plugins.spip.net, le zip est dispo dans la page « ajouter des plugins » de l’espace privé dé spip.