Het bestand plugin.xml
moet in de root van de plug-in worden aangemaakt. Het bevat de beschrijving van het programma en stelt je in staat om bepaalde acties te definiëren.
Het minimum zou dit kunnen zijn (niet-ASCII-tekens zijn ontsnapt):
<plugin>
<nom>Porte plume - Une barre d'outil pour bien écrire</nom>
<auteur>Matthieu Marcillaud</auteur>
<licence>GNU/GLP</licence>
<version>1.2.1</version>
<description>
"Porte plume" est une barre d'outil géniale pour SPIP [...]
</description>
<etat>stable</etat>
<prefix>porte_plume</prefix>
</plugin>
Deze attributen zijn eenvoudig te begrijpen, maar laten we ze beschrijven:
-
nom
: naam van de plug-in, -
auteur
: auteur(s) van de plug-in, -
licence
: licentie(s) van de plug-in, -
version
: versie van de plug-in. Deze naam wordt weergegeven in de privé gedeelte wanneer informatie over de plug-in wordt opgevraagd, het wordt ook gebruikt om afhankelijkheden tussen plug-ins te beheren, gekoppeld aan de prefix. Een ander niet te verwarren attribuut is ’version_base’ dat gebruikt wordt wanneer de plug-in tabellen of velden in de database aanmaakt, -
description
: de omschrijving van de plug-in, -
etat
: status van de plug-in, kan zijn "dev" (in ontwikkeling), "test" (in test) of "stable" (stabiel), -
prefix
: unieke prefix die de plug-in van andere onderscheidt. Geen cijfers en geschreven in kleine letters.