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

Si vous souhaitez faire de votre contribution un plugin SPIP - ce qui facilite son utilisation - suivez la démarche expliquée dans la rubrique Développer des plugins du site programmer.spip.net. Cette documentation est rédigée pour SPIP 2 mais les principes restent quasiment identiques pour SPIP 3 à l’exception du fichier plugin.xml qui est remplacé par paquet.xml.

Pour plus d’information sur ces fichiers XML de définition du plugin, à savoir, plugin.xml pour SPIP 2 et paquet.xml pour SPIP 3, consultez les articles suivants :

N’oubliez pas d’indiquer l’emplacement de votre mode d’emploi dans le fichier XML du plugin afin que la documentation soit accessible depuis les divers affichages du plugin (interface d’administration, site des plugins...).

Pour distribuer votre plugin, vous pouvez toujours utiliser la méthode présentée dans le premier paragraphe (création et publication manuelle d’une archive et d’un mode d’emploi). Néanmoins, nous vous conseillons de suivre la méthode proposée dans les paragraphes suivants.

Déposer une contribution sur la Zone

La Zone est un espace propulsé par Subversion (en abrégé SVN) - 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 en premier lieu demander un login aux administrateurs : un mail adressé à la liste « spip-zone » suffit.

Ensuite, veuillez consulter les articles suivants pour vous familiariser avec les outils et les usages de la Zone :

Enfin, la liste « spip-zone-commit » vous permettra de suivre la vie de la Zone et plus particulièrement de vos contributions.

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 peut ainsi être automatisée : vous disposerez donc constamment d’une archive à jour.

Pour cela, il suffit de déclarer [1] votre contribution :

Votre zip sera généré dans l’heure qui suit.

Une fois généré, le zip de votre contribution est automatiquement présenté et téléchargeable depuis la page files.spip.org. Les plugins sont en outre automatiquement référencés dans l’annuaire officiel des plugins SPIP [2] : 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, avec SPIP 3, un plugin hébergé sur la Zone bénéficiera de la nouvelle interface d’administration motorisée par le plugin SVP.

[1L’en-tête du fichier explique le format des déclarations

[2N’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