Un fichier paquet.xml
doit être présent à la racine de tout plugin. Ce fichier contient la description normalisée du plugin et permet de définir certaines actions.
Sa documentation figure sur le site dédié aux plugins : Rédaction du fichier paquet.xml
Modification du fichier paquet.xml
Après toute modification du fichier paquet.xml
, il faut impérativement passer par la page de gestion des plugins : cela permet la prise en compte des modifications et les mise à jour des caches.
Historique
- SPIP 3.0 :
paquet.xml
remplace plugin.xml
(mais ce dernier continue d’être compris) - SPIP 2.0 : Un fichier
plugin.xml
était utilisé pour cet usage.
Exemple
Voici le contenu du fichier paquet.xml
pour le plugin "mots_techniques" :
<paquet
prefix="mots_techniques"
categorie="outil"
version="1.0.4"
etat="stable"
compatibilite="[3.0.0;3.2.*]"
logo="prive/themes/spip/images/mots-techniques-48.png"
schema="0.3"
documentation="https://contrib.spip.net/?article3726"
>
<nom>Mots techniques</nom>
<auteur>Matthieu Marcillaud</auteur>
<auteur>Joseph</auteur>
<licence>GNU/GPL</licence>
<credit lien="http://www.iconfinder.com/icondetails/10622/48/orange_tag_icon">MidTone Design (logo)</credit>
<necessite nom="cextras" compatibilite="[3.0.0;[" />
<utilise nom="mots" compatibilite="[2.4.6;[" />
<utilise nom="gma" compatibilite="[1.2.0;[" />
<pipeline nom="autoriser" inclure="mots_techniques_autorisations.php" />
<pipeline nom="pre_boucle" inclure="mots_techniques_pipelines.php" />
<pipeline nom="declarer_tables_objets_sql" inclure="base/mots_techniques.php" />
<pipeline nom="declarer_champs_extras" inclure="base/mots_techniques.php" />
<pipeline nom="groupes_mots_arborescents_heritages" inclure="base/mots_techniques.php" />
</paquet>
On y trouve
- les différentes indications sur la nature du plugin, pour sa présentation et son utilisation dans l’univers SPIP
- les auteurs, licences et crédits
- les liens de dépendance avec d’autres plugins
- la déclaration des pipelines définis