Programmer avec SPIP 3.0
Documentation technique sur SPIP 3.0

> > > plugin.xml minimum

plugin.xml minimum

Le fichier plugin.xml doit être créé à la racine de votre plugin. Il contient la description de celui-ci et permet de définir certaines actions.

Le minimum pourrait être cela (les caractères hors ASCII sont échappés) :

  1. <plugin>
  2. <nom>Porte plume - Une barre d'outil pour bien &eacute;crire</nom>
  3. <auteur>Matthieu Marcillaud</auteur>
  4. <licence>GNU/GLP</licence>
  5. <version>1.2.1</version>
  6. <description>
  7. "Porte plume" est une barre d'outil g&eacute;niale pour SPIP [...]
  8. </description>
  9. <etat>stable</etat>
  10. <prefix>porte_plume</prefix>
  11. </plugin>

Télécharger

Ces attributs sont simples à comprendre, mais décrivons-les :

  • nom : nom du plugin,
  • auteur : auteur(s) du plugin,
  • licence : licence(s) du plugin,
  • version : version du plugin. Ce nommage est affiché dans l’espace privé lorsqu’on demande des informations sur le plugin, il sert aussi à gérer les dépendances entre plugins, couplé avec le préfixe. Un autre attribut à ne pas confondre est ’version_base’ qui sert lorsque le plugin crée des tables ou des champs dans la base de données,
  • description : c’est assez évident !
  • etat : état d’avancement du plugin, peut être « dev » (en développement), « test » (en test) ou stable
  • prefix : préfixe unique distinguant ce plugin d’un autre. Pas de chiffre, écrit en minuscule.